instana-client 1.0.0__py3-none-any.whl → 1.0.3__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 (604) hide show
  1. instana_client/__init__.py +91 -9
  2. instana_client/api/__init__.py +8 -0
  3. instana_client/api/action_catalog_api.py +329 -6
  4. instana_client/api/action_history_api.py +54 -2
  5. instana_client/api/ai_management_api.py +1973 -0
  6. instana_client/api/apdex_report_api.py +2 -2
  7. instana_client/api/apdex_settings_api.py +8 -9
  8. instana_client/api/api_token_api.py +23 -24
  9. instana_client/api/application_alert_configuration_api.py +79 -66
  10. instana_client/api/application_analyze_api.py +20 -282
  11. instana_client/api/application_catalog_api.py +11 -11
  12. instana_client/api/application_metrics_api.py +14 -14
  13. instana_client/api/application_resources_api.py +171 -44
  14. instana_client/api/application_settings_api.py +134 -104
  15. instana_client/api/application_topology_api.py +11 -2
  16. instana_client/api/audit_log_api.py +2 -2
  17. instana_client/api/authentication_api.py +14 -30
  18. instana_client/api/business_monitoring_api.py +2 -2
  19. instana_client/api/custom_dashboards_api.py +29 -19
  20. instana_client/api/custom_entities_api.py +1398 -0
  21. instana_client/api/end_user_monitoring_api.py +310 -0
  22. instana_client/api/event_settings_api.py +1365 -658
  23. instana_client/api/events_api.py +11 -26
  24. instana_client/api/global_application_alert_configuration_api.py +53 -56
  25. instana_client/api/groups_api.py +888 -87
  26. instana_client/api/health_api.py +8 -5
  27. instana_client/api/host_agent_api.py +274 -8
  28. instana_client/api/infrastructure_alert_configuration_api.py +50 -30
  29. instana_client/api/infrastructure_analyze_api.py +14 -14
  30. instana_client/api/infrastructure_catalog_api.py +44 -13
  31. instana_client/api/infrastructure_metrics_api.py +5 -5
  32. instana_client/api/infrastructure_resources_api.py +11 -11
  33. instana_client/api/infrastructure_topology_api.py +2 -2
  34. instana_client/api/log_alert_configuration_api.py +50 -30
  35. instana_client/api/logging_analyze_api.py +343 -0
  36. instana_client/api/maintenance_configuration_api.py +32 -20
  37. instana_client/api/mobile_app_analyze_api.py +2 -2
  38. instana_client/api/mobile_app_catalog_api.py +8 -2
  39. instana_client/api/mobile_app_configuration_api.py +3058 -334
  40. instana_client/api/mobile_app_metrics_api.py +3 -6
  41. instana_client/api/policies_api.py +14 -11
  42. instana_client/api/releases_api.py +8 -11
  43. instana_client/api/roles_api.py +1410 -0
  44. instana_client/api/service_levels_alert_configuration_api.py +2 -2
  45. instana_client/api/service_levels_objective_slo_configurations_api.py +211 -87
  46. instana_client/api/service_levels_objective_slo_report_api.py +38 -2
  47. instana_client/api/session_settings_api.py +2 -2
  48. instana_client/api/sli_report_api.py +2 -2
  49. instana_client/api/sli_settings_api.py +5 -8
  50. instana_client/api/slo_correction_configurations_api.py +1537 -0
  51. instana_client/api/slo_correction_windows_api.py +392 -0
  52. instana_client/api/synthetic_alert_configuration_api.py +53 -56
  53. instana_client/api/synthetic_calls_api.py +20 -9
  54. instana_client/api/synthetic_catalog_api.py +20 -2
  55. instana_client/api/synthetic_metrics_api.py +5 -5
  56. instana_client/api/synthetic_settings_api.py +1915 -477
  57. instana_client/api/synthetic_test_playback_results_api.py +307 -20
  58. instana_client/api/teams_api.py +1380 -0
  59. instana_client/api/usage_api.py +2 -2
  60. instana_client/api/user_api.py +41 -28
  61. instana_client/api/website_analyze_api.py +8 -8
  62. instana_client/api/website_catalog_api.py +11 -8
  63. instana_client/api/website_configuration_api.py +1801 -336
  64. instana_client/api/website_metrics_api.py +3 -3
  65. instana_client/api_client.py +3 -3
  66. instana_client/configuration.py +14 -7
  67. instana_client/exceptions.py +2 -2
  68. instana_client/models/__init__.py +626 -11
  69. instana_client/models/abstract_integration.py +11 -5
  70. instana_client/models/abstract_rule.py +2 -2
  71. instana_client/models/access_log_entry.py +12 -7
  72. instana_client/models/access_log_response.py +2 -2
  73. instana_client/models/access_rule.py +2 -2
  74. instana_client/models/action.py +2 -2
  75. instana_client/models/action_configuration.py +2 -2
  76. instana_client/models/action_instance.py +2 -2
  77. instana_client/models/action_instance_metadata_entry.py +2 -2
  78. instana_client/models/action_instance_parameter.py +2 -2
  79. instana_client/models/action_instance_request.py +2 -2
  80. instana_client/models/action_instance_request_parameters.py +2 -2
  81. instana_client/models/action_match.py +19 -6
  82. instana_client/models/action_search_space.py +2 -2
  83. instana_client/models/adaptive_baseline.py +3 -3
  84. instana_client/models/adaptive_threshold_rule.py +3 -3
  85. instana_client/models/addition.py +97 -0
  86. instana_client/models/adjusted_timeframe.py +2 -2
  87. instana_client/models/agent_configuration_update.py +2 -2
  88. instana_client/models/alerting_configuration.py +2 -2
  89. instana_client/models/alerting_configuration_with_last_updated.py +2 -2
  90. instana_client/models/alerting_time_window.py +2 -2
  91. instana_client/models/apdex_configuration.py +2 -2
  92. instana_client/models/apdex_configuration_input.py +2 -2
  93. instana_client/models/apdex_entity.py +2 -2
  94. instana_client/models/apdex_report.py +2 -2
  95. instana_client/models/api_create_group.py +2 -2
  96. instana_client/models/api_create_role.py +101 -0
  97. instana_client/models/api_group.py +2 -2
  98. instana_client/models/api_member.py +5 -3
  99. instana_client/models/api_permission_set.py +12 -3
  100. instana_client/models/api_restricted_application_filter.py +2 -2
  101. instana_client/models/api_role.py +102 -0
  102. instana_client/models/api_tag.py +91 -0
  103. instana_client/models/api_team.py +113 -0
  104. instana_client/models/api_team_info.py +89 -0
  105. instana_client/models/api_team_member.py +102 -0
  106. instana_client/models/api_team_role.py +92 -0
  107. instana_client/models/api_team_scope.py +131 -0
  108. instana_client/models/api_token.py +35 -5
  109. instana_client/models/app_data_metric_configuration.py +2 -2
  110. instana_client/models/application.py +2 -2
  111. instana_client/models/application_alert_config.py +2 -2
  112. instana_client/models/application_alert_config_with_metadata.py +2 -2
  113. instana_client/models/application_alert_rule.py +2 -2
  114. instana_client/models/application_apdex_entity.py +2 -2
  115. instana_client/models/application_config.py +2 -2
  116. instana_client/models/application_event_result.py +6 -7
  117. instana_client/models/application_item.py +2 -2
  118. instana_client/models/application_metric_result.py +2 -2
  119. instana_client/models/application_node.py +2 -2
  120. instana_client/models/application_result.py +2 -2
  121. instana_client/models/application_scope.py +4 -4
  122. instana_client/models/application_scope_with_metadata.py +6 -6
  123. instana_client/models/application_sli_entity.py +2 -2
  124. instana_client/models/application_slo_entity.py +2 -2
  125. instana_client/models/application_time_threshold.py +2 -2
  126. instana_client/models/arithmetic_configuration.py +123 -0
  127. instana_client/models/arithmetic_operand.py +154 -0
  128. instana_client/models/arithmetic_operation.py +128 -0
  129. instana_client/models/audit_log_entry.py +2 -2
  130. instana_client/models/audit_log_ui_response.py +2 -2
  131. instana_client/models/author.py +2 -2
  132. instana_client/models/availability_blueprint_indicator.py +5 -16
  133. instana_client/models/availability_sli_entity.py +2 -2
  134. instana_client/models/available_metrics.py +2 -2
  135. instana_client/models/available_plugins.py +2 -2
  136. instana_client/models/backend_trace_reference.py +2 -2
  137. instana_client/models/bidirectional_ms_teams_app_integration.py +108 -0
  138. instana_client/models/bidirectional_slack_app_integration.py +104 -0
  139. instana_client/models/binary_operator_dto.py +2 -2
  140. instana_client/models/browser_script_configuration.py +5 -3
  141. instana_client/models/browser_script_configuration_update.py +129 -0
  142. instana_client/models/built_in_event_specification.py +2 -2
  143. instana_client/models/built_in_event_specification_with_last_updated.py +2 -2
  144. instana_client/models/business_activity.py +5 -3
  145. instana_client/models/business_perspective_config.py +2 -2
  146. instana_client/models/call_groups_item.py +2 -2
  147. instana_client/models/call_groups_result.py +2 -2
  148. instana_client/models/call_relation.py +2 -2
  149. instana_client/models/change_summary.py +2 -2
  150. instana_client/models/cloudfoundry_physical_context.py +4 -4
  151. instana_client/models/condition.py +2 -2
  152. instana_client/models/config_version.py +2 -2
  153. instana_client/models/correction.py +105 -0
  154. instana_client/models/correction_configuration.py +110 -0
  155. instana_client/models/correction_scheduling.py +105 -0
  156. instana_client/models/correction_window.py +95 -0
  157. instana_client/models/crash_mobile_app_alert_rule.py +2 -2
  158. instana_client/models/create_website_request_inner.py +90 -0
  159. instana_client/models/cursor_paginated_business_activity_item.py +2 -2
  160. instana_client/models/cursor_pagination.py +2 -2
  161. instana_client/models/cursor_pagination_infra_explore_cursor.py +2 -2
  162. instana_client/models/custom_blueprint_indicator.py +8 -4
  163. instana_client/models/custom_dashboard.py +2 -2
  164. instana_client/models/custom_dashboard_preview.py +2 -2
  165. instana_client/models/custom_dashboard_with_user_specific_information.py +115 -0
  166. instana_client/models/custom_dependency.py +119 -0
  167. instana_client/models/custom_email_subject_prefix.py +2 -2
  168. instana_client/models/custom_entity_model.py +126 -0
  169. instana_client/models/custom_entity_with_metadata.py +98 -0
  170. instana_client/models/custom_event_mobile_app_alert_rule.py +2 -2
  171. instana_client/models/custom_event_specification.py +9 -3
  172. instana_client/models/custom_event_specification_with_last_updated.py +9 -3
  173. instana_client/models/custom_event_website_alert_rule.py +2 -2
  174. instana_client/models/custom_metric.py +134 -0
  175. instana_client/models/custom_payload_configuration.py +2 -2
  176. instana_client/models/custom_payload_field.py +2 -2
  177. instana_client/models/custom_payload_with_last_updated.py +2 -2
  178. instana_client/models/custom_payload_with_version.py +101 -0
  179. instana_client/models/dashboard_api_token.py +2 -2
  180. instana_client/models/database_integration.py +2 -2
  181. instana_client/models/deprecated_tag_filter.py +4 -4
  182. instana_client/models/division.py +97 -0
  183. instana_client/models/dns_configuration.py +146 -0
  184. instana_client/models/dns_configuration_update.py +143 -0
  185. instana_client/models/dns_filter_query_time.py +99 -0
  186. instana_client/models/dns_filter_target_value.py +106 -0
  187. instana_client/models/duration.py +2 -2
  188. instana_client/models/dynamic_field.py +2 -2
  189. instana_client/models/dynamic_field_value.py +2 -2
  190. instana_client/models/dynamic_parameter.py +2 -2
  191. instana_client/models/edit_user.py +2 -2
  192. instana_client/models/email_integration.py +2 -2
  193. instana_client/models/empty_configuration.py +2 -2
  194. instana_client/models/endpoint.py +4 -4
  195. instana_client/models/endpoint_config.py +2 -2
  196. instana_client/models/endpoint_event_result.py +8 -9
  197. instana_client/models/endpoint_item.py +2 -2
  198. instana_client/models/endpoint_metric_result.py +2 -2
  199. instana_client/models/endpoint_node.py +2 -2
  200. instana_client/models/endpoint_result.py +3 -3
  201. instana_client/models/endpoint_simple.py +3 -3
  202. instana_client/models/entity_count_rule.py +2 -2
  203. instana_client/models/entity_count_verification_rule.py +3 -3
  204. instana_client/models/entity_health_info.py +2 -2
  205. instana_client/models/entity_id.py +2 -2
  206. instana_client/models/entity_verification_rule.py +3 -3
  207. instana_client/models/error_budget_alert_rule.py +5 -5
  208. instana_client/models/errors_application_alert_rule.py +2 -2
  209. instana_client/models/event.py +11 -3
  210. instana_client/models/event_filtering_configuration.py +2 -2
  211. instana_client/models/event_result.py +4 -3
  212. instana_client/models/event_specification_info.py +2 -2
  213. instana_client/models/extended_service.py +2 -2
  214. instana_client/models/failure_synthetic_alert_rule.py +2 -2
  215. instana_client/models/fixed_http_path_segment_matching_rule.py +2 -2
  216. instana_client/models/fixed_time_window.py +4 -3
  217. instana_client/models/generic_infra_alert_rule.py +12 -4
  218. instana_client/models/geo_location_configuration.py +2 -2
  219. instana_client/models/geo_mapping_rule.py +2 -2
  220. instana_client/models/geo_subdivision.py +2 -2
  221. instana_client/models/get_activities.py +2 -2
  222. instana_client/models/get_application_metrics.py +2 -2
  223. instana_client/models/get_applications.py +2 -2
  224. instana_client/models/get_available_metrics_query.py +2 -2
  225. instana_client/models/get_available_plugins_query.py +2 -2
  226. instana_client/models/get_call_groups.py +2 -2
  227. instana_client/models/get_combined_metrics.py +2 -2
  228. instana_client/models/get_dynamic_parameter_values.py +2 -2
  229. instana_client/models/get_endpoints.py +2 -2
  230. instana_client/models/get_infrastructure_groups_query.py +2 -2
  231. instana_client/models/get_infrastructure_query.py +2 -2
  232. instana_client/models/get_metrics_result.py +2 -2
  233. instana_client/models/get_mobile_app_beacon_groups.py +2 -2
  234. instana_client/models/get_mobile_app_beacons.py +2 -2
  235. instana_client/models/get_mobile_app_metrics.py +2 -2
  236. instana_client/models/get_mobile_app_metrics_v2.py +2 -2
  237. instana_client/models/get_payload_keys_result.py +2 -2
  238. instana_client/models/get_services.py +2 -2
  239. instana_client/models/get_snapshots_query.py +2 -2
  240. instana_client/models/get_test_result.py +2 -2
  241. instana_client/models/get_test_result_analytic.py +126 -0
  242. instana_client/models/get_test_result_base.py +2 -2
  243. instana_client/models/get_test_result_list.py +2 -2
  244. instana_client/models/get_test_summary_result.py +2 -2
  245. instana_client/models/get_trace_download_result_item.py +3 -3
  246. instana_client/models/get_trace_groups.py +2 -2
  247. instana_client/models/get_traces.py +4 -4
  248. instana_client/models/get_website_beacon_groups.py +2 -2
  249. instana_client/models/get_website_beacons.py +2 -2
  250. instana_client/models/get_website_metrics.py +2 -2
  251. instana_client/models/get_website_metrics_v2.py +2 -2
  252. instana_client/models/global_application_alert_config_with_metadata.py +2 -2
  253. instana_client/models/global_applications_alert_config.py +2 -2
  254. instana_client/models/google_chat_integration.py +2 -2
  255. instana_client/models/graph_edge.py +2 -2
  256. instana_client/models/graph_node.py +2 -2
  257. instana_client/models/group.py +2 -2
  258. instana_client/models/group_by_tag.py +2 -2
  259. instana_client/models/group_mapping.py +5 -3
  260. instana_client/models/group_mapping_overview.py +96 -0
  261. instana_client/models/health_state.py +2 -2
  262. instana_client/models/historic_baseline.py +3 -3
  263. instana_client/models/host_availability_rule.py +2 -2
  264. instana_client/models/http_action_configuration.py +2 -2
  265. instana_client/models/http_action_configuration_update.py +138 -0
  266. instana_client/models/http_endpoint_config.py +2 -2
  267. instana_client/models/http_endpoint_rule.py +2 -2
  268. instana_client/models/http_path_segment_matching_rule.py +2 -2
  269. instana_client/models/http_script_configuration.py +5 -3
  270. instana_client/models/http_script_configuration_update.py +115 -0
  271. instana_client/models/hyper_param.py +2 -2
  272. instana_client/models/identity_provider_patch.py +2 -2
  273. instana_client/models/impacted_beacon_info.py +96 -0
  274. instana_client/models/infra_alert_config.py +8 -6
  275. instana_client/models/infra_alert_config_with_metadata.py +7 -5
  276. instana_client/models/infra_alert_rule.py +9 -3
  277. instana_client/models/infra_event_result.py +7 -8
  278. instana_client/models/infra_metric_configuration.py +103 -80
  279. instana_client/models/infra_slo_entity.py +95 -0
  280. instana_client/models/infra_time_threshold.py +2 -2
  281. instana_client/models/infrastructure_entities_result.py +2 -2
  282. instana_client/models/infrastructure_group.py +5 -3
  283. instana_client/models/infrastructure_groups_result.py +2 -2
  284. instana_client/models/infrastructure_item.py +2 -2
  285. instana_client/models/infrastructure_metric_result.py +2 -2
  286. instana_client/models/instana_version_info.py +2 -2
  287. instana_client/models/integration_overview.py +14 -4
  288. instana_client/models/invitation.py +6 -4
  289. instana_client/models/invitation_response.py +2 -2
  290. instana_client/models/invitation_result.py +2 -2
  291. instana_client/models/ip_masking_configuration.py +2 -2
  292. instana_client/models/js_stack_trace_line.py +2 -2
  293. instana_client/models/kubernetes_physical_context.py +3 -3
  294. instana_client/models/latency_blueprint_indicator.py +5 -16
  295. instana_client/models/llm_egress_gateway.py +124 -0
  296. instana_client/models/location_status.py +2 -2
  297. instana_client/models/log_alert_config.py +8 -6
  298. instana_client/models/log_alert_config_with_metadata.py +8 -6
  299. instana_client/models/log_alert_rule.py +2 -2
  300. instana_client/models/log_count_alert_rule.py +2 -2
  301. instana_client/models/log_entry_actor.py +2 -2
  302. instana_client/models/log_event_result.py +6 -7
  303. instana_client/models/log_time_threshold.py +2 -2
  304. instana_client/models/log_volume_group.py +91 -0
  305. instana_client/models/log_volume_usage_item.py +101 -0
  306. instana_client/models/log_volume_usage_result.py +96 -0
  307. instana_client/models/logs_application_alert_rule.py +4 -4
  308. instana_client/models/maintenance_config.py +2 -2
  309. instana_client/models/maintenance_config_scheduling.py +2 -2
  310. instana_client/models/maintenance_config_v2.py +2 -2
  311. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +2 -2
  312. instana_client/models/maintenance_config_with_last_updated.py +2 -2
  313. instana_client/models/maintenance_window.py +2 -2
  314. instana_client/models/manual_alerting_channel_configuration.py +2 -2
  315. instana_client/models/manual_close_info.py +2 -2
  316. instana_client/models/manual_service_config.py +2 -2
  317. instana_client/models/match_all_http_path_segment_matching_rule.py +2 -2
  318. instana_client/models/match_expression_dto.py +3 -3
  319. instana_client/models/meta_data.py +2 -2
  320. instana_client/models/metric_api_result.py +2 -2
  321. instana_client/models/metric_config.py +2 -2
  322. instana_client/models/metric_configuration.py +3 -3
  323. instana_client/models/metric_description.py +2 -2
  324. instana_client/models/metric_instance.py +2 -2
  325. instana_client/models/metric_item.py +2 -2
  326. instana_client/models/metric_metadata.py +4 -4
  327. instana_client/models/metric_pattern.py +2 -2
  328. instana_client/models/metric_query.py +128 -0
  329. instana_client/models/metrics_result.py +2 -2
  330. instana_client/models/metrics_result_item.py +5 -3
  331. instana_client/models/metrics_test_result_item.py +2 -2
  332. instana_client/models/mobile_app.py +2 -2
  333. instana_client/models/mobile_app_alert_config.py +2 -2
  334. instana_client/models/mobile_app_alert_rule.py +8 -5
  335. instana_client/models/mobile_app_beacon_groups_item.py +2 -2
  336. instana_client/models/mobile_app_beacon_groups_result.py +2 -2
  337. instana_client/models/mobile_app_beacon_result.py +2 -2
  338. instana_client/models/mobile_app_beacon_tag_group.py +2 -2
  339. instana_client/models/mobile_app_beacons_item.py +11 -5
  340. instana_client/models/mobile_app_event_result.py +6 -7
  341. instana_client/models/mobile_app_metric_result.py +2 -2
  342. instana_client/models/mobile_app_monitoring_beacon.py +22 -4
  343. instana_client/models/mobile_app_monitoring_metric_description.py +5 -3
  344. instana_client/models/mobile_app_monitoring_metrics_configuration.py +2 -2
  345. instana_client/models/mobile_app_time_threshold.py +2 -2
  346. instana_client/models/model_field.py +2 -2
  347. instana_client/models/monitored_entities_stats.py +92 -0
  348. instana_client/models/monitoring_state.py +11 -3
  349. instana_client/models/multiple_scripts_configuration.py +2 -2
  350. instana_client/models/multiplication.py +97 -0
  351. instana_client/models/nested_operation.py +128 -0
  352. instana_client/models/new_application_config.py +2 -2
  353. instana_client/models/new_business_perspective_config.py +2 -2
  354. instana_client/models/new_manual_service_config.py +2 -2
  355. instana_client/models/o_auth_config.py +110 -0
  356. instana_client/models/o_auth_integration.py +98 -0
  357. instana_client/models/o_auth_token.py +111 -0
  358. instana_client/models/occurrence.py +2 -2
  359. instana_client/models/office365_integration.py +2 -2
  360. instana_client/models/one_time_maintenance_window.py +2 -2
  361. instana_client/models/opsgenie_integration.py +2 -2
  362. instana_client/models/order.py +2 -2
  363. instana_client/models/pagerduty_integration.py +2 -2
  364. instana_client/models/paginated_result.py +2 -2
  365. instana_client/models/pagination.py +2 -2
  366. instana_client/models/parameter.py +2 -2
  367. instana_client/models/parameter_value.py +2 -2
  368. instana_client/models/path_parameter_http_path_segment_matching_rule.py +2 -2
  369. instana_client/models/physical_context.py +3 -3
  370. instana_client/models/plugin_result.py +2 -2
  371. instana_client/models/policy.py +2 -2
  372. instana_client/models/policy_runnable.py +2 -2
  373. instana_client/models/policy_scheduling.py +91 -0
  374. instana_client/models/post_mobile_app_source_map_config_request.py +88 -0
  375. instana_client/models/post_snapshots_result.py +2 -2
  376. instana_client/models/problem.py +2 -2
  377. instana_client/models/prometheus_webhook_integration.py +2 -2
  378. instana_client/models/recurrent_maintenance_window.py +2 -2
  379. instana_client/models/release.py +6 -6
  380. instana_client/models/release_scope.py +2 -2
  381. instana_client/models/release_with_metadata.py +8 -8
  382. instana_client/models/retention_period.py +101 -0
  383. instana_client/models/rolling_time_window.py +4 -3
  384. instana_client/models/rule_input.py +2 -2
  385. instana_client/models/rule_with_threshold_application_alert_rule.py +2 -2
  386. instana_client/models/rule_with_threshold_infra_alert_rule.py +2 -2
  387. instana_client/models/rule_with_threshold_log_alert_rule.py +2 -2
  388. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +2 -2
  389. instana_client/models/rule_with_threshold_website_alert_rule.py +2 -2
  390. instana_client/models/run_configuration.py +2 -2
  391. instana_client/models/salesforce_integration.py +2 -2
  392. instana_client/models/saturation_blueprint_indicator.py +97 -0
  393. instana_client/models/scope_binding.py +2 -2
  394. instana_client/models/search_field_result.py +2 -2
  395. instana_client/models/service.py +3 -3
  396. instana_client/models/service_config.py +2 -2
  397. instana_client/models/service_event_result.py +6 -7
  398. instana_client/models/service_item.py +2 -2
  399. instana_client/models/service_level_indicator.py +10 -7
  400. instana_client/models/service_level_objective_alert_rule.py +2 -2
  401. instana_client/models/service_level_objective_configuration.py +3 -3
  402. instana_client/models/service_levels_alert_config.py +15 -5
  403. instana_client/models/service_levels_alert_rule.py +2 -2
  404. instana_client/models/service_levels_burn_rate_config.py +115 -0
  405. instana_client/models/service_levels_burn_rate_time_windows.py +2 -2
  406. instana_client/models/service_levels_static_threshold_config.py +100 -0
  407. instana_client/models/service_levels_time_threshold.py +5 -5
  408. instana_client/models/service_levelse_alert_config_with_metadata.py +15 -5
  409. instana_client/models/service_map.py +2 -2
  410. instana_client/models/service_map_connection.py +2 -2
  411. instana_client/models/service_matching_rule.py +2 -2
  412. instana_client/models/service_metric_result.py +2 -2
  413. instana_client/models/service_node.py +2 -2
  414. instana_client/models/service_now_enhanced_integration.py +2 -2
  415. instana_client/models/service_now_integration.py +2 -2
  416. instana_client/models/service_result.py +3 -3
  417. instana_client/models/service_scope.py +4 -4
  418. instana_client/models/service_scope_with_metadata.py +5 -5
  419. instana_client/models/service_scoped_to.py +3 -3
  420. instana_client/models/service_scoped_to_with_metadata.py +4 -4
  421. instana_client/models/service_simple.py +2 -2
  422. instana_client/models/session_settings.py +4 -4
  423. instana_client/models/simple_metric_configuration.py +123 -0
  424. instana_client/models/single_value.py +128 -0
  425. instana_client/models/slack_integration.py +2 -2
  426. instana_client/models/sli_configuration.py +2 -2
  427. instana_client/models/sli_configuration_with_last_updated.py +2 -2
  428. instana_client/models/sli_entity.py +2 -2
  429. instana_client/models/sli_report.py +2 -2
  430. instana_client/models/slo_config_with_rbac_tag.py +128 -0
  431. instana_client/models/slo_entity.py +8 -5
  432. instana_client/models/slo_report.py +2 -2
  433. instana_client/models/slowness_application_alert_rule.py +2 -2
  434. instana_client/models/slowness_mobile_app_alert_rule.py +90 -0
  435. instana_client/models/slowness_website_alert_rule.py +2 -2
  436. instana_client/models/snapshot_item.py +2 -2
  437. instana_client/models/snapshot_preview.py +7 -7
  438. instana_client/models/snapshot_result.py +2 -2
  439. instana_client/models/software_user.py +2 -2
  440. instana_client/models/software_version.py +2 -2
  441. instana_client/models/source_map_file_blob.py +2 -2
  442. instana_client/models/source_map_file_meta.py +2 -2
  443. instana_client/models/source_map_upload_config.py +2 -2
  444. instana_client/models/source_map_upload_configs.py +106 -0
  445. instana_client/models/span_excerpt.py +12 -12
  446. instana_client/models/span_relation.py +3 -3
  447. instana_client/models/specific_js_errors_website_alert_rule.py +4 -4
  448. instana_client/models/splunk_integration.py +2 -2
  449. instana_client/models/ssl_certificate_configuration.py +17 -5
  450. instana_client/models/ssl_certificate_configuration_update.py +107 -0
  451. instana_client/models/ssl_certificate_validation.py +99 -0
  452. instana_client/models/stack_trace_item.py +7 -7
  453. instana_client/models/stack_trace_line.py +2 -2
  454. instana_client/models/static_baseline_threshold_rule.py +3 -3
  455. instana_client/models/static_string_field.py +2 -2
  456. instana_client/models/static_threshold.py +2 -2
  457. instana_client/models/static_threshold_rule.py +2 -2
  458. instana_client/models/status_code_application_alert_rule.py +2 -2
  459. instana_client/models/status_code_mobile_app_alert_rule.py +4 -4
  460. instana_client/models/status_code_website_alert_rule.py +4 -4
  461. instana_client/models/subtraction.py +97 -0
  462. instana_client/models/synthetic_alert_config.py +2 -2
  463. instana_client/models/synthetic_alert_config_with_metadata.py +2 -2
  464. instana_client/models/synthetic_alert_rule.py +2 -2
  465. instana_client/models/synthetic_bulk_response.py +92 -0
  466. instana_client/models/synthetic_call_config.py +4 -4
  467. instana_client/models/synthetic_call_rule.py +6 -6
  468. instana_client/models/synthetic_call_with_defaults_config.py +4 -4
  469. instana_client/models/synthetic_configuration.py +93 -0
  470. instana_client/models/synthetic_configuration_update.py +95 -0
  471. instana_client/models/synthetic_credential.py +23 -3
  472. instana_client/models/synthetic_datacenter.py +2 -2
  473. instana_client/models/synthetic_datacenter_configuration.py +2 -2
  474. instana_client/models/synthetic_geo_point.py +2 -2
  475. instana_client/models/synthetic_location.py +2 -2
  476. instana_client/models/synthetic_location_configuration.py +2 -2
  477. instana_client/models/synthetic_metric_configuration.py +2 -2
  478. instana_client/models/synthetic_metric_tag_group.py +18 -5
  479. instana_client/models/synthetic_playback_capabilities.py +17 -4
  480. instana_client/models/synthetic_resource_update_list_dns_filter_target_value_list_dns_filter_target_value.py +105 -0
  481. instana_client/models/synthetic_resource_update_list_ssl_certificate_validation_list_ssl_certificate_validation.py +105 -0
  482. instana_client/models/synthetic_resource_update_list_string_list_string.py +90 -0
  483. instana_client/models/synthetic_resource_update_map_string_string_list_string.py +90 -0
  484. instana_client/models/synthetic_slo_entity.py +7 -5
  485. instana_client/models/synthetic_test.py +27 -3
  486. instana_client/models/synthetic_test_cicd.py +96 -0
  487. instana_client/models/synthetic_test_cicd_customization.py +96 -0
  488. instana_client/models/synthetic_test_cicd_item.py +114 -0
  489. instana_client/models/synthetic_test_cicd_response.py +92 -0
  490. instana_client/models/synthetic_test_deep_update.py +122 -0
  491. instana_client/models/synthetic_test_shallow_update.py +122 -0
  492. instana_client/models/synthetic_test_update.py +147 -0
  493. instana_client/models/synthetic_time_threshold.py +2 -2
  494. instana_client/models/synthetic_type_configuration.py +11 -11
  495. instana_client/models/synthetic_type_configuration_update.py +152 -0
  496. instana_client/models/synthetics_event_result.py +6 -7
  497. instana_client/models/system_rule.py +2 -2
  498. instana_client/models/system_rule_label.py +2 -2
  499. instana_client/models/tag.py +6 -6
  500. instana_client/models/tag_catalog.py +2 -2
  501. instana_client/models/tag_filter.py +22 -10
  502. instana_client/models/tag_filter_all_of_value.py +195 -0
  503. instana_client/models/tag_filter_expression.py +2 -2
  504. instana_client/models/tag_filter_expression_element.py +2 -2
  505. instana_client/models/tag_matcher_dto.py +2 -2
  506. instana_client/models/tag_tree_level.py +2 -2
  507. instana_client/models/tag_tree_node.py +2 -2
  508. instana_client/models/tag_tree_tag.py +2 -2
  509. instana_client/models/test_common_properties.py +2 -2
  510. instana_client/models/test_last_error.py +90 -0
  511. instana_client/models/test_result.py +2 -2
  512. instana_client/models/test_result_common_properties.py +24 -3
  513. instana_client/models/test_result_detail_data.py +2 -2
  514. instana_client/models/test_result_item.py +2 -2
  515. instana_client/models/test_result_list_item.py +2 -2
  516. instana_client/models/test_result_list_result.py +2 -2
  517. instana_client/models/test_result_metadata.py +2 -2
  518. instana_client/models/test_result_subtransaction.py +2 -2
  519. instana_client/models/threshold.py +2 -2
  520. instana_client/models/threshold_config_rule.py +2 -2
  521. instana_client/models/threshold_rule.py +2 -2
  522. instana_client/models/throughput_application_alert_rule.py +2 -2
  523. instana_client/models/throughput_mobile_app_alert_rule.py +2 -2
  524. instana_client/models/throughput_website_alert_rule.py +2 -2
  525. instana_client/models/time_frame.py +2 -2
  526. instana_client/models/time_window.py +5 -4
  527. instana_client/models/topology.py +2 -2
  528. instana_client/models/trace.py +8 -8
  529. instana_client/models/trace_activity_tree_node_details.py +27 -15
  530. instana_client/models/trace_download_result.py +2 -2
  531. instana_client/models/trace_groups_item.py +2 -2
  532. instana_client/models/trace_groups_result.py +2 -2
  533. instana_client/models/trace_impact_application_time_threshold.py +2 -2
  534. instana_client/models/trace_item.py +2 -2
  535. instana_client/models/trace_result.py +2 -2
  536. instana_client/models/traffic_blueprint_indicator.py +3 -3
  537. instana_client/models/trigger.py +15 -7
  538. instana_client/models/type_configuration.py +2 -2
  539. instana_client/models/unsupported_http_path_segment_matching_rule.py +2 -2
  540. instana_client/models/updated_business_perspective_config.py +2 -2
  541. instana_client/models/usage_result.py +2 -2
  542. instana_client/models/usage_result_items.py +2 -2
  543. instana_client/models/user_basic_result.py +2 -2
  544. instana_client/models/user_impact_mobile_app_time_threshold.py +3 -3
  545. instana_client/models/user_impact_website_time_threshold.py +3 -3
  546. instana_client/models/user_result.py +2 -2
  547. instana_client/models/users_result.py +2 -2
  548. instana_client/models/validated_alerting_channel_input_info.py +4 -4
  549. instana_client/models/validated_alerting_configuration.py +2 -2
  550. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +2 -2
  551. instana_client/models/validated_maintenance_config_with_status.py +2 -2
  552. instana_client/models/victor_ops_integration.py +2 -2
  553. instana_client/models/violations_in_period_application_time_threshold.py +2 -2
  554. instana_client/models/violations_in_period_mobile_app_time_threshold.py +2 -2
  555. instana_client/models/violations_in_period_website_time_threshold.py +2 -2
  556. instana_client/models/violations_in_sequence_application_time_threshold.py +2 -2
  557. instana_client/models/violations_in_sequence_infra_time_threshold.py +2 -2
  558. instana_client/models/violations_in_sequence_log_time_threshold.py +2 -2
  559. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +2 -2
  560. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +2 -2
  561. instana_client/models/violations_in_sequence_website_time_threshold.py +2 -2
  562. instana_client/models/watson_ai_ops_webhook_integration.py +2 -2
  563. instana_client/models/webex_teams_webhook_integration.py +2 -2
  564. instana_client/models/webhook_integration.py +14 -4
  565. instana_client/models/webpage_action_configuration.py +2 -2
  566. instana_client/models/webpage_action_configuration_update.py +109 -0
  567. instana_client/models/webpage_script_configuration.py +5 -3
  568. instana_client/models/webpage_script_configuration_update.py +111 -0
  569. instana_client/models/website.py +2 -2
  570. instana_client/models/website_alert_config.py +2 -2
  571. instana_client/models/website_alert_config_with_metadata.py +2 -2
  572. instana_client/models/website_alert_rule.py +2 -2
  573. instana_client/models/website_apdex_entity.py +2 -2
  574. instana_client/models/website_beacon_groups_item.py +2 -2
  575. instana_client/models/website_beacon_groups_result.py +2 -2
  576. instana_client/models/website_beacon_result.py +2 -2
  577. instana_client/models/website_beacon_tag_group.py +2 -2
  578. instana_client/models/website_beacons_item.py +11 -5
  579. instana_client/models/website_event_based_sli_entity.py +2 -2
  580. instana_client/models/website_event_result.py +5 -6
  581. instana_client/models/website_metric_result.py +2 -2
  582. instana_client/models/website_monitoring_beacon.py +7 -3
  583. instana_client/models/website_monitoring_metric_description.py +2 -2
  584. instana_client/models/website_monitoring_metrics_configuration.py +2 -2
  585. instana_client/models/website_slo_entity.py +2 -2
  586. instana_client/models/website_time_based_sli_entity.py +2 -2
  587. instana_client/models/website_time_threshold.py +2 -2
  588. instana_client/models/widget.py +2 -2
  589. instana_client/models/with_metadata.py +2 -2
  590. instana_client/models/with_resolved_name.py +2 -2
  591. instana_client/models/z_chat_ops_integration.py +2 -2
  592. instana_client/rest.py +3 -2
  593. instana_client-1.0.3.dist-info/METADATA +1097 -0
  594. instana_client-1.0.3.dist-info/RECORD +599 -0
  595. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/WHEEL +1 -1
  596. instana_client/models/dns_action_configuration.py +0 -134
  597. instana_client/models/dns_action_filter_query_time.py +0 -99
  598. instana_client/models/dns_action_filter_target_value.py +0 -106
  599. instana_client/models/full_trace.py +0 -97
  600. instana_client/models/span.py +0 -156
  601. instana_client-1.0.0.dist-info/METADATA +0 -25
  602. instana_client-1.0.0.dist-info/RECORD +0 -515
  603. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/licenses/LICENSE +0 -0
  604. {instana_client-1.0.0.dist-info → instana_client-1.0.3.dist-info}/top_level.txt +0 -0
@@ -3,9 +3,9 @@
3
3
  """
4
4
  Instana REST API documentation
5
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 ```
6
+ Documentation for INSTANA REST API
7
7
 
8
- The version of the OpenAPI document: 1.291.1002
8
+ The version of the OpenAPI document: 1.309.1268
9
9
  Contact: support@instana.com
10
10
  Generated by OpenAPI Generator (https://openapi-generator.tech)
11
11
 
@@ -30,6 +30,7 @@ from instana_client.models.custom_event_specification import CustomEventSpecific
30
30
  from instana_client.models.custom_event_specification_with_last_updated import CustomEventSpecificationWithLastUpdated
31
31
  from instana_client.models.custom_payload_configuration import CustomPayloadConfiguration
32
32
  from instana_client.models.custom_payload_with_last_updated import CustomPayloadWithLastUpdated
33
+ from instana_client.models.custom_payload_with_version import CustomPayloadWithVersion
33
34
  from instana_client.models.event import Event
34
35
  from instana_client.models.event_specification_info import EventSpecificationInfo
35
36
  from instana_client.models.integration_overview import IntegrationOverview
@@ -324,6 +325,7 @@ class EventSettingsApi:
324
325
 
325
326
  # authentication setting
326
327
  _auth_settings: List[str] = [
328
+ 'ApiKeyAuth'
327
329
  ]
328
330
 
329
331
  return self.api_client.param_serialize(
@@ -402,6 +404,7 @@ class EventSettingsApi:
402
404
  '400': None,
403
405
  '403': None,
404
406
  '422': None,
407
+ '428': None,
405
408
  }
406
409
  response_data = self.api_client.call_api(
407
410
  *_param,
@@ -472,6 +475,7 @@ class EventSettingsApi:
472
475
  '400': None,
473
476
  '403': None,
474
477
  '422': None,
478
+ '428': None,
475
479
  }
476
480
  response_data = self.api_client.call_api(
477
481
  *_param,
@@ -542,6 +546,7 @@ class EventSettingsApi:
542
546
  '400': None,
543
547
  '403': None,
544
548
  '422': None,
549
+ '428': None,
545
550
  }
546
551
  response_data = self.api_client.call_api(
547
552
  *_param,
@@ -903,7 +908,7 @@ class EventSettingsApi:
903
908
  ) -> None:
904
909
  """Delete Alerting Channel
905
910
 
906
- Deletes an alert channel.
911
+ Deletes an alert channel. Requires the permission called CanConfigureIntegrations.
907
912
 
908
913
  :param id: ID of the Alerting Channel to delete. (required)
909
914
  :type id: str
@@ -938,7 +943,7 @@ class EventSettingsApi:
938
943
  )
939
944
 
940
945
  _response_types_map: Dict[str, Optional[str]] = {
941
- '200': None,
946
+ '204': None,
942
947
  }
943
948
  response_data = self.api_client.call_api(
944
949
  *_param,
@@ -970,7 +975,7 @@ class EventSettingsApi:
970
975
  ) -> ApiResponse[None]:
971
976
  """Delete Alerting Channel
972
977
 
973
- Deletes an alert channel.
978
+ Deletes an alert channel. Requires the permission called CanConfigureIntegrations.
974
979
 
975
980
  :param id: ID of the Alerting Channel to delete. (required)
976
981
  :type id: str
@@ -1005,7 +1010,7 @@ class EventSettingsApi:
1005
1010
  )
1006
1011
 
1007
1012
  _response_types_map: Dict[str, Optional[str]] = {
1008
- '200': None,
1013
+ '204': None,
1009
1014
  }
1010
1015
  response_data = self.api_client.call_api(
1011
1016
  *_param,
@@ -1037,7 +1042,7 @@ class EventSettingsApi:
1037
1042
  ) -> RESTResponseType:
1038
1043
  """Delete Alerting Channel
1039
1044
 
1040
- Deletes an alert channel.
1045
+ Deletes an alert channel. Requires the permission called CanConfigureIntegrations.
1041
1046
 
1042
1047
  :param id: ID of the Alerting Channel to delete. (required)
1043
1048
  :type id: str
@@ -1072,7 +1077,7 @@ class EventSettingsApi:
1072
1077
  )
1073
1078
 
1074
1079
  _response_types_map: Dict[str, Optional[str]] = {
1075
- '200': None,
1080
+ '204': None,
1076
1081
  }
1077
1082
  response_data = self.api_client.call_api(
1078
1083
  *_param,
@@ -1191,6 +1196,9 @@ class EventSettingsApi:
1191
1196
  )
1192
1197
 
1193
1198
  _response_types_map: Dict[str, Optional[str]] = {
1199
+ '204': None,
1200
+ '401': None,
1201
+ '403': None,
1194
1202
  }
1195
1203
  response_data = self.api_client.call_api(
1196
1204
  *_param,
@@ -1256,6 +1264,9 @@ class EventSettingsApi:
1256
1264
  )
1257
1265
 
1258
1266
  _response_types_map: Dict[str, Optional[str]] = {
1267
+ '204': None,
1268
+ '401': None,
1269
+ '403': None,
1259
1270
  }
1260
1271
  response_data = self.api_client.call_api(
1261
1272
  *_param,
@@ -1321,6 +1332,9 @@ class EventSettingsApi:
1321
1332
  )
1322
1333
 
1323
1334
  _response_types_map: Dict[str, Optional[str]] = {
1335
+ '204': None,
1336
+ '401': None,
1337
+ '403': None,
1324
1338
  }
1325
1339
  response_data = self.api_client.call_api(
1326
1340
  *_param,
@@ -1361,13 +1375,6 @@ class EventSettingsApi:
1361
1375
  # process the body parameter
1362
1376
 
1363
1377
 
1364
- # set the HTTP header `Accept`
1365
- if 'Accept' not in _header_params:
1366
- _header_params['Accept'] = self.api_client.select_header_accept(
1367
- [
1368
- 'application/json'
1369
- ]
1370
- )
1371
1378
 
1372
1379
 
1373
1380
  # authentication setting
@@ -1412,7 +1419,6 @@ class EventSettingsApi:
1412
1419
  ) -> None:
1413
1420
  """Delete custom event specification
1414
1421
 
1415
- This endpoint deletes a Custom Event Specification. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. However, check out the docs for [updating a configuration](#operation/putCustomEventSpecification) how this default behavior can be changed using the `allowRestore` query parameter. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for the custom event specification to delete. # Example: ``` curl --request DELETE 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' ```
1416
1422
 
1417
1423
  :param event_specification_id: (required)
1418
1424
  :type event_specification_id: str
@@ -1447,6 +1453,9 @@ class EventSettingsApi:
1447
1453
  )
1448
1454
 
1449
1455
  _response_types_map: Dict[str, Optional[str]] = {
1456
+ '204': None,
1457
+ '401': None,
1458
+ '403': None,
1450
1459
  }
1451
1460
  response_data = self.api_client.call_api(
1452
1461
  *_param,
@@ -1478,7 +1487,6 @@ class EventSettingsApi:
1478
1487
  ) -> ApiResponse[None]:
1479
1488
  """Delete custom event specification
1480
1489
 
1481
- This endpoint deletes a Custom Event Specification. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. However, check out the docs for [updating a configuration](#operation/putCustomEventSpecification) how this default behavior can be changed using the `allowRestore` query parameter. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for the custom event specification to delete. # Example: ``` curl --request DELETE 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' ```
1482
1490
 
1483
1491
  :param event_specification_id: (required)
1484
1492
  :type event_specification_id: str
@@ -1513,6 +1521,9 @@ class EventSettingsApi:
1513
1521
  )
1514
1522
 
1515
1523
  _response_types_map: Dict[str, Optional[str]] = {
1524
+ '204': None,
1525
+ '401': None,
1526
+ '403': None,
1516
1527
  }
1517
1528
  response_data = self.api_client.call_api(
1518
1529
  *_param,
@@ -1544,7 +1555,6 @@ class EventSettingsApi:
1544
1555
  ) -> RESTResponseType:
1545
1556
  """Delete custom event specification
1546
1557
 
1547
- This endpoint deletes a Custom Event Specification. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. However, check out the docs for [updating a configuration](#operation/putCustomEventSpecification) how this default behavior can be changed using the `allowRestore` query parameter. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for the custom event specification to delete. # Example: ``` curl --request DELETE 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' ```
1548
1558
 
1549
1559
  :param event_specification_id: (required)
1550
1560
  :type event_specification_id: str
@@ -1579,6 +1589,9 @@ class EventSettingsApi:
1579
1589
  )
1580
1590
 
1581
1591
  _response_types_map: Dict[str, Optional[str]] = {
1592
+ '204': None,
1593
+ '401': None,
1594
+ '403': None,
1582
1595
  }
1583
1596
  response_data = self.api_client.call_api(
1584
1597
  *_param,
@@ -1619,13 +1632,6 @@ class EventSettingsApi:
1619
1632
  # process the body parameter
1620
1633
 
1621
1634
 
1622
- # set the HTTP header `Accept`
1623
- if 'Accept' not in _header_params:
1624
- _header_params['Accept'] = self.api_client.select_header_accept(
1625
- [
1626
- 'application/json'
1627
- ]
1628
- )
1629
1635
 
1630
1636
 
1631
1637
  # authentication setting
@@ -1701,7 +1707,7 @@ class EventSettingsApi:
1701
1707
  )
1702
1708
 
1703
1709
  _response_types_map: Dict[str, Optional[str]] = {
1704
- '200': None,
1710
+ '204': None,
1705
1711
  '401': None,
1706
1712
  '403': None,
1707
1713
  }
@@ -1766,7 +1772,7 @@ class EventSettingsApi:
1766
1772
  )
1767
1773
 
1768
1774
  _response_types_map: Dict[str, Optional[str]] = {
1769
- '200': None,
1775
+ '204': None,
1770
1776
  '401': None,
1771
1777
  '403': None,
1772
1778
  }
@@ -1831,7 +1837,7 @@ class EventSettingsApi:
1831
1837
  )
1832
1838
 
1833
1839
  _response_types_map: Dict[str, Optional[str]] = {
1834
- '200': None,
1840
+ '204': None,
1835
1841
  '401': None,
1836
1842
  '403': None,
1837
1843
  }
@@ -1950,9 +1956,9 @@ class EventSettingsApi:
1950
1956
  )
1951
1957
 
1952
1958
  _response_types_map: Dict[str, Optional[str]] = {
1953
- '200': None,
1954
- '400': None,
1959
+ '204': None,
1955
1960
  '403': None,
1961
+ '404': None,
1956
1962
  }
1957
1963
  response_data = self.api_client.call_api(
1958
1964
  *_param,
@@ -2019,9 +2025,9 @@ class EventSettingsApi:
2019
2025
  )
2020
2026
 
2021
2027
  _response_types_map: Dict[str, Optional[str]] = {
2022
- '200': None,
2023
- '400': None,
2028
+ '204': None,
2024
2029
  '403': None,
2030
+ '404': None,
2025
2031
  }
2026
2032
  response_data = self.api_client.call_api(
2027
2033
  *_param,
@@ -2088,9 +2094,9 @@ class EventSettingsApi:
2088
2094
  )
2089
2095
 
2090
2096
  _response_types_map: Dict[str, Optional[str]] = {
2091
- '200': None,
2092
- '400': None,
2097
+ '204': None,
2093
2098
  '403': None,
2099
+ '404': None,
2094
2100
  }
2095
2101
  response_data = self.api_client.call_api(
2096
2102
  *_param,
@@ -2135,6 +2141,7 @@ class EventSettingsApi:
2135
2141
 
2136
2142
  # authentication setting
2137
2143
  _auth_settings: List[str] = [
2144
+ 'ApiKeyAuth'
2138
2145
  ]
2139
2146
 
2140
2147
  return self.api_client.param_serialize(
@@ -2209,9 +2216,9 @@ class EventSettingsApi:
2209
2216
  )
2210
2217
 
2211
2218
  _response_types_map: Dict[str, Optional[str]] = {
2212
- '200': None,
2213
- '400': None,
2219
+ '204': None,
2214
2220
  '403': None,
2221
+ '404': None,
2215
2222
  }
2216
2223
  response_data = self.api_client.call_api(
2217
2224
  *_param,
@@ -2278,9 +2285,9 @@ class EventSettingsApi:
2278
2285
  )
2279
2286
 
2280
2287
  _response_types_map: Dict[str, Optional[str]] = {
2281
- '200': None,
2282
- '400': None,
2288
+ '204': None,
2283
2289
  '403': None,
2290
+ '404': None,
2284
2291
  }
2285
2292
  response_data = self.api_client.call_api(
2286
2293
  *_param,
@@ -2347,9 +2354,9 @@ class EventSettingsApi:
2347
2354
  )
2348
2355
 
2349
2356
  _response_types_map: Dict[str, Optional[str]] = {
2350
- '200': None,
2351
- '400': None,
2357
+ '204': None,
2352
2358
  '403': None,
2359
+ '404': None,
2353
2360
  }
2354
2361
  response_data = self.api_client.call_api(
2355
2362
  *_param,
@@ -2473,6 +2480,9 @@ class EventSettingsApi:
2473
2480
 
2474
2481
  _response_types_map: Dict[str, Optional[str]] = {
2475
2482
  '200': "BuiltInEventSpecificationWithLastUpdated",
2483
+ '401': None,
2484
+ '403': None,
2485
+ '404': None,
2476
2486
  }
2477
2487
  response_data = self.api_client.call_api(
2478
2488
  *_param,
@@ -2543,6 +2553,9 @@ class EventSettingsApi:
2543
2553
 
2544
2554
  _response_types_map: Dict[str, Optional[str]] = {
2545
2555
  '200': "BuiltInEventSpecificationWithLastUpdated",
2556
+ '401': None,
2557
+ '403': None,
2558
+ '404': None,
2546
2559
  }
2547
2560
  response_data = self.api_client.call_api(
2548
2561
  *_param,
@@ -2613,6 +2626,9 @@ class EventSettingsApi:
2613
2626
 
2614
2627
  _response_types_map: Dict[str, Optional[str]] = {
2615
2628
  '200': "BuiltInEventSpecificationWithLastUpdated",
2629
+ '401': None,
2630
+ '403': None,
2631
+ '404': None,
2616
2632
  }
2617
2633
  response_data = self.api_client.call_api(
2618
2634
  *_param,
@@ -2759,6 +2775,10 @@ class EventSettingsApi:
2759
2775
 
2760
2776
  _response_types_map: Dict[str, Optional[str]] = {
2761
2777
  '200': "CustomEventSpecificationWithLastUpdated",
2778
+ '400': None,
2779
+ '401': None,
2780
+ '403': None,
2781
+ '404': None,
2762
2782
  }
2763
2783
  response_data = self.api_client.call_api(
2764
2784
  *_param,
@@ -2829,6 +2849,10 @@ class EventSettingsApi:
2829
2849
 
2830
2850
  _response_types_map: Dict[str, Optional[str]] = {
2831
2851
  '200': "CustomEventSpecificationWithLastUpdated",
2852
+ '400': None,
2853
+ '401': None,
2854
+ '403': None,
2855
+ '404': None,
2832
2856
  }
2833
2857
  response_data = self.api_client.call_api(
2834
2858
  *_param,
@@ -2899,6 +2923,10 @@ class EventSettingsApi:
2899
2923
 
2900
2924
  _response_types_map: Dict[str, Optional[str]] = {
2901
2925
  '200': "CustomEventSpecificationWithLastUpdated",
2926
+ '400': None,
2927
+ '401': None,
2928
+ '403': None,
2929
+ '404': None,
2902
2930
  }
2903
2931
  response_data = self.api_client.call_api(
2904
2932
  *_param,
@@ -3045,9 +3073,9 @@ class EventSettingsApi:
3045
3073
  )
3046
3074
 
3047
3075
  _response_types_map: Dict[str, Optional[str]] = {
3048
- '200': None,
3049
- '400': None,
3076
+ '204': None,
3050
3077
  '403': None,
3078
+ '404': None,
3051
3079
  }
3052
3080
  response_data = self.api_client.call_api(
3053
3081
  *_param,
@@ -3118,9 +3146,9 @@ class EventSettingsApi:
3118
3146
  )
3119
3147
 
3120
3148
  _response_types_map: Dict[str, Optional[str]] = {
3121
- '200': None,
3122
- '400': None,
3149
+ '204': None,
3123
3150
  '403': None,
3151
+ '404': None,
3124
3152
  }
3125
3153
  response_data = self.api_client.call_api(
3126
3154
  *_param,
@@ -3191,9 +3219,9 @@ class EventSettingsApi:
3191
3219
  )
3192
3220
 
3193
3221
  _response_types_map: Dict[str, Optional[str]] = {
3194
- '200': None,
3195
- '400': None,
3222
+ '204': None,
3196
3223
  '403': None,
3224
+ '404': None,
3197
3225
  }
3198
3226
  response_data = self.api_client.call_api(
3199
3227
  *_param,
@@ -3254,6 +3282,7 @@ class EventSettingsApi:
3254
3282
 
3255
3283
  # authentication setting
3256
3284
  _auth_settings: List[str] = [
3285
+ 'ApiKeyAuth'
3257
3286
  ]
3258
3287
 
3259
3288
  return self.api_client.param_serialize(
@@ -3332,9 +3361,9 @@ class EventSettingsApi:
3332
3361
  )
3333
3362
 
3334
3363
  _response_types_map: Dict[str, Optional[str]] = {
3335
- '200': None,
3336
- '400': None,
3364
+ '204': None,
3337
3365
  '403': None,
3366
+ '404': None,
3338
3367
  }
3339
3368
  response_data = self.api_client.call_api(
3340
3369
  *_param,
@@ -3405,9 +3434,9 @@ class EventSettingsApi:
3405
3434
  )
3406
3435
 
3407
3436
  _response_types_map: Dict[str, Optional[str]] = {
3408
- '200': None,
3409
- '400': None,
3437
+ '204': None,
3410
3438
  '403': None,
3439
+ '404': None,
3411
3440
  }
3412
3441
  response_data = self.api_client.call_api(
3413
3442
  *_param,
@@ -3478,9 +3507,9 @@ class EventSettingsApi:
3478
3507
  )
3479
3508
 
3480
3509
  _response_types_map: Dict[str, Optional[str]] = {
3481
- '200': None,
3482
- '400': None,
3510
+ '204': None,
3483
3511
  '403': None,
3512
+ '404': None,
3484
3513
  }
3485
3514
  response_data = self.api_client.call_api(
3486
3515
  *_param,
@@ -3620,6 +3649,9 @@ class EventSettingsApi:
3620
3649
 
3621
3650
  _response_types_map: Dict[str, Optional[str]] = {
3622
3651
  '200': "BuiltInEventSpecificationWithLastUpdated",
3652
+ '401': None,
3653
+ '403': None,
3654
+ '404': None,
3623
3655
  }
3624
3656
  response_data = self.api_client.call_api(
3625
3657
  *_param,
@@ -3690,6 +3722,9 @@ class EventSettingsApi:
3690
3722
 
3691
3723
  _response_types_map: Dict[str, Optional[str]] = {
3692
3724
  '200': "BuiltInEventSpecificationWithLastUpdated",
3725
+ '401': None,
3726
+ '403': None,
3727
+ '404': None,
3693
3728
  }
3694
3729
  response_data = self.api_client.call_api(
3695
3730
  *_param,
@@ -3760,6 +3795,9 @@ class EventSettingsApi:
3760
3795
 
3761
3796
  _response_types_map: Dict[str, Optional[str]] = {
3762
3797
  '200': "BuiltInEventSpecificationWithLastUpdated",
3798
+ '401': None,
3799
+ '403': None,
3800
+ '404': None,
3763
3801
  }
3764
3802
  response_data = self.api_client.call_api(
3765
3803
  *_param,
@@ -3906,6 +3944,10 @@ class EventSettingsApi:
3906
3944
 
3907
3945
  _response_types_map: Dict[str, Optional[str]] = {
3908
3946
  '200': "CustomEventSpecificationWithLastUpdated",
3947
+ '400': None,
3948
+ '401': None,
3949
+ '403': None,
3950
+ '404': None,
3909
3951
  }
3910
3952
  response_data = self.api_client.call_api(
3911
3953
  *_param,
@@ -3976,6 +4018,10 @@ class EventSettingsApi:
3976
4018
 
3977
4019
  _response_types_map: Dict[str, Optional[str]] = {
3978
4020
  '200': "CustomEventSpecificationWithLastUpdated",
4021
+ '400': None,
4022
+ '401': None,
4023
+ '403': None,
4024
+ '404': None,
3979
4025
  }
3980
4026
  response_data = self.api_client.call_api(
3981
4027
  *_param,
@@ -4046,6 +4092,10 @@ class EventSettingsApi:
4046
4092
 
4047
4093
  _response_types_map: Dict[str, Optional[str]] = {
4048
4094
  '200': "CustomEventSpecificationWithLastUpdated",
4095
+ '400': None,
4096
+ '401': None,
4097
+ '403': None,
4098
+ '404': None,
4049
4099
  }
4050
4100
  response_data = self.api_client.call_api(
4051
4101
  *_param,
@@ -4192,9 +4242,9 @@ class EventSettingsApi:
4192
4242
  )
4193
4243
 
4194
4244
  _response_types_map: Dict[str, Optional[str]] = {
4195
- '200': None,
4196
- '400': None,
4245
+ '204': None,
4197
4246
  '403': None,
4247
+ '404': None,
4198
4248
  }
4199
4249
  response_data = self.api_client.call_api(
4200
4250
  *_param,
@@ -4265,9 +4315,9 @@ class EventSettingsApi:
4265
4315
  )
4266
4316
 
4267
4317
  _response_types_map: Dict[str, Optional[str]] = {
4268
- '200': None,
4269
- '400': None,
4318
+ '204': None,
4270
4319
  '403': None,
4320
+ '404': None,
4271
4321
  }
4272
4322
  response_data = self.api_client.call_api(
4273
4323
  *_param,
@@ -4338,9 +4388,9 @@ class EventSettingsApi:
4338
4388
  )
4339
4389
 
4340
4390
  _response_types_map: Dict[str, Optional[str]] = {
4341
- '200': None,
4342
- '400': None,
4391
+ '204': None,
4343
4392
  '403': None,
4393
+ '404': None,
4344
4394
  }
4345
4395
  response_data = self.api_client.call_api(
4346
4396
  *_param,
@@ -4401,6 +4451,7 @@ class EventSettingsApi:
4401
4451
 
4402
4452
  # authentication setting
4403
4453
  _auth_settings: List[str] = [
4454
+ 'ApiKeyAuth'
4404
4455
  ]
4405
4456
 
4406
4457
  return self.api_client.param_serialize(
@@ -4479,9 +4530,9 @@ class EventSettingsApi:
4479
4530
  )
4480
4531
 
4481
4532
  _response_types_map: Dict[str, Optional[str]] = {
4482
- '200': None,
4483
- '400': None,
4533
+ '204': None,
4484
4534
  '403': None,
4535
+ '404': None,
4485
4536
  }
4486
4537
  response_data = self.api_client.call_api(
4487
4538
  *_param,
@@ -4552,9 +4603,9 @@ class EventSettingsApi:
4552
4603
  )
4553
4604
 
4554
4605
  _response_types_map: Dict[str, Optional[str]] = {
4555
- '200': None,
4556
- '400': None,
4606
+ '204': None,
4557
4607
  '403': None,
4608
+ '404': None,
4558
4609
  }
4559
4610
  response_data = self.api_client.call_api(
4560
4611
  *_param,
@@ -4625,9 +4676,9 @@ class EventSettingsApi:
4625
4676
  )
4626
4677
 
4627
4678
  _response_types_map: Dict[str, Optional[str]] = {
4628
- '200': None,
4629
- '400': None,
4679
+ '204': None,
4630
4680
  '403': None,
4681
+ '404': None,
4631
4682
  }
4632
4683
  response_data = self.api_client.call_api(
4633
4684
  *_param,
@@ -4729,7 +4780,7 @@ class EventSettingsApi:
4729
4780
  ) -> List[WithMetadata]:
4730
4781
  """Get all Mobile Smart Alert Configs
4731
4782
 
4732
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4783
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4733
4784
 
4734
4785
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4735
4786
  :type mobile_app_id: str
@@ -4769,7 +4820,6 @@ class EventSettingsApi:
4769
4820
  _response_types_map: Dict[str, Optional[str]] = {
4770
4821
  '200': "List[WithMetadata]",
4771
4822
  '403': None,
4772
- '404': None,
4773
4823
  }
4774
4824
  response_data = self.api_client.call_api(
4775
4825
  *_param,
@@ -4802,7 +4852,7 @@ class EventSettingsApi:
4802
4852
  ) -> ApiResponse[List[WithMetadata]]:
4803
4853
  """Get all Mobile Smart Alert Configs
4804
4854
 
4805
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4855
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4806
4856
 
4807
4857
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4808
4858
  :type mobile_app_id: str
@@ -4842,7 +4892,6 @@ class EventSettingsApi:
4842
4892
  _response_types_map: Dict[str, Optional[str]] = {
4843
4893
  '200': "List[WithMetadata]",
4844
4894
  '403': None,
4845
- '404': None,
4846
4895
  }
4847
4896
  response_data = self.api_client.call_api(
4848
4897
  *_param,
@@ -4875,7 +4924,7 @@ class EventSettingsApi:
4875
4924
  ) -> RESTResponseType:
4876
4925
  """Get all Mobile Smart Alert Configs
4877
4926
 
4878
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4927
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4879
4928
 
4880
4929
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4881
4930
  :type mobile_app_id: str
@@ -4915,7 +4964,6 @@ class EventSettingsApi:
4915
4964
  _response_types_map: Dict[str, Optional[str]] = {
4916
4965
  '200': "List[WithMetadata]",
4917
4966
  '403': None,
4918
- '404': None,
4919
4967
  }
4920
4968
  response_data = self.api_client.call_api(
4921
4969
  *_param,
@@ -4975,6 +5023,7 @@ class EventSettingsApi:
4975
5023
 
4976
5024
  # authentication setting
4977
5025
  _auth_settings: List[str] = [
5026
+ 'ApiKeyAuth'
4978
5027
  ]
4979
5028
 
4980
5029
  return self.api_client.param_serialize(
@@ -5015,7 +5064,7 @@ class EventSettingsApi:
5015
5064
  ) -> List[WebsiteAlertConfigWithMetadata]:
5016
5065
  """Get all Website Smart Alert Configs
5017
5066
 
5018
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5067
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5019
5068
 
5020
5069
  :param website_id: The ID of a specific Website (required)
5021
5070
  :type website_id: str
@@ -5055,7 +5104,6 @@ class EventSettingsApi:
5055
5104
  _response_types_map: Dict[str, Optional[str]] = {
5056
5105
  '200': "List[WebsiteAlertConfigWithMetadata]",
5057
5106
  '403': None,
5058
- '404': None,
5059
5107
  }
5060
5108
  response_data = self.api_client.call_api(
5061
5109
  *_param,
@@ -5088,7 +5136,7 @@ class EventSettingsApi:
5088
5136
  ) -> ApiResponse[List[WebsiteAlertConfigWithMetadata]]:
5089
5137
  """Get all Website Smart Alert Configs
5090
5138
 
5091
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5139
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5092
5140
 
5093
5141
  :param website_id: The ID of a specific Website (required)
5094
5142
  :type website_id: str
@@ -5128,7 +5176,6 @@ class EventSettingsApi:
5128
5176
  _response_types_map: Dict[str, Optional[str]] = {
5129
5177
  '200': "List[WebsiteAlertConfigWithMetadata]",
5130
5178
  '403': None,
5131
- '404': None,
5132
5179
  }
5133
5180
  response_data = self.api_client.call_api(
5134
5181
  *_param,
@@ -5161,7 +5208,7 @@ class EventSettingsApi:
5161
5208
  ) -> RESTResponseType:
5162
5209
  """Get all Website Smart Alert Configs
5163
5210
 
5164
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5211
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5165
5212
 
5166
5213
  :param website_id: The ID of a specific Website (required)
5167
5214
  :type website_id: str
@@ -5201,7 +5248,6 @@ class EventSettingsApi:
5201
5248
  _response_types_map: Dict[str, Optional[str]] = {
5202
5249
  '200': "List[WebsiteAlertConfigWithMetadata]",
5203
5250
  '403': None,
5204
- '404': None,
5205
5251
  }
5206
5252
  response_data = self.api_client.call_api(
5207
5253
  *_param,
@@ -5545,6 +5591,7 @@ class EventSettingsApi:
5545
5591
 
5546
5592
  # authentication setting
5547
5593
  _auth_settings: List[str] = [
5594
+ 'ApiKeyAuth'
5548
5595
  ]
5549
5596
 
5550
5597
  return self.api_client.param_serialize(
@@ -5811,6 +5858,7 @@ class EventSettingsApi:
5811
5858
 
5812
5859
  # authentication setting
5813
5860
  _auth_settings: List[str] = [
5861
+ 'ApiKeyAuth'
5814
5862
  ]
5815
5863
 
5816
5864
  return self.api_client.param_serialize(
@@ -6671,7 +6719,7 @@ class EventSettingsApi:
6671
6719
  ) -> AbstractIntegration:
6672
6720
  """Get Alerting Channel
6673
6721
 
6674
- Gets an alerting channel.
6722
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6675
6723
 
6676
6724
  :param id: ID of the Alerting Channel to get. (required)
6677
6725
  :type id: str
@@ -6738,7 +6786,7 @@ class EventSettingsApi:
6738
6786
  ) -> ApiResponse[AbstractIntegration]:
6739
6787
  """Get Alerting Channel
6740
6788
 
6741
- Gets an alerting channel.
6789
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6742
6790
 
6743
6791
  :param id: ID of the Alerting Channel to get. (required)
6744
6792
  :type id: str
@@ -6805,7 +6853,7 @@ class EventSettingsApi:
6805
6853
  ) -> RESTResponseType:
6806
6854
  """Get Alerting Channel
6807
6855
 
6808
- Gets an alerting channel.
6856
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6809
6857
 
6810
6858
  :param id: ID of the Alerting Channel to get. (required)
6811
6859
  :type id: str
@@ -6932,7 +6980,7 @@ class EventSettingsApi:
6932
6980
  ) -> List[AbstractIntegration]:
6933
6981
  """Get all Alerting Channels
6934
6982
 
6935
- Gets all the alerting channels.
6983
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
6936
6984
 
6937
6985
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
6938
6986
  :type ids: List[str]
@@ -6999,7 +7047,7 @@ class EventSettingsApi:
6999
7047
  ) -> ApiResponse[List[AbstractIntegration]]:
7000
7048
  """Get all Alerting Channels
7001
7049
 
7002
- Gets all the alerting channels.
7050
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
7003
7051
 
7004
7052
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7005
7053
  :type ids: List[str]
@@ -7066,7 +7114,7 @@ class EventSettingsApi:
7066
7114
  ) -> RESTResponseType:
7067
7115
  """Get all Alerting Channels
7068
7116
 
7069
- Gets all the alerting channels.
7117
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
7070
7118
 
7071
7119
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7072
7120
  :type ids: List[str]
@@ -7196,7 +7244,7 @@ class EventSettingsApi:
7196
7244
  ) -> List[IntegrationOverview]:
7197
7245
  """Get Overview of Alerting Channels
7198
7246
 
7199
- Gets the overview information of all alerting channels.
7247
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7200
7248
 
7201
7249
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7202
7250
  :type ids: List[str]
@@ -7263,7 +7311,7 @@ class EventSettingsApi:
7263
7311
  ) -> ApiResponse[List[IntegrationOverview]]:
7264
7312
  """Get Overview of Alerting Channels
7265
7313
 
7266
- Gets the overview information of all alerting channels.
7314
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7267
7315
 
7268
7316
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7269
7317
  :type ids: List[str]
@@ -7330,7 +7378,7 @@ class EventSettingsApi:
7330
7378
  ) -> RESTResponseType:
7331
7379
  """Get Overview of Alerting Channels
7332
7380
 
7333
- Gets the overview information of all alerting channels.
7381
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7334
7382
 
7335
7383
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7336
7384
  :type ids: List[str]
@@ -8016,6 +8064,9 @@ class EventSettingsApi:
8016
8064
 
8017
8065
  _response_types_map: Dict[str, Optional[str]] = {
8018
8066
  '200': "BuiltInEventSpecification",
8067
+ '401': None,
8068
+ '403': None,
8069
+ '404': None,
8019
8070
  }
8020
8071
  response_data = self.api_client.call_api(
8021
8072
  *_param,
@@ -8082,6 +8133,9 @@ class EventSettingsApi:
8082
8133
 
8083
8134
  _response_types_map: Dict[str, Optional[str]] = {
8084
8135
  '200': "BuiltInEventSpecification",
8136
+ '401': None,
8137
+ '403': None,
8138
+ '404': None,
8085
8139
  }
8086
8140
  response_data = self.api_client.call_api(
8087
8141
  *_param,
@@ -8148,6 +8202,9 @@ class EventSettingsApi:
8148
8202
 
8149
8203
  _response_types_map: Dict[str, Optional[str]] = {
8150
8204
  '200': "BuiltInEventSpecification",
8205
+ '401': None,
8206
+ '403': None,
8207
+ '404': None,
8151
8208
  }
8152
8209
  response_data = self.api_client.call_api(
8153
8210
  *_param,
@@ -8545,6 +8602,9 @@ class EventSettingsApi:
8545
8602
 
8546
8603
  _response_types_map: Dict[str, Optional[str]] = {
8547
8604
  '200': "CustomEventSpecificationWithLastUpdated",
8605
+ '401': None,
8606
+ '403': None,
8607
+ '404': None,
8548
8608
  }
8549
8609
  response_data = self.api_client.call_api(
8550
8610
  *_param,
@@ -8612,6 +8672,9 @@ class EventSettingsApi:
8612
8672
 
8613
8673
  _response_types_map: Dict[str, Optional[str]] = {
8614
8674
  '200': "CustomEventSpecificationWithLastUpdated",
8675
+ '401': None,
8676
+ '403': None,
8677
+ '404': None,
8615
8678
  }
8616
8679
  response_data = self.api_client.call_api(
8617
8680
  *_param,
@@ -8679,6 +8742,9 @@ class EventSettingsApi:
8679
8742
 
8680
8743
  _response_types_map: Dict[str, Optional[str]] = {
8681
8744
  '200': "CustomEventSpecificationWithLastUpdated",
8745
+ '401': None,
8746
+ '403': None,
8747
+ '404': None,
8682
8748
  }
8683
8749
  response_data = self.api_client.call_api(
8684
8750
  *_param,
@@ -8802,6 +8868,8 @@ class EventSettingsApi:
8802
8868
 
8803
8869
  _response_types_map: Dict[str, Optional[str]] = {
8804
8870
  '200': "List[CustomEventSpecificationWithLastUpdated]",
8871
+ '401': None,
8872
+ '403': None,
8805
8873
  }
8806
8874
  response_data = self.api_client.call_api(
8807
8875
  *_param,
@@ -8865,6 +8933,8 @@ class EventSettingsApi:
8865
8933
 
8866
8934
  _response_types_map: Dict[str, Optional[str]] = {
8867
8935
  '200': "List[CustomEventSpecificationWithLastUpdated]",
8936
+ '401': None,
8937
+ '403': None,
8868
8938
  }
8869
8939
  response_data = self.api_client.call_api(
8870
8940
  *_param,
@@ -8928,6 +8998,8 @@ class EventSettingsApi:
8928
8998
 
8929
8999
  _response_types_map: Dict[str, Optional[str]] = {
8930
9000
  '200': "List[CustomEventSpecificationWithLastUpdated]",
9001
+ '401': None,
9002
+ '403': None,
8931
9003
  }
8932
9004
  response_data = self.api_client.call_api(
8933
9005
  *_param,
@@ -9013,7 +9085,7 @@ class EventSettingsApi:
9013
9085
  _content_type: Optional[StrictStr] = None,
9014
9086
  _headers: Optional[Dict[StrictStr, Any]] = None,
9015
9087
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
9016
- ) -> CustomPayloadWithLastUpdated:
9088
+ ) -> CustomPayloadWithVersion:
9017
9089
  """Get All Global Custom Payload Configurations
9018
9090
 
9019
9091
  Gets All Global Custom Payload Configurations.
@@ -9051,7 +9123,7 @@ class EventSettingsApi:
9051
9123
  )
9052
9124
 
9053
9125
  _response_types_map: Dict[str, Optional[str]] = {
9054
- '200': "CustomPayloadWithLastUpdated",
9126
+ '200': "CustomPayloadWithVersion",
9055
9127
  '401': None,
9056
9128
  '403': None,
9057
9129
  }
@@ -9082,7 +9154,7 @@ class EventSettingsApi:
9082
9154
  _content_type: Optional[StrictStr] = None,
9083
9155
  _headers: Optional[Dict[StrictStr, Any]] = None,
9084
9156
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
9085
- ) -> ApiResponse[CustomPayloadWithLastUpdated]:
9157
+ ) -> ApiResponse[CustomPayloadWithVersion]:
9086
9158
  """Get All Global Custom Payload Configurations
9087
9159
 
9088
9160
  Gets All Global Custom Payload Configurations.
@@ -9120,7 +9192,7 @@ class EventSettingsApi:
9120
9192
  )
9121
9193
 
9122
9194
  _response_types_map: Dict[str, Optional[str]] = {
9123
- '200': "CustomPayloadWithLastUpdated",
9195
+ '200': "CustomPayloadWithVersion",
9124
9196
  '401': None,
9125
9197
  '403': None,
9126
9198
  }
@@ -9189,7 +9261,7 @@ class EventSettingsApi:
9189
9261
  )
9190
9262
 
9191
9263
  _response_types_map: Dict[str, Optional[str]] = {
9192
- '200': "CustomPayloadWithLastUpdated",
9264
+ '200': "CustomPayloadWithVersion",
9193
9265
  '401': None,
9194
9266
  '403': None,
9195
9267
  }
@@ -9569,6 +9641,8 @@ class EventSettingsApi:
9569
9641
 
9570
9642
  _response_types_map: Dict[str, Optional[str]] = {
9571
9643
  '200': "List[EventSpecificationInfo]",
9644
+ '401': None,
9645
+ '403': None,
9572
9646
  }
9573
9647
  response_data = self.api_client.call_api(
9574
9648
  *_param,
@@ -9632,6 +9706,8 @@ class EventSettingsApi:
9632
9706
 
9633
9707
  _response_types_map: Dict[str, Optional[str]] = {
9634
9708
  '200': "List[EventSpecificationInfo]",
9709
+ '401': None,
9710
+ '403': None,
9635
9711
  }
9636
9712
  response_data = self.api_client.call_api(
9637
9713
  *_param,
@@ -9695,6 +9771,8 @@ class EventSettingsApi:
9695
9771
 
9696
9772
  _response_types_map: Dict[str, Optional[str]] = {
9697
9773
  '200': "List[EventSpecificationInfo]",
9774
+ '401': None,
9775
+ '403': None,
9698
9776
  }
9699
9777
  response_data = self.api_client.call_api(
9700
9778
  *_param,
@@ -9819,6 +9897,8 @@ class EventSettingsApi:
9819
9897
 
9820
9898
  _response_types_map: Dict[str, Optional[str]] = {
9821
9899
  '200': "List[EventSpecificationInfo]",
9900
+ '401': None,
9901
+ '403': None,
9822
9902
  }
9823
9903
  response_data = self.api_client.call_api(
9824
9904
  *_param,
@@ -9886,6 +9966,8 @@ class EventSettingsApi:
9886
9966
 
9887
9967
  _response_types_map: Dict[str, Optional[str]] = {
9888
9968
  '200': "List[EventSpecificationInfo]",
9969
+ '401': None,
9970
+ '403': None,
9889
9971
  }
9890
9972
  response_data = self.api_client.call_api(
9891
9973
  *_param,
@@ -9953,6 +10035,8 @@ class EventSettingsApi:
9953
10035
 
9954
10036
  _response_types_map: Dict[str, Optional[str]] = {
9955
10037
  '200': "List[EventSpecificationInfo]",
10038
+ '401': None,
10039
+ '403': None,
9956
10040
  }
9957
10041
  response_data = self.api_client.call_api(
9958
10042
  *_param,
@@ -10090,6 +10174,8 @@ class EventSettingsApi:
10090
10174
 
10091
10175
  _response_types_map: Dict[str, Optional[str]] = {
10092
10176
  '200': "List[SystemRuleLabel]",
10177
+ '401': None,
10178
+ '403': None,
10093
10179
  }
10094
10180
  response_data = self.api_client.call_api(
10095
10181
  *_param,
@@ -10153,6 +10239,8 @@ class EventSettingsApi:
10153
10239
 
10154
10240
  _response_types_map: Dict[str, Optional[str]] = {
10155
10241
  '200': "List[SystemRuleLabel]",
10242
+ '401': None,
10243
+ '403': None,
10156
10244
  }
10157
10245
  response_data = self.api_client.call_api(
10158
10246
  *_param,
@@ -10216,6 +10304,8 @@ class EventSettingsApi:
10216
10304
 
10217
10305
  _response_types_map: Dict[str, Optional[str]] = {
10218
10306
  '200': "List[SystemRuleLabel]",
10307
+ '401': None,
10308
+ '403': None,
10219
10309
  }
10220
10310
  response_data = self.api_client.call_api(
10221
10311
  *_param,
@@ -10873,9 +10963,9 @@ class EventSettingsApi:
10873
10963
 
10874
10964
 
10875
10965
  @validate_call
10876
- def post_custom_event_specification(
10966
+ def post_alerting_channel(
10877
10967
  self,
10878
- custom_event_specification: CustomEventSpecification,
10968
+ abstract_integration: AbstractIntegration,
10879
10969
  _request_timeout: Union[
10880
10970
  None,
10881
10971
  Annotated[StrictFloat, Field(gt=0)],
@@ -10888,13 +10978,13 @@ class EventSettingsApi:
10888
10978
  _content_type: Optional[StrictStr] = None,
10889
10979
  _headers: Optional[Dict[StrictStr, Any]] = None,
10890
10980
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
10891
- ) -> CustomEventSpecificationWithLastUpdated:
10892
- """Create new custom event specification
10981
+ ) -> AbstractIntegration:
10982
+ """Create Alert Channel
10893
10983
 
10894
- This endpoint creates a new Custom Event Specification. ## Mandatory Parameters: - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
10984
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
10895
10985
 
10896
- :param custom_event_specification: (required)
10897
- :type custom_event_specification: CustomEventSpecification
10986
+ :param abstract_integration: (required)
10987
+ :type abstract_integration: AbstractIntegration
10898
10988
  :param _request_timeout: timeout setting for this request. If one
10899
10989
  number provided, it will be total request
10900
10990
  timeout. It can also be a pair (tuple) of
@@ -10917,8 +11007,8 @@ class EventSettingsApi:
10917
11007
  :return: Returns the result object.
10918
11008
  """ # noqa: E501
10919
11009
 
10920
- _param = self._post_custom_event_specification_serialize(
10921
- custom_event_specification=custom_event_specification,
11010
+ _param = self._post_alerting_channel_serialize(
11011
+ abstract_integration=abstract_integration,
10922
11012
  _request_auth=_request_auth,
10923
11013
  _content_type=_content_type,
10924
11014
  _headers=_headers,
@@ -10926,7 +11016,9 @@ class EventSettingsApi:
10926
11016
  )
10927
11017
 
10928
11018
  _response_types_map: Dict[str, Optional[str]] = {
10929
- '200': "CustomEventSpecificationWithLastUpdated",
11019
+ '200': "AbstractIntegration",
11020
+ '302': None,
11021
+ '400': "str",
10930
11022
  }
10931
11023
  response_data = self.api_client.call_api(
10932
11024
  *_param,
@@ -10940,9 +11032,9 @@ class EventSettingsApi:
10940
11032
 
10941
11033
 
10942
11034
  @validate_call
10943
- def post_custom_event_specification_with_http_info(
11035
+ def post_alerting_channel_with_http_info(
10944
11036
  self,
10945
- custom_event_specification: CustomEventSpecification,
11037
+ abstract_integration: AbstractIntegration,
10946
11038
  _request_timeout: Union[
10947
11039
  None,
10948
11040
  Annotated[StrictFloat, Field(gt=0)],
@@ -10955,13 +11047,13 @@ class EventSettingsApi:
10955
11047
  _content_type: Optional[StrictStr] = None,
10956
11048
  _headers: Optional[Dict[StrictStr, Any]] = None,
10957
11049
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
10958
- ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
10959
- """Create new custom event specification
11050
+ ) -> ApiResponse[AbstractIntegration]:
11051
+ """Create Alert Channel
10960
11052
 
10961
- This endpoint creates a new Custom Event Specification. ## Mandatory Parameters: - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
11053
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
10962
11054
 
10963
- :param custom_event_specification: (required)
10964
- :type custom_event_specification: CustomEventSpecification
11055
+ :param abstract_integration: (required)
11056
+ :type abstract_integration: AbstractIntegration
10965
11057
  :param _request_timeout: timeout setting for this request. If one
10966
11058
  number provided, it will be total request
10967
11059
  timeout. It can also be a pair (tuple) of
@@ -10984,8 +11076,8 @@ class EventSettingsApi:
10984
11076
  :return: Returns the result object.
10985
11077
  """ # noqa: E501
10986
11078
 
10987
- _param = self._post_custom_event_specification_serialize(
10988
- custom_event_specification=custom_event_specification,
11079
+ _param = self._post_alerting_channel_serialize(
11080
+ abstract_integration=abstract_integration,
10989
11081
  _request_auth=_request_auth,
10990
11082
  _content_type=_content_type,
10991
11083
  _headers=_headers,
@@ -10993,7 +11085,9 @@ class EventSettingsApi:
10993
11085
  )
10994
11086
 
10995
11087
  _response_types_map: Dict[str, Optional[str]] = {
10996
- '200': "CustomEventSpecificationWithLastUpdated",
11088
+ '200': "AbstractIntegration",
11089
+ '302': None,
11090
+ '400': "str",
10997
11091
  }
10998
11092
  response_data = self.api_client.call_api(
10999
11093
  *_param,
@@ -11007,9 +11101,9 @@ class EventSettingsApi:
11007
11101
 
11008
11102
 
11009
11103
  @validate_call
11010
- def post_custom_event_specification_without_preload_content(
11104
+ def post_alerting_channel_without_preload_content(
11011
11105
  self,
11012
- custom_event_specification: CustomEventSpecification,
11106
+ abstract_integration: AbstractIntegration,
11013
11107
  _request_timeout: Union[
11014
11108
  None,
11015
11109
  Annotated[StrictFloat, Field(gt=0)],
@@ -11023,12 +11117,12 @@ class EventSettingsApi:
11023
11117
  _headers: Optional[Dict[StrictStr, Any]] = None,
11024
11118
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11025
11119
  ) -> RESTResponseType:
11026
- """Create new custom event specification
11120
+ """Create Alert Channel
11027
11121
 
11028
- This endpoint creates a new Custom Event Specification. ## Mandatory Parameters: - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request POST 'https://<Host>/api/events/settings/event-specifications/custom' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
11122
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
11029
11123
 
11030
- :param custom_event_specification: (required)
11031
- :type custom_event_specification: CustomEventSpecification
11124
+ :param abstract_integration: (required)
11125
+ :type abstract_integration: AbstractIntegration
11032
11126
  :param _request_timeout: timeout setting for this request. If one
11033
11127
  number provided, it will be total request
11034
11128
  timeout. It can also be a pair (tuple) of
@@ -11051,8 +11145,8 @@ class EventSettingsApi:
11051
11145
  :return: Returns the result object.
11052
11146
  """ # noqa: E501
11053
11147
 
11054
- _param = self._post_custom_event_specification_serialize(
11055
- custom_event_specification=custom_event_specification,
11148
+ _param = self._post_alerting_channel_serialize(
11149
+ abstract_integration=abstract_integration,
11056
11150
  _request_auth=_request_auth,
11057
11151
  _content_type=_content_type,
11058
11152
  _headers=_headers,
@@ -11060,7 +11154,9 @@ class EventSettingsApi:
11060
11154
  )
11061
11155
 
11062
11156
  _response_types_map: Dict[str, Optional[str]] = {
11063
- '200': "CustomEventSpecificationWithLastUpdated",
11157
+ '200': "AbstractIntegration",
11158
+ '302': None,
11159
+ '400': "str",
11064
11160
  }
11065
11161
  response_data = self.api_client.call_api(
11066
11162
  *_param,
@@ -11069,9 +11165,9 @@ class EventSettingsApi:
11069
11165
  return response_data.response
11070
11166
 
11071
11167
 
11072
- def _post_custom_event_specification_serialize(
11168
+ def _post_alerting_channel_serialize(
11073
11169
  self,
11074
- custom_event_specification,
11170
+ abstract_integration,
11075
11171
  _request_auth,
11076
11172
  _content_type,
11077
11173
  _headers,
@@ -11097,8 +11193,8 @@ class EventSettingsApi:
11097
11193
  # process the header parameters
11098
11194
  # process the form parameters
11099
11195
  # process the body parameter
11100
- if custom_event_specification is not None:
11101
- _body_params = custom_event_specification
11196
+ if abstract_integration is not None:
11197
+ _body_params = abstract_integration
11102
11198
 
11103
11199
 
11104
11200
  # set the HTTP header `Accept`
@@ -11130,7 +11226,7 @@ class EventSettingsApi:
11130
11226
 
11131
11227
  return self.api_client.param_serialize(
11132
11228
  method='POST',
11133
- resource_path='/api/events/settings/event-specifications/custom',
11229
+ resource_path='/api/events/settings/alertingChannels',
11134
11230
  path_params=_path_params,
11135
11231
  query_params=_query_params,
11136
11232
  header_params=_header_params,
@@ -11147,10 +11243,9 @@ class EventSettingsApi:
11147
11243
 
11148
11244
 
11149
11245
  @validate_call
11150
- def put_alert(
11246
+ def post_custom_event_specification(
11151
11247
  self,
11152
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11153
- alerting_configuration: AlertingConfiguration,
11248
+ custom_event_specification: CustomEventSpecification,
11154
11249
  _request_timeout: Union[
11155
11250
  None,
11156
11251
  Annotated[StrictFloat, Field(gt=0)],
@@ -11163,15 +11258,12 @@ class EventSettingsApi:
11163
11258
  _content_type: Optional[StrictStr] = None,
11164
11259
  _headers: Optional[Dict[StrictStr, Any]] = None,
11165
11260
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11166
- ) -> AlertingConfigurationWithLastUpdated:
11167
- """Create or update Alert Configuration
11261
+ ) -> CustomEventSpecificationWithLastUpdated:
11262
+ """Create new custom event specification
11168
11263
 
11169
- Create or update a specific Alert configuration by ID
11170
11264
 
11171
- :param id: ID of a specific Alert Configuration to create or update. (required)
11172
- :type id: str
11173
- :param alerting_configuration: (required)
11174
- :type alerting_configuration: AlertingConfiguration
11265
+ :param custom_event_specification: (required)
11266
+ :type custom_event_specification: CustomEventSpecification
11175
11267
  :param _request_timeout: timeout setting for this request. If one
11176
11268
  number provided, it will be total request
11177
11269
  timeout. It can also be a pair (tuple) of
@@ -11194,9 +11286,8 @@ class EventSettingsApi:
11194
11286
  :return: Returns the result object.
11195
11287
  """ # noqa: E501
11196
11288
 
11197
- _param = self._put_alert_serialize(
11198
- id=id,
11199
- alerting_configuration=alerting_configuration,
11289
+ _param = self._post_custom_event_specification_serialize(
11290
+ custom_event_specification=custom_event_specification,
11200
11291
  _request_auth=_request_auth,
11201
11292
  _content_type=_content_type,
11202
11293
  _headers=_headers,
@@ -11204,10 +11295,10 @@ class EventSettingsApi:
11204
11295
  )
11205
11296
 
11206
11297
  _response_types_map: Dict[str, Optional[str]] = {
11207
- '200': "AlertingConfigurationWithLastUpdated",
11298
+ '200': "CustomEventSpecificationWithLastUpdated",
11299
+ '400': None,
11208
11300
  '401': None,
11209
11301
  '403': None,
11210
- '422': None,
11211
11302
  }
11212
11303
  response_data = self.api_client.call_api(
11213
11304
  *_param,
@@ -11221,10 +11312,9 @@ class EventSettingsApi:
11221
11312
 
11222
11313
 
11223
11314
  @validate_call
11224
- def put_alert_with_http_info(
11315
+ def post_custom_event_specification_with_http_info(
11225
11316
  self,
11226
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11227
- alerting_configuration: AlertingConfiguration,
11317
+ custom_event_specification: CustomEventSpecification,
11228
11318
  _request_timeout: Union[
11229
11319
  None,
11230
11320
  Annotated[StrictFloat, Field(gt=0)],
@@ -11237,15 +11327,12 @@ class EventSettingsApi:
11237
11327
  _content_type: Optional[StrictStr] = None,
11238
11328
  _headers: Optional[Dict[StrictStr, Any]] = None,
11239
11329
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11240
- ) -> ApiResponse[AlertingConfigurationWithLastUpdated]:
11241
- """Create or update Alert Configuration
11330
+ ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
11331
+ """Create new custom event specification
11242
11332
 
11243
- Create or update a specific Alert configuration by ID
11244
11333
 
11245
- :param id: ID of a specific Alert Configuration to create or update. (required)
11246
- :type id: str
11247
- :param alerting_configuration: (required)
11248
- :type alerting_configuration: AlertingConfiguration
11334
+ :param custom_event_specification: (required)
11335
+ :type custom_event_specification: CustomEventSpecification
11249
11336
  :param _request_timeout: timeout setting for this request. If one
11250
11337
  number provided, it will be total request
11251
11338
  timeout. It can also be a pair (tuple) of
@@ -11268,9 +11355,8 @@ class EventSettingsApi:
11268
11355
  :return: Returns the result object.
11269
11356
  """ # noqa: E501
11270
11357
 
11271
- _param = self._put_alert_serialize(
11272
- id=id,
11273
- alerting_configuration=alerting_configuration,
11358
+ _param = self._post_custom_event_specification_serialize(
11359
+ custom_event_specification=custom_event_specification,
11274
11360
  _request_auth=_request_auth,
11275
11361
  _content_type=_content_type,
11276
11362
  _headers=_headers,
@@ -11278,10 +11364,10 @@ class EventSettingsApi:
11278
11364
  )
11279
11365
 
11280
11366
  _response_types_map: Dict[str, Optional[str]] = {
11281
- '200': "AlertingConfigurationWithLastUpdated",
11367
+ '200': "CustomEventSpecificationWithLastUpdated",
11368
+ '400': None,
11282
11369
  '401': None,
11283
11370
  '403': None,
11284
- '422': None,
11285
11371
  }
11286
11372
  response_data = self.api_client.call_api(
11287
11373
  *_param,
@@ -11295,10 +11381,9 @@ class EventSettingsApi:
11295
11381
 
11296
11382
 
11297
11383
  @validate_call
11298
- def put_alert_without_preload_content(
11384
+ def post_custom_event_specification_without_preload_content(
11299
11385
  self,
11300
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11301
- alerting_configuration: AlertingConfiguration,
11386
+ custom_event_specification: CustomEventSpecification,
11302
11387
  _request_timeout: Union[
11303
11388
  None,
11304
11389
  Annotated[StrictFloat, Field(gt=0)],
@@ -11312,14 +11397,11 @@ class EventSettingsApi:
11312
11397
  _headers: Optional[Dict[StrictStr, Any]] = None,
11313
11398
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11314
11399
  ) -> RESTResponseType:
11315
- """Create or update Alert Configuration
11400
+ """Create new custom event specification
11316
11401
 
11317
- Create or update a specific Alert configuration by ID
11318
11402
 
11319
- :param id: ID of a specific Alert Configuration to create or update. (required)
11320
- :type id: str
11321
- :param alerting_configuration: (required)
11322
- :type alerting_configuration: AlertingConfiguration
11403
+ :param custom_event_specification: (required)
11404
+ :type custom_event_specification: CustomEventSpecification
11323
11405
  :param _request_timeout: timeout setting for this request. If one
11324
11406
  number provided, it will be total request
11325
11407
  timeout. It can also be a pair (tuple) of
@@ -11342,9 +11424,8 @@ class EventSettingsApi:
11342
11424
  :return: Returns the result object.
11343
11425
  """ # noqa: E501
11344
11426
 
11345
- _param = self._put_alert_serialize(
11346
- id=id,
11347
- alerting_configuration=alerting_configuration,
11427
+ _param = self._post_custom_event_specification_serialize(
11428
+ custom_event_specification=custom_event_specification,
11348
11429
  _request_auth=_request_auth,
11349
11430
  _content_type=_content_type,
11350
11431
  _headers=_headers,
@@ -11352,10 +11433,10 @@ class EventSettingsApi:
11352
11433
  )
11353
11434
 
11354
11435
  _response_types_map: Dict[str, Optional[str]] = {
11355
- '200': "AlertingConfigurationWithLastUpdated",
11436
+ '200': "CustomEventSpecificationWithLastUpdated",
11437
+ '400': None,
11356
11438
  '401': None,
11357
11439
  '403': None,
11358
- '422': None,
11359
11440
  }
11360
11441
  response_data = self.api_client.call_api(
11361
11442
  *_param,
@@ -11364,10 +11445,9 @@ class EventSettingsApi:
11364
11445
  return response_data.response
11365
11446
 
11366
11447
 
11367
- def _put_alert_serialize(
11448
+ def _post_custom_event_specification_serialize(
11368
11449
  self,
11369
- id,
11370
- alerting_configuration,
11450
+ custom_event_specification,
11371
11451
  _request_auth,
11372
11452
  _content_type,
11373
11453
  _headers,
@@ -11389,14 +11469,12 @@ class EventSettingsApi:
11389
11469
  _body_params: Optional[bytes] = None
11390
11470
 
11391
11471
  # process the path parameters
11392
- if id is not None:
11393
- _path_params['id'] = id
11394
11472
  # process the query parameters
11395
11473
  # process the header parameters
11396
11474
  # process the form parameters
11397
11475
  # process the body parameter
11398
- if alerting_configuration is not None:
11399
- _body_params = alerting_configuration
11476
+ if custom_event_specification is not None:
11477
+ _body_params = custom_event_specification
11400
11478
 
11401
11479
 
11402
11480
  # set the HTTP header `Accept`
@@ -11427,8 +11505,8 @@ class EventSettingsApi:
11427
11505
  ]
11428
11506
 
11429
11507
  return self.api_client.param_serialize(
11430
- method='PUT',
11431
- resource_path='/api/events/settings/alerts/{id}',
11508
+ method='POST',
11509
+ resource_path='/api/events/settings/event-specifications/custom',
11432
11510
  path_params=_path_params,
11433
11511
  query_params=_query_params,
11434
11512
  header_params=_header_params,
@@ -11445,10 +11523,10 @@ class EventSettingsApi:
11445
11523
 
11446
11524
 
11447
11525
  @validate_call
11448
- def put_alerting_channel(
11526
+ def put_alert(
11449
11527
  self,
11450
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11451
- abstract_integration: AbstractIntegration,
11528
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11529
+ alerting_configuration: AlertingConfiguration,
11452
11530
  _request_timeout: Union[
11453
11531
  None,
11454
11532
  Annotated[StrictFloat, Field(gt=0)],
@@ -11461,15 +11539,15 @@ class EventSettingsApi:
11461
11539
  _content_type: Optional[StrictStr] = None,
11462
11540
  _headers: Optional[Dict[StrictStr, Any]] = None,
11463
11541
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11464
- ) -> AbstractIntegration:
11465
- """Update Alert Channel
11542
+ ) -> AlertingConfigurationWithLastUpdated:
11543
+ """Create or update Alert Configuration
11466
11544
 
11467
- Updates an alerting channel.
11545
+ Create or update a specific Alert configuration by ID
11468
11546
 
11469
- :param id: ID of the Alerting Channel to update. (required)
11547
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11470
11548
  :type id: str
11471
- :param abstract_integration: (required)
11472
- :type abstract_integration: AbstractIntegration
11549
+ :param alerting_configuration: (required)
11550
+ :type alerting_configuration: AlertingConfiguration
11473
11551
  :param _request_timeout: timeout setting for this request. If one
11474
11552
  number provided, it will be total request
11475
11553
  timeout. It can also be a pair (tuple) of
@@ -11492,9 +11570,9 @@ class EventSettingsApi:
11492
11570
  :return: Returns the result object.
11493
11571
  """ # noqa: E501
11494
11572
 
11495
- _param = self._put_alerting_channel_serialize(
11573
+ _param = self._put_alert_serialize(
11496
11574
  id=id,
11497
- abstract_integration=abstract_integration,
11575
+ alerting_configuration=alerting_configuration,
11498
11576
  _request_auth=_request_auth,
11499
11577
  _content_type=_content_type,
11500
11578
  _headers=_headers,
@@ -11502,8 +11580,10 @@ class EventSettingsApi:
11502
11580
  )
11503
11581
 
11504
11582
  _response_types_map: Dict[str, Optional[str]] = {
11505
- '200': "AbstractIntegration",
11506
- '400': "str",
11583
+ '200': "AlertingConfigurationWithLastUpdated",
11584
+ '401': None,
11585
+ '403': None,
11586
+ '422': None,
11507
11587
  }
11508
11588
  response_data = self.api_client.call_api(
11509
11589
  *_param,
@@ -11517,10 +11597,10 @@ class EventSettingsApi:
11517
11597
 
11518
11598
 
11519
11599
  @validate_call
11520
- def put_alerting_channel_with_http_info(
11600
+ def put_alert_with_http_info(
11521
11601
  self,
11522
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11523
- abstract_integration: AbstractIntegration,
11602
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11603
+ alerting_configuration: AlertingConfiguration,
11524
11604
  _request_timeout: Union[
11525
11605
  None,
11526
11606
  Annotated[StrictFloat, Field(gt=0)],
@@ -11533,15 +11613,15 @@ class EventSettingsApi:
11533
11613
  _content_type: Optional[StrictStr] = None,
11534
11614
  _headers: Optional[Dict[StrictStr, Any]] = None,
11535
11615
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11536
- ) -> ApiResponse[AbstractIntegration]:
11537
- """Update Alert Channel
11616
+ ) -> ApiResponse[AlertingConfigurationWithLastUpdated]:
11617
+ """Create or update Alert Configuration
11538
11618
 
11539
- Updates an alerting channel.
11619
+ Create or update a specific Alert configuration by ID
11540
11620
 
11541
- :param id: ID of the Alerting Channel to update. (required)
11621
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11542
11622
  :type id: str
11543
- :param abstract_integration: (required)
11544
- :type abstract_integration: AbstractIntegration
11623
+ :param alerting_configuration: (required)
11624
+ :type alerting_configuration: AlertingConfiguration
11545
11625
  :param _request_timeout: timeout setting for this request. If one
11546
11626
  number provided, it will be total request
11547
11627
  timeout. It can also be a pair (tuple) of
@@ -11564,9 +11644,9 @@ class EventSettingsApi:
11564
11644
  :return: Returns the result object.
11565
11645
  """ # noqa: E501
11566
11646
 
11567
- _param = self._put_alerting_channel_serialize(
11647
+ _param = self._put_alert_serialize(
11568
11648
  id=id,
11569
- abstract_integration=abstract_integration,
11649
+ alerting_configuration=alerting_configuration,
11570
11650
  _request_auth=_request_auth,
11571
11651
  _content_type=_content_type,
11572
11652
  _headers=_headers,
@@ -11574,8 +11654,10 @@ class EventSettingsApi:
11574
11654
  )
11575
11655
 
11576
11656
  _response_types_map: Dict[str, Optional[str]] = {
11577
- '200': "AbstractIntegration",
11578
- '400': "str",
11657
+ '200': "AlertingConfigurationWithLastUpdated",
11658
+ '401': None,
11659
+ '403': None,
11660
+ '422': None,
11579
11661
  }
11580
11662
  response_data = self.api_client.call_api(
11581
11663
  *_param,
@@ -11589,10 +11671,10 @@ class EventSettingsApi:
11589
11671
 
11590
11672
 
11591
11673
  @validate_call
11592
- def put_alerting_channel_without_preload_content(
11674
+ def put_alert_without_preload_content(
11593
11675
  self,
11594
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11595
- abstract_integration: AbstractIntegration,
11676
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11677
+ alerting_configuration: AlertingConfiguration,
11596
11678
  _request_timeout: Union[
11597
11679
  None,
11598
11680
  Annotated[StrictFloat, Field(gt=0)],
@@ -11606,14 +11688,14 @@ class EventSettingsApi:
11606
11688
  _headers: Optional[Dict[StrictStr, Any]] = None,
11607
11689
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11608
11690
  ) -> RESTResponseType:
11609
- """Update Alert Channel
11691
+ """Create or update Alert Configuration
11610
11692
 
11611
- Updates an alerting channel.
11693
+ Create or update a specific Alert configuration by ID
11612
11694
 
11613
- :param id: ID of the Alerting Channel to update. (required)
11695
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11614
11696
  :type id: str
11615
- :param abstract_integration: (required)
11616
- :type abstract_integration: AbstractIntegration
11697
+ :param alerting_configuration: (required)
11698
+ :type alerting_configuration: AlertingConfiguration
11617
11699
  :param _request_timeout: timeout setting for this request. If one
11618
11700
  number provided, it will be total request
11619
11701
  timeout. It can also be a pair (tuple) of
@@ -11636,9 +11718,9 @@ class EventSettingsApi:
11636
11718
  :return: Returns the result object.
11637
11719
  """ # noqa: E501
11638
11720
 
11639
- _param = self._put_alerting_channel_serialize(
11721
+ _param = self._put_alert_serialize(
11640
11722
  id=id,
11641
- abstract_integration=abstract_integration,
11723
+ alerting_configuration=alerting_configuration,
11642
11724
  _request_auth=_request_auth,
11643
11725
  _content_type=_content_type,
11644
11726
  _headers=_headers,
@@ -11646,8 +11728,10 @@ class EventSettingsApi:
11646
11728
  )
11647
11729
 
11648
11730
  _response_types_map: Dict[str, Optional[str]] = {
11649
- '200': "AbstractIntegration",
11650
- '400': "str",
11731
+ '200': "AlertingConfigurationWithLastUpdated",
11732
+ '401': None,
11733
+ '403': None,
11734
+ '422': None,
11651
11735
  }
11652
11736
  response_data = self.api_client.call_api(
11653
11737
  *_param,
@@ -11656,10 +11740,10 @@ class EventSettingsApi:
11656
11740
  return response_data.response
11657
11741
 
11658
11742
 
11659
- def _put_alerting_channel_serialize(
11743
+ def _put_alert_serialize(
11660
11744
  self,
11661
11745
  id,
11662
- abstract_integration,
11746
+ alerting_configuration,
11663
11747
  _request_auth,
11664
11748
  _content_type,
11665
11749
  _headers,
@@ -11687,8 +11771,8 @@ class EventSettingsApi:
11687
11771
  # process the header parameters
11688
11772
  # process the form parameters
11689
11773
  # process the body parameter
11690
- if abstract_integration is not None:
11691
- _body_params = abstract_integration
11774
+ if alerting_configuration is not None:
11775
+ _body_params = alerting_configuration
11692
11776
 
11693
11777
 
11694
11778
  # set the HTTP header `Accept`
@@ -11720,7 +11804,7 @@ class EventSettingsApi:
11720
11804
 
11721
11805
  return self.api_client.param_serialize(
11722
11806
  method='PUT',
11723
- resource_path='/api/events/settings/alertingChannels/{id}',
11807
+ resource_path='/api/events/settings/alerts/{id}',
11724
11808
  path_params=_path_params,
11725
11809
  query_params=_query_params,
11726
11810
  header_params=_header_params,
@@ -11737,11 +11821,10 @@ class EventSettingsApi:
11737
11821
 
11738
11822
 
11739
11823
  @validate_call
11740
- def put_custom_event_specification(
11824
+ def put_alerting_channel(
11741
11825
  self,
11742
- event_specification_id: StrictStr,
11743
- custom_event_specification: CustomEventSpecification,
11744
- allow_restore: Optional[StrictBool] = None,
11826
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11827
+ abstract_integration: AbstractIntegration,
11745
11828
  _request_timeout: Union[
11746
11829
  None,
11747
11830
  Annotated[StrictFloat, Field(gt=0)],
@@ -11754,17 +11837,15 @@ class EventSettingsApi:
11754
11837
  _content_type: Optional[StrictStr] = None,
11755
11838
  _headers: Optional[Dict[StrictStr, Any]] = None,
11756
11839
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11757
- ) -> CustomEventSpecificationWithLastUpdated:
11758
- """Create or update custom event specification
11840
+ ) -> AbstractIntegration:
11841
+ """Update Alert Channel
11759
11842
 
11760
- This endpoint creates or updates a Custom Event Specification. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for each custom event - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ## Optional Parameters: - **allowRestore (Query Parameter):** Allows to restore a custom event specification that was previously deleted or migrated when set to `true`. This allows to have idempotent operations that can be useful in _configuration as code_ scenarios. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
11843
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11761
11844
 
11762
- :param event_specification_id: (required)
11763
- :type event_specification_id: str
11764
- :param custom_event_specification: (required)
11765
- :type custom_event_specification: CustomEventSpecification
11766
- :param allow_restore:
11767
- :type allow_restore: bool
11845
+ :param id: ID of the Alerting Channel to update. (required)
11846
+ :type id: str
11847
+ :param abstract_integration: (required)
11848
+ :type abstract_integration: AbstractIntegration
11768
11849
  :param _request_timeout: timeout setting for this request. If one
11769
11850
  number provided, it will be total request
11770
11851
  timeout. It can also be a pair (tuple) of
@@ -11787,10 +11868,9 @@ class EventSettingsApi:
11787
11868
  :return: Returns the result object.
11788
11869
  """ # noqa: E501
11789
11870
 
11790
- _param = self._put_custom_event_specification_serialize(
11791
- event_specification_id=event_specification_id,
11792
- custom_event_specification=custom_event_specification,
11793
- allow_restore=allow_restore,
11871
+ _param = self._put_alerting_channel_serialize(
11872
+ id=id,
11873
+ abstract_integration=abstract_integration,
11794
11874
  _request_auth=_request_auth,
11795
11875
  _content_type=_content_type,
11796
11876
  _headers=_headers,
@@ -11798,7 +11878,9 @@ class EventSettingsApi:
11798
11878
  )
11799
11879
 
11800
11880
  _response_types_map: Dict[str, Optional[str]] = {
11801
- '200': "CustomEventSpecificationWithLastUpdated",
11881
+ '200': "AbstractIntegration",
11882
+ '302': None,
11883
+ '400': "str",
11802
11884
  }
11803
11885
  response_data = self.api_client.call_api(
11804
11886
  *_param,
@@ -11812,11 +11894,10 @@ class EventSettingsApi:
11812
11894
 
11813
11895
 
11814
11896
  @validate_call
11815
- def put_custom_event_specification_with_http_info(
11897
+ def put_alerting_channel_with_http_info(
11816
11898
  self,
11817
- event_specification_id: StrictStr,
11818
- custom_event_specification: CustomEventSpecification,
11819
- allow_restore: Optional[StrictBool] = None,
11899
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11900
+ abstract_integration: AbstractIntegration,
11820
11901
  _request_timeout: Union[
11821
11902
  None,
11822
11903
  Annotated[StrictFloat, Field(gt=0)],
@@ -11829,17 +11910,15 @@ class EventSettingsApi:
11829
11910
  _content_type: Optional[StrictStr] = None,
11830
11911
  _headers: Optional[Dict[StrictStr, Any]] = None,
11831
11912
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11832
- ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
11833
- """Create or update custom event specification
11913
+ ) -> ApiResponse[AbstractIntegration]:
11914
+ """Update Alert Channel
11834
11915
 
11835
- This endpoint creates or updates a Custom Event Specification. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for each custom event - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ## Optional Parameters: - **allowRestore (Query Parameter):** Allows to restore a custom event specification that was previously deleted or migrated when set to `true`. This allows to have idempotent operations that can be useful in _configuration as code_ scenarios. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
11916
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11836
11917
 
11837
- :param event_specification_id: (required)
11838
- :type event_specification_id: str
11839
- :param custom_event_specification: (required)
11840
- :type custom_event_specification: CustomEventSpecification
11841
- :param allow_restore:
11842
- :type allow_restore: bool
11918
+ :param id: ID of the Alerting Channel to update. (required)
11919
+ :type id: str
11920
+ :param abstract_integration: (required)
11921
+ :type abstract_integration: AbstractIntegration
11843
11922
  :param _request_timeout: timeout setting for this request. If one
11844
11923
  number provided, it will be total request
11845
11924
  timeout. It can also be a pair (tuple) of
@@ -11862,10 +11941,9 @@ class EventSettingsApi:
11862
11941
  :return: Returns the result object.
11863
11942
  """ # noqa: E501
11864
11943
 
11865
- _param = self._put_custom_event_specification_serialize(
11866
- event_specification_id=event_specification_id,
11867
- custom_event_specification=custom_event_specification,
11868
- allow_restore=allow_restore,
11944
+ _param = self._put_alerting_channel_serialize(
11945
+ id=id,
11946
+ abstract_integration=abstract_integration,
11869
11947
  _request_auth=_request_auth,
11870
11948
  _content_type=_content_type,
11871
11949
  _headers=_headers,
@@ -11873,7 +11951,9 @@ class EventSettingsApi:
11873
11951
  )
11874
11952
 
11875
11953
  _response_types_map: Dict[str, Optional[str]] = {
11876
- '200': "CustomEventSpecificationWithLastUpdated",
11954
+ '200': "AbstractIntegration",
11955
+ '302': None,
11956
+ '400': "str",
11877
11957
  }
11878
11958
  response_data = self.api_client.call_api(
11879
11959
  *_param,
@@ -11887,11 +11967,10 @@ class EventSettingsApi:
11887
11967
 
11888
11968
 
11889
11969
  @validate_call
11890
- def put_custom_event_specification_without_preload_content(
11970
+ def put_alerting_channel_without_preload_content(
11891
11971
  self,
11892
- event_specification_id: StrictStr,
11893
- custom_event_specification: CustomEventSpecification,
11894
- allow_restore: Optional[StrictBool] = None,
11972
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11973
+ abstract_integration: AbstractIntegration,
11895
11974
  _request_timeout: Union[
11896
11975
  None,
11897
11976
  Annotated[StrictFloat, Field(gt=0)],
@@ -11905,9 +11984,236 @@ class EventSettingsApi:
11905
11984
  _headers: Optional[Dict[StrictStr, Any]] = None,
11906
11985
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11907
11986
  ) -> RESTResponseType:
11987
+ """Update Alert Channel
11988
+
11989
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11990
+
11991
+ :param id: ID of the Alerting Channel to update. (required)
11992
+ :type id: str
11993
+ :param abstract_integration: (required)
11994
+ :type abstract_integration: AbstractIntegration
11995
+ :param _request_timeout: timeout setting for this request. If one
11996
+ number provided, it will be total request
11997
+ timeout. It can also be a pair (tuple) of
11998
+ (connection, read) timeouts.
11999
+ :type _request_timeout: int, tuple(int, int), optional
12000
+ :param _request_auth: set to override the auth_settings for an a single
12001
+ request; this effectively ignores the
12002
+ authentication in the spec for a single request.
12003
+ :type _request_auth: dict, optional
12004
+ :param _content_type: force content-type for the request.
12005
+ :type _content_type: str, Optional
12006
+ :param _headers: set to override the headers for a single
12007
+ request; this effectively ignores the headers
12008
+ in the spec for a single request.
12009
+ :type _headers: dict, optional
12010
+ :param _host_index: set to override the host_index for a single
12011
+ request; this effectively ignores the host_index
12012
+ in the spec for a single request.
12013
+ :type _host_index: int, optional
12014
+ :return: Returns the result object.
12015
+ """ # noqa: E501
12016
+
12017
+ _param = self._put_alerting_channel_serialize(
12018
+ id=id,
12019
+ abstract_integration=abstract_integration,
12020
+ _request_auth=_request_auth,
12021
+ _content_type=_content_type,
12022
+ _headers=_headers,
12023
+ _host_index=_host_index
12024
+ )
12025
+
12026
+ _response_types_map: Dict[str, Optional[str]] = {
12027
+ '200': "AbstractIntegration",
12028
+ '302': None,
12029
+ '400': "str",
12030
+ }
12031
+ response_data = self.api_client.call_api(
12032
+ *_param,
12033
+ _request_timeout=_request_timeout
12034
+ )
12035
+ return response_data.response
12036
+
12037
+
12038
+ def _put_alerting_channel_serialize(
12039
+ self,
12040
+ id,
12041
+ abstract_integration,
12042
+ _request_auth,
12043
+ _content_type,
12044
+ _headers,
12045
+ _host_index,
12046
+ ) -> RequestSerialized:
12047
+
12048
+ _host = None
12049
+
12050
+ _collection_formats: Dict[str, str] = {
12051
+ }
12052
+
12053
+ _path_params: Dict[str, str] = {}
12054
+ _query_params: List[Tuple[str, str]] = []
12055
+ _header_params: Dict[str, Optional[str]] = _headers or {}
12056
+ _form_params: List[Tuple[str, str]] = []
12057
+ _files: Dict[
12058
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
12059
+ ] = {}
12060
+ _body_params: Optional[bytes] = None
12061
+
12062
+ # process the path parameters
12063
+ if id is not None:
12064
+ _path_params['id'] = id
12065
+ # process the query parameters
12066
+ # process the header parameters
12067
+ # process the form parameters
12068
+ # process the body parameter
12069
+ if abstract_integration is not None:
12070
+ _body_params = abstract_integration
12071
+
12072
+
12073
+ # set the HTTP header `Accept`
12074
+ if 'Accept' not in _header_params:
12075
+ _header_params['Accept'] = self.api_client.select_header_accept(
12076
+ [
12077
+ 'application/json'
12078
+ ]
12079
+ )
12080
+
12081
+ # set the HTTP header `Content-Type`
12082
+ if _content_type:
12083
+ _header_params['Content-Type'] = _content_type
12084
+ else:
12085
+ _default_content_type = (
12086
+ self.api_client.select_header_content_type(
12087
+ [
12088
+ 'application/json'
12089
+ ]
12090
+ )
12091
+ )
12092
+ if _default_content_type is not None:
12093
+ _header_params['Content-Type'] = _default_content_type
12094
+
12095
+ # authentication setting
12096
+ _auth_settings: List[str] = [
12097
+ 'ApiKeyAuth'
12098
+ ]
12099
+
12100
+ return self.api_client.param_serialize(
12101
+ method='PUT',
12102
+ resource_path='/api/events/settings/alertingChannels/{id}',
12103
+ path_params=_path_params,
12104
+ query_params=_query_params,
12105
+ header_params=_header_params,
12106
+ body=_body_params,
12107
+ post_params=_form_params,
12108
+ files=_files,
12109
+ auth_settings=_auth_settings,
12110
+ collection_formats=_collection_formats,
12111
+ _host=_host,
12112
+ _request_auth=_request_auth
12113
+ )
12114
+
12115
+
12116
+
12117
+
12118
+ @validate_call
12119
+ def put_custom_event_specification(
12120
+ self,
12121
+ event_specification_id: StrictStr,
12122
+ custom_event_specification: CustomEventSpecification,
12123
+ allow_restore: Optional[StrictBool] = None,
12124
+ _request_timeout: Union[
12125
+ None,
12126
+ Annotated[StrictFloat, Field(gt=0)],
12127
+ Tuple[
12128
+ Annotated[StrictFloat, Field(gt=0)],
12129
+ Annotated[StrictFloat, Field(gt=0)]
12130
+ ]
12131
+ ] = None,
12132
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12133
+ _content_type: Optional[StrictStr] = None,
12134
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12135
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12136
+ ) -> CustomEventSpecificationWithLastUpdated:
12137
+ """Create or update custom event specification
12138
+
12139
+
12140
+ :param event_specification_id: (required)
12141
+ :type event_specification_id: str
12142
+ :param custom_event_specification: (required)
12143
+ :type custom_event_specification: CustomEventSpecification
12144
+ :param allow_restore:
12145
+ :type allow_restore: bool
12146
+ :param _request_timeout: timeout setting for this request. If one
12147
+ number provided, it will be total request
12148
+ timeout. It can also be a pair (tuple) of
12149
+ (connection, read) timeouts.
12150
+ :type _request_timeout: int, tuple(int, int), optional
12151
+ :param _request_auth: set to override the auth_settings for an a single
12152
+ request; this effectively ignores the
12153
+ authentication in the spec for a single request.
12154
+ :type _request_auth: dict, optional
12155
+ :param _content_type: force content-type for the request.
12156
+ :type _content_type: str, Optional
12157
+ :param _headers: set to override the headers for a single
12158
+ request; this effectively ignores the headers
12159
+ in the spec for a single request.
12160
+ :type _headers: dict, optional
12161
+ :param _host_index: set to override the host_index for a single
12162
+ request; this effectively ignores the host_index
12163
+ in the spec for a single request.
12164
+ :type _host_index: int, optional
12165
+ :return: Returns the result object.
12166
+ """ # noqa: E501
12167
+
12168
+ _param = self._put_custom_event_specification_serialize(
12169
+ event_specification_id=event_specification_id,
12170
+ custom_event_specification=custom_event_specification,
12171
+ allow_restore=allow_restore,
12172
+ _request_auth=_request_auth,
12173
+ _content_type=_content_type,
12174
+ _headers=_headers,
12175
+ _host_index=_host_index
12176
+ )
12177
+
12178
+ _response_types_map: Dict[str, Optional[str]] = {
12179
+ '200': "CustomEventSpecificationWithLastUpdated",
12180
+ '400': None,
12181
+ '401': None,
12182
+ '403': None,
12183
+ '500': None,
12184
+ }
12185
+ response_data = self.api_client.call_api(
12186
+ *_param,
12187
+ _request_timeout=_request_timeout
12188
+ )
12189
+ response_data.read()
12190
+ return self.api_client.response_deserialize(
12191
+ response_data=response_data,
12192
+ response_types_map=_response_types_map,
12193
+ ).data
12194
+
12195
+
12196
+ @validate_call
12197
+ def put_custom_event_specification_with_http_info(
12198
+ self,
12199
+ event_specification_id: StrictStr,
12200
+ custom_event_specification: CustomEventSpecification,
12201
+ allow_restore: Optional[StrictBool] = None,
12202
+ _request_timeout: Union[
12203
+ None,
12204
+ Annotated[StrictFloat, Field(gt=0)],
12205
+ Tuple[
12206
+ Annotated[StrictFloat, Field(gt=0)],
12207
+ Annotated[StrictFloat, Field(gt=0)]
12208
+ ]
12209
+ ] = None,
12210
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12211
+ _content_type: Optional[StrictStr] = None,
12212
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12213
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12214
+ ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
11908
12215
  """Create or update custom event specification
11909
12216
 
11910
- This endpoint creates or updates a Custom Event Specification. ## Mandatory Parameters: - **eventSpecificationId (Path Parameter):** A unique identifier for each custom event - **name:** Name for the custom event - **entityType:** Name of the available plugins for the selected source - **rules.ruleType:** Type of the rule being set for the custom event ### Rule-type specific parameters Depending on the chosen `ruleType`, there are further required parameters: #### Threshold Rule using a dynamic built-in metric by pattern : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricPattern.prefix:** Prefix pattern for the metric - **rules.metricPattern.operator:** Operator for matching the metric ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\",\"name\":\"Event for OpenAPI documentation\", \"query\":<Query>, \"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":null, \"metricPattern\":{\"prefix\":\"fs\", \"postfix\":\"free\", \"operator\":\"endsWith\", \"placeholder\":\"/xvda1\"}, \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` The above example creates a custom event that matches disk devices that end with \"/xvda1\" for the metric \"fs.{device}.free\" for any host in scope. #### Threshold Rule using fixed metric : - **rules.conditionOperator:** Conditional operator for the aggregation for the provided time window - **rules.metricName:** Metric name for the event ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation fixed Metric\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation fixed metric\",\"rules\":[{\"aggregation\":\"sum\",\"conditionOperator\":\">\", \"conditionValue\":0.1, \"metricName\":\"fs./dev/xvda1.free\", \"rollup\":null, \"ruleType\":\"threshold\", \"severity\":10, \"window\":30000}], \"triggering\":false }' ``` #### System Rule: - **rules.systemRuleId:** Id of the System Rule being set ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI documentation System Rule\", \"enabled\":true,\"entityType\":\"any\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI documentation System Rule\", \"rules\":[{\"ruleType\":\"system\", \"systemRuleId\":\"entity.offline\",\"severity\":10}], \"triggering\":false }' ``` #### Entity Verification Rule: - **rules.matchingEntityType:** Type of the Entity - **rules.matchingOperator:** Operator for matching the Entity name - **rules.matchingEntityLabel:** Name Pattern for the Entity ``` curl --request PUT 'https://<Host>/api/events/settings/event-specifications/custom/<EventSpecificationId>' \\ --header 'Authorization: apiToken <Token>' \\ --header 'Content-Type: application/json' \\ --data-raw '{ \"description\":\"Event for OpenAPI Entity Verification Rule\", \"enabled\":true,\"entityType\":\"host\",\"expirationTime\":\"60000\", \"name\":\"Event for OpenAPI Entity Verification Rule\", \"rules\":[{\"matchingEntityLabel\":\"test\", \"matchingEntityType\":\"jvmRuntimePlatform\",\"matchingOperator\":\"startsWith\",\"offlineDuration\":1800000, \"ruleType\":\"entity_verification\",\"severity\": 5}], \"triggering\":false }' ``` ## Optional Parameters: - **allowRestore (Query Parameter):** Allows to restore a custom event specification that was previously deleted or migrated when set to `true`. This allows to have idempotent operations that can be useful in _configuration as code_ scenarios. By default, the ID of a deleted configuration cannot be reused anymore to enable links in previous Issues or Incidents to stay valid. ### Deprecations: The entity types `application`, `service` and `endpoint` are deprecated for custom events and need to be migrated to a Smart Alert soon. We advise to configure a respective Smart Alert instead of a custom Event. For more information please [refer to our documentation](https://www.ibm.com/docs/en/obi/current?topic=applications-smart-alerts).
11911
12217
 
11912
12218
  :param event_specification_id: (required)
11913
12219
  :type event_specification_id: str
@@ -11937,10 +12243,402 @@ class EventSettingsApi:
11937
12243
  :return: Returns the result object.
11938
12244
  """ # noqa: E501
11939
12245
 
11940
- _param = self._put_custom_event_specification_serialize(
11941
- event_specification_id=event_specification_id,
11942
- custom_event_specification=custom_event_specification,
11943
- allow_restore=allow_restore,
12246
+ _param = self._put_custom_event_specification_serialize(
12247
+ event_specification_id=event_specification_id,
12248
+ custom_event_specification=custom_event_specification,
12249
+ allow_restore=allow_restore,
12250
+ _request_auth=_request_auth,
12251
+ _content_type=_content_type,
12252
+ _headers=_headers,
12253
+ _host_index=_host_index
12254
+ )
12255
+
12256
+ _response_types_map: Dict[str, Optional[str]] = {
12257
+ '200': "CustomEventSpecificationWithLastUpdated",
12258
+ '400': None,
12259
+ '401': None,
12260
+ '403': None,
12261
+ '500': None,
12262
+ }
12263
+ response_data = self.api_client.call_api(
12264
+ *_param,
12265
+ _request_timeout=_request_timeout
12266
+ )
12267
+ response_data.read()
12268
+ return self.api_client.response_deserialize(
12269
+ response_data=response_data,
12270
+ response_types_map=_response_types_map,
12271
+ )
12272
+
12273
+
12274
+ @validate_call
12275
+ def put_custom_event_specification_without_preload_content(
12276
+ self,
12277
+ event_specification_id: StrictStr,
12278
+ custom_event_specification: CustomEventSpecification,
12279
+ allow_restore: Optional[StrictBool] = None,
12280
+ _request_timeout: Union[
12281
+ None,
12282
+ Annotated[StrictFloat, Field(gt=0)],
12283
+ Tuple[
12284
+ Annotated[StrictFloat, Field(gt=0)],
12285
+ Annotated[StrictFloat, Field(gt=0)]
12286
+ ]
12287
+ ] = None,
12288
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12289
+ _content_type: Optional[StrictStr] = None,
12290
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12291
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12292
+ ) -> RESTResponseType:
12293
+ """Create or update custom event specification
12294
+
12295
+
12296
+ :param event_specification_id: (required)
12297
+ :type event_specification_id: str
12298
+ :param custom_event_specification: (required)
12299
+ :type custom_event_specification: CustomEventSpecification
12300
+ :param allow_restore:
12301
+ :type allow_restore: bool
12302
+ :param _request_timeout: timeout setting for this request. If one
12303
+ number provided, it will be total request
12304
+ timeout. It can also be a pair (tuple) of
12305
+ (connection, read) timeouts.
12306
+ :type _request_timeout: int, tuple(int, int), optional
12307
+ :param _request_auth: set to override the auth_settings for an a single
12308
+ request; this effectively ignores the
12309
+ authentication in the spec for a single request.
12310
+ :type _request_auth: dict, optional
12311
+ :param _content_type: force content-type for the request.
12312
+ :type _content_type: str, Optional
12313
+ :param _headers: set to override the headers for a single
12314
+ request; this effectively ignores the headers
12315
+ in the spec for a single request.
12316
+ :type _headers: dict, optional
12317
+ :param _host_index: set to override the host_index for a single
12318
+ request; this effectively ignores the host_index
12319
+ in the spec for a single request.
12320
+ :type _host_index: int, optional
12321
+ :return: Returns the result object.
12322
+ """ # noqa: E501
12323
+
12324
+ _param = self._put_custom_event_specification_serialize(
12325
+ event_specification_id=event_specification_id,
12326
+ custom_event_specification=custom_event_specification,
12327
+ allow_restore=allow_restore,
12328
+ _request_auth=_request_auth,
12329
+ _content_type=_content_type,
12330
+ _headers=_headers,
12331
+ _host_index=_host_index
12332
+ )
12333
+
12334
+ _response_types_map: Dict[str, Optional[str]] = {
12335
+ '200': "CustomEventSpecificationWithLastUpdated",
12336
+ '400': None,
12337
+ '401': None,
12338
+ '403': None,
12339
+ '500': None,
12340
+ }
12341
+ response_data = self.api_client.call_api(
12342
+ *_param,
12343
+ _request_timeout=_request_timeout
12344
+ )
12345
+ return response_data.response
12346
+
12347
+
12348
+ def _put_custom_event_specification_serialize(
12349
+ self,
12350
+ event_specification_id,
12351
+ custom_event_specification,
12352
+ allow_restore,
12353
+ _request_auth,
12354
+ _content_type,
12355
+ _headers,
12356
+ _host_index,
12357
+ ) -> RequestSerialized:
12358
+
12359
+ _host = None
12360
+
12361
+ _collection_formats: Dict[str, str] = {
12362
+ }
12363
+
12364
+ _path_params: Dict[str, str] = {}
12365
+ _query_params: List[Tuple[str, str]] = []
12366
+ _header_params: Dict[str, Optional[str]] = _headers or {}
12367
+ _form_params: List[Tuple[str, str]] = []
12368
+ _files: Dict[
12369
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
12370
+ ] = {}
12371
+ _body_params: Optional[bytes] = None
12372
+
12373
+ # process the path parameters
12374
+ if event_specification_id is not None:
12375
+ _path_params['eventSpecificationId'] = event_specification_id
12376
+ # process the query parameters
12377
+ if allow_restore is not None:
12378
+
12379
+ _query_params.append(('allowRestore', allow_restore))
12380
+
12381
+ # process the header parameters
12382
+ # process the form parameters
12383
+ # process the body parameter
12384
+ if custom_event_specification is not None:
12385
+ _body_params = custom_event_specification
12386
+
12387
+
12388
+ # set the HTTP header `Accept`
12389
+ if 'Accept' not in _header_params:
12390
+ _header_params['Accept'] = self.api_client.select_header_accept(
12391
+ [
12392
+ 'application/json'
12393
+ ]
12394
+ )
12395
+
12396
+ # set the HTTP header `Content-Type`
12397
+ if _content_type:
12398
+ _header_params['Content-Type'] = _content_type
12399
+ else:
12400
+ _default_content_type = (
12401
+ self.api_client.select_header_content_type(
12402
+ [
12403
+ 'application/json'
12404
+ ]
12405
+ )
12406
+ )
12407
+ if _default_content_type is not None:
12408
+ _header_params['Content-Type'] = _default_content_type
12409
+
12410
+ # authentication setting
12411
+ _auth_settings: List[str] = [
12412
+ 'ApiKeyAuth'
12413
+ ]
12414
+
12415
+ return self.api_client.param_serialize(
12416
+ method='PUT',
12417
+ resource_path='/api/events/settings/event-specifications/custom/{eventSpecificationId}',
12418
+ path_params=_path_params,
12419
+ query_params=_query_params,
12420
+ header_params=_header_params,
12421
+ body=_body_params,
12422
+ post_params=_form_params,
12423
+ files=_files,
12424
+ auth_settings=_auth_settings,
12425
+ collection_formats=_collection_formats,
12426
+ _host=_host,
12427
+ _request_auth=_request_auth
12428
+ )
12429
+
12430
+
12431
+
12432
+
12433
+ @validate_call
12434
+ def restore_mobile_app_alert_config(
12435
+ self,
12436
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12437
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12438
+ body: Optional[StrictStr] = None,
12439
+ _request_timeout: Union[
12440
+ None,
12441
+ Annotated[StrictFloat, Field(gt=0)],
12442
+ Tuple[
12443
+ Annotated[StrictFloat, Field(gt=0)],
12444
+ Annotated[StrictFloat, Field(gt=0)]
12445
+ ]
12446
+ ] = None,
12447
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12448
+ _content_type: Optional[StrictStr] = None,
12449
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12450
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12451
+ ) -> None:
12452
+ """Restore Mobile Smart Alert Config
12453
+
12454
+ Restores a Mobile Smart Alert Configuration.
12455
+
12456
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12457
+ :type id: str
12458
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12459
+ :type created: int
12460
+ :param body:
12461
+ :type body: str
12462
+ :param _request_timeout: timeout setting for this request. If one
12463
+ number provided, it will be total request
12464
+ timeout. It can also be a pair (tuple) of
12465
+ (connection, read) timeouts.
12466
+ :type _request_timeout: int, tuple(int, int), optional
12467
+ :param _request_auth: set to override the auth_settings for an a single
12468
+ request; this effectively ignores the
12469
+ authentication in the spec for a single request.
12470
+ :type _request_auth: dict, optional
12471
+ :param _content_type: force content-type for the request.
12472
+ :type _content_type: str, Optional
12473
+ :param _headers: set to override the headers for a single
12474
+ request; this effectively ignores the headers
12475
+ in the spec for a single request.
12476
+ :type _headers: dict, optional
12477
+ :param _host_index: set to override the host_index for a single
12478
+ request; this effectively ignores the host_index
12479
+ in the spec for a single request.
12480
+ :type _host_index: int, optional
12481
+ :return: Returns the result object.
12482
+ """ # noqa: E501
12483
+
12484
+ _param = self._restore_mobile_app_alert_config_serialize(
12485
+ id=id,
12486
+ created=created,
12487
+ body=body,
12488
+ _request_auth=_request_auth,
12489
+ _content_type=_content_type,
12490
+ _headers=_headers,
12491
+ _host_index=_host_index
12492
+ )
12493
+
12494
+ _response_types_map: Dict[str, Optional[str]] = {
12495
+ '204': None,
12496
+ '403': None,
12497
+ '404': None,
12498
+ }
12499
+ response_data = self.api_client.call_api(
12500
+ *_param,
12501
+ _request_timeout=_request_timeout
12502
+ )
12503
+ response_data.read()
12504
+ return self.api_client.response_deserialize(
12505
+ response_data=response_data,
12506
+ response_types_map=_response_types_map,
12507
+ ).data
12508
+
12509
+
12510
+ @validate_call
12511
+ def restore_mobile_app_alert_config_with_http_info(
12512
+ self,
12513
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12514
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12515
+ body: Optional[StrictStr] = None,
12516
+ _request_timeout: Union[
12517
+ None,
12518
+ Annotated[StrictFloat, Field(gt=0)],
12519
+ Tuple[
12520
+ Annotated[StrictFloat, Field(gt=0)],
12521
+ Annotated[StrictFloat, Field(gt=0)]
12522
+ ]
12523
+ ] = None,
12524
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12525
+ _content_type: Optional[StrictStr] = None,
12526
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12527
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12528
+ ) -> ApiResponse[None]:
12529
+ """Restore Mobile Smart Alert Config
12530
+
12531
+ Restores a Mobile Smart Alert Configuration.
12532
+
12533
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12534
+ :type id: str
12535
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12536
+ :type created: int
12537
+ :param body:
12538
+ :type body: str
12539
+ :param _request_timeout: timeout setting for this request. If one
12540
+ number provided, it will be total request
12541
+ timeout. It can also be a pair (tuple) of
12542
+ (connection, read) timeouts.
12543
+ :type _request_timeout: int, tuple(int, int), optional
12544
+ :param _request_auth: set to override the auth_settings for an a single
12545
+ request; this effectively ignores the
12546
+ authentication in the spec for a single request.
12547
+ :type _request_auth: dict, optional
12548
+ :param _content_type: force content-type for the request.
12549
+ :type _content_type: str, Optional
12550
+ :param _headers: set to override the headers for a single
12551
+ request; this effectively ignores the headers
12552
+ in the spec for a single request.
12553
+ :type _headers: dict, optional
12554
+ :param _host_index: set to override the host_index for a single
12555
+ request; this effectively ignores the host_index
12556
+ in the spec for a single request.
12557
+ :type _host_index: int, optional
12558
+ :return: Returns the result object.
12559
+ """ # noqa: E501
12560
+
12561
+ _param = self._restore_mobile_app_alert_config_serialize(
12562
+ id=id,
12563
+ created=created,
12564
+ body=body,
12565
+ _request_auth=_request_auth,
12566
+ _content_type=_content_type,
12567
+ _headers=_headers,
12568
+ _host_index=_host_index
12569
+ )
12570
+
12571
+ _response_types_map: Dict[str, Optional[str]] = {
12572
+ '204': None,
12573
+ '403': None,
12574
+ '404': None,
12575
+ }
12576
+ response_data = self.api_client.call_api(
12577
+ *_param,
12578
+ _request_timeout=_request_timeout
12579
+ )
12580
+ response_data.read()
12581
+ return self.api_client.response_deserialize(
12582
+ response_data=response_data,
12583
+ response_types_map=_response_types_map,
12584
+ )
12585
+
12586
+
12587
+ @validate_call
12588
+ def restore_mobile_app_alert_config_without_preload_content(
12589
+ self,
12590
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12591
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12592
+ body: Optional[StrictStr] = None,
12593
+ _request_timeout: Union[
12594
+ None,
12595
+ Annotated[StrictFloat, Field(gt=0)],
12596
+ Tuple[
12597
+ Annotated[StrictFloat, Field(gt=0)],
12598
+ Annotated[StrictFloat, Field(gt=0)]
12599
+ ]
12600
+ ] = None,
12601
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12602
+ _content_type: Optional[StrictStr] = None,
12603
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12604
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12605
+ ) -> RESTResponseType:
12606
+ """Restore Mobile Smart Alert Config
12607
+
12608
+ Restores a Mobile Smart Alert Configuration.
12609
+
12610
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12611
+ :type id: str
12612
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12613
+ :type created: int
12614
+ :param body:
12615
+ :type body: str
12616
+ :param _request_timeout: timeout setting for this request. If one
12617
+ number provided, it will be total request
12618
+ timeout. It can also be a pair (tuple) of
12619
+ (connection, read) timeouts.
12620
+ :type _request_timeout: int, tuple(int, int), optional
12621
+ :param _request_auth: set to override the auth_settings for an a single
12622
+ request; this effectively ignores the
12623
+ authentication in the spec for a single request.
12624
+ :type _request_auth: dict, optional
12625
+ :param _content_type: force content-type for the request.
12626
+ :type _content_type: str, Optional
12627
+ :param _headers: set to override the headers for a single
12628
+ request; this effectively ignores the headers
12629
+ in the spec for a single request.
12630
+ :type _headers: dict, optional
12631
+ :param _host_index: set to override the host_index for a single
12632
+ request; this effectively ignores the host_index
12633
+ in the spec for a single request.
12634
+ :type _host_index: int, optional
12635
+ :return: Returns the result object.
12636
+ """ # noqa: E501
12637
+
12638
+ _param = self._restore_mobile_app_alert_config_serialize(
12639
+ id=id,
12640
+ created=created,
12641
+ body=body,
11944
12642
  _request_auth=_request_auth,
11945
12643
  _content_type=_content_type,
11946
12644
  _headers=_headers,
@@ -11948,7 +12646,9 @@ class EventSettingsApi:
11948
12646
  )
11949
12647
 
11950
12648
  _response_types_map: Dict[str, Optional[str]] = {
11951
- '200': "CustomEventSpecificationWithLastUpdated",
12649
+ '204': None,
12650
+ '403': None,
12651
+ '404': None,
11952
12652
  }
11953
12653
  response_data = self.api_client.call_api(
11954
12654
  *_param,
@@ -11957,11 +12657,11 @@ class EventSettingsApi:
11957
12657
  return response_data.response
11958
12658
 
11959
12659
 
11960
- def _put_custom_event_specification_serialize(
12660
+ def _restore_mobile_app_alert_config_serialize(
11961
12661
  self,
11962
- event_specification_id,
11963
- custom_event_specification,
11964
- allow_restore,
12662
+ id,
12663
+ created,
12664
+ body,
11965
12665
  _request_auth,
11966
12666
  _content_type,
11967
12667
  _headers,
@@ -11983,27 +12683,18 @@ class EventSettingsApi:
11983
12683
  _body_params: Optional[bytes] = None
11984
12684
 
11985
12685
  # process the path parameters
11986
- if event_specification_id is not None:
11987
- _path_params['eventSpecificationId'] = event_specification_id
12686
+ if id is not None:
12687
+ _path_params['id'] = id
12688
+ if created is not None:
12689
+ _path_params['created'] = created
11988
12690
  # process the query parameters
11989
- if allow_restore is not None:
11990
-
11991
- _query_params.append(('allowRestore', allow_restore))
11992
-
11993
12691
  # process the header parameters
11994
12692
  # process the form parameters
11995
12693
  # process the body parameter
11996
- if custom_event_specification is not None:
11997
- _body_params = custom_event_specification
12694
+ if body is not None:
12695
+ _body_params = body
11998
12696
 
11999
12697
 
12000
- # set the HTTP header `Accept`
12001
- if 'Accept' not in _header_params:
12002
- _header_params['Accept'] = self.api_client.select_header_accept(
12003
- [
12004
- 'application/json'
12005
- ]
12006
- )
12007
12698
 
12008
12699
  # set the HTTP header `Content-Type`
12009
12700
  if _content_type:
@@ -12026,7 +12717,7 @@ class EventSettingsApi:
12026
12717
 
12027
12718
  return self.api_client.param_serialize(
12028
12719
  method='PUT',
12029
- resource_path='/api/events/settings/event-specifications/custom/{eventSpecificationId}',
12720
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}/restore/{created}',
12030
12721
  path_params=_path_params,
12031
12722
  query_params=_query_params,
12032
12723
  header_params=_header_params,
@@ -12043,10 +12734,10 @@ class EventSettingsApi:
12043
12734
 
12044
12735
 
12045
12736
  @validate_call
12046
- def restore_mobile_app_alert_config(
12737
+ def restore_website_alert_config(
12047
12738
  self,
12048
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12049
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12739
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12740
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12050
12741
  body: Optional[StrictStr] = None,
12051
12742
  _request_timeout: Union[
12052
12743
  None,
@@ -12061,13 +12752,13 @@ class EventSettingsApi:
12061
12752
  _headers: Optional[Dict[StrictStr, Any]] = None,
12062
12753
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12063
12754
  ) -> None:
12064
- """Restore Mobile Smart Alert Config
12755
+ """Restore Website Smart Alert Config
12065
12756
 
12066
- Restores a Mobile Smart Alert Configuration.
12757
+ Restores a deleted Website Smart Alert Configuration.
12067
12758
 
12068
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12759
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12069
12760
  :type id: str
12070
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12761
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12071
12762
  :type created: int
12072
12763
  :param body:
12073
12764
  :type body: str
@@ -12093,7 +12784,7 @@ class EventSettingsApi:
12093
12784
  :return: Returns the result object.
12094
12785
  """ # noqa: E501
12095
12786
 
12096
- _param = self._restore_mobile_app_alert_config_serialize(
12787
+ _param = self._restore_website_alert_config_serialize(
12097
12788
  id=id,
12098
12789
  created=created,
12099
12790
  body=body,
@@ -12104,9 +12795,9 @@ class EventSettingsApi:
12104
12795
  )
12105
12796
 
12106
12797
  _response_types_map: Dict[str, Optional[str]] = {
12107
- '200': None,
12108
- '400': None,
12798
+ '204': None,
12109
12799
  '403': None,
12800
+ '404': None,
12110
12801
  }
12111
12802
  response_data = self.api_client.call_api(
12112
12803
  *_param,
@@ -12120,10 +12811,10 @@ class EventSettingsApi:
12120
12811
 
12121
12812
 
12122
12813
  @validate_call
12123
- def restore_mobile_app_alert_config_with_http_info(
12814
+ def restore_website_alert_config_with_http_info(
12124
12815
  self,
12125
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12126
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12816
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12817
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12127
12818
  body: Optional[StrictStr] = None,
12128
12819
  _request_timeout: Union[
12129
12820
  None,
@@ -12138,13 +12829,13 @@ class EventSettingsApi:
12138
12829
  _headers: Optional[Dict[StrictStr, Any]] = None,
12139
12830
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12140
12831
  ) -> ApiResponse[None]:
12141
- """Restore Mobile Smart Alert Config
12832
+ """Restore Website Smart Alert Config
12142
12833
 
12143
- Restores a Mobile Smart Alert Configuration.
12834
+ Restores a deleted Website Smart Alert Configuration.
12144
12835
 
12145
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12836
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12146
12837
  :type id: str
12147
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12838
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12148
12839
  :type created: int
12149
12840
  :param body:
12150
12841
  :type body: str
@@ -12170,7 +12861,7 @@ class EventSettingsApi:
12170
12861
  :return: Returns the result object.
12171
12862
  """ # noqa: E501
12172
12863
 
12173
- _param = self._restore_mobile_app_alert_config_serialize(
12864
+ _param = self._restore_website_alert_config_serialize(
12174
12865
  id=id,
12175
12866
  created=created,
12176
12867
  body=body,
@@ -12181,9 +12872,9 @@ class EventSettingsApi:
12181
12872
  )
12182
12873
 
12183
12874
  _response_types_map: Dict[str, Optional[str]] = {
12184
- '200': None,
12185
- '400': None,
12875
+ '204': None,
12186
12876
  '403': None,
12877
+ '404': None,
12187
12878
  }
12188
12879
  response_data = self.api_client.call_api(
12189
12880
  *_param,
@@ -12197,10 +12888,10 @@ class EventSettingsApi:
12197
12888
 
12198
12889
 
12199
12890
  @validate_call
12200
- def restore_mobile_app_alert_config_without_preload_content(
12891
+ def restore_website_alert_config_without_preload_content(
12201
12892
  self,
12202
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12203
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12893
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12894
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12204
12895
  body: Optional[StrictStr] = None,
12205
12896
  _request_timeout: Union[
12206
12897
  None,
@@ -12215,13 +12906,13 @@ class EventSettingsApi:
12215
12906
  _headers: Optional[Dict[StrictStr, Any]] = None,
12216
12907
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12217
12908
  ) -> RESTResponseType:
12218
- """Restore Mobile Smart Alert Config
12909
+ """Restore Website Smart Alert Config
12219
12910
 
12220
- Restores a Mobile Smart Alert Configuration.
12911
+ Restores a deleted Website Smart Alert Configuration.
12221
12912
 
12222
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12913
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12223
12914
  :type id: str
12224
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12915
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12225
12916
  :type created: int
12226
12917
  :param body:
12227
12918
  :type body: str
@@ -12247,7 +12938,7 @@ class EventSettingsApi:
12247
12938
  :return: Returns the result object.
12248
12939
  """ # noqa: E501
12249
12940
 
12250
- _param = self._restore_mobile_app_alert_config_serialize(
12941
+ _param = self._restore_website_alert_config_serialize(
12251
12942
  id=id,
12252
12943
  created=created,
12253
12944
  body=body,
@@ -12258,9 +12949,9 @@ class EventSettingsApi:
12258
12949
  )
12259
12950
 
12260
12951
  _response_types_map: Dict[str, Optional[str]] = {
12261
- '200': None,
12262
- '400': None,
12952
+ '204': None,
12263
12953
  '403': None,
12954
+ '404': None,
12264
12955
  }
12265
12956
  response_data = self.api_client.call_api(
12266
12957
  *_param,
@@ -12269,7 +12960,7 @@ class EventSettingsApi:
12269
12960
  return response_data.response
12270
12961
 
12271
12962
 
12272
- def _restore_mobile_app_alert_config_serialize(
12963
+ def _restore_website_alert_config_serialize(
12273
12964
  self,
12274
12965
  id,
12275
12966
  created,
@@ -12324,11 +13015,12 @@ class EventSettingsApi:
12324
13015
 
12325
13016
  # authentication setting
12326
13017
  _auth_settings: List[str] = [
13018
+ 'ApiKeyAuth'
12327
13019
  ]
12328
13020
 
12329
13021
  return self.api_client.param_serialize(
12330
13022
  method='PUT',
12331
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}/restore/{created}',
13023
+ resource_path='/api/events/settings/website-alert-configs/{id}/restore/{created}',
12332
13024
  path_params=_path_params,
12333
13025
  query_params=_query_params,
12334
13026
  header_params=_header_params,
@@ -12345,11 +13037,9 @@ class EventSettingsApi:
12345
13037
 
12346
13038
 
12347
13039
  @validate_call
12348
- def restore_website_alert_config(
13040
+ def send_test_alerting(
12349
13041
  self,
12350
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12351
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12352
- body: Optional[StrictStr] = None,
13042
+ abstract_integration: AbstractIntegration,
12353
13043
  _request_timeout: Union[
12354
13044
  None,
12355
13045
  Annotated[StrictFloat, Field(gt=0)],
@@ -12363,16 +13053,12 @@ class EventSettingsApi:
12363
13053
  _headers: Optional[Dict[StrictStr, Any]] = None,
12364
13054
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12365
13055
  ) -> None:
12366
- """Restore Website Smart Alert Config
13056
+ """Test Alerting Channel
12367
13057
 
12368
- Restores a deleted Website Smart Alert Configuration.
13058
+ Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana. Requires the permission called CanConfigureIntegrations.
12369
13059
 
12370
- :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12371
- :type id: str
12372
- :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12373
- :type created: int
12374
- :param body:
12375
- :type body: str
13060
+ :param abstract_integration: (required)
13061
+ :type abstract_integration: AbstractIntegration
12376
13062
  :param _request_timeout: timeout setting for this request. If one
12377
13063
  number provided, it will be total request
12378
13064
  timeout. It can also be a pair (tuple) of
@@ -12395,10 +13081,8 @@ class EventSettingsApi:
12395
13081
  :return: Returns the result object.
12396
13082
  """ # noqa: E501
12397
13083
 
12398
- _param = self._restore_website_alert_config_serialize(
12399
- id=id,
12400
- created=created,
12401
- body=body,
13084
+ _param = self._send_test_alerting_serialize(
13085
+ abstract_integration=abstract_integration,
12402
13086
  _request_auth=_request_auth,
12403
13087
  _content_type=_content_type,
12404
13088
  _headers=_headers,
@@ -12407,8 +13091,6 @@ class EventSettingsApi:
12407
13091
 
12408
13092
  _response_types_map: Dict[str, Optional[str]] = {
12409
13093
  '200': None,
12410
- '400': None,
12411
- '403': None,
12412
13094
  }
12413
13095
  response_data = self.api_client.call_api(
12414
13096
  *_param,
@@ -12422,11 +13104,9 @@ class EventSettingsApi:
12422
13104
 
12423
13105
 
12424
13106
  @validate_call
12425
- def restore_website_alert_config_with_http_info(
13107
+ def send_test_alerting_with_http_info(
12426
13108
  self,
12427
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12428
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12429
- body: Optional[StrictStr] = None,
13109
+ abstract_integration: AbstractIntegration,
12430
13110
  _request_timeout: Union[
12431
13111
  None,
12432
13112
  Annotated[StrictFloat, Field(gt=0)],
@@ -12440,16 +13120,12 @@ class EventSettingsApi:
12440
13120
  _headers: Optional[Dict[StrictStr, Any]] = None,
12441
13121
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12442
13122
  ) -> ApiResponse[None]:
12443
- """Restore Website Smart Alert Config
13123
+ """Test Alerting Channel
12444
13124
 
12445
- Restores a deleted Website Smart Alert Configuration.
13125
+ Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana. Requires the permission called CanConfigureIntegrations.
12446
13126
 
12447
- :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12448
- :type id: str
12449
- :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12450
- :type created: int
12451
- :param body:
12452
- :type body: str
13127
+ :param abstract_integration: (required)
13128
+ :type abstract_integration: AbstractIntegration
12453
13129
  :param _request_timeout: timeout setting for this request. If one
12454
13130
  number provided, it will be total request
12455
13131
  timeout. It can also be a pair (tuple) of
@@ -12472,10 +13148,8 @@ class EventSettingsApi:
12472
13148
  :return: Returns the result object.
12473
13149
  """ # noqa: E501
12474
13150
 
12475
- _param = self._restore_website_alert_config_serialize(
12476
- id=id,
12477
- created=created,
12478
- body=body,
13151
+ _param = self._send_test_alerting_serialize(
13152
+ abstract_integration=abstract_integration,
12479
13153
  _request_auth=_request_auth,
12480
13154
  _content_type=_content_type,
12481
13155
  _headers=_headers,
@@ -12484,8 +13158,6 @@ class EventSettingsApi:
12484
13158
 
12485
13159
  _response_types_map: Dict[str, Optional[str]] = {
12486
13160
  '200': None,
12487
- '400': None,
12488
- '403': None,
12489
13161
  }
12490
13162
  response_data = self.api_client.call_api(
12491
13163
  *_param,
@@ -12499,11 +13171,9 @@ class EventSettingsApi:
12499
13171
 
12500
13172
 
12501
13173
  @validate_call
12502
- def restore_website_alert_config_without_preload_content(
13174
+ def send_test_alerting_without_preload_content(
12503
13175
  self,
12504
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12505
- created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12506
- body: Optional[StrictStr] = None,
13176
+ abstract_integration: AbstractIntegration,
12507
13177
  _request_timeout: Union[
12508
13178
  None,
12509
13179
  Annotated[StrictFloat, Field(gt=0)],
@@ -12517,16 +13187,12 @@ class EventSettingsApi:
12517
13187
  _headers: Optional[Dict[StrictStr, Any]] = None,
12518
13188
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12519
13189
  ) -> RESTResponseType:
12520
- """Restore Website Smart Alert Config
13190
+ """Test Alerting Channel
12521
13191
 
12522
- Restores a deleted Website Smart Alert Configuration.
13192
+ Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana. Requires the permission called CanConfigureIntegrations.
12523
13193
 
12524
- :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12525
- :type id: str
12526
- :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12527
- :type created: int
12528
- :param body:
12529
- :type body: str
13194
+ :param abstract_integration: (required)
13195
+ :type abstract_integration: AbstractIntegration
12530
13196
  :param _request_timeout: timeout setting for this request. If one
12531
13197
  number provided, it will be total request
12532
13198
  timeout. It can also be a pair (tuple) of
@@ -12549,10 +13215,8 @@ class EventSettingsApi:
12549
13215
  :return: Returns the result object.
12550
13216
  """ # noqa: E501
12551
13217
 
12552
- _param = self._restore_website_alert_config_serialize(
12553
- id=id,
12554
- created=created,
12555
- body=body,
13218
+ _param = self._send_test_alerting_serialize(
13219
+ abstract_integration=abstract_integration,
12556
13220
  _request_auth=_request_auth,
12557
13221
  _content_type=_content_type,
12558
13222
  _headers=_headers,
@@ -12561,8 +13225,6 @@ class EventSettingsApi:
12561
13225
 
12562
13226
  _response_types_map: Dict[str, Optional[str]] = {
12563
13227
  '200': None,
12564
- '400': None,
12565
- '403': None,
12566
13228
  }
12567
13229
  response_data = self.api_client.call_api(
12568
13230
  *_param,
@@ -12571,11 +13233,9 @@ class EventSettingsApi:
12571
13233
  return response_data.response
12572
13234
 
12573
13235
 
12574
- def _restore_website_alert_config_serialize(
13236
+ def _send_test_alerting_serialize(
12575
13237
  self,
12576
- id,
12577
- created,
12578
- body,
13238
+ abstract_integration,
12579
13239
  _request_auth,
12580
13240
  _content_type,
12581
13241
  _headers,
@@ -12597,18 +13257,21 @@ class EventSettingsApi:
12597
13257
  _body_params: Optional[bytes] = None
12598
13258
 
12599
13259
  # process the path parameters
12600
- if id is not None:
12601
- _path_params['id'] = id
12602
- if created is not None:
12603
- _path_params['created'] = created
12604
13260
  # process the query parameters
12605
13261
  # process the header parameters
12606
13262
  # process the form parameters
12607
13263
  # process the body parameter
12608
- if body is not None:
12609
- _body_params = body
13264
+ if abstract_integration is not None:
13265
+ _body_params = abstract_integration
12610
13266
 
12611
13267
 
13268
+ # set the HTTP header `Accept`
13269
+ if 'Accept' not in _header_params:
13270
+ _header_params['Accept'] = self.api_client.select_header_accept(
13271
+ [
13272
+ 'application/json'
13273
+ ]
13274
+ )
12612
13275
 
12613
13276
  # set the HTTP header `Content-Type`
12614
13277
  if _content_type:
@@ -12631,7 +13294,7 @@ class EventSettingsApi:
12631
13294
 
12632
13295
  return self.api_client.param_serialize(
12633
13296
  method='PUT',
12634
- resource_path='/api/events/settings/website-alert-configs/{id}/restore/{created}',
13297
+ resource_path='/api/events/settings/alertingChannels/test',
12635
13298
  path_params=_path_params,
12636
13299
  query_params=_query_params,
12637
13300
  header_params=_header_params,
@@ -12648,9 +13311,10 @@ class EventSettingsApi:
12648
13311
 
12649
13312
 
12650
13313
  @validate_call
12651
- def send_test_alerting(
13314
+ def send_test_alerting_by_id(
12652
13315
  self,
12653
- abstract_integration: AbstractIntegration,
13316
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13317
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12654
13318
  _request_timeout: Union[
12655
13319
  None,
12656
13320
  Annotated[StrictFloat, Field(gt=0)],
@@ -12664,12 +13328,14 @@ class EventSettingsApi:
12664
13328
  _headers: Optional[Dict[StrictStr, Any]] = None,
12665
13329
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12666
13330
  ) -> None:
12667
- """Test Alerting Channel
13331
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12668
13332
 
12669
- Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana.
13333
+ Sends alert for a specific event to an alerting channel. Provided the event Id, an alert could be sent to the alerting channel. This endpoint requires `canInvokeAlertChannel` permission.
12670
13334
 
12671
- :param abstract_integration: (required)
12672
- :type abstract_integration: AbstractIntegration
13335
+ :param id: ID of the alerting channel to be notified on. (required)
13336
+ :type id: str
13337
+ :param manual_alerting_channel_configuration: (required)
13338
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12673
13339
  :param _request_timeout: timeout setting for this request. If one
12674
13340
  number provided, it will be total request
12675
13341
  timeout. It can also be a pair (tuple) of
@@ -12692,8 +13358,9 @@ class EventSettingsApi:
12692
13358
  :return: Returns the result object.
12693
13359
  """ # noqa: E501
12694
13360
 
12695
- _param = self._send_test_alerting_serialize(
12696
- abstract_integration=abstract_integration,
13361
+ _param = self._send_test_alerting_by_id_serialize(
13362
+ id=id,
13363
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12697
13364
  _request_auth=_request_auth,
12698
13365
  _content_type=_content_type,
12699
13366
  _headers=_headers,
@@ -12714,9 +13381,10 @@ class EventSettingsApi:
12714
13381
 
12715
13382
 
12716
13383
  @validate_call
12717
- def send_test_alerting_with_http_info(
13384
+ def send_test_alerting_by_id_with_http_info(
12718
13385
  self,
12719
- abstract_integration: AbstractIntegration,
13386
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13387
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12720
13388
  _request_timeout: Union[
12721
13389
  None,
12722
13390
  Annotated[StrictFloat, Field(gt=0)],
@@ -12730,12 +13398,14 @@ class EventSettingsApi:
12730
13398
  _headers: Optional[Dict[StrictStr, Any]] = None,
12731
13399
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12732
13400
  ) -> ApiResponse[None]:
12733
- """Test Alerting Channel
13401
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12734
13402
 
12735
- Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana.
13403
+ Sends alert for a specific event to an alerting channel. Provided the event Id, an alert could be sent to the alerting channel. This endpoint requires `canInvokeAlertChannel` permission.
12736
13404
 
12737
- :param abstract_integration: (required)
12738
- :type abstract_integration: AbstractIntegration
13405
+ :param id: ID of the alerting channel to be notified on. (required)
13406
+ :type id: str
13407
+ :param manual_alerting_channel_configuration: (required)
13408
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12739
13409
  :param _request_timeout: timeout setting for this request. If one
12740
13410
  number provided, it will be total request
12741
13411
  timeout. It can also be a pair (tuple) of
@@ -12758,8 +13428,9 @@ class EventSettingsApi:
12758
13428
  :return: Returns the result object.
12759
13429
  """ # noqa: E501
12760
13430
 
12761
- _param = self._send_test_alerting_serialize(
12762
- abstract_integration=abstract_integration,
13431
+ _param = self._send_test_alerting_by_id_serialize(
13432
+ id=id,
13433
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12763
13434
  _request_auth=_request_auth,
12764
13435
  _content_type=_content_type,
12765
13436
  _headers=_headers,
@@ -12780,9 +13451,10 @@ class EventSettingsApi:
12780
13451
 
12781
13452
 
12782
13453
  @validate_call
12783
- def send_test_alerting_without_preload_content(
13454
+ def send_test_alerting_by_id_without_preload_content(
12784
13455
  self,
12785
- abstract_integration: AbstractIntegration,
13456
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13457
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12786
13458
  _request_timeout: Union[
12787
13459
  None,
12788
13460
  Annotated[StrictFloat, Field(gt=0)],
@@ -12796,12 +13468,14 @@ class EventSettingsApi:
12796
13468
  _headers: Optional[Dict[StrictStr, Any]] = None,
12797
13469
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12798
13470
  ) -> RESTResponseType:
12799
- """Test Alerting Channel
13471
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12800
13472
 
12801
- Sends a test alert to an alert channel. This is for testing if an potential alert channel is able to receive alerts from Instana.
13473
+ Sends alert for a specific event to an alerting channel. Provided the event Id, an alert could be sent to the alerting channel. This endpoint requires `canInvokeAlertChannel` permission.
12802
13474
 
12803
- :param abstract_integration: (required)
12804
- :type abstract_integration: AbstractIntegration
13475
+ :param id: ID of the alerting channel to be notified on. (required)
13476
+ :type id: str
13477
+ :param manual_alerting_channel_configuration: (required)
13478
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12805
13479
  :param _request_timeout: timeout setting for this request. If one
12806
13480
  number provided, it will be total request
12807
13481
  timeout. It can also be a pair (tuple) of
@@ -12824,8 +13498,9 @@ class EventSettingsApi:
12824
13498
  :return: Returns the result object.
12825
13499
  """ # noqa: E501
12826
13500
 
12827
- _param = self._send_test_alerting_serialize(
12828
- abstract_integration=abstract_integration,
13501
+ _param = self._send_test_alerting_by_id_serialize(
13502
+ id=id,
13503
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12829
13504
  _request_auth=_request_auth,
12830
13505
  _content_type=_content_type,
12831
13506
  _headers=_headers,
@@ -12841,9 +13516,10 @@ class EventSettingsApi:
12841
13516
  return response_data.response
12842
13517
 
12843
13518
 
12844
- def _send_test_alerting_serialize(
13519
+ def _send_test_alerting_by_id_serialize(
12845
13520
  self,
12846
- abstract_integration,
13521
+ id,
13522
+ manual_alerting_channel_configuration,
12847
13523
  _request_auth,
12848
13524
  _content_type,
12849
13525
  _headers,
@@ -12865,12 +13541,14 @@ class EventSettingsApi:
12865
13541
  _body_params: Optional[bytes] = None
12866
13542
 
12867
13543
  # process the path parameters
13544
+ if id is not None:
13545
+ _path_params['id'] = id
12868
13546
  # process the query parameters
12869
13547
  # process the header parameters
12870
13548
  # process the form parameters
12871
13549
  # process the body parameter
12872
- if abstract_integration is not None:
12873
- _body_params = abstract_integration
13550
+ if manual_alerting_channel_configuration is not None:
13551
+ _body_params = manual_alerting_channel_configuration
12874
13552
 
12875
13553
 
12876
13554
  # set the HTTP header `Accept`
@@ -12901,8 +13579,8 @@ class EventSettingsApi:
12901
13579
  ]
12902
13580
 
12903
13581
  return self.api_client.param_serialize(
12904
- method='PUT',
12905
- resource_path='/api/events/settings/alertingChannels/test',
13582
+ method='POST',
13583
+ resource_path='/api/events/settings/alertingChannels/notify/{id}',
12906
13584
  path_params=_path_params,
12907
13585
  query_params=_query_params,
12908
13586
  header_params=_header_params,
@@ -12919,10 +13597,10 @@ class EventSettingsApi:
12919
13597
 
12920
13598
 
12921
13599
  @validate_call
12922
- def send_test_alerting_by_id(
13600
+ def update_mobile_app_alert_config(
12923
13601
  self,
12924
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
12925
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13602
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13603
+ mobile_app_alert_config: MobileAppAlertConfig,
12926
13604
  _request_timeout: Union[
12927
13605
  None,
12928
13606
  Annotated[StrictFloat, Field(gt=0)],
@@ -12935,15 +13613,15 @@ class EventSettingsApi:
12935
13613
  _content_type: Optional[StrictStr] = None,
12936
13614
  _headers: Optional[Dict[StrictStr, Any]] = None,
12937
13615
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12938
- ) -> None:
12939
- """Notify manually to Alerting Channel
13616
+ ) -> WithMetadata:
13617
+ """Update Mobile Smart Alert Config
12940
13618
 
12941
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13619
+ Updates an existing Mobile Smart Alert Configuration.
12942
13620
 
12943
- :param id: ID of the alerting channel to be notified on. (required)
13621
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
12944
13622
  :type id: str
12945
- :param manual_alerting_channel_configuration: (required)
12946
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13623
+ :param mobile_app_alert_config: (required)
13624
+ :type mobile_app_alert_config: MobileAppAlertConfig
12947
13625
  :param _request_timeout: timeout setting for this request. If one
12948
13626
  number provided, it will be total request
12949
13627
  timeout. It can also be a pair (tuple) of
@@ -12966,9 +13644,9 @@ class EventSettingsApi:
12966
13644
  :return: Returns the result object.
12967
13645
  """ # noqa: E501
12968
13646
 
12969
- _param = self._send_test_alerting_by_id_serialize(
13647
+ _param = self._update_mobile_app_alert_config_serialize(
12970
13648
  id=id,
12971
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13649
+ mobile_app_alert_config=mobile_app_alert_config,
12972
13650
  _request_auth=_request_auth,
12973
13651
  _content_type=_content_type,
12974
13652
  _headers=_headers,
@@ -12976,6 +13654,12 @@ class EventSettingsApi:
12976
13654
  )
12977
13655
 
12978
13656
  _response_types_map: Dict[str, Optional[str]] = {
13657
+ '200': "WithMetadata",
13658
+ '204': None,
13659
+ '400': None,
13660
+ '403': None,
13661
+ '422': None,
13662
+ '500': None,
12979
13663
  }
12980
13664
  response_data = self.api_client.call_api(
12981
13665
  *_param,
@@ -12989,10 +13673,10 @@ class EventSettingsApi:
12989
13673
 
12990
13674
 
12991
13675
  @validate_call
12992
- def send_test_alerting_by_id_with_http_info(
13676
+ def update_mobile_app_alert_config_with_http_info(
12993
13677
  self,
12994
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
12995
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13678
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13679
+ mobile_app_alert_config: MobileAppAlertConfig,
12996
13680
  _request_timeout: Union[
12997
13681
  None,
12998
13682
  Annotated[StrictFloat, Field(gt=0)],
@@ -13005,15 +13689,15 @@ class EventSettingsApi:
13005
13689
  _content_type: Optional[StrictStr] = None,
13006
13690
  _headers: Optional[Dict[StrictStr, Any]] = None,
13007
13691
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13008
- ) -> ApiResponse[None]:
13009
- """Notify manually to Alerting Channel
13692
+ ) -> ApiResponse[WithMetadata]:
13693
+ """Update Mobile Smart Alert Config
13010
13694
 
13011
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13695
+ Updates an existing Mobile Smart Alert Configuration.
13012
13696
 
13013
- :param id: ID of the alerting channel to be notified on. (required)
13697
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13014
13698
  :type id: str
13015
- :param manual_alerting_channel_configuration: (required)
13016
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13699
+ :param mobile_app_alert_config: (required)
13700
+ :type mobile_app_alert_config: MobileAppAlertConfig
13017
13701
  :param _request_timeout: timeout setting for this request. If one
13018
13702
  number provided, it will be total request
13019
13703
  timeout. It can also be a pair (tuple) of
@@ -13036,9 +13720,9 @@ class EventSettingsApi:
13036
13720
  :return: Returns the result object.
13037
13721
  """ # noqa: E501
13038
13722
 
13039
- _param = self._send_test_alerting_by_id_serialize(
13723
+ _param = self._update_mobile_app_alert_config_serialize(
13040
13724
  id=id,
13041
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13725
+ mobile_app_alert_config=mobile_app_alert_config,
13042
13726
  _request_auth=_request_auth,
13043
13727
  _content_type=_content_type,
13044
13728
  _headers=_headers,
@@ -13046,6 +13730,12 @@ class EventSettingsApi:
13046
13730
  )
13047
13731
 
13048
13732
  _response_types_map: Dict[str, Optional[str]] = {
13733
+ '200': "WithMetadata",
13734
+ '204': None,
13735
+ '400': None,
13736
+ '403': None,
13737
+ '422': None,
13738
+ '500': None,
13049
13739
  }
13050
13740
  response_data = self.api_client.call_api(
13051
13741
  *_param,
@@ -13059,10 +13749,10 @@ class EventSettingsApi:
13059
13749
 
13060
13750
 
13061
13751
  @validate_call
13062
- def send_test_alerting_by_id_without_preload_content(
13752
+ def update_mobile_app_alert_config_without_preload_content(
13063
13753
  self,
13064
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13065
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13754
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13755
+ mobile_app_alert_config: MobileAppAlertConfig,
13066
13756
  _request_timeout: Union[
13067
13757
  None,
13068
13758
  Annotated[StrictFloat, Field(gt=0)],
@@ -13076,14 +13766,14 @@ class EventSettingsApi:
13076
13766
  _headers: Optional[Dict[StrictStr, Any]] = None,
13077
13767
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13078
13768
  ) -> RESTResponseType:
13079
- """Notify manually to Alerting Channel
13769
+ """Update Mobile Smart Alert Config
13080
13770
 
13081
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13771
+ Updates an existing Mobile Smart Alert Configuration.
13082
13772
 
13083
- :param id: ID of the alerting channel to be notified on. (required)
13773
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13084
13774
  :type id: str
13085
- :param manual_alerting_channel_configuration: (required)
13086
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13775
+ :param mobile_app_alert_config: (required)
13776
+ :type mobile_app_alert_config: MobileAppAlertConfig
13087
13777
  :param _request_timeout: timeout setting for this request. If one
13088
13778
  number provided, it will be total request
13089
13779
  timeout. It can also be a pair (tuple) of
@@ -13106,9 +13796,9 @@ class EventSettingsApi:
13106
13796
  :return: Returns the result object.
13107
13797
  """ # noqa: E501
13108
13798
 
13109
- _param = self._send_test_alerting_by_id_serialize(
13799
+ _param = self._update_mobile_app_alert_config_serialize(
13110
13800
  id=id,
13111
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13801
+ mobile_app_alert_config=mobile_app_alert_config,
13112
13802
  _request_auth=_request_auth,
13113
13803
  _content_type=_content_type,
13114
13804
  _headers=_headers,
@@ -13116,6 +13806,12 @@ class EventSettingsApi:
13116
13806
  )
13117
13807
 
13118
13808
  _response_types_map: Dict[str, Optional[str]] = {
13809
+ '200': "WithMetadata",
13810
+ '204': None,
13811
+ '400': None,
13812
+ '403': None,
13813
+ '422': None,
13814
+ '500': None,
13119
13815
  }
13120
13816
  response_data = self.api_client.call_api(
13121
13817
  *_param,
@@ -13124,10 +13820,10 @@ class EventSettingsApi:
13124
13820
  return response_data.response
13125
13821
 
13126
13822
 
13127
- def _send_test_alerting_by_id_serialize(
13823
+ def _update_mobile_app_alert_config_serialize(
13128
13824
  self,
13129
13825
  id,
13130
- manual_alerting_channel_configuration,
13826
+ mobile_app_alert_config,
13131
13827
  _request_auth,
13132
13828
  _content_type,
13133
13829
  _headers,
@@ -13155,8 +13851,8 @@ class EventSettingsApi:
13155
13851
  # process the header parameters
13156
13852
  # process the form parameters
13157
13853
  # process the body parameter
13158
- if manual_alerting_channel_configuration is not None:
13159
- _body_params = manual_alerting_channel_configuration
13854
+ if mobile_app_alert_config is not None:
13855
+ _body_params = mobile_app_alert_config
13160
13856
 
13161
13857
 
13162
13858
  # set the HTTP header `Accept`
@@ -13188,7 +13884,7 @@ class EventSettingsApi:
13188
13884
 
13189
13885
  return self.api_client.param_serialize(
13190
13886
  method='POST',
13191
- resource_path='/api/events/settings/alertingChannels/notify/{id}',
13887
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}',
13192
13888
  path_params=_path_params,
13193
13889
  query_params=_query_params,
13194
13890
  header_params=_header_params,
@@ -13205,10 +13901,9 @@ class EventSettingsApi:
13205
13901
 
13206
13902
 
13207
13903
  @validate_call
13208
- def update_mobile_app_alert_config(
13904
+ def update_mobile_app_historic_baseline(
13209
13905
  self,
13210
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13211
- mobile_app_alert_config: MobileAppAlertConfig,
13906
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13212
13907
  _request_timeout: Union[
13213
13908
  None,
13214
13909
  Annotated[StrictFloat, Field(gt=0)],
@@ -13221,15 +13916,13 @@ class EventSettingsApi:
13221
13916
  _content_type: Optional[StrictStr] = None,
13222
13917
  _headers: Optional[Dict[StrictStr, Any]] = None,
13223
13918
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13224
- ) -> WithMetadata:
13225
- """Update Mobile Smart Alert Config
13919
+ ) -> None:
13920
+ """Recalculate Mobile Smart Alert Config Baseline
13226
13921
 
13227
- Updates an existing Mobile Smart Alert Configuration.
13922
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13228
13923
 
13229
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13924
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13230
13925
  :type id: str
13231
- :param mobile_app_alert_config: (required)
13232
- :type mobile_app_alert_config: MobileAppAlertConfig
13233
13926
  :param _request_timeout: timeout setting for this request. If one
13234
13927
  number provided, it will be total request
13235
13928
  timeout. It can also be a pair (tuple) of
@@ -13252,9 +13945,8 @@ class EventSettingsApi:
13252
13945
  :return: Returns the result object.
13253
13946
  """ # noqa: E501
13254
13947
 
13255
- _param = self._update_mobile_app_alert_config_serialize(
13948
+ _param = self._update_mobile_app_historic_baseline_serialize(
13256
13949
  id=id,
13257
- mobile_app_alert_config=mobile_app_alert_config,
13258
13950
  _request_auth=_request_auth,
13259
13951
  _content_type=_content_type,
13260
13952
  _headers=_headers,
@@ -13262,12 +13954,12 @@ class EventSettingsApi:
13262
13954
  )
13263
13955
 
13264
13956
  _response_types_map: Dict[str, Optional[str]] = {
13265
- '200': "WithMetadata",
13957
+ '200': None,
13266
13958
  '204': None,
13267
13959
  '400': None,
13268
13960
  '403': None,
13269
- '422': None,
13270
- '500': None,
13961
+ '404': None,
13962
+ '428': None,
13271
13963
  }
13272
13964
  response_data = self.api_client.call_api(
13273
13965
  *_param,
@@ -13281,10 +13973,9 @@ class EventSettingsApi:
13281
13973
 
13282
13974
 
13283
13975
  @validate_call
13284
- def update_mobile_app_alert_config_with_http_info(
13976
+ def update_mobile_app_historic_baseline_with_http_info(
13285
13977
  self,
13286
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13287
- mobile_app_alert_config: MobileAppAlertConfig,
13978
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13288
13979
  _request_timeout: Union[
13289
13980
  None,
13290
13981
  Annotated[StrictFloat, Field(gt=0)],
@@ -13297,15 +13988,13 @@ class EventSettingsApi:
13297
13988
  _content_type: Optional[StrictStr] = None,
13298
13989
  _headers: Optional[Dict[StrictStr, Any]] = None,
13299
13990
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13300
- ) -> ApiResponse[WithMetadata]:
13301
- """Update Mobile Smart Alert Config
13991
+ ) -> ApiResponse[None]:
13992
+ """Recalculate Mobile Smart Alert Config Baseline
13302
13993
 
13303
- Updates an existing Mobile Smart Alert Configuration.
13994
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13304
13995
 
13305
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13996
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13306
13997
  :type id: str
13307
- :param mobile_app_alert_config: (required)
13308
- :type mobile_app_alert_config: MobileAppAlertConfig
13309
13998
  :param _request_timeout: timeout setting for this request. If one
13310
13999
  number provided, it will be total request
13311
14000
  timeout. It can also be a pair (tuple) of
@@ -13328,9 +14017,8 @@ class EventSettingsApi:
13328
14017
  :return: Returns the result object.
13329
14018
  """ # noqa: E501
13330
14019
 
13331
- _param = self._update_mobile_app_alert_config_serialize(
14020
+ _param = self._update_mobile_app_historic_baseline_serialize(
13332
14021
  id=id,
13333
- mobile_app_alert_config=mobile_app_alert_config,
13334
14022
  _request_auth=_request_auth,
13335
14023
  _content_type=_content_type,
13336
14024
  _headers=_headers,
@@ -13338,12 +14026,12 @@ class EventSettingsApi:
13338
14026
  )
13339
14027
 
13340
14028
  _response_types_map: Dict[str, Optional[str]] = {
13341
- '200': "WithMetadata",
14029
+ '200': None,
13342
14030
  '204': None,
13343
14031
  '400': None,
13344
14032
  '403': None,
13345
- '422': None,
13346
- '500': None,
14033
+ '404': None,
14034
+ '428': None,
13347
14035
  }
13348
14036
  response_data = self.api_client.call_api(
13349
14037
  *_param,
@@ -13357,10 +14045,9 @@ class EventSettingsApi:
13357
14045
 
13358
14046
 
13359
14047
  @validate_call
13360
- def update_mobile_app_alert_config_without_preload_content(
14048
+ def update_mobile_app_historic_baseline_without_preload_content(
13361
14049
  self,
13362
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13363
- mobile_app_alert_config: MobileAppAlertConfig,
14050
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13364
14051
  _request_timeout: Union[
13365
14052
  None,
13366
14053
  Annotated[StrictFloat, Field(gt=0)],
@@ -13374,14 +14061,12 @@ class EventSettingsApi:
13374
14061
  _headers: Optional[Dict[StrictStr, Any]] = None,
13375
14062
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13376
14063
  ) -> RESTResponseType:
13377
- """Update Mobile Smart Alert Config
14064
+ """Recalculate Mobile Smart Alert Config Baseline
13378
14065
 
13379
- Updates an existing Mobile Smart Alert Configuration.
14066
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13380
14067
 
13381
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
14068
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13382
14069
  :type id: str
13383
- :param mobile_app_alert_config: (required)
13384
- :type mobile_app_alert_config: MobileAppAlertConfig
13385
14070
  :param _request_timeout: timeout setting for this request. If one
13386
14071
  number provided, it will be total request
13387
14072
  timeout. It can also be a pair (tuple) of
@@ -13404,9 +14089,8 @@ class EventSettingsApi:
13404
14089
  :return: Returns the result object.
13405
14090
  """ # noqa: E501
13406
14091
 
13407
- _param = self._update_mobile_app_alert_config_serialize(
14092
+ _param = self._update_mobile_app_historic_baseline_serialize(
13408
14093
  id=id,
13409
- mobile_app_alert_config=mobile_app_alert_config,
13410
14094
  _request_auth=_request_auth,
13411
14095
  _content_type=_content_type,
13412
14096
  _headers=_headers,
@@ -13414,12 +14098,12 @@ class EventSettingsApi:
13414
14098
  )
13415
14099
 
13416
14100
  _response_types_map: Dict[str, Optional[str]] = {
13417
- '200': "WithMetadata",
14101
+ '200': None,
13418
14102
  '204': None,
13419
14103
  '400': None,
13420
14104
  '403': None,
13421
- '422': None,
13422
- '500': None,
14105
+ '404': None,
14106
+ '428': None,
13423
14107
  }
13424
14108
  response_data = self.api_client.call_api(
13425
14109
  *_param,
@@ -13428,10 +14112,9 @@ class EventSettingsApi:
13428
14112
  return response_data.response
13429
14113
 
13430
14114
 
13431
- def _update_mobile_app_alert_config_serialize(
14115
+ def _update_mobile_app_historic_baseline_serialize(
13432
14116
  self,
13433
14117
  id,
13434
- mobile_app_alert_config,
13435
14118
  _request_auth,
13436
14119
  _content_type,
13437
14120
  _headers,
@@ -13459,39 +14142,18 @@ class EventSettingsApi:
13459
14142
  # process the header parameters
13460
14143
  # process the form parameters
13461
14144
  # process the body parameter
13462
- if mobile_app_alert_config is not None:
13463
- _body_params = mobile_app_alert_config
13464
14145
 
13465
14146
 
13466
- # set the HTTP header `Accept`
13467
- if 'Accept' not in _header_params:
13468
- _header_params['Accept'] = self.api_client.select_header_accept(
13469
- [
13470
- 'application/json'
13471
- ]
13472
- )
13473
14147
 
13474
- # set the HTTP header `Content-Type`
13475
- if _content_type:
13476
- _header_params['Content-Type'] = _content_type
13477
- else:
13478
- _default_content_type = (
13479
- self.api_client.select_header_content_type(
13480
- [
13481
- 'application/json'
13482
- ]
13483
- )
13484
- )
13485
- if _default_content_type is not None:
13486
- _header_params['Content-Type'] = _default_content_type
13487
14148
 
13488
14149
  # authentication setting
13489
14150
  _auth_settings: List[str] = [
14151
+ 'ApiKeyAuth'
13490
14152
  ]
13491
14153
 
13492
14154
  return self.api_client.param_serialize(
13493
14155
  method='POST',
13494
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}',
14156
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}/update-baseline',
13495
14157
  path_params=_path_params,
13496
14158
  query_params=_query_params,
13497
14159
  header_params=_header_params,
@@ -13508,9 +14170,10 @@ class EventSettingsApi:
13508
14170
 
13509
14171
 
13510
14172
  @validate_call
13511
- def update_mobile_app_historic_baseline(
14173
+ def update_website_alert_config(
13512
14174
  self,
13513
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14175
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14176
+ website_alert_config: WebsiteAlertConfig,
13514
14177
  _request_timeout: Union[
13515
14178
  None,
13516
14179
  Annotated[StrictFloat, Field(gt=0)],
@@ -13523,13 +14186,15 @@ class EventSettingsApi:
13523
14186
  _content_type: Optional[StrictStr] = None,
13524
14187
  _headers: Optional[Dict[StrictStr, Any]] = None,
13525
14188
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13526
- ) -> None:
13527
- """Recalculate Mobile Smart Alert Config Baseline
14189
+ ) -> WebsiteAlertConfigWithMetadata:
14190
+ """Update Website Smart Alert Config
13528
14191
 
13529
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14192
+ Updates an existing Website Smart Alert Configuration.
13530
14193
 
13531
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14194
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13532
14195
  :type id: str
14196
+ :param website_alert_config: (required)
14197
+ :type website_alert_config: WebsiteAlertConfig
13533
14198
  :param _request_timeout: timeout setting for this request. If one
13534
14199
  number provided, it will be total request
13535
14200
  timeout. It can also be a pair (tuple) of
@@ -13552,8 +14217,9 @@ class EventSettingsApi:
13552
14217
  :return: Returns the result object.
13553
14218
  """ # noqa: E501
13554
14219
 
13555
- _param = self._update_mobile_app_historic_baseline_serialize(
14220
+ _param = self._update_website_alert_config_serialize(
13556
14221
  id=id,
14222
+ website_alert_config=website_alert_config,
13557
14223
  _request_auth=_request_auth,
13558
14224
  _content_type=_content_type,
13559
14225
  _headers=_headers,
@@ -13561,9 +14227,14 @@ class EventSettingsApi:
13561
14227
  )
13562
14228
 
13563
14229
  _response_types_map: Dict[str, Optional[str]] = {
13564
- '200': None,
14230
+ '200': "WebsiteAlertConfigWithMetadata",
14231
+ '204': None,
13565
14232
  '400': None,
13566
14233
  '403': None,
14234
+ '404': None,
14235
+ '422': None,
14236
+ '428': None,
14237
+ '500': None,
13567
14238
  }
13568
14239
  response_data = self.api_client.call_api(
13569
14240
  *_param,
@@ -13577,9 +14248,10 @@ class EventSettingsApi:
13577
14248
 
13578
14249
 
13579
14250
  @validate_call
13580
- def update_mobile_app_historic_baseline_with_http_info(
14251
+ def update_website_alert_config_with_http_info(
13581
14252
  self,
13582
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14253
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14254
+ website_alert_config: WebsiteAlertConfig,
13583
14255
  _request_timeout: Union[
13584
14256
  None,
13585
14257
  Annotated[StrictFloat, Field(gt=0)],
@@ -13592,13 +14264,15 @@ class EventSettingsApi:
13592
14264
  _content_type: Optional[StrictStr] = None,
13593
14265
  _headers: Optional[Dict[StrictStr, Any]] = None,
13594
14266
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13595
- ) -> ApiResponse[None]:
13596
- """Recalculate Mobile Smart Alert Config Baseline
14267
+ ) -> ApiResponse[WebsiteAlertConfigWithMetadata]:
14268
+ """Update Website Smart Alert Config
13597
14269
 
13598
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14270
+ Updates an existing Website Smart Alert Configuration.
13599
14271
 
13600
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14272
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13601
14273
  :type id: str
14274
+ :param website_alert_config: (required)
14275
+ :type website_alert_config: WebsiteAlertConfig
13602
14276
  :param _request_timeout: timeout setting for this request. If one
13603
14277
  number provided, it will be total request
13604
14278
  timeout. It can also be a pair (tuple) of
@@ -13621,8 +14295,9 @@ class EventSettingsApi:
13621
14295
  :return: Returns the result object.
13622
14296
  """ # noqa: E501
13623
14297
 
13624
- _param = self._update_mobile_app_historic_baseline_serialize(
14298
+ _param = self._update_website_alert_config_serialize(
13625
14299
  id=id,
14300
+ website_alert_config=website_alert_config,
13626
14301
  _request_auth=_request_auth,
13627
14302
  _content_type=_content_type,
13628
14303
  _headers=_headers,
@@ -13630,9 +14305,14 @@ class EventSettingsApi:
13630
14305
  )
13631
14306
 
13632
14307
  _response_types_map: Dict[str, Optional[str]] = {
13633
- '200': None,
14308
+ '200': "WebsiteAlertConfigWithMetadata",
14309
+ '204': None,
13634
14310
  '400': None,
13635
14311
  '403': None,
14312
+ '404': None,
14313
+ '422': None,
14314
+ '428': None,
14315
+ '500': None,
13636
14316
  }
13637
14317
  response_data = self.api_client.call_api(
13638
14318
  *_param,
@@ -13646,9 +14326,10 @@ class EventSettingsApi:
13646
14326
 
13647
14327
 
13648
14328
  @validate_call
13649
- def update_mobile_app_historic_baseline_without_preload_content(
14329
+ def update_website_alert_config_without_preload_content(
13650
14330
  self,
13651
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14331
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14332
+ website_alert_config: WebsiteAlertConfig,
13652
14333
  _request_timeout: Union[
13653
14334
  None,
13654
14335
  Annotated[StrictFloat, Field(gt=0)],
@@ -13662,12 +14343,14 @@ class EventSettingsApi:
13662
14343
  _headers: Optional[Dict[StrictStr, Any]] = None,
13663
14344
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13664
14345
  ) -> RESTResponseType:
13665
- """Recalculate Mobile Smart Alert Config Baseline
14346
+ """Update Website Smart Alert Config
13666
14347
 
13667
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14348
+ Updates an existing Website Smart Alert Configuration.
13668
14349
 
13669
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14350
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13670
14351
  :type id: str
14352
+ :param website_alert_config: (required)
14353
+ :type website_alert_config: WebsiteAlertConfig
13671
14354
  :param _request_timeout: timeout setting for this request. If one
13672
14355
  number provided, it will be total request
13673
14356
  timeout. It can also be a pair (tuple) of
@@ -13690,8 +14373,9 @@ class EventSettingsApi:
13690
14373
  :return: Returns the result object.
13691
14374
  """ # noqa: E501
13692
14375
 
13693
- _param = self._update_mobile_app_historic_baseline_serialize(
14376
+ _param = self._update_website_alert_config_serialize(
13694
14377
  id=id,
14378
+ website_alert_config=website_alert_config,
13695
14379
  _request_auth=_request_auth,
13696
14380
  _content_type=_content_type,
13697
14381
  _headers=_headers,
@@ -13699,9 +14383,14 @@ class EventSettingsApi:
13699
14383
  )
13700
14384
 
13701
14385
  _response_types_map: Dict[str, Optional[str]] = {
13702
- '200': None,
14386
+ '200': "WebsiteAlertConfigWithMetadata",
14387
+ '204': None,
13703
14388
  '400': None,
13704
14389
  '403': None,
14390
+ '404': None,
14391
+ '422': None,
14392
+ '428': None,
14393
+ '500': None,
13705
14394
  }
13706
14395
  response_data = self.api_client.call_api(
13707
14396
  *_param,
@@ -13710,9 +14399,10 @@ class EventSettingsApi:
13710
14399
  return response_data.response
13711
14400
 
13712
14401
 
13713
- def _update_mobile_app_historic_baseline_serialize(
14402
+ def _update_website_alert_config_serialize(
13714
14403
  self,
13715
14404
  id,
14405
+ website_alert_config,
13716
14406
  _request_auth,
13717
14407
  _content_type,
13718
14408
  _headers,
@@ -13740,17 +14430,40 @@ class EventSettingsApi:
13740
14430
  # process the header parameters
13741
14431
  # process the form parameters
13742
14432
  # process the body parameter
14433
+ if website_alert_config is not None:
14434
+ _body_params = website_alert_config
13743
14435
 
13744
14436
 
14437
+ # set the HTTP header `Accept`
14438
+ if 'Accept' not in _header_params:
14439
+ _header_params['Accept'] = self.api_client.select_header_accept(
14440
+ [
14441
+ 'application/json'
14442
+ ]
14443
+ )
13745
14444
 
14445
+ # set the HTTP header `Content-Type`
14446
+ if _content_type:
14447
+ _header_params['Content-Type'] = _content_type
14448
+ else:
14449
+ _default_content_type = (
14450
+ self.api_client.select_header_content_type(
14451
+ [
14452
+ 'application/json'
14453
+ ]
14454
+ )
14455
+ )
14456
+ if _default_content_type is not None:
14457
+ _header_params['Content-Type'] = _default_content_type
13746
14458
 
13747
14459
  # authentication setting
13748
14460
  _auth_settings: List[str] = [
14461
+ 'ApiKeyAuth'
13749
14462
  ]
13750
14463
 
13751
14464
  return self.api_client.param_serialize(
13752
14465
  method='POST',
13753
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}/update-baseline',
14466
+ resource_path='/api/events/settings/website-alert-configs/{id}',
13754
14467
  path_params=_path_params,
13755
14468
  query_params=_query_params,
13756
14469
  header_params=_header_params,
@@ -13767,10 +14480,9 @@ class EventSettingsApi:
13767
14480
 
13768
14481
 
13769
14482
  @validate_call
13770
- def update_website_alert_config(
14483
+ def update_website_historic_baseline(
13771
14484
  self,
13772
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13773
- website_alert_config: WebsiteAlertConfig,
14485
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13774
14486
  _request_timeout: Union[
13775
14487
  None,
13776
14488
  Annotated[StrictFloat, Field(gt=0)],
@@ -13783,15 +14495,13 @@ class EventSettingsApi:
13783
14495
  _content_type: Optional[StrictStr] = None,
13784
14496
  _headers: Optional[Dict[StrictStr, Any]] = None,
13785
14497
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13786
- ) -> WebsiteAlertConfigWithMetadata:
13787
- """Update Website Smart Alert Config
14498
+ ) -> None:
14499
+ """Recalculate Website Smart Alert Config Baseline
13788
14500
 
13789
- Updates an existing Website Smart Alert Configuration.
14501
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13790
14502
 
13791
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14503
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13792
14504
  :type id: str
13793
- :param website_alert_config: (required)
13794
- :type website_alert_config: WebsiteAlertConfig
13795
14505
  :param _request_timeout: timeout setting for this request. If one
13796
14506
  number provided, it will be total request
13797
14507
  timeout. It can also be a pair (tuple) of
@@ -13814,9 +14524,8 @@ class EventSettingsApi:
13814
14524
  :return: Returns the result object.
13815
14525
  """ # noqa: E501
13816
14526
 
13817
- _param = self._update_website_alert_config_serialize(
14527
+ _param = self._update_website_historic_baseline_serialize(
13818
14528
  id=id,
13819
- website_alert_config=website_alert_config,
13820
14529
  _request_auth=_request_auth,
13821
14530
  _content_type=_content_type,
13822
14531
  _headers=_headers,
@@ -13824,12 +14533,12 @@ class EventSettingsApi:
13824
14533
  )
13825
14534
 
13826
14535
  _response_types_map: Dict[str, Optional[str]] = {
13827
- '200': "WebsiteAlertConfigWithMetadata",
14536
+ '200': None,
13828
14537
  '204': None,
13829
14538
  '400': None,
13830
14539
  '403': None,
13831
- '422': None,
13832
- '500': None,
14540
+ '404': None,
14541
+ '428': None,
13833
14542
  }
13834
14543
  response_data = self.api_client.call_api(
13835
14544
  *_param,
@@ -13843,10 +14552,9 @@ class EventSettingsApi:
13843
14552
 
13844
14553
 
13845
14554
  @validate_call
13846
- def update_website_alert_config_with_http_info(
14555
+ def update_website_historic_baseline_with_http_info(
13847
14556
  self,
13848
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13849
- website_alert_config: WebsiteAlertConfig,
14557
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13850
14558
  _request_timeout: Union[
13851
14559
  None,
13852
14560
  Annotated[StrictFloat, Field(gt=0)],
@@ -13859,15 +14567,13 @@ class EventSettingsApi:
13859
14567
  _content_type: Optional[StrictStr] = None,
13860
14568
  _headers: Optional[Dict[StrictStr, Any]] = None,
13861
14569
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13862
- ) -> ApiResponse[WebsiteAlertConfigWithMetadata]:
13863
- """Update Website Smart Alert Config
14570
+ ) -> ApiResponse[None]:
14571
+ """Recalculate Website Smart Alert Config Baseline
13864
14572
 
13865
- Updates an existing Website Smart Alert Configuration.
14573
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13866
14574
 
13867
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14575
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13868
14576
  :type id: str
13869
- :param website_alert_config: (required)
13870
- :type website_alert_config: WebsiteAlertConfig
13871
14577
  :param _request_timeout: timeout setting for this request. If one
13872
14578
  number provided, it will be total request
13873
14579
  timeout. It can also be a pair (tuple) of
@@ -13890,9 +14596,8 @@ class EventSettingsApi:
13890
14596
  :return: Returns the result object.
13891
14597
  """ # noqa: E501
13892
14598
 
13893
- _param = self._update_website_alert_config_serialize(
14599
+ _param = self._update_website_historic_baseline_serialize(
13894
14600
  id=id,
13895
- website_alert_config=website_alert_config,
13896
14601
  _request_auth=_request_auth,
13897
14602
  _content_type=_content_type,
13898
14603
  _headers=_headers,
@@ -13900,12 +14605,12 @@ class EventSettingsApi:
13900
14605
  )
13901
14606
 
13902
14607
  _response_types_map: Dict[str, Optional[str]] = {
13903
- '200': "WebsiteAlertConfigWithMetadata",
14608
+ '200': None,
13904
14609
  '204': None,
13905
14610
  '400': None,
13906
14611
  '403': None,
13907
- '422': None,
13908
- '500': None,
14612
+ '404': None,
14613
+ '428': None,
13909
14614
  }
13910
14615
  response_data = self.api_client.call_api(
13911
14616
  *_param,
@@ -13919,10 +14624,9 @@ class EventSettingsApi:
13919
14624
 
13920
14625
 
13921
14626
  @validate_call
13922
- def update_website_alert_config_without_preload_content(
14627
+ def update_website_historic_baseline_without_preload_content(
13923
14628
  self,
13924
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13925
- website_alert_config: WebsiteAlertConfig,
14629
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13926
14630
  _request_timeout: Union[
13927
14631
  None,
13928
14632
  Annotated[StrictFloat, Field(gt=0)],
@@ -13936,14 +14640,12 @@ class EventSettingsApi:
13936
14640
  _headers: Optional[Dict[StrictStr, Any]] = None,
13937
14641
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13938
14642
  ) -> RESTResponseType:
13939
- """Update Website Smart Alert Config
14643
+ """Recalculate Website Smart Alert Config Baseline
13940
14644
 
13941
- Updates an existing Website Smart Alert Configuration.
14645
+ Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
13942
14646
 
13943
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14647
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13944
14648
  :type id: str
13945
- :param website_alert_config: (required)
13946
- :type website_alert_config: WebsiteAlertConfig
13947
14649
  :param _request_timeout: timeout setting for this request. If one
13948
14650
  number provided, it will be total request
13949
14651
  timeout. It can also be a pair (tuple) of
@@ -13966,9 +14668,8 @@ class EventSettingsApi:
13966
14668
  :return: Returns the result object.
13967
14669
  """ # noqa: E501
13968
14670
 
13969
- _param = self._update_website_alert_config_serialize(
14671
+ _param = self._update_website_historic_baseline_serialize(
13970
14672
  id=id,
13971
- website_alert_config=website_alert_config,
13972
14673
  _request_auth=_request_auth,
13973
14674
  _content_type=_content_type,
13974
14675
  _headers=_headers,
@@ -13976,12 +14677,12 @@ class EventSettingsApi:
13976
14677
  )
13977
14678
 
13978
14679
  _response_types_map: Dict[str, Optional[str]] = {
13979
- '200': "WebsiteAlertConfigWithMetadata",
14680
+ '200': None,
13980
14681
  '204': None,
13981
14682
  '400': None,
13982
14683
  '403': None,
13983
- '422': None,
13984
- '500': None,
14684
+ '404': None,
14685
+ '428': None,
13985
14686
  }
13986
14687
  response_data = self.api_client.call_api(
13987
14688
  *_param,
@@ -13990,10 +14691,9 @@ class EventSettingsApi:
13990
14691
  return response_data.response
13991
14692
 
13992
14693
 
13993
- def _update_website_alert_config_serialize(
14694
+ def _update_website_historic_baseline_serialize(
13994
14695
  self,
13995
14696
  id,
13996
- website_alert_config,
13997
14697
  _request_auth,
13998
14698
  _content_type,
13999
14699
  _headers,
@@ -14021,31 +14721,9 @@ class EventSettingsApi:
14021
14721
  # process the header parameters
14022
14722
  # process the form parameters
14023
14723
  # process the body parameter
14024
- if website_alert_config is not None:
14025
- _body_params = website_alert_config
14026
14724
 
14027
14725
 
14028
- # set the HTTP header `Accept`
14029
- if 'Accept' not in _header_params:
14030
- _header_params['Accept'] = self.api_client.select_header_accept(
14031
- [
14032
- 'application/json'
14033
- ]
14034
- )
14035
14726
 
14036
- # set the HTTP header `Content-Type`
14037
- if _content_type:
14038
- _header_params['Content-Type'] = _content_type
14039
- else:
14040
- _default_content_type = (
14041
- self.api_client.select_header_content_type(
14042
- [
14043
- 'application/json'
14044
- ]
14045
- )
14046
- )
14047
- if _default_content_type is not None:
14048
- _header_params['Content-Type'] = _default_content_type
14049
14727
 
14050
14728
  # authentication setting
14051
14729
  _auth_settings: List[str] = [
@@ -14054,7 +14732,7 @@ class EventSettingsApi:
14054
14732
 
14055
14733
  return self.api_client.param_serialize(
14056
14734
  method='POST',
14057
- resource_path='/api/events/settings/website-alert-configs/{id}',
14735
+ resource_path='/api/events/settings/website-alert-configs/{id}/update-baseline',
14058
14736
  path_params=_path_params,
14059
14737
  query_params=_query_params,
14060
14738
  header_params=_header_params,
@@ -14071,9 +14749,9 @@ class EventSettingsApi:
14071
14749
 
14072
14750
 
14073
14751
  @validate_call
14074
- def update_website_historic_baseline(
14752
+ def upsert_custom_payload_configuration(
14075
14753
  self,
14076
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14754
+ custom_payload_configuration: CustomPayloadConfiguration,
14077
14755
  _request_timeout: Union[
14078
14756
  None,
14079
14757
  Annotated[StrictFloat, Field(gt=0)],
@@ -14086,13 +14764,13 @@ class EventSettingsApi:
14086
14764
  _content_type: Optional[StrictStr] = None,
14087
14765
  _headers: Optional[Dict[StrictStr, Any]] = None,
14088
14766
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14089
- ) -> None:
14090
- """Recalculate Website Smart Alert Config Baseline
14767
+ ) -> List[CustomPayloadWithLastUpdated]:
14768
+ """Create/Update Global Custom Payload Configuration
14091
14769
 
14092
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14770
+ Creates or Updates Global Custom Payload Configuration.
14093
14771
 
14094
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14095
- :type id: str
14772
+ :param custom_payload_configuration: (required)
14773
+ :type custom_payload_configuration: CustomPayloadConfiguration
14096
14774
  :param _request_timeout: timeout setting for this request. If one
14097
14775
  number provided, it will be total request
14098
14776
  timeout. It can also be a pair (tuple) of
@@ -14115,8 +14793,8 @@ class EventSettingsApi:
14115
14793
  :return: Returns the result object.
14116
14794
  """ # noqa: E501
14117
14795
 
14118
- _param = self._update_website_historic_baseline_serialize(
14119
- id=id,
14796
+ _param = self._upsert_custom_payload_configuration_serialize(
14797
+ custom_payload_configuration=custom_payload_configuration,
14120
14798
  _request_auth=_request_auth,
14121
14799
  _content_type=_content_type,
14122
14800
  _headers=_headers,
@@ -14124,9 +14802,10 @@ class EventSettingsApi:
14124
14802
  )
14125
14803
 
14126
14804
  _response_types_map: Dict[str, Optional[str]] = {
14127
- '200': None,
14128
- '400': None,
14805
+ '200': "List[CustomPayloadWithLastUpdated]",
14806
+ '401': None,
14129
14807
  '403': None,
14808
+ '422': None,
14130
14809
  }
14131
14810
  response_data = self.api_client.call_api(
14132
14811
  *_param,
@@ -14140,9 +14819,9 @@ class EventSettingsApi:
14140
14819
 
14141
14820
 
14142
14821
  @validate_call
14143
- def update_website_historic_baseline_with_http_info(
14822
+ def upsert_custom_payload_configuration_with_http_info(
14144
14823
  self,
14145
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14824
+ custom_payload_configuration: CustomPayloadConfiguration,
14146
14825
  _request_timeout: Union[
14147
14826
  None,
14148
14827
  Annotated[StrictFloat, Field(gt=0)],
@@ -14155,13 +14834,13 @@ class EventSettingsApi:
14155
14834
  _content_type: Optional[StrictStr] = None,
14156
14835
  _headers: Optional[Dict[StrictStr, Any]] = None,
14157
14836
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14158
- ) -> ApiResponse[None]:
14159
- """Recalculate Website Smart Alert Config Baseline
14837
+ ) -> ApiResponse[List[CustomPayloadWithLastUpdated]]:
14838
+ """Create/Update Global Custom Payload Configuration
14160
14839
 
14161
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14840
+ Creates or Updates Global Custom Payload Configuration.
14162
14841
 
14163
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14164
- :type id: str
14842
+ :param custom_payload_configuration: (required)
14843
+ :type custom_payload_configuration: CustomPayloadConfiguration
14165
14844
  :param _request_timeout: timeout setting for this request. If one
14166
14845
  number provided, it will be total request
14167
14846
  timeout. It can also be a pair (tuple) of
@@ -14184,8 +14863,8 @@ class EventSettingsApi:
14184
14863
  :return: Returns the result object.
14185
14864
  """ # noqa: E501
14186
14865
 
14187
- _param = self._update_website_historic_baseline_serialize(
14188
- id=id,
14866
+ _param = self._upsert_custom_payload_configuration_serialize(
14867
+ custom_payload_configuration=custom_payload_configuration,
14189
14868
  _request_auth=_request_auth,
14190
14869
  _content_type=_content_type,
14191
14870
  _headers=_headers,
@@ -14193,9 +14872,10 @@ class EventSettingsApi:
14193
14872
  )
14194
14873
 
14195
14874
  _response_types_map: Dict[str, Optional[str]] = {
14196
- '200': None,
14197
- '400': None,
14875
+ '200': "List[CustomPayloadWithLastUpdated]",
14876
+ '401': None,
14198
14877
  '403': None,
14878
+ '422': None,
14199
14879
  }
14200
14880
  response_data = self.api_client.call_api(
14201
14881
  *_param,
@@ -14209,9 +14889,9 @@ class EventSettingsApi:
14209
14889
 
14210
14890
 
14211
14891
  @validate_call
14212
- def update_website_historic_baseline_without_preload_content(
14892
+ def upsert_custom_payload_configuration_without_preload_content(
14213
14893
  self,
14214
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14894
+ custom_payload_configuration: CustomPayloadConfiguration,
14215
14895
  _request_timeout: Union[
14216
14896
  None,
14217
14897
  Annotated[StrictFloat, Field(gt=0)],
@@ -14225,12 +14905,12 @@ class EventSettingsApi:
14225
14905
  _headers: Optional[Dict[StrictStr, Any]] = None,
14226
14906
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14227
14907
  ) -> RESTResponseType:
14228
- """Recalculate Website Smart Alert Config Baseline
14908
+ """Create/Update Global Custom Payload Configuration
14229
14909
 
14230
- Recalculates and updates the historic baseline (static seasonal threshold) of a Configuration. The `LastUpdated` field of the Configuration is changed to the current time.
14910
+ Creates or Updates Global Custom Payload Configuration.
14231
14911
 
14232
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14233
- :type id: str
14912
+ :param custom_payload_configuration: (required)
14913
+ :type custom_payload_configuration: CustomPayloadConfiguration
14234
14914
  :param _request_timeout: timeout setting for this request. If one
14235
14915
  number provided, it will be total request
14236
14916
  timeout. It can also be a pair (tuple) of
@@ -14253,8 +14933,8 @@ class EventSettingsApi:
14253
14933
  :return: Returns the result object.
14254
14934
  """ # noqa: E501
14255
14935
 
14256
- _param = self._update_website_historic_baseline_serialize(
14257
- id=id,
14936
+ _param = self._upsert_custom_payload_configuration_serialize(
14937
+ custom_payload_configuration=custom_payload_configuration,
14258
14938
  _request_auth=_request_auth,
14259
14939
  _content_type=_content_type,
14260
14940
  _headers=_headers,
@@ -14262,9 +14942,10 @@ class EventSettingsApi:
14262
14942
  )
14263
14943
 
14264
14944
  _response_types_map: Dict[str, Optional[str]] = {
14265
- '200': None,
14266
- '400': None,
14945
+ '200': "List[CustomPayloadWithLastUpdated]",
14946
+ '401': None,
14267
14947
  '403': None,
14948
+ '422': None,
14268
14949
  }
14269
14950
  response_data = self.api_client.call_api(
14270
14951
  *_param,
@@ -14273,9 +14954,9 @@ class EventSettingsApi:
14273
14954
  return response_data.response
14274
14955
 
14275
14956
 
14276
- def _update_website_historic_baseline_serialize(
14957
+ def _upsert_custom_payload_configuration_serialize(
14277
14958
  self,
14278
- id,
14959
+ custom_payload_configuration,
14279
14960
  _request_auth,
14280
14961
  _content_type,
14281
14962
  _headers,
@@ -14297,15 +14978,35 @@ class EventSettingsApi:
14297
14978
  _body_params: Optional[bytes] = None
14298
14979
 
14299
14980
  # process the path parameters
14300
- if id is not None:
14301
- _path_params['id'] = id
14302
14981
  # process the query parameters
14303
14982
  # process the header parameters
14304
14983
  # process the form parameters
14305
14984
  # process the body parameter
14985
+ if custom_payload_configuration is not None:
14986
+ _body_params = custom_payload_configuration
14306
14987
 
14307
14988
 
14989
+ # set the HTTP header `Accept`
14990
+ if 'Accept' not in _header_params:
14991
+ _header_params['Accept'] = self.api_client.select_header_accept(
14992
+ [
14993
+ 'application/json'
14994
+ ]
14995
+ )
14308
14996
 
14997
+ # set the HTTP header `Content-Type`
14998
+ if _content_type:
14999
+ _header_params['Content-Type'] = _content_type
15000
+ else:
15001
+ _default_content_type = (
15002
+ self.api_client.select_header_content_type(
15003
+ [
15004
+ 'application/json'
15005
+ ]
15006
+ )
15007
+ )
15008
+ if _default_content_type is not None:
15009
+ _header_params['Content-Type'] = _default_content_type
14309
15010
 
14310
15011
  # authentication setting
14311
15012
  _auth_settings: List[str] = [
@@ -14313,8 +15014,8 @@ class EventSettingsApi:
14313
15014
  ]
14314
15015
 
14315
15016
  return self.api_client.param_serialize(
14316
- method='POST',
14317
- resource_path='/api/events/settings/website-alert-configs/{id}/update-baseline',
15017
+ method='PUT',
15018
+ resource_path='/api/events/settings/custom-payload-configurations',
14318
15019
  path_params=_path_params,
14319
15020
  query_params=_query_params,
14320
15021
  header_params=_header_params,
@@ -14331,7 +15032,7 @@ class EventSettingsApi:
14331
15032
 
14332
15033
 
14333
15034
  @validate_call
14334
- def upsert_custom_payload_configuration(
15035
+ def upsert_custom_payload_configuration_v2(
14335
15036
  self,
14336
15037
  custom_payload_configuration: CustomPayloadConfiguration,
14337
15038
  _request_timeout: Union[
@@ -14346,7 +15047,7 @@ class EventSettingsApi:
14346
15047
  _content_type: Optional[StrictStr] = None,
14347
15048
  _headers: Optional[Dict[StrictStr, Any]] = None,
14348
15049
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14349
- ) -> List[CustomPayloadWithLastUpdated]:
15050
+ ) -> List[CustomPayloadWithVersion]:
14350
15051
  """Create/Update Global Custom Payload Configuration
14351
15052
 
14352
15053
  Creates or Updates Global Custom Payload Configuration.
@@ -14375,7 +15076,7 @@ class EventSettingsApi:
14375
15076
  :return: Returns the result object.
14376
15077
  """ # noqa: E501
14377
15078
 
14378
- _param = self._upsert_custom_payload_configuration_serialize(
15079
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14379
15080
  custom_payload_configuration=custom_payload_configuration,
14380
15081
  _request_auth=_request_auth,
14381
15082
  _content_type=_content_type,
@@ -14384,9 +15085,11 @@ class EventSettingsApi:
14384
15085
  )
14385
15086
 
14386
15087
  _response_types_map: Dict[str, Optional[str]] = {
14387
- '200': "List[CustomPayloadWithLastUpdated]",
15088
+ '200': "List[CustomPayloadWithVersion]",
15089
+ '400': None,
14388
15090
  '401': None,
14389
15091
  '403': None,
15092
+ '409': None,
14390
15093
  '422': None,
14391
15094
  }
14392
15095
  response_data = self.api_client.call_api(
@@ -14401,7 +15104,7 @@ class EventSettingsApi:
14401
15104
 
14402
15105
 
14403
15106
  @validate_call
14404
- def upsert_custom_payload_configuration_with_http_info(
15107
+ def upsert_custom_payload_configuration_v2_with_http_info(
14405
15108
  self,
14406
15109
  custom_payload_configuration: CustomPayloadConfiguration,
14407
15110
  _request_timeout: Union[
@@ -14416,7 +15119,7 @@ class EventSettingsApi:
14416
15119
  _content_type: Optional[StrictStr] = None,
14417
15120
  _headers: Optional[Dict[StrictStr, Any]] = None,
14418
15121
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14419
- ) -> ApiResponse[List[CustomPayloadWithLastUpdated]]:
15122
+ ) -> ApiResponse[List[CustomPayloadWithVersion]]:
14420
15123
  """Create/Update Global Custom Payload Configuration
14421
15124
 
14422
15125
  Creates or Updates Global Custom Payload Configuration.
@@ -14445,7 +15148,7 @@ class EventSettingsApi:
14445
15148
  :return: Returns the result object.
14446
15149
  """ # noqa: E501
14447
15150
 
14448
- _param = self._upsert_custom_payload_configuration_serialize(
15151
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14449
15152
  custom_payload_configuration=custom_payload_configuration,
14450
15153
  _request_auth=_request_auth,
14451
15154
  _content_type=_content_type,
@@ -14454,9 +15157,11 @@ class EventSettingsApi:
14454
15157
  )
14455
15158
 
14456
15159
  _response_types_map: Dict[str, Optional[str]] = {
14457
- '200': "List[CustomPayloadWithLastUpdated]",
15160
+ '200': "List[CustomPayloadWithVersion]",
15161
+ '400': None,
14458
15162
  '401': None,
14459
15163
  '403': None,
15164
+ '409': None,
14460
15165
  '422': None,
14461
15166
  }
14462
15167
  response_data = self.api_client.call_api(
@@ -14471,7 +15176,7 @@ class EventSettingsApi:
14471
15176
 
14472
15177
 
14473
15178
  @validate_call
14474
- def upsert_custom_payload_configuration_without_preload_content(
15179
+ def upsert_custom_payload_configuration_v2_without_preload_content(
14475
15180
  self,
14476
15181
  custom_payload_configuration: CustomPayloadConfiguration,
14477
15182
  _request_timeout: Union[
@@ -14515,7 +15220,7 @@ class EventSettingsApi:
14515
15220
  :return: Returns the result object.
14516
15221
  """ # noqa: E501
14517
15222
 
14518
- _param = self._upsert_custom_payload_configuration_serialize(
15223
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14519
15224
  custom_payload_configuration=custom_payload_configuration,
14520
15225
  _request_auth=_request_auth,
14521
15226
  _content_type=_content_type,
@@ -14524,9 +15229,11 @@ class EventSettingsApi:
14524
15229
  )
14525
15230
 
14526
15231
  _response_types_map: Dict[str, Optional[str]] = {
14527
- '200': "List[CustomPayloadWithLastUpdated]",
15232
+ '200': "List[CustomPayloadWithVersion]",
15233
+ '400': None,
14528
15234
  '401': None,
14529
15235
  '403': None,
15236
+ '409': None,
14530
15237
  '422': None,
14531
15238
  }
14532
15239
  response_data = self.api_client.call_api(
@@ -14536,7 +15243,7 @@ class EventSettingsApi:
14536
15243
  return response_data.response
14537
15244
 
14538
15245
 
14539
- def _upsert_custom_payload_configuration_serialize(
15246
+ def _upsert_custom_payload_configuration_v2_serialize(
14540
15247
  self,
14541
15248
  custom_payload_configuration,
14542
15249
  _request_auth,
@@ -14597,7 +15304,7 @@ class EventSettingsApi:
14597
15304
 
14598
15305
  return self.api_client.param_serialize(
14599
15306
  method='PUT',
14600
- resource_path='/api/events/settings/custom-payload-configurations',
15307
+ resource_path='/api/events/settings/custom-payload-configurations/v2',
14601
15308
  path_params=_path_params,
14602
15309
  query_params=_query_params,
14603
15310
  header_params=_header_params,