instana-client 1.0.0__py3-none-any.whl → 1.0.1__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 (586) hide show
  1. instana_client/__init__.py +1754 -514
  2. instana_client/api/__init__.py +85 -1
  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 +17 -17
  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 +21 -21
  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 +2 -2
  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 +1673 -0
  21. instana_client/api/end_user_monitoring_api.py +310 -0
  22. instana_client/api/event_settings_api.py +1251 -653
  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 +1121 -62
  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 +2 -2
  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 +44 -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 +1394 -0
  44. instana_client/api/service_levels_alert_configuration_api.py +2 -2
  45. instana_client/api/service_levels_objective_slo_configurations_api.py +160 -89
  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 +1528 -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 +1238 -369
  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 +302 -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 +11 -4
  66. instana_client/configuration.py +14 -7
  67. instana_client/exceptions.py +2 -2
  68. instana_client/models/__init__.py +585 -9
  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 +29 -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 +5 -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 +121 -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 +102 -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/built_in_event_specification.py +2 -2
  142. instana_client/models/built_in_event_specification_with_last_updated.py +2 -2
  143. instana_client/models/business_activity.py +5 -3
  144. instana_client/models/business_perspective_config.py +2 -2
  145. instana_client/models/call_groups_item.py +2 -2
  146. instana_client/models/call_groups_result.py +2 -2
  147. instana_client/models/call_relation.py +2 -2
  148. instana_client/models/change_summary.py +2 -2
  149. instana_client/models/cloudfoundry_physical_context.py +4 -4
  150. instana_client/models/condition.py +2 -2
  151. instana_client/models/config_version.py +2 -2
  152. instana_client/models/correction.py +105 -0
  153. instana_client/models/correction_configuration.py +109 -0
  154. instana_client/models/correction_scheduling.py +104 -0
  155. instana_client/models/correction_window.py +95 -0
  156. instana_client/models/crash_mobile_app_alert_rule.py +2 -2
  157. instana_client/models/create_website_request_inner.py +90 -0
  158. instana_client/models/cursor_paginated_business_activity_item.py +2 -2
  159. instana_client/models/cursor_pagination.py +2 -2
  160. instana_client/models/cursor_pagination_infra_explore_cursor.py +2 -2
  161. instana_client/models/custom_blueprint_indicator.py +8 -4
  162. instana_client/models/custom_dashboard.py +2 -2
  163. instana_client/models/custom_dashboard_preview.py +2 -2
  164. instana_client/models/custom_dashboard_with_user_specific_information.py +115 -0
  165. instana_client/models/custom_dependency.py +116 -0
  166. instana_client/models/custom_email_subject_prefix.py +2 -2
  167. instana_client/models/custom_entity_model.py +126 -0
  168. instana_client/models/custom_entity_with_metadata.py +98 -0
  169. instana_client/models/custom_event_mobile_app_alert_rule.py +2 -2
  170. instana_client/models/custom_event_specification.py +9 -3
  171. instana_client/models/custom_event_specification_with_last_updated.py +9 -3
  172. instana_client/models/custom_event_website_alert_rule.py +2 -2
  173. instana_client/models/custom_metric.py +134 -0
  174. instana_client/models/custom_payload_configuration.py +2 -2
  175. instana_client/models/custom_payload_field.py +2 -2
  176. instana_client/models/custom_payload_with_last_updated.py +2 -2
  177. instana_client/models/custom_payload_with_version.py +101 -0
  178. instana_client/models/dashboard_api_token.py +2 -2
  179. instana_client/models/database_integration.py +2 -2
  180. instana_client/models/deprecated_tag_filter.py +4 -4
  181. instana_client/models/division.py +97 -0
  182. instana_client/models/dns_configuration.py +146 -0
  183. instana_client/models/dns_filter_query_time.py +99 -0
  184. instana_client/models/dns_filter_target_value.py +106 -0
  185. instana_client/models/duration.py +2 -2
  186. instana_client/models/dynamic_field.py +2 -2
  187. instana_client/models/dynamic_field_value.py +2 -2
  188. instana_client/models/dynamic_parameter.py +2 -2
  189. instana_client/models/edit_user.py +2 -2
  190. instana_client/models/email_integration.py +2 -2
  191. instana_client/models/empty_configuration.py +2 -2
  192. instana_client/models/endpoint.py +4 -4
  193. instana_client/models/endpoint_config.py +2 -2
  194. instana_client/models/endpoint_event_result.py +7 -9
  195. instana_client/models/endpoint_item.py +2 -2
  196. instana_client/models/endpoint_metric_result.py +2 -2
  197. instana_client/models/endpoint_node.py +2 -2
  198. instana_client/models/endpoint_result.py +3 -3
  199. instana_client/models/endpoint_simple.py +3 -3
  200. instana_client/models/entity_count_rule.py +2 -2
  201. instana_client/models/entity_count_verification_rule.py +3 -3
  202. instana_client/models/entity_health_info.py +2 -2
  203. instana_client/models/entity_id.py +2 -2
  204. instana_client/models/entity_verification_rule.py +3 -3
  205. instana_client/models/error_budget_alert_rule.py +5 -5
  206. instana_client/models/errors_application_alert_rule.py +2 -2
  207. instana_client/models/event.py +7 -3
  208. instana_client/models/event_filtering_configuration.py +2 -2
  209. instana_client/models/event_result.py +2 -2
  210. instana_client/models/event_specification_info.py +2 -2
  211. instana_client/models/extended_service.py +2 -2
  212. instana_client/models/failure_synthetic_alert_rule.py +2 -2
  213. instana_client/models/fixed_http_path_segment_matching_rule.py +2 -2
  214. instana_client/models/fixed_time_window.py +4 -3
  215. instana_client/models/generic_infra_alert_rule.py +12 -4
  216. instana_client/models/geo_location_configuration.py +2 -2
  217. instana_client/models/geo_mapping_rule.py +2 -2
  218. instana_client/models/geo_subdivision.py +2 -2
  219. instana_client/models/get_activities.py +2 -2
  220. instana_client/models/get_application_metrics.py +2 -2
  221. instana_client/models/get_applications.py +2 -2
  222. instana_client/models/get_available_metrics_query.py +2 -2
  223. instana_client/models/get_available_plugins_query.py +2 -2
  224. instana_client/models/get_call_groups.py +2 -2
  225. instana_client/models/get_combined_metrics.py +2 -2
  226. instana_client/models/get_dynamic_parameter_values.py +2 -2
  227. instana_client/models/get_endpoints.py +2 -2
  228. instana_client/models/get_infrastructure_groups_query.py +2 -2
  229. instana_client/models/get_infrastructure_query.py +2 -2
  230. instana_client/models/get_metrics_result.py +2 -2
  231. instana_client/models/get_mobile_app_beacon_groups.py +2 -2
  232. instana_client/models/get_mobile_app_beacons.py +2 -2
  233. instana_client/models/get_mobile_app_metrics.py +2 -2
  234. instana_client/models/get_mobile_app_metrics_v2.py +2 -2
  235. instana_client/models/get_payload_keys_result.py +2 -2
  236. instana_client/models/get_services.py +2 -2
  237. instana_client/models/get_snapshots_query.py +2 -2
  238. instana_client/models/get_test_result.py +2 -2
  239. instana_client/models/get_test_result_analytic.py +126 -0
  240. instana_client/models/get_test_result_base.py +2 -2
  241. instana_client/models/get_test_result_list.py +2 -2
  242. instana_client/models/get_test_summary_result.py +2 -2
  243. instana_client/models/get_trace_download_result_item.py +3 -3
  244. instana_client/models/get_trace_groups.py +2 -2
  245. instana_client/models/get_traces.py +4 -4
  246. instana_client/models/get_website_beacon_groups.py +2 -2
  247. instana_client/models/get_website_beacons.py +2 -2
  248. instana_client/models/get_website_metrics.py +2 -2
  249. instana_client/models/get_website_metrics_v2.py +2 -2
  250. instana_client/models/global_application_alert_config_with_metadata.py +2 -2
  251. instana_client/models/global_applications_alert_config.py +2 -2
  252. instana_client/models/google_chat_integration.py +2 -2
  253. instana_client/models/graph_edge.py +2 -2
  254. instana_client/models/graph_node.py +2 -2
  255. instana_client/models/group.py +2 -2
  256. instana_client/models/group_by_tag.py +2 -2
  257. instana_client/models/group_mapping.py +5 -3
  258. instana_client/models/group_mapping_overview.py +96 -0
  259. instana_client/models/health_state.py +2 -2
  260. instana_client/models/historic_baseline.py +3 -3
  261. instana_client/models/host_availability_rule.py +2 -2
  262. instana_client/models/http_action_configuration.py +2 -2
  263. instana_client/models/http_endpoint_config.py +2 -2
  264. instana_client/models/http_endpoint_rule.py +2 -2
  265. instana_client/models/http_path_segment_matching_rule.py +2 -2
  266. instana_client/models/http_script_configuration.py +5 -3
  267. instana_client/models/hyper_param.py +2 -2
  268. instana_client/models/identity_provider_patch.py +2 -2
  269. instana_client/models/impacted_beacon_info.py +96 -0
  270. instana_client/models/infra_alert_config.py +8 -6
  271. instana_client/models/infra_alert_config_with_metadata.py +7 -5
  272. instana_client/models/infra_alert_rule.py +9 -3
  273. instana_client/models/infra_event_result.py +6 -8
  274. instana_client/models/infra_metric_configuration.py +103 -80
  275. instana_client/models/infra_slo_entity.py +95 -0
  276. instana_client/models/infra_time_threshold.py +2 -2
  277. instana_client/models/infrastructure_entities_result.py +2 -2
  278. instana_client/models/infrastructure_group.py +5 -3
  279. instana_client/models/infrastructure_groups_result.py +2 -2
  280. instana_client/models/infrastructure_item.py +2 -2
  281. instana_client/models/infrastructure_metric_result.py +2 -2
  282. instana_client/models/instana_version_info.py +2 -2
  283. instana_client/models/integration_overview.py +14 -4
  284. instana_client/models/invitation.py +2 -2
  285. instana_client/models/invitation_response.py +2 -2
  286. instana_client/models/invitation_result.py +2 -2
  287. instana_client/models/ip_masking_configuration.py +2 -2
  288. instana_client/models/js_stack_trace_line.py +2 -2
  289. instana_client/models/kubernetes_physical_context.py +3 -3
  290. instana_client/models/latency_blueprint_indicator.py +5 -16
  291. instana_client/models/llm_egress_gateway.py +125 -0
  292. instana_client/models/location_status.py +2 -2
  293. instana_client/models/log_alert_config.py +8 -6
  294. instana_client/models/log_alert_config_with_metadata.py +8 -6
  295. instana_client/models/log_alert_rule.py +2 -2
  296. instana_client/models/log_count_alert_rule.py +2 -2
  297. instana_client/models/log_entry_actor.py +2 -2
  298. instana_client/models/log_event_result.py +5 -7
  299. instana_client/models/log_time_threshold.py +2 -2
  300. instana_client/models/log_volume_group.py +91 -0
  301. instana_client/models/log_volume_usage_item.py +101 -0
  302. instana_client/models/log_volume_usage_result.py +96 -0
  303. instana_client/models/logs_application_alert_rule.py +4 -4
  304. instana_client/models/maintenance_config.py +2 -2
  305. instana_client/models/maintenance_config_scheduling.py +2 -2
  306. instana_client/models/maintenance_config_v2.py +2 -2
  307. instana_client/models/maintenance_config_v2_with_state_and_occurrence.py +2 -2
  308. instana_client/models/maintenance_config_with_last_updated.py +2 -2
  309. instana_client/models/maintenance_window.py +2 -2
  310. instana_client/models/manual_alerting_channel_configuration.py +2 -2
  311. instana_client/models/manual_close_info.py +2 -2
  312. instana_client/models/manual_service_config.py +2 -2
  313. instana_client/models/match_all_http_path_segment_matching_rule.py +2 -2
  314. instana_client/models/match_expression_dto.py +3 -3
  315. instana_client/models/meta_data.py +2 -2
  316. instana_client/models/metric_api_result.py +2 -2
  317. instana_client/models/metric_config.py +2 -2
  318. instana_client/models/metric_configuration.py +3 -3
  319. instana_client/models/metric_description.py +2 -2
  320. instana_client/models/metric_instance.py +2 -2
  321. instana_client/models/metric_item.py +2 -2
  322. instana_client/models/metric_metadata.py +4 -4
  323. instana_client/models/metric_pattern.py +2 -2
  324. instana_client/models/metric_query.py +128 -0
  325. instana_client/models/metrics_result.py +2 -2
  326. instana_client/models/metrics_result_item.py +5 -3
  327. instana_client/models/metrics_test_result_item.py +2 -2
  328. instana_client/models/mobile_app.py +2 -2
  329. instana_client/models/mobile_app_alert_config.py +2 -2
  330. instana_client/models/mobile_app_alert_rule.py +8 -5
  331. instana_client/models/mobile_app_beacon_groups_item.py +2 -2
  332. instana_client/models/mobile_app_beacon_groups_result.py +2 -2
  333. instana_client/models/mobile_app_beacon_result.py +2 -2
  334. instana_client/models/mobile_app_beacon_tag_group.py +2 -2
  335. instana_client/models/mobile_app_beacons_item.py +11 -5
  336. instana_client/models/mobile_app_event_result.py +5 -7
  337. instana_client/models/mobile_app_metric_result.py +2 -2
  338. instana_client/models/mobile_app_monitoring_beacon.py +22 -4
  339. instana_client/models/mobile_app_monitoring_metric_description.py +5 -3
  340. instana_client/models/mobile_app_monitoring_metrics_configuration.py +2 -2
  341. instana_client/models/mobile_app_time_threshold.py +2 -2
  342. instana_client/models/model_field.py +2 -2
  343. instana_client/models/monitored_entities_stats.py +92 -0
  344. instana_client/models/monitoring_state.py +11 -3
  345. instana_client/models/multiple_scripts_configuration.py +2 -2
  346. instana_client/models/multiplication.py +97 -0
  347. instana_client/models/nested_operation.py +128 -0
  348. instana_client/models/new_application_config.py +2 -2
  349. instana_client/models/new_business_perspective_config.py +2 -2
  350. instana_client/models/new_manual_service_config.py +2 -2
  351. instana_client/models/o_auth_config.py +107 -0
  352. instana_client/models/o_auth_integration.py +98 -0
  353. instana_client/models/o_auth_token.py +121 -0
  354. instana_client/models/occurrence.py +2 -2
  355. instana_client/models/office365_integration.py +2 -2
  356. instana_client/models/one_time_maintenance_window.py +2 -2
  357. instana_client/models/opsgenie_integration.py +2 -2
  358. instana_client/models/order.py +2 -2
  359. instana_client/models/pagerduty_integration.py +2 -2
  360. instana_client/models/paginated_result.py +2 -2
  361. instana_client/models/pagination.py +2 -2
  362. instana_client/models/parameter.py +2 -2
  363. instana_client/models/parameter_value.py +2 -2
  364. instana_client/models/path_parameter_http_path_segment_matching_rule.py +2 -2
  365. instana_client/models/physical_context.py +3 -3
  366. instana_client/models/plugin_result.py +2 -2
  367. instana_client/models/policy.py +2 -2
  368. instana_client/models/policy_runnable.py +2 -2
  369. instana_client/models/policy_scheduling.py +91 -0
  370. instana_client/models/post_mobile_app_source_map_config_request.py +88 -0
  371. instana_client/models/post_snapshots_result.py +2 -2
  372. instana_client/models/problem.py +2 -2
  373. instana_client/models/prometheus_webhook_integration.py +2 -2
  374. instana_client/models/recurrent_maintenance_window.py +2 -2
  375. instana_client/models/release.py +6 -6
  376. instana_client/models/release_scope.py +2 -2
  377. instana_client/models/release_with_metadata.py +8 -8
  378. instana_client/models/retention_period.py +101 -0
  379. instana_client/models/rolling_time_window.py +4 -3
  380. instana_client/models/rule_input.py +2 -2
  381. instana_client/models/rule_with_threshold_application_alert_rule.py +2 -2
  382. instana_client/models/rule_with_threshold_infra_alert_rule.py +2 -2
  383. instana_client/models/rule_with_threshold_log_alert_rule.py +2 -2
  384. instana_client/models/rule_with_threshold_mobile_app_alert_rule.py +2 -2
  385. instana_client/models/rule_with_threshold_website_alert_rule.py +2 -2
  386. instana_client/models/run_configuration.py +2 -2
  387. instana_client/models/salesforce_integration.py +2 -2
  388. instana_client/models/saturation_blueprint_indicator.py +97 -0
  389. instana_client/models/scope_binding.py +2 -2
  390. instana_client/models/search_field_result.py +2 -2
  391. instana_client/models/service.py +3 -3
  392. instana_client/models/service_config.py +2 -2
  393. instana_client/models/service_event_result.py +5 -7
  394. instana_client/models/service_item.py +2 -2
  395. instana_client/models/service_level_indicator.py +10 -7
  396. instana_client/models/service_level_objective_alert_rule.py +2 -2
  397. instana_client/models/service_level_objective_configuration.py +3 -3
  398. instana_client/models/service_levels_alert_config.py +15 -5
  399. instana_client/models/service_levels_alert_rule.py +2 -2
  400. instana_client/models/service_levels_burn_rate_config.py +115 -0
  401. instana_client/models/service_levels_burn_rate_time_windows.py +2 -2
  402. instana_client/models/service_levels_static_threshold_config.py +100 -0
  403. instana_client/models/service_levels_time_threshold.py +5 -5
  404. instana_client/models/service_levelse_alert_config_with_metadata.py +15 -5
  405. instana_client/models/service_map.py +2 -2
  406. instana_client/models/service_map_connection.py +2 -2
  407. instana_client/models/service_matching_rule.py +2 -2
  408. instana_client/models/service_metric_result.py +2 -2
  409. instana_client/models/service_node.py +2 -2
  410. instana_client/models/service_now_enhanced_integration.py +2 -2
  411. instana_client/models/service_now_integration.py +2 -2
  412. instana_client/models/service_result.py +3 -3
  413. instana_client/models/service_scope.py +4 -4
  414. instana_client/models/service_scope_with_metadata.py +5 -5
  415. instana_client/models/service_scoped_to.py +3 -3
  416. instana_client/models/service_scoped_to_with_metadata.py +4 -4
  417. instana_client/models/service_simple.py +2 -2
  418. instana_client/models/session_settings.py +4 -4
  419. instana_client/models/simple_metric_configuration.py +121 -0
  420. instana_client/models/single_value.py +128 -0
  421. instana_client/models/slack_integration.py +2 -2
  422. instana_client/models/sli_configuration.py +2 -2
  423. instana_client/models/sli_configuration_with_last_updated.py +2 -2
  424. instana_client/models/sli_entity.py +2 -2
  425. instana_client/models/sli_report.py +2 -2
  426. instana_client/models/slo_config_with_rbac_tag.py +128 -0
  427. instana_client/models/slo_entity.py +8 -5
  428. instana_client/models/slo_report.py +2 -2
  429. instana_client/models/slowness_application_alert_rule.py +2 -2
  430. instana_client/models/slowness_mobile_app_alert_rule.py +90 -0
  431. instana_client/models/slowness_website_alert_rule.py +2 -2
  432. instana_client/models/snapshot_item.py +2 -2
  433. instana_client/models/snapshot_preview.py +7 -7
  434. instana_client/models/snapshot_result.py +2 -2
  435. instana_client/models/software_user.py +2 -2
  436. instana_client/models/software_version.py +2 -2
  437. instana_client/models/source_map_file_blob.py +2 -2
  438. instana_client/models/source_map_file_meta.py +2 -2
  439. instana_client/models/source_map_upload_config.py +2 -2
  440. instana_client/models/source_map_upload_configs.py +106 -0
  441. instana_client/models/span_excerpt.py +12 -12
  442. instana_client/models/span_relation.py +3 -3
  443. instana_client/models/specific_js_errors_website_alert_rule.py +4 -4
  444. instana_client/models/splunk_integration.py +2 -2
  445. instana_client/models/ssl_certificate_configuration.py +17 -5
  446. instana_client/models/ssl_certificate_validation.py +99 -0
  447. instana_client/models/stack_trace_item.py +7 -7
  448. instana_client/models/stack_trace_line.py +2 -2
  449. instana_client/models/static_baseline_threshold_rule.py +3 -3
  450. instana_client/models/static_string_field.py +2 -2
  451. instana_client/models/static_threshold.py +2 -2
  452. instana_client/models/static_threshold_rule.py +2 -2
  453. instana_client/models/status_code_application_alert_rule.py +2 -2
  454. instana_client/models/status_code_mobile_app_alert_rule.py +4 -4
  455. instana_client/models/status_code_website_alert_rule.py +4 -4
  456. instana_client/models/subtraction.py +97 -0
  457. instana_client/models/synthetic_alert_config.py +2 -2
  458. instana_client/models/synthetic_alert_config_with_metadata.py +2 -2
  459. instana_client/models/synthetic_alert_rule.py +2 -2
  460. instana_client/models/synthetic_call_config.py +4 -4
  461. instana_client/models/synthetic_call_rule.py +6 -6
  462. instana_client/models/synthetic_call_with_defaults_config.py +4 -4
  463. instana_client/models/synthetic_configuration.py +93 -0
  464. instana_client/models/synthetic_credential.py +23 -3
  465. instana_client/models/synthetic_datacenter.py +2 -2
  466. instana_client/models/synthetic_datacenter_configuration.py +2 -2
  467. instana_client/models/synthetic_geo_point.py +2 -2
  468. instana_client/models/synthetic_location.py +2 -2
  469. instana_client/models/synthetic_location_configuration.py +2 -2
  470. instana_client/models/synthetic_metric_configuration.py +2 -2
  471. instana_client/models/synthetic_metric_tag_group.py +2 -2
  472. instana_client/models/synthetic_playback_capabilities.py +17 -4
  473. instana_client/models/synthetic_slo_entity.py +7 -5
  474. instana_client/models/synthetic_test.py +27 -3
  475. instana_client/models/synthetic_test_cicd.py +96 -0
  476. instana_client/models/synthetic_test_cicd_customization.py +96 -0
  477. instana_client/models/synthetic_test_cicd_item.py +114 -0
  478. instana_client/models/synthetic_test_cicd_response.py +92 -0
  479. instana_client/models/synthetic_time_threshold.py +2 -2
  480. instana_client/models/synthetic_type_configuration.py +11 -11
  481. instana_client/models/synthetics_event_result.py +5 -7
  482. instana_client/models/system_rule.py +2 -2
  483. instana_client/models/system_rule_label.py +2 -2
  484. instana_client/models/tag.py +6 -6
  485. instana_client/models/tag_catalog.py +2 -2
  486. instana_client/models/tag_filter.py +4 -4
  487. instana_client/models/tag_filter_expression.py +2 -2
  488. instana_client/models/tag_filter_expression_element.py +2 -2
  489. instana_client/models/tag_matcher_dto.py +2 -2
  490. instana_client/models/tag_tree_level.py +2 -2
  491. instana_client/models/tag_tree_node.py +2 -2
  492. instana_client/models/tag_tree_tag.py +2 -2
  493. instana_client/models/test_common_properties.py +2 -2
  494. instana_client/models/test_last_error.py +90 -0
  495. instana_client/models/test_result.py +2 -2
  496. instana_client/models/test_result_common_properties.py +24 -3
  497. instana_client/models/test_result_detail_data.py +2 -2
  498. instana_client/models/test_result_item.py +2 -2
  499. instana_client/models/test_result_list_item.py +2 -2
  500. instana_client/models/test_result_list_result.py +2 -2
  501. instana_client/models/test_result_metadata.py +2 -2
  502. instana_client/models/test_result_subtransaction.py +2 -2
  503. instana_client/models/threshold.py +2 -2
  504. instana_client/models/threshold_config_rule.py +2 -2
  505. instana_client/models/threshold_rule.py +2 -2
  506. instana_client/models/throughput_application_alert_rule.py +2 -2
  507. instana_client/models/throughput_mobile_app_alert_rule.py +2 -2
  508. instana_client/models/throughput_website_alert_rule.py +2 -2
  509. instana_client/models/time_frame.py +2 -2
  510. instana_client/models/time_window.py +5 -4
  511. instana_client/models/topology.py +2 -2
  512. instana_client/models/trace.py +8 -8
  513. instana_client/models/trace_activity_tree_node_details.py +13 -13
  514. instana_client/models/trace_download_result.py +2 -2
  515. instana_client/models/trace_groups_item.py +2 -2
  516. instana_client/models/trace_groups_result.py +2 -2
  517. instana_client/models/trace_impact_application_time_threshold.py +2 -2
  518. instana_client/models/trace_item.py +2 -2
  519. instana_client/models/trace_result.py +2 -2
  520. instana_client/models/traffic_blueprint_indicator.py +3 -3
  521. instana_client/models/trigger.py +15 -7
  522. instana_client/models/type_configuration.py +2 -2
  523. instana_client/models/unsupported_http_path_segment_matching_rule.py +2 -2
  524. instana_client/models/updated_business_perspective_config.py +2 -2
  525. instana_client/models/usage_result.py +2 -2
  526. instana_client/models/usage_result_items.py +2 -2
  527. instana_client/models/user_basic_result.py +2 -2
  528. instana_client/models/user_impact_mobile_app_time_threshold.py +3 -3
  529. instana_client/models/user_impact_website_time_threshold.py +3 -3
  530. instana_client/models/user_result.py +2 -2
  531. instana_client/models/users_result.py +2 -2
  532. instana_client/models/validated_alerting_channel_input_info.py +4 -4
  533. instana_client/models/validated_alerting_configuration.py +2 -2
  534. instana_client/models/validated_maintenance_config_v2_with_state_and_occurrence.py +2 -2
  535. instana_client/models/validated_maintenance_config_with_status.py +2 -2
  536. instana_client/models/victor_ops_integration.py +2 -2
  537. instana_client/models/violations_in_period_application_time_threshold.py +2 -2
  538. instana_client/models/violations_in_period_mobile_app_time_threshold.py +2 -2
  539. instana_client/models/violations_in_period_website_time_threshold.py +2 -2
  540. instana_client/models/violations_in_sequence_application_time_threshold.py +2 -2
  541. instana_client/models/violations_in_sequence_infra_time_threshold.py +2 -2
  542. instana_client/models/violations_in_sequence_log_time_threshold.py +2 -2
  543. instana_client/models/violations_in_sequence_mobile_app_time_threshold.py +2 -2
  544. instana_client/models/violations_in_sequence_synthetic_time_threshold.py +2 -2
  545. instana_client/models/violations_in_sequence_website_time_threshold.py +2 -2
  546. instana_client/models/watson_ai_ops_webhook_integration.py +2 -2
  547. instana_client/models/webex_teams_webhook_integration.py +2 -2
  548. instana_client/models/webhook_integration.py +14 -4
  549. instana_client/models/webpage_action_configuration.py +2 -2
  550. instana_client/models/webpage_script_configuration.py +5 -3
  551. instana_client/models/website.py +2 -2
  552. instana_client/models/website_alert_config.py +2 -2
  553. instana_client/models/website_alert_config_with_metadata.py +2 -2
  554. instana_client/models/website_alert_rule.py +2 -2
  555. instana_client/models/website_apdex_entity.py +2 -2
  556. instana_client/models/website_beacon_groups_item.py +2 -2
  557. instana_client/models/website_beacon_groups_result.py +2 -2
  558. instana_client/models/website_beacon_result.py +2 -2
  559. instana_client/models/website_beacon_tag_group.py +2 -2
  560. instana_client/models/website_beacons_item.py +11 -5
  561. instana_client/models/website_event_based_sli_entity.py +2 -2
  562. instana_client/models/website_event_result.py +4 -6
  563. instana_client/models/website_metric_result.py +2 -2
  564. instana_client/models/website_monitoring_beacon.py +7 -3
  565. instana_client/models/website_monitoring_metric_description.py +2 -2
  566. instana_client/models/website_monitoring_metrics_configuration.py +2 -2
  567. instana_client/models/website_slo_entity.py +2 -2
  568. instana_client/models/website_time_based_sli_entity.py +2 -2
  569. instana_client/models/website_time_threshold.py +2 -2
  570. instana_client/models/widget.py +2 -2
  571. instana_client/models/with_metadata.py +2 -2
  572. instana_client/models/with_resolved_name.py +2 -2
  573. instana_client/models/z_chat_ops_integration.py +2 -2
  574. instana_client/rest.py +3 -2
  575. instana_client-1.0.1.dist-info/METADATA +1068 -0
  576. instana_client-1.0.1.dist-info/RECORD +581 -0
  577. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/WHEEL +1 -1
  578. instana_client/models/dns_action_configuration.py +0 -134
  579. instana_client/models/dns_action_filter_query_time.py +0 -99
  580. instana_client/models/dns_action_filter_target_value.py +0 -106
  581. instana_client/models/full_trace.py +0 -97
  582. instana_client/models/span.py +0 -156
  583. instana_client-1.0.0.dist-info/METADATA +0 -25
  584. instana_client-1.0.0.dist-info/RECORD +0 -515
  585. {instana_client-1.0.0.dist-info → instana_client-1.0.1.dist-info}/licenses/LICENSE +0 -0
  586. {instana_client-1.0.0.dist-info → instana_client-1.0.1.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.306.1368
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
@@ -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
@@ -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
@@ -1412,7 +1417,6 @@ class EventSettingsApi:
1412
1417
  ) -> None:
1413
1418
  """Delete custom event specification
1414
1419
 
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
1420
 
1417
1421
  :param event_specification_id: (required)
1418
1422
  :type event_specification_id: str
@@ -1478,7 +1482,6 @@ class EventSettingsApi:
1478
1482
  ) -> ApiResponse[None]:
1479
1483
  """Delete custom event specification
1480
1484
 
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
1485
 
1483
1486
  :param event_specification_id: (required)
1484
1487
  :type event_specification_id: str
@@ -1544,7 +1547,6 @@ class EventSettingsApi:
1544
1547
  ) -> RESTResponseType:
1545
1548
  """Delete custom event specification
1546
1549
 
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
1550
 
1549
1551
  :param event_specification_id: (required)
1550
1552
  :type event_specification_id: str
@@ -1950,9 +1952,9 @@ class EventSettingsApi:
1950
1952
  )
1951
1953
 
1952
1954
  _response_types_map: Dict[str, Optional[str]] = {
1953
- '200': None,
1954
- '400': None,
1955
+ '204': None,
1955
1956
  '403': None,
1957
+ '404': None,
1956
1958
  }
1957
1959
  response_data = self.api_client.call_api(
1958
1960
  *_param,
@@ -2019,9 +2021,9 @@ class EventSettingsApi:
2019
2021
  )
2020
2022
 
2021
2023
  _response_types_map: Dict[str, Optional[str]] = {
2022
- '200': None,
2023
- '400': None,
2024
+ '204': None,
2024
2025
  '403': None,
2026
+ '404': None,
2025
2027
  }
2026
2028
  response_data = self.api_client.call_api(
2027
2029
  *_param,
@@ -2088,9 +2090,9 @@ class EventSettingsApi:
2088
2090
  )
2089
2091
 
2090
2092
  _response_types_map: Dict[str, Optional[str]] = {
2091
- '200': None,
2092
- '400': None,
2093
+ '204': None,
2093
2094
  '403': None,
2095
+ '404': None,
2094
2096
  }
2095
2097
  response_data = self.api_client.call_api(
2096
2098
  *_param,
@@ -2135,6 +2137,7 @@ class EventSettingsApi:
2135
2137
 
2136
2138
  # authentication setting
2137
2139
  _auth_settings: List[str] = [
2140
+ 'ApiKeyAuth'
2138
2141
  ]
2139
2142
 
2140
2143
  return self.api_client.param_serialize(
@@ -2209,9 +2212,9 @@ class EventSettingsApi:
2209
2212
  )
2210
2213
 
2211
2214
  _response_types_map: Dict[str, Optional[str]] = {
2212
- '200': None,
2213
- '400': None,
2215
+ '204': None,
2214
2216
  '403': None,
2217
+ '404': None,
2215
2218
  }
2216
2219
  response_data = self.api_client.call_api(
2217
2220
  *_param,
@@ -2278,9 +2281,9 @@ class EventSettingsApi:
2278
2281
  )
2279
2282
 
2280
2283
  _response_types_map: Dict[str, Optional[str]] = {
2281
- '200': None,
2282
- '400': None,
2284
+ '204': None,
2283
2285
  '403': None,
2286
+ '404': None,
2284
2287
  }
2285
2288
  response_data = self.api_client.call_api(
2286
2289
  *_param,
@@ -2347,9 +2350,9 @@ class EventSettingsApi:
2347
2350
  )
2348
2351
 
2349
2352
  _response_types_map: Dict[str, Optional[str]] = {
2350
- '200': None,
2351
- '400': None,
2353
+ '204': None,
2352
2354
  '403': None,
2355
+ '404': None,
2353
2356
  }
2354
2357
  response_data = self.api_client.call_api(
2355
2358
  *_param,
@@ -3045,9 +3048,9 @@ class EventSettingsApi:
3045
3048
  )
3046
3049
 
3047
3050
  _response_types_map: Dict[str, Optional[str]] = {
3048
- '200': None,
3049
- '400': None,
3051
+ '204': None,
3050
3052
  '403': None,
3053
+ '404': None,
3051
3054
  }
3052
3055
  response_data = self.api_client.call_api(
3053
3056
  *_param,
@@ -3118,9 +3121,9 @@ class EventSettingsApi:
3118
3121
  )
3119
3122
 
3120
3123
  _response_types_map: Dict[str, Optional[str]] = {
3121
- '200': None,
3122
- '400': None,
3124
+ '204': None,
3123
3125
  '403': None,
3126
+ '404': None,
3124
3127
  }
3125
3128
  response_data = self.api_client.call_api(
3126
3129
  *_param,
@@ -3191,9 +3194,9 @@ class EventSettingsApi:
3191
3194
  )
3192
3195
 
3193
3196
  _response_types_map: Dict[str, Optional[str]] = {
3194
- '200': None,
3195
- '400': None,
3197
+ '204': None,
3196
3198
  '403': None,
3199
+ '404': None,
3197
3200
  }
3198
3201
  response_data = self.api_client.call_api(
3199
3202
  *_param,
@@ -3254,6 +3257,7 @@ class EventSettingsApi:
3254
3257
 
3255
3258
  # authentication setting
3256
3259
  _auth_settings: List[str] = [
3260
+ 'ApiKeyAuth'
3257
3261
  ]
3258
3262
 
3259
3263
  return self.api_client.param_serialize(
@@ -3332,9 +3336,9 @@ class EventSettingsApi:
3332
3336
  )
3333
3337
 
3334
3338
  _response_types_map: Dict[str, Optional[str]] = {
3335
- '200': None,
3336
- '400': None,
3339
+ '204': None,
3337
3340
  '403': None,
3341
+ '404': None,
3338
3342
  }
3339
3343
  response_data = self.api_client.call_api(
3340
3344
  *_param,
@@ -3405,9 +3409,9 @@ class EventSettingsApi:
3405
3409
  )
3406
3410
 
3407
3411
  _response_types_map: Dict[str, Optional[str]] = {
3408
- '200': None,
3409
- '400': None,
3412
+ '204': None,
3410
3413
  '403': None,
3414
+ '404': None,
3411
3415
  }
3412
3416
  response_data = self.api_client.call_api(
3413
3417
  *_param,
@@ -3478,9 +3482,9 @@ class EventSettingsApi:
3478
3482
  )
3479
3483
 
3480
3484
  _response_types_map: Dict[str, Optional[str]] = {
3481
- '200': None,
3482
- '400': None,
3485
+ '204': None,
3483
3486
  '403': None,
3487
+ '404': None,
3484
3488
  }
3485
3489
  response_data = self.api_client.call_api(
3486
3490
  *_param,
@@ -4192,9 +4196,9 @@ class EventSettingsApi:
4192
4196
  )
4193
4197
 
4194
4198
  _response_types_map: Dict[str, Optional[str]] = {
4195
- '200': None,
4196
- '400': None,
4199
+ '204': None,
4197
4200
  '403': None,
4201
+ '404': None,
4198
4202
  }
4199
4203
  response_data = self.api_client.call_api(
4200
4204
  *_param,
@@ -4265,9 +4269,9 @@ class EventSettingsApi:
4265
4269
  )
4266
4270
 
4267
4271
  _response_types_map: Dict[str, Optional[str]] = {
4268
- '200': None,
4269
- '400': None,
4272
+ '204': None,
4270
4273
  '403': None,
4274
+ '404': None,
4271
4275
  }
4272
4276
  response_data = self.api_client.call_api(
4273
4277
  *_param,
@@ -4338,9 +4342,9 @@ class EventSettingsApi:
4338
4342
  )
4339
4343
 
4340
4344
  _response_types_map: Dict[str, Optional[str]] = {
4341
- '200': None,
4342
- '400': None,
4345
+ '204': None,
4343
4346
  '403': None,
4347
+ '404': None,
4344
4348
  }
4345
4349
  response_data = self.api_client.call_api(
4346
4350
  *_param,
@@ -4401,6 +4405,7 @@ class EventSettingsApi:
4401
4405
 
4402
4406
  # authentication setting
4403
4407
  _auth_settings: List[str] = [
4408
+ 'ApiKeyAuth'
4404
4409
  ]
4405
4410
 
4406
4411
  return self.api_client.param_serialize(
@@ -4479,9 +4484,9 @@ class EventSettingsApi:
4479
4484
  )
4480
4485
 
4481
4486
  _response_types_map: Dict[str, Optional[str]] = {
4482
- '200': None,
4483
- '400': None,
4487
+ '204': None,
4484
4488
  '403': None,
4489
+ '404': None,
4485
4490
  }
4486
4491
  response_data = self.api_client.call_api(
4487
4492
  *_param,
@@ -4552,9 +4557,9 @@ class EventSettingsApi:
4552
4557
  )
4553
4558
 
4554
4559
  _response_types_map: Dict[str, Optional[str]] = {
4555
- '200': None,
4556
- '400': None,
4560
+ '204': None,
4557
4561
  '403': None,
4562
+ '404': None,
4558
4563
  }
4559
4564
  response_data = self.api_client.call_api(
4560
4565
  *_param,
@@ -4625,9 +4630,9 @@ class EventSettingsApi:
4625
4630
  )
4626
4631
 
4627
4632
  _response_types_map: Dict[str, Optional[str]] = {
4628
- '200': None,
4629
- '400': None,
4633
+ '204': None,
4630
4634
  '403': None,
4635
+ '404': None,
4631
4636
  }
4632
4637
  response_data = self.api_client.call_api(
4633
4638
  *_param,
@@ -4729,7 +4734,7 @@ class EventSettingsApi:
4729
4734
  ) -> List[WithMetadata]:
4730
4735
  """Get all Mobile Smart Alert Configs
4731
4736
 
4732
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4737
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4733
4738
 
4734
4739
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4735
4740
  :type mobile_app_id: str
@@ -4769,7 +4774,6 @@ class EventSettingsApi:
4769
4774
  _response_types_map: Dict[str, Optional[str]] = {
4770
4775
  '200': "List[WithMetadata]",
4771
4776
  '403': None,
4772
- '404': None,
4773
4777
  }
4774
4778
  response_data = self.api_client.call_api(
4775
4779
  *_param,
@@ -4802,7 +4806,7 @@ class EventSettingsApi:
4802
4806
  ) -> ApiResponse[List[WithMetadata]]:
4803
4807
  """Get all Mobile Smart Alert Configs
4804
4808
 
4805
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4809
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4806
4810
 
4807
4811
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4808
4812
  :type mobile_app_id: str
@@ -4842,7 +4846,6 @@ class EventSettingsApi:
4842
4846
  _response_types_map: Dict[str, Optional[str]] = {
4843
4847
  '200': "List[WithMetadata]",
4844
4848
  '403': None,
4845
- '404': None,
4846
4849
  }
4847
4850
  response_data = self.api_client.call_api(
4848
4851
  *_param,
@@ -4875,7 +4878,7 @@ class EventSettingsApi:
4875
4878
  ) -> RESTResponseType:
4876
4879
  """Get all Mobile Smart Alert Configs
4877
4880
 
4878
- Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurationss are sorted by creation date in descending order.
4881
+ Gets all the Mobile Smart Alert Configuration pertaining to a specific mobile app.Configurations are sorted by creation date in descending order.
4879
4882
 
4880
4883
  :param mobile_app_id: The ID of a specific Mobile Application. (required)
4881
4884
  :type mobile_app_id: str
@@ -4915,7 +4918,6 @@ class EventSettingsApi:
4915
4918
  _response_types_map: Dict[str, Optional[str]] = {
4916
4919
  '200': "List[WithMetadata]",
4917
4920
  '403': None,
4918
- '404': None,
4919
4921
  }
4920
4922
  response_data = self.api_client.call_api(
4921
4923
  *_param,
@@ -4975,6 +4977,7 @@ class EventSettingsApi:
4975
4977
 
4976
4978
  # authentication setting
4977
4979
  _auth_settings: List[str] = [
4980
+ 'ApiKeyAuth'
4978
4981
  ]
4979
4982
 
4980
4983
  return self.api_client.param_serialize(
@@ -5015,7 +5018,7 @@ class EventSettingsApi:
5015
5018
  ) -> List[WebsiteAlertConfigWithMetadata]:
5016
5019
  """Get all Website Smart Alert Configs
5017
5020
 
5018
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5021
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5019
5022
 
5020
5023
  :param website_id: The ID of a specific Website (required)
5021
5024
  :type website_id: str
@@ -5055,7 +5058,6 @@ class EventSettingsApi:
5055
5058
  _response_types_map: Dict[str, Optional[str]] = {
5056
5059
  '200': "List[WebsiteAlertConfigWithMetadata]",
5057
5060
  '403': None,
5058
- '404': None,
5059
5061
  }
5060
5062
  response_data = self.api_client.call_api(
5061
5063
  *_param,
@@ -5088,7 +5090,7 @@ class EventSettingsApi:
5088
5090
  ) -> ApiResponse[List[WebsiteAlertConfigWithMetadata]]:
5089
5091
  """Get all Website Smart Alert Configs
5090
5092
 
5091
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5093
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5092
5094
 
5093
5095
  :param website_id: The ID of a specific Website (required)
5094
5096
  :type website_id: str
@@ -5128,7 +5130,6 @@ class EventSettingsApi:
5128
5130
  _response_types_map: Dict[str, Optional[str]] = {
5129
5131
  '200': "List[WebsiteAlertConfigWithMetadata]",
5130
5132
  '403': None,
5131
- '404': None,
5132
5133
  }
5133
5134
  response_data = self.api_client.call_api(
5134
5135
  *_param,
@@ -5161,7 +5162,7 @@ class EventSettingsApi:
5161
5162
  ) -> RESTResponseType:
5162
5163
  """Get all Website Smart Alert Configs
5163
5164
 
5164
- Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurationss are sorted by creation date in descending order.
5165
+ Gets all the Website Smart Alert Configuration pertaining to a specific website. Configurations are sorted by creation date in descending order.
5165
5166
 
5166
5167
  :param website_id: The ID of a specific Website (required)
5167
5168
  :type website_id: str
@@ -5201,7 +5202,6 @@ class EventSettingsApi:
5201
5202
  _response_types_map: Dict[str, Optional[str]] = {
5202
5203
  '200': "List[WebsiteAlertConfigWithMetadata]",
5203
5204
  '403': None,
5204
- '404': None,
5205
5205
  }
5206
5206
  response_data = self.api_client.call_api(
5207
5207
  *_param,
@@ -5545,6 +5545,7 @@ class EventSettingsApi:
5545
5545
 
5546
5546
  # authentication setting
5547
5547
  _auth_settings: List[str] = [
5548
+ 'ApiKeyAuth'
5548
5549
  ]
5549
5550
 
5550
5551
  return self.api_client.param_serialize(
@@ -5811,6 +5812,7 @@ class EventSettingsApi:
5811
5812
 
5812
5813
  # authentication setting
5813
5814
  _auth_settings: List[str] = [
5815
+ 'ApiKeyAuth'
5814
5816
  ]
5815
5817
 
5816
5818
  return self.api_client.param_serialize(
@@ -6671,7 +6673,7 @@ class EventSettingsApi:
6671
6673
  ) -> AbstractIntegration:
6672
6674
  """Get Alerting Channel
6673
6675
 
6674
- Gets an alerting channel.
6676
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6675
6677
 
6676
6678
  :param id: ID of the Alerting Channel to get. (required)
6677
6679
  :type id: str
@@ -6738,7 +6740,7 @@ class EventSettingsApi:
6738
6740
  ) -> ApiResponse[AbstractIntegration]:
6739
6741
  """Get Alerting Channel
6740
6742
 
6741
- Gets an alerting channel.
6743
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6742
6744
 
6743
6745
  :param id: ID of the Alerting Channel to get. (required)
6744
6746
  :type id: str
@@ -6805,7 +6807,7 @@ class EventSettingsApi:
6805
6807
  ) -> RESTResponseType:
6806
6808
  """Get Alerting Channel
6807
6809
 
6808
- Gets an alerting channel.
6810
+ Gets an alerting channel. Requires the permission called CanConfigureIntegrations.
6809
6811
 
6810
6812
  :param id: ID of the Alerting Channel to get. (required)
6811
6813
  :type id: str
@@ -6932,7 +6934,7 @@ class EventSettingsApi:
6932
6934
  ) -> List[AbstractIntegration]:
6933
6935
  """Get all Alerting Channels
6934
6936
 
6935
- Gets all the alerting channels.
6937
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
6936
6938
 
6937
6939
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
6938
6940
  :type ids: List[str]
@@ -6999,7 +7001,7 @@ class EventSettingsApi:
6999
7001
  ) -> ApiResponse[List[AbstractIntegration]]:
7000
7002
  """Get all Alerting Channels
7001
7003
 
7002
- Gets all the alerting channels.
7004
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
7003
7005
 
7004
7006
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7005
7007
  :type ids: List[str]
@@ -7066,7 +7068,7 @@ class EventSettingsApi:
7066
7068
  ) -> RESTResponseType:
7067
7069
  """Get all Alerting Channels
7068
7070
 
7069
- Gets all the alerting channels.
7071
+ Gets all the alerting channels. Requires the permission called CanConfigureIntegrations.
7070
7072
 
7071
7073
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7072
7074
  :type ids: List[str]
@@ -7196,7 +7198,7 @@ class EventSettingsApi:
7196
7198
  ) -> List[IntegrationOverview]:
7197
7199
  """Get Overview of Alerting Channels
7198
7200
 
7199
- Gets the overview information of all alerting channels.
7201
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7200
7202
 
7201
7203
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7202
7204
  :type ids: List[str]
@@ -7263,7 +7265,7 @@ class EventSettingsApi:
7263
7265
  ) -> ApiResponse[List[IntegrationOverview]]:
7264
7266
  """Get Overview of Alerting Channels
7265
7267
 
7266
- Gets the overview information of all alerting channels.
7268
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7267
7269
 
7268
7270
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7269
7271
  :type ids: List[str]
@@ -7330,7 +7332,7 @@ class EventSettingsApi:
7330
7332
  ) -> RESTResponseType:
7331
7333
  """Get Overview of Alerting Channels
7332
7334
 
7333
- Gets the overview information of all alerting channels.
7335
+ Gets the overview information of all alerting channels. Requires the permission called CanConfigureIntegrations.
7334
7336
 
7335
7337
  :param ids: List of IDs of alert channels defined in Instana. Can be left empty.
7336
7338
  :type ids: List[str]
@@ -9013,7 +9015,7 @@ class EventSettingsApi:
9013
9015
  _content_type: Optional[StrictStr] = None,
9014
9016
  _headers: Optional[Dict[StrictStr, Any]] = None,
9015
9017
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
9016
- ) -> CustomPayloadWithLastUpdated:
9018
+ ) -> CustomPayloadWithVersion:
9017
9019
  """Get All Global Custom Payload Configurations
9018
9020
 
9019
9021
  Gets All Global Custom Payload Configurations.
@@ -9051,7 +9053,7 @@ class EventSettingsApi:
9051
9053
  )
9052
9054
 
9053
9055
  _response_types_map: Dict[str, Optional[str]] = {
9054
- '200': "CustomPayloadWithLastUpdated",
9056
+ '200': "CustomPayloadWithVersion",
9055
9057
  '401': None,
9056
9058
  '403': None,
9057
9059
  }
@@ -9082,7 +9084,7 @@ class EventSettingsApi:
9082
9084
  _content_type: Optional[StrictStr] = None,
9083
9085
  _headers: Optional[Dict[StrictStr, Any]] = None,
9084
9086
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
9085
- ) -> ApiResponse[CustomPayloadWithLastUpdated]:
9087
+ ) -> ApiResponse[CustomPayloadWithVersion]:
9086
9088
  """Get All Global Custom Payload Configurations
9087
9089
 
9088
9090
  Gets All Global Custom Payload Configurations.
@@ -9120,7 +9122,7 @@ class EventSettingsApi:
9120
9122
  )
9121
9123
 
9122
9124
  _response_types_map: Dict[str, Optional[str]] = {
9123
- '200': "CustomPayloadWithLastUpdated",
9125
+ '200': "CustomPayloadWithVersion",
9124
9126
  '401': None,
9125
9127
  '403': None,
9126
9128
  }
@@ -9189,7 +9191,7 @@ class EventSettingsApi:
9189
9191
  )
9190
9192
 
9191
9193
  _response_types_map: Dict[str, Optional[str]] = {
9192
- '200': "CustomPayloadWithLastUpdated",
9194
+ '200': "CustomPayloadWithVersion",
9193
9195
  '401': None,
9194
9196
  '403': None,
9195
9197
  }
@@ -10873,9 +10875,9 @@ class EventSettingsApi:
10873
10875
 
10874
10876
 
10875
10877
  @validate_call
10876
- def post_custom_event_specification(
10878
+ def post_alerting_channel(
10877
10879
  self,
10878
- custom_event_specification: CustomEventSpecification,
10880
+ abstract_integration: AbstractIntegration,
10879
10881
  _request_timeout: Union[
10880
10882
  None,
10881
10883
  Annotated[StrictFloat, Field(gt=0)],
@@ -10888,13 +10890,13 @@ class EventSettingsApi:
10888
10890
  _content_type: Optional[StrictStr] = None,
10889
10891
  _headers: Optional[Dict[StrictStr, Any]] = None,
10890
10892
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
10891
- ) -> CustomEventSpecificationWithLastUpdated:
10892
- """Create new custom event specification
10893
+ ) -> AbstractIntegration:
10894
+ """Create Alert Channel
10893
10895
 
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).
10896
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
10895
10897
 
10896
- :param custom_event_specification: (required)
10897
- :type custom_event_specification: CustomEventSpecification
10898
+ :param abstract_integration: (required)
10899
+ :type abstract_integration: AbstractIntegration
10898
10900
  :param _request_timeout: timeout setting for this request. If one
10899
10901
  number provided, it will be total request
10900
10902
  timeout. It can also be a pair (tuple) of
@@ -10917,8 +10919,8 @@ class EventSettingsApi:
10917
10919
  :return: Returns the result object.
10918
10920
  """ # noqa: E501
10919
10921
 
10920
- _param = self._post_custom_event_specification_serialize(
10921
- custom_event_specification=custom_event_specification,
10922
+ _param = self._post_alerting_channel_serialize(
10923
+ abstract_integration=abstract_integration,
10922
10924
  _request_auth=_request_auth,
10923
10925
  _content_type=_content_type,
10924
10926
  _headers=_headers,
@@ -10926,7 +10928,9 @@ class EventSettingsApi:
10926
10928
  )
10927
10929
 
10928
10930
  _response_types_map: Dict[str, Optional[str]] = {
10929
- '200': "CustomEventSpecificationWithLastUpdated",
10931
+ '200': "AbstractIntegration",
10932
+ '302': None,
10933
+ '400': "str",
10930
10934
  }
10931
10935
  response_data = self.api_client.call_api(
10932
10936
  *_param,
@@ -10940,9 +10944,9 @@ class EventSettingsApi:
10940
10944
 
10941
10945
 
10942
10946
  @validate_call
10943
- def post_custom_event_specification_with_http_info(
10947
+ def post_alerting_channel_with_http_info(
10944
10948
  self,
10945
- custom_event_specification: CustomEventSpecification,
10949
+ abstract_integration: AbstractIntegration,
10946
10950
  _request_timeout: Union[
10947
10951
  None,
10948
10952
  Annotated[StrictFloat, Field(gt=0)],
@@ -10955,13 +10959,13 @@ class EventSettingsApi:
10955
10959
  _content_type: Optional[StrictStr] = None,
10956
10960
  _headers: Optional[Dict[StrictStr, Any]] = None,
10957
10961
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
10958
- ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
10959
- """Create new custom event specification
10962
+ ) -> ApiResponse[AbstractIntegration]:
10963
+ """Create Alert Channel
10960
10964
 
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).
10965
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
10962
10966
 
10963
- :param custom_event_specification: (required)
10964
- :type custom_event_specification: CustomEventSpecification
10967
+ :param abstract_integration: (required)
10968
+ :type abstract_integration: AbstractIntegration
10965
10969
  :param _request_timeout: timeout setting for this request. If one
10966
10970
  number provided, it will be total request
10967
10971
  timeout. It can also be a pair (tuple) of
@@ -10984,8 +10988,8 @@ class EventSettingsApi:
10984
10988
  :return: Returns the result object.
10985
10989
  """ # noqa: E501
10986
10990
 
10987
- _param = self._post_custom_event_specification_serialize(
10988
- custom_event_specification=custom_event_specification,
10991
+ _param = self._post_alerting_channel_serialize(
10992
+ abstract_integration=abstract_integration,
10989
10993
  _request_auth=_request_auth,
10990
10994
  _content_type=_content_type,
10991
10995
  _headers=_headers,
@@ -10993,7 +10997,9 @@ class EventSettingsApi:
10993
10997
  )
10994
10998
 
10995
10999
  _response_types_map: Dict[str, Optional[str]] = {
10996
- '200': "CustomEventSpecificationWithLastUpdated",
11000
+ '200': "AbstractIntegration",
11001
+ '302': None,
11002
+ '400': "str",
10997
11003
  }
10998
11004
  response_data = self.api_client.call_api(
10999
11005
  *_param,
@@ -11007,9 +11013,9 @@ class EventSettingsApi:
11007
11013
 
11008
11014
 
11009
11015
  @validate_call
11010
- def post_custom_event_specification_without_preload_content(
11016
+ def post_alerting_channel_without_preload_content(
11011
11017
  self,
11012
- custom_event_specification: CustomEventSpecification,
11018
+ abstract_integration: AbstractIntegration,
11013
11019
  _request_timeout: Union[
11014
11020
  None,
11015
11021
  Annotated[StrictFloat, Field(gt=0)],
@@ -11023,12 +11029,12 @@ class EventSettingsApi:
11023
11029
  _headers: Optional[Dict[StrictStr, Any]] = None,
11024
11030
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11025
11031
  ) -> RESTResponseType:
11026
- """Create new custom event specification
11032
+ """Create Alert Channel
11027
11033
 
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).
11034
+ Creates an alerting channel. Requires the permission called CanConfigureIntegrations.
11029
11035
 
11030
- :param custom_event_specification: (required)
11031
- :type custom_event_specification: CustomEventSpecification
11036
+ :param abstract_integration: (required)
11037
+ :type abstract_integration: AbstractIntegration
11032
11038
  :param _request_timeout: timeout setting for this request. If one
11033
11039
  number provided, it will be total request
11034
11040
  timeout. It can also be a pair (tuple) of
@@ -11051,8 +11057,8 @@ class EventSettingsApi:
11051
11057
  :return: Returns the result object.
11052
11058
  """ # noqa: E501
11053
11059
 
11054
- _param = self._post_custom_event_specification_serialize(
11055
- custom_event_specification=custom_event_specification,
11060
+ _param = self._post_alerting_channel_serialize(
11061
+ abstract_integration=abstract_integration,
11056
11062
  _request_auth=_request_auth,
11057
11063
  _content_type=_content_type,
11058
11064
  _headers=_headers,
@@ -11060,7 +11066,9 @@ class EventSettingsApi:
11060
11066
  )
11061
11067
 
11062
11068
  _response_types_map: Dict[str, Optional[str]] = {
11063
- '200': "CustomEventSpecificationWithLastUpdated",
11069
+ '200': "AbstractIntegration",
11070
+ '302': None,
11071
+ '400': "str",
11064
11072
  }
11065
11073
  response_data = self.api_client.call_api(
11066
11074
  *_param,
@@ -11069,9 +11077,9 @@ class EventSettingsApi:
11069
11077
  return response_data.response
11070
11078
 
11071
11079
 
11072
- def _post_custom_event_specification_serialize(
11080
+ def _post_alerting_channel_serialize(
11073
11081
  self,
11074
- custom_event_specification,
11082
+ abstract_integration,
11075
11083
  _request_auth,
11076
11084
  _content_type,
11077
11085
  _headers,
@@ -11097,8 +11105,8 @@ class EventSettingsApi:
11097
11105
  # process the header parameters
11098
11106
  # process the form parameters
11099
11107
  # process the body parameter
11100
- if custom_event_specification is not None:
11101
- _body_params = custom_event_specification
11108
+ if abstract_integration is not None:
11109
+ _body_params = abstract_integration
11102
11110
 
11103
11111
 
11104
11112
  # set the HTTP header `Accept`
@@ -11130,7 +11138,7 @@ class EventSettingsApi:
11130
11138
 
11131
11139
  return self.api_client.param_serialize(
11132
11140
  method='POST',
11133
- resource_path='/api/events/settings/event-specifications/custom',
11141
+ resource_path='/api/events/settings/alertingChannels',
11134
11142
  path_params=_path_params,
11135
11143
  query_params=_query_params,
11136
11144
  header_params=_header_params,
@@ -11147,10 +11155,9 @@ class EventSettingsApi:
11147
11155
 
11148
11156
 
11149
11157
  @validate_call
11150
- def put_alert(
11158
+ def post_custom_event_specification(
11151
11159
  self,
11152
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11153
- alerting_configuration: AlertingConfiguration,
11160
+ custom_event_specification: CustomEventSpecification,
11154
11161
  _request_timeout: Union[
11155
11162
  None,
11156
11163
  Annotated[StrictFloat, Field(gt=0)],
@@ -11163,15 +11170,12 @@ class EventSettingsApi:
11163
11170
  _content_type: Optional[StrictStr] = None,
11164
11171
  _headers: Optional[Dict[StrictStr, Any]] = None,
11165
11172
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11166
- ) -> AlertingConfigurationWithLastUpdated:
11167
- """Create or update Alert Configuration
11173
+ ) -> CustomEventSpecificationWithLastUpdated:
11174
+ """Create new custom event specification
11168
11175
 
11169
- Create or update a specific Alert configuration by ID
11170
11176
 
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
11177
+ :param custom_event_specification: (required)
11178
+ :type custom_event_specification: CustomEventSpecification
11175
11179
  :param _request_timeout: timeout setting for this request. If one
11176
11180
  number provided, it will be total request
11177
11181
  timeout. It can also be a pair (tuple) of
@@ -11194,9 +11198,8 @@ class EventSettingsApi:
11194
11198
  :return: Returns the result object.
11195
11199
  """ # noqa: E501
11196
11200
 
11197
- _param = self._put_alert_serialize(
11198
- id=id,
11199
- alerting_configuration=alerting_configuration,
11201
+ _param = self._post_custom_event_specification_serialize(
11202
+ custom_event_specification=custom_event_specification,
11200
11203
  _request_auth=_request_auth,
11201
11204
  _content_type=_content_type,
11202
11205
  _headers=_headers,
@@ -11204,10 +11207,7 @@ class EventSettingsApi:
11204
11207
  )
11205
11208
 
11206
11209
  _response_types_map: Dict[str, Optional[str]] = {
11207
- '200': "AlertingConfigurationWithLastUpdated",
11208
- '401': None,
11209
- '403': None,
11210
- '422': None,
11210
+ '200': "CustomEventSpecificationWithLastUpdated",
11211
11211
  }
11212
11212
  response_data = self.api_client.call_api(
11213
11213
  *_param,
@@ -11221,10 +11221,9 @@ class EventSettingsApi:
11221
11221
 
11222
11222
 
11223
11223
  @validate_call
11224
- def put_alert_with_http_info(
11224
+ def post_custom_event_specification_with_http_info(
11225
11225
  self,
11226
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11227
- alerting_configuration: AlertingConfiguration,
11226
+ custom_event_specification: CustomEventSpecification,
11228
11227
  _request_timeout: Union[
11229
11228
  None,
11230
11229
  Annotated[StrictFloat, Field(gt=0)],
@@ -11237,15 +11236,12 @@ class EventSettingsApi:
11237
11236
  _content_type: Optional[StrictStr] = None,
11238
11237
  _headers: Optional[Dict[StrictStr, Any]] = None,
11239
11238
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11240
- ) -> ApiResponse[AlertingConfigurationWithLastUpdated]:
11241
- """Create or update Alert Configuration
11239
+ ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
11240
+ """Create new custom event specification
11242
11241
 
11243
- Create or update a specific Alert configuration by ID
11244
11242
 
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
11243
+ :param custom_event_specification: (required)
11244
+ :type custom_event_specification: CustomEventSpecification
11249
11245
  :param _request_timeout: timeout setting for this request. If one
11250
11246
  number provided, it will be total request
11251
11247
  timeout. It can also be a pair (tuple) of
@@ -11268,9 +11264,8 @@ class EventSettingsApi:
11268
11264
  :return: Returns the result object.
11269
11265
  """ # noqa: E501
11270
11266
 
11271
- _param = self._put_alert_serialize(
11272
- id=id,
11273
- alerting_configuration=alerting_configuration,
11267
+ _param = self._post_custom_event_specification_serialize(
11268
+ custom_event_specification=custom_event_specification,
11274
11269
  _request_auth=_request_auth,
11275
11270
  _content_type=_content_type,
11276
11271
  _headers=_headers,
@@ -11278,10 +11273,7 @@ class EventSettingsApi:
11278
11273
  )
11279
11274
 
11280
11275
  _response_types_map: Dict[str, Optional[str]] = {
11281
- '200': "AlertingConfigurationWithLastUpdated",
11282
- '401': None,
11283
- '403': None,
11284
- '422': None,
11276
+ '200': "CustomEventSpecificationWithLastUpdated",
11285
11277
  }
11286
11278
  response_data = self.api_client.call_api(
11287
11279
  *_param,
@@ -11295,10 +11287,9 @@ class EventSettingsApi:
11295
11287
 
11296
11288
 
11297
11289
  @validate_call
11298
- def put_alert_without_preload_content(
11290
+ def post_custom_event_specification_without_preload_content(
11299
11291
  self,
11300
- id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11301
- alerting_configuration: AlertingConfiguration,
11292
+ custom_event_specification: CustomEventSpecification,
11302
11293
  _request_timeout: Union[
11303
11294
  None,
11304
11295
  Annotated[StrictFloat, Field(gt=0)],
@@ -11312,14 +11303,11 @@ class EventSettingsApi:
11312
11303
  _headers: Optional[Dict[StrictStr, Any]] = None,
11313
11304
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11314
11305
  ) -> RESTResponseType:
11315
- """Create or update Alert Configuration
11306
+ """Create new custom event specification
11316
11307
 
11317
- Create or update a specific Alert configuration by ID
11318
11308
 
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
11309
+ :param custom_event_specification: (required)
11310
+ :type custom_event_specification: CustomEventSpecification
11323
11311
  :param _request_timeout: timeout setting for this request. If one
11324
11312
  number provided, it will be total request
11325
11313
  timeout. It can also be a pair (tuple) of
@@ -11342,9 +11330,8 @@ class EventSettingsApi:
11342
11330
  :return: Returns the result object.
11343
11331
  """ # noqa: E501
11344
11332
 
11345
- _param = self._put_alert_serialize(
11346
- id=id,
11347
- alerting_configuration=alerting_configuration,
11333
+ _param = self._post_custom_event_specification_serialize(
11334
+ custom_event_specification=custom_event_specification,
11348
11335
  _request_auth=_request_auth,
11349
11336
  _content_type=_content_type,
11350
11337
  _headers=_headers,
@@ -11352,10 +11339,7 @@ class EventSettingsApi:
11352
11339
  )
11353
11340
 
11354
11341
  _response_types_map: Dict[str, Optional[str]] = {
11355
- '200': "AlertingConfigurationWithLastUpdated",
11356
- '401': None,
11357
- '403': None,
11358
- '422': None,
11342
+ '200': "CustomEventSpecificationWithLastUpdated",
11359
11343
  }
11360
11344
  response_data = self.api_client.call_api(
11361
11345
  *_param,
@@ -11364,10 +11348,9 @@ class EventSettingsApi:
11364
11348
  return response_data.response
11365
11349
 
11366
11350
 
11367
- def _put_alert_serialize(
11351
+ def _post_custom_event_specification_serialize(
11368
11352
  self,
11369
- id,
11370
- alerting_configuration,
11353
+ custom_event_specification,
11371
11354
  _request_auth,
11372
11355
  _content_type,
11373
11356
  _headers,
@@ -11389,14 +11372,12 @@ class EventSettingsApi:
11389
11372
  _body_params: Optional[bytes] = None
11390
11373
 
11391
11374
  # process the path parameters
11392
- if id is not None:
11393
- _path_params['id'] = id
11394
11375
  # process the query parameters
11395
11376
  # process the header parameters
11396
11377
  # process the form parameters
11397
11378
  # process the body parameter
11398
- if alerting_configuration is not None:
11399
- _body_params = alerting_configuration
11379
+ if custom_event_specification is not None:
11380
+ _body_params = custom_event_specification
11400
11381
 
11401
11382
 
11402
11383
  # set the HTTP header `Accept`
@@ -11427,8 +11408,8 @@ class EventSettingsApi:
11427
11408
  ]
11428
11409
 
11429
11410
  return self.api_client.param_serialize(
11430
- method='PUT',
11431
- resource_path='/api/events/settings/alerts/{id}',
11411
+ method='POST',
11412
+ resource_path='/api/events/settings/event-specifications/custom',
11432
11413
  path_params=_path_params,
11433
11414
  query_params=_query_params,
11434
11415
  header_params=_header_params,
@@ -11445,10 +11426,10 @@ class EventSettingsApi:
11445
11426
 
11446
11427
 
11447
11428
  @validate_call
11448
- def put_alerting_channel(
11429
+ def put_alert(
11449
11430
  self,
11450
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11451
- abstract_integration: AbstractIntegration,
11431
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11432
+ alerting_configuration: AlertingConfiguration,
11452
11433
  _request_timeout: Union[
11453
11434
  None,
11454
11435
  Annotated[StrictFloat, Field(gt=0)],
@@ -11461,15 +11442,15 @@ class EventSettingsApi:
11461
11442
  _content_type: Optional[StrictStr] = None,
11462
11443
  _headers: Optional[Dict[StrictStr, Any]] = None,
11463
11444
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11464
- ) -> AbstractIntegration:
11465
- """Update Alert Channel
11445
+ ) -> AlertingConfigurationWithLastUpdated:
11446
+ """Create or update Alert Configuration
11466
11447
 
11467
- Updates an alerting channel.
11448
+ Create or update a specific Alert configuration by ID
11468
11449
 
11469
- :param id: ID of the Alerting Channel to update. (required)
11450
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11470
11451
  :type id: str
11471
- :param abstract_integration: (required)
11472
- :type abstract_integration: AbstractIntegration
11452
+ :param alerting_configuration: (required)
11453
+ :type alerting_configuration: AlertingConfiguration
11473
11454
  :param _request_timeout: timeout setting for this request. If one
11474
11455
  number provided, it will be total request
11475
11456
  timeout. It can also be a pair (tuple) of
@@ -11492,9 +11473,9 @@ class EventSettingsApi:
11492
11473
  :return: Returns the result object.
11493
11474
  """ # noqa: E501
11494
11475
 
11495
- _param = self._put_alerting_channel_serialize(
11476
+ _param = self._put_alert_serialize(
11496
11477
  id=id,
11497
- abstract_integration=abstract_integration,
11478
+ alerting_configuration=alerting_configuration,
11498
11479
  _request_auth=_request_auth,
11499
11480
  _content_type=_content_type,
11500
11481
  _headers=_headers,
@@ -11502,10 +11483,12 @@ class EventSettingsApi:
11502
11483
  )
11503
11484
 
11504
11485
  _response_types_map: Dict[str, Optional[str]] = {
11505
- '200': "AbstractIntegration",
11506
- '400': "str",
11507
- }
11508
- response_data = self.api_client.call_api(
11486
+ '200': "AlertingConfigurationWithLastUpdated",
11487
+ '401': None,
11488
+ '403': None,
11489
+ '422': None,
11490
+ }
11491
+ response_data = self.api_client.call_api(
11509
11492
  *_param,
11510
11493
  _request_timeout=_request_timeout
11511
11494
  )
@@ -11517,10 +11500,10 @@ class EventSettingsApi:
11517
11500
 
11518
11501
 
11519
11502
  @validate_call
11520
- def put_alerting_channel_with_http_info(
11503
+ def put_alert_with_http_info(
11521
11504
  self,
11522
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11523
- abstract_integration: AbstractIntegration,
11505
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11506
+ alerting_configuration: AlertingConfiguration,
11524
11507
  _request_timeout: Union[
11525
11508
  None,
11526
11509
  Annotated[StrictFloat, Field(gt=0)],
@@ -11533,15 +11516,15 @@ class EventSettingsApi:
11533
11516
  _content_type: Optional[StrictStr] = None,
11534
11517
  _headers: Optional[Dict[StrictStr, Any]] = None,
11535
11518
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11536
- ) -> ApiResponse[AbstractIntegration]:
11537
- """Update Alert Channel
11519
+ ) -> ApiResponse[AlertingConfigurationWithLastUpdated]:
11520
+ """Create or update Alert Configuration
11538
11521
 
11539
- Updates an alerting channel.
11522
+ Create or update a specific Alert configuration by ID
11540
11523
 
11541
- :param id: ID of the Alerting Channel to update. (required)
11524
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11542
11525
  :type id: str
11543
- :param abstract_integration: (required)
11544
- :type abstract_integration: AbstractIntegration
11526
+ :param alerting_configuration: (required)
11527
+ :type alerting_configuration: AlertingConfiguration
11545
11528
  :param _request_timeout: timeout setting for this request. If one
11546
11529
  number provided, it will be total request
11547
11530
  timeout. It can also be a pair (tuple) of
@@ -11564,9 +11547,9 @@ class EventSettingsApi:
11564
11547
  :return: Returns the result object.
11565
11548
  """ # noqa: E501
11566
11549
 
11567
- _param = self._put_alerting_channel_serialize(
11550
+ _param = self._put_alert_serialize(
11568
11551
  id=id,
11569
- abstract_integration=abstract_integration,
11552
+ alerting_configuration=alerting_configuration,
11570
11553
  _request_auth=_request_auth,
11571
11554
  _content_type=_content_type,
11572
11555
  _headers=_headers,
@@ -11574,8 +11557,10 @@ class EventSettingsApi:
11574
11557
  )
11575
11558
 
11576
11559
  _response_types_map: Dict[str, Optional[str]] = {
11577
- '200': "AbstractIntegration",
11578
- '400': "str",
11560
+ '200': "AlertingConfigurationWithLastUpdated",
11561
+ '401': None,
11562
+ '403': None,
11563
+ '422': None,
11579
11564
  }
11580
11565
  response_data = self.api_client.call_api(
11581
11566
  *_param,
@@ -11589,10 +11574,10 @@ class EventSettingsApi:
11589
11574
 
11590
11575
 
11591
11576
  @validate_call
11592
- def put_alerting_channel_without_preload_content(
11577
+ def put_alert_without_preload_content(
11593
11578
  self,
11594
- id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11595
- abstract_integration: AbstractIntegration,
11579
+ id: Annotated[StrictStr, Field(description="ID of a specific Alert Configuration to create or update.")],
11580
+ alerting_configuration: AlertingConfiguration,
11596
11581
  _request_timeout: Union[
11597
11582
  None,
11598
11583
  Annotated[StrictFloat, Field(gt=0)],
@@ -11606,14 +11591,14 @@ class EventSettingsApi:
11606
11591
  _headers: Optional[Dict[StrictStr, Any]] = None,
11607
11592
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11608
11593
  ) -> RESTResponseType:
11609
- """Update Alert Channel
11594
+ """Create or update Alert Configuration
11610
11595
 
11611
- Updates an alerting channel.
11596
+ Create or update a specific Alert configuration by ID
11612
11597
 
11613
- :param id: ID of the Alerting Channel to update. (required)
11598
+ :param id: ID of a specific Alert Configuration to create or update. (required)
11614
11599
  :type id: str
11615
- :param abstract_integration: (required)
11616
- :type abstract_integration: AbstractIntegration
11600
+ :param alerting_configuration: (required)
11601
+ :type alerting_configuration: AlertingConfiguration
11617
11602
  :param _request_timeout: timeout setting for this request. If one
11618
11603
  number provided, it will be total request
11619
11604
  timeout. It can also be a pair (tuple) of
@@ -11636,9 +11621,9 @@ class EventSettingsApi:
11636
11621
  :return: Returns the result object.
11637
11622
  """ # noqa: E501
11638
11623
 
11639
- _param = self._put_alerting_channel_serialize(
11624
+ _param = self._put_alert_serialize(
11640
11625
  id=id,
11641
- abstract_integration=abstract_integration,
11626
+ alerting_configuration=alerting_configuration,
11642
11627
  _request_auth=_request_auth,
11643
11628
  _content_type=_content_type,
11644
11629
  _headers=_headers,
@@ -11646,8 +11631,10 @@ class EventSettingsApi:
11646
11631
  )
11647
11632
 
11648
11633
  _response_types_map: Dict[str, Optional[str]] = {
11649
- '200': "AbstractIntegration",
11650
- '400': "str",
11634
+ '200': "AlertingConfigurationWithLastUpdated",
11635
+ '401': None,
11636
+ '403': None,
11637
+ '422': None,
11651
11638
  }
11652
11639
  response_data = self.api_client.call_api(
11653
11640
  *_param,
@@ -11656,10 +11643,10 @@ class EventSettingsApi:
11656
11643
  return response_data.response
11657
11644
 
11658
11645
 
11659
- def _put_alerting_channel_serialize(
11646
+ def _put_alert_serialize(
11660
11647
  self,
11661
11648
  id,
11662
- abstract_integration,
11649
+ alerting_configuration,
11663
11650
  _request_auth,
11664
11651
  _content_type,
11665
11652
  _headers,
@@ -11687,8 +11674,8 @@ class EventSettingsApi:
11687
11674
  # process the header parameters
11688
11675
  # process the form parameters
11689
11676
  # process the body parameter
11690
- if abstract_integration is not None:
11691
- _body_params = abstract_integration
11677
+ if alerting_configuration is not None:
11678
+ _body_params = alerting_configuration
11692
11679
 
11693
11680
 
11694
11681
  # set the HTTP header `Accept`
@@ -11720,7 +11707,7 @@ class EventSettingsApi:
11720
11707
 
11721
11708
  return self.api_client.param_serialize(
11722
11709
  method='PUT',
11723
- resource_path='/api/events/settings/alertingChannels/{id}',
11710
+ resource_path='/api/events/settings/alerts/{id}',
11724
11711
  path_params=_path_params,
11725
11712
  query_params=_query_params,
11726
11713
  header_params=_header_params,
@@ -11737,11 +11724,10 @@ class EventSettingsApi:
11737
11724
 
11738
11725
 
11739
11726
  @validate_call
11740
- def put_custom_event_specification(
11727
+ def put_alerting_channel(
11741
11728
  self,
11742
- event_specification_id: StrictStr,
11743
- custom_event_specification: CustomEventSpecification,
11744
- allow_restore: Optional[StrictBool] = None,
11729
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11730
+ abstract_integration: AbstractIntegration,
11745
11731
  _request_timeout: Union[
11746
11732
  None,
11747
11733
  Annotated[StrictFloat, Field(gt=0)],
@@ -11754,17 +11740,15 @@ class EventSettingsApi:
11754
11740
  _content_type: Optional[StrictStr] = None,
11755
11741
  _headers: Optional[Dict[StrictStr, Any]] = None,
11756
11742
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11757
- ) -> CustomEventSpecificationWithLastUpdated:
11758
- """Create or update custom event specification
11743
+ ) -> AbstractIntegration:
11744
+ """Update Alert Channel
11759
11745
 
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).
11746
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11761
11747
 
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
11748
+ :param id: ID of the Alerting Channel to update. (required)
11749
+ :type id: str
11750
+ :param abstract_integration: (required)
11751
+ :type abstract_integration: AbstractIntegration
11768
11752
  :param _request_timeout: timeout setting for this request. If one
11769
11753
  number provided, it will be total request
11770
11754
  timeout. It can also be a pair (tuple) of
@@ -11787,10 +11771,9 @@ class EventSettingsApi:
11787
11771
  :return: Returns the result object.
11788
11772
  """ # noqa: E501
11789
11773
 
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,
11774
+ _param = self._put_alerting_channel_serialize(
11775
+ id=id,
11776
+ abstract_integration=abstract_integration,
11794
11777
  _request_auth=_request_auth,
11795
11778
  _content_type=_content_type,
11796
11779
  _headers=_headers,
@@ -11798,7 +11781,9 @@ class EventSettingsApi:
11798
11781
  )
11799
11782
 
11800
11783
  _response_types_map: Dict[str, Optional[str]] = {
11801
- '200': "CustomEventSpecificationWithLastUpdated",
11784
+ '200': "AbstractIntegration",
11785
+ '302': None,
11786
+ '400': "str",
11802
11787
  }
11803
11788
  response_data = self.api_client.call_api(
11804
11789
  *_param,
@@ -11812,11 +11797,10 @@ class EventSettingsApi:
11812
11797
 
11813
11798
 
11814
11799
  @validate_call
11815
- def put_custom_event_specification_with_http_info(
11800
+ def put_alerting_channel_with_http_info(
11816
11801
  self,
11817
- event_specification_id: StrictStr,
11818
- custom_event_specification: CustomEventSpecification,
11819
- allow_restore: Optional[StrictBool] = None,
11802
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11803
+ abstract_integration: AbstractIntegration,
11820
11804
  _request_timeout: Union[
11821
11805
  None,
11822
11806
  Annotated[StrictFloat, Field(gt=0)],
@@ -11829,17 +11813,15 @@ class EventSettingsApi:
11829
11813
  _content_type: Optional[StrictStr] = None,
11830
11814
  _headers: Optional[Dict[StrictStr, Any]] = None,
11831
11815
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11832
- ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
11833
- """Create or update custom event specification
11816
+ ) -> ApiResponse[AbstractIntegration]:
11817
+ """Update Alert Channel
11834
11818
 
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).
11819
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11836
11820
 
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
11821
+ :param id: ID of the Alerting Channel to update. (required)
11822
+ :type id: str
11823
+ :param abstract_integration: (required)
11824
+ :type abstract_integration: AbstractIntegration
11843
11825
  :param _request_timeout: timeout setting for this request. If one
11844
11826
  number provided, it will be total request
11845
11827
  timeout. It can also be a pair (tuple) of
@@ -11862,10 +11844,9 @@ class EventSettingsApi:
11862
11844
  :return: Returns the result object.
11863
11845
  """ # noqa: E501
11864
11846
 
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,
11847
+ _param = self._put_alerting_channel_serialize(
11848
+ id=id,
11849
+ abstract_integration=abstract_integration,
11869
11850
  _request_auth=_request_auth,
11870
11851
  _content_type=_content_type,
11871
11852
  _headers=_headers,
@@ -11873,7 +11854,9 @@ class EventSettingsApi:
11873
11854
  )
11874
11855
 
11875
11856
  _response_types_map: Dict[str, Optional[str]] = {
11876
- '200': "CustomEventSpecificationWithLastUpdated",
11857
+ '200': "AbstractIntegration",
11858
+ '302': None,
11859
+ '400': "str",
11877
11860
  }
11878
11861
  response_data = self.api_client.call_api(
11879
11862
  *_param,
@@ -11887,11 +11870,10 @@ class EventSettingsApi:
11887
11870
 
11888
11871
 
11889
11872
  @validate_call
11890
- def put_custom_event_specification_without_preload_content(
11873
+ def put_alerting_channel_without_preload_content(
11891
11874
  self,
11892
- event_specification_id: StrictStr,
11893
- custom_event_specification: CustomEventSpecification,
11894
- allow_restore: Optional[StrictBool] = None,
11875
+ id: Annotated[StrictStr, Field(description="ID of the Alerting Channel to update.")],
11876
+ abstract_integration: AbstractIntegration,
11895
11877
  _request_timeout: Union[
11896
11878
  None,
11897
11879
  Annotated[StrictFloat, Field(gt=0)],
@@ -11905,16 +11887,623 @@ class EventSettingsApi:
11905
11887
  _headers: Optional[Dict[StrictStr, Any]] = None,
11906
11888
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
11907
11889
  ) -> RESTResponseType:
11908
- """Create or update custom event specification
11890
+ """Update Alert Channel
11909
11891
 
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).
11892
+ Updates an alerting channel. Requires the permission called CanConfigureIntegrations.
11911
11893
 
11912
- :param event_specification_id: (required)
11913
- :type event_specification_id: str
11914
- :param custom_event_specification: (required)
11915
- :type custom_event_specification: CustomEventSpecification
11916
- :param allow_restore:
11917
- :type allow_restore: bool
11894
+ :param id: ID of the Alerting Channel to update. (required)
11895
+ :type id: str
11896
+ :param abstract_integration: (required)
11897
+ :type abstract_integration: AbstractIntegration
11898
+ :param _request_timeout: timeout setting for this request. If one
11899
+ number provided, it will be total request
11900
+ timeout. It can also be a pair (tuple) of
11901
+ (connection, read) timeouts.
11902
+ :type _request_timeout: int, tuple(int, int), optional
11903
+ :param _request_auth: set to override the auth_settings for an a single
11904
+ request; this effectively ignores the
11905
+ authentication in the spec for a single request.
11906
+ :type _request_auth: dict, optional
11907
+ :param _content_type: force content-type for the request.
11908
+ :type _content_type: str, Optional
11909
+ :param _headers: set to override the headers for a single
11910
+ request; this effectively ignores the headers
11911
+ in the spec for a single request.
11912
+ :type _headers: dict, optional
11913
+ :param _host_index: set to override the host_index for a single
11914
+ request; this effectively ignores the host_index
11915
+ in the spec for a single request.
11916
+ :type _host_index: int, optional
11917
+ :return: Returns the result object.
11918
+ """ # noqa: E501
11919
+
11920
+ _param = self._put_alerting_channel_serialize(
11921
+ id=id,
11922
+ abstract_integration=abstract_integration,
11923
+ _request_auth=_request_auth,
11924
+ _content_type=_content_type,
11925
+ _headers=_headers,
11926
+ _host_index=_host_index
11927
+ )
11928
+
11929
+ _response_types_map: Dict[str, Optional[str]] = {
11930
+ '200': "AbstractIntegration",
11931
+ '302': None,
11932
+ '400': "str",
11933
+ }
11934
+ response_data = self.api_client.call_api(
11935
+ *_param,
11936
+ _request_timeout=_request_timeout
11937
+ )
11938
+ return response_data.response
11939
+
11940
+
11941
+ def _put_alerting_channel_serialize(
11942
+ self,
11943
+ id,
11944
+ abstract_integration,
11945
+ _request_auth,
11946
+ _content_type,
11947
+ _headers,
11948
+ _host_index,
11949
+ ) -> RequestSerialized:
11950
+
11951
+ _host = None
11952
+
11953
+ _collection_formats: Dict[str, str] = {
11954
+ }
11955
+
11956
+ _path_params: Dict[str, str] = {}
11957
+ _query_params: List[Tuple[str, str]] = []
11958
+ _header_params: Dict[str, Optional[str]] = _headers or {}
11959
+ _form_params: List[Tuple[str, str]] = []
11960
+ _files: Dict[
11961
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
11962
+ ] = {}
11963
+ _body_params: Optional[bytes] = None
11964
+
11965
+ # process the path parameters
11966
+ if id is not None:
11967
+ _path_params['id'] = id
11968
+ # process the query parameters
11969
+ # process the header parameters
11970
+ # process the form parameters
11971
+ # process the body parameter
11972
+ if abstract_integration is not None:
11973
+ _body_params = abstract_integration
11974
+
11975
+
11976
+ # set the HTTP header `Accept`
11977
+ if 'Accept' not in _header_params:
11978
+ _header_params['Accept'] = self.api_client.select_header_accept(
11979
+ [
11980
+ 'application/json'
11981
+ ]
11982
+ )
11983
+
11984
+ # set the HTTP header `Content-Type`
11985
+ if _content_type:
11986
+ _header_params['Content-Type'] = _content_type
11987
+ else:
11988
+ _default_content_type = (
11989
+ self.api_client.select_header_content_type(
11990
+ [
11991
+ 'application/json'
11992
+ ]
11993
+ )
11994
+ )
11995
+ if _default_content_type is not None:
11996
+ _header_params['Content-Type'] = _default_content_type
11997
+
11998
+ # authentication setting
11999
+ _auth_settings: List[str] = [
12000
+ 'ApiKeyAuth'
12001
+ ]
12002
+
12003
+ return self.api_client.param_serialize(
12004
+ method='PUT',
12005
+ resource_path='/api/events/settings/alertingChannels/{id}',
12006
+ path_params=_path_params,
12007
+ query_params=_query_params,
12008
+ header_params=_header_params,
12009
+ body=_body_params,
12010
+ post_params=_form_params,
12011
+ files=_files,
12012
+ auth_settings=_auth_settings,
12013
+ collection_formats=_collection_formats,
12014
+ _host=_host,
12015
+ _request_auth=_request_auth
12016
+ )
12017
+
12018
+
12019
+
12020
+
12021
+ @validate_call
12022
+ def put_custom_event_specification(
12023
+ self,
12024
+ event_specification_id: StrictStr,
12025
+ custom_event_specification: CustomEventSpecification,
12026
+ allow_restore: Optional[StrictBool] = None,
12027
+ _request_timeout: Union[
12028
+ None,
12029
+ Annotated[StrictFloat, Field(gt=0)],
12030
+ Tuple[
12031
+ Annotated[StrictFloat, Field(gt=0)],
12032
+ Annotated[StrictFloat, Field(gt=0)]
12033
+ ]
12034
+ ] = None,
12035
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12036
+ _content_type: Optional[StrictStr] = None,
12037
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12038
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12039
+ ) -> CustomEventSpecificationWithLastUpdated:
12040
+ """Create or update custom event specification
12041
+
12042
+
12043
+ :param event_specification_id: (required)
12044
+ :type event_specification_id: str
12045
+ :param custom_event_specification: (required)
12046
+ :type custom_event_specification: CustomEventSpecification
12047
+ :param allow_restore:
12048
+ :type allow_restore: bool
12049
+ :param _request_timeout: timeout setting for this request. If one
12050
+ number provided, it will be total request
12051
+ timeout. It can also be a pair (tuple) of
12052
+ (connection, read) timeouts.
12053
+ :type _request_timeout: int, tuple(int, int), optional
12054
+ :param _request_auth: set to override the auth_settings for an a single
12055
+ request; this effectively ignores the
12056
+ authentication in the spec for a single request.
12057
+ :type _request_auth: dict, optional
12058
+ :param _content_type: force content-type for the request.
12059
+ :type _content_type: str, Optional
12060
+ :param _headers: set to override the headers for a single
12061
+ request; this effectively ignores the headers
12062
+ in the spec for a single request.
12063
+ :type _headers: dict, optional
12064
+ :param _host_index: set to override the host_index for a single
12065
+ request; this effectively ignores the host_index
12066
+ in the spec for a single request.
12067
+ :type _host_index: int, optional
12068
+ :return: Returns the result object.
12069
+ """ # noqa: E501
12070
+
12071
+ _param = self._put_custom_event_specification_serialize(
12072
+ event_specification_id=event_specification_id,
12073
+ custom_event_specification=custom_event_specification,
12074
+ allow_restore=allow_restore,
12075
+ _request_auth=_request_auth,
12076
+ _content_type=_content_type,
12077
+ _headers=_headers,
12078
+ _host_index=_host_index
12079
+ )
12080
+
12081
+ _response_types_map: Dict[str, Optional[str]] = {
12082
+ '200': "CustomEventSpecificationWithLastUpdated",
12083
+ }
12084
+ response_data = self.api_client.call_api(
12085
+ *_param,
12086
+ _request_timeout=_request_timeout
12087
+ )
12088
+ response_data.read()
12089
+ return self.api_client.response_deserialize(
12090
+ response_data=response_data,
12091
+ response_types_map=_response_types_map,
12092
+ ).data
12093
+
12094
+
12095
+ @validate_call
12096
+ def put_custom_event_specification_with_http_info(
12097
+ self,
12098
+ event_specification_id: StrictStr,
12099
+ custom_event_specification: CustomEventSpecification,
12100
+ allow_restore: Optional[StrictBool] = None,
12101
+ _request_timeout: Union[
12102
+ None,
12103
+ Annotated[StrictFloat, Field(gt=0)],
12104
+ Tuple[
12105
+ Annotated[StrictFloat, Field(gt=0)],
12106
+ Annotated[StrictFloat, Field(gt=0)]
12107
+ ]
12108
+ ] = None,
12109
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12110
+ _content_type: Optional[StrictStr] = None,
12111
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12112
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12113
+ ) -> ApiResponse[CustomEventSpecificationWithLastUpdated]:
12114
+ """Create or update custom event specification
12115
+
12116
+
12117
+ :param event_specification_id: (required)
12118
+ :type event_specification_id: str
12119
+ :param custom_event_specification: (required)
12120
+ :type custom_event_specification: CustomEventSpecification
12121
+ :param allow_restore:
12122
+ :type allow_restore: bool
12123
+ :param _request_timeout: timeout setting for this request. If one
12124
+ number provided, it will be total request
12125
+ timeout. It can also be a pair (tuple) of
12126
+ (connection, read) timeouts.
12127
+ :type _request_timeout: int, tuple(int, int), optional
12128
+ :param _request_auth: set to override the auth_settings for an a single
12129
+ request; this effectively ignores the
12130
+ authentication in the spec for a single request.
12131
+ :type _request_auth: dict, optional
12132
+ :param _content_type: force content-type for the request.
12133
+ :type _content_type: str, Optional
12134
+ :param _headers: set to override the headers for a single
12135
+ request; this effectively ignores the headers
12136
+ in the spec for a single request.
12137
+ :type _headers: dict, optional
12138
+ :param _host_index: set to override the host_index for a single
12139
+ request; this effectively ignores the host_index
12140
+ in the spec for a single request.
12141
+ :type _host_index: int, optional
12142
+ :return: Returns the result object.
12143
+ """ # noqa: E501
12144
+
12145
+ _param = self._put_custom_event_specification_serialize(
12146
+ event_specification_id=event_specification_id,
12147
+ custom_event_specification=custom_event_specification,
12148
+ allow_restore=allow_restore,
12149
+ _request_auth=_request_auth,
12150
+ _content_type=_content_type,
12151
+ _headers=_headers,
12152
+ _host_index=_host_index
12153
+ )
12154
+
12155
+ _response_types_map: Dict[str, Optional[str]] = {
12156
+ '200': "CustomEventSpecificationWithLastUpdated",
12157
+ }
12158
+ response_data = self.api_client.call_api(
12159
+ *_param,
12160
+ _request_timeout=_request_timeout
12161
+ )
12162
+ response_data.read()
12163
+ return self.api_client.response_deserialize(
12164
+ response_data=response_data,
12165
+ response_types_map=_response_types_map,
12166
+ )
12167
+
12168
+
12169
+ @validate_call
12170
+ def put_custom_event_specification_without_preload_content(
12171
+ self,
12172
+ event_specification_id: StrictStr,
12173
+ custom_event_specification: CustomEventSpecification,
12174
+ allow_restore: Optional[StrictBool] = None,
12175
+ _request_timeout: Union[
12176
+ None,
12177
+ Annotated[StrictFloat, Field(gt=0)],
12178
+ Tuple[
12179
+ Annotated[StrictFloat, Field(gt=0)],
12180
+ Annotated[StrictFloat, Field(gt=0)]
12181
+ ]
12182
+ ] = None,
12183
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12184
+ _content_type: Optional[StrictStr] = None,
12185
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12186
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12187
+ ) -> RESTResponseType:
12188
+ """Create or update custom event specification
12189
+
12190
+
12191
+ :param event_specification_id: (required)
12192
+ :type event_specification_id: str
12193
+ :param custom_event_specification: (required)
12194
+ :type custom_event_specification: CustomEventSpecification
12195
+ :param allow_restore:
12196
+ :type allow_restore: bool
12197
+ :param _request_timeout: timeout setting for this request. If one
12198
+ number provided, it will be total request
12199
+ timeout. It can also be a pair (tuple) of
12200
+ (connection, read) timeouts.
12201
+ :type _request_timeout: int, tuple(int, int), optional
12202
+ :param _request_auth: set to override the auth_settings for an a single
12203
+ request; this effectively ignores the
12204
+ authentication in the spec for a single request.
12205
+ :type _request_auth: dict, optional
12206
+ :param _content_type: force content-type for the request.
12207
+ :type _content_type: str, Optional
12208
+ :param _headers: set to override the headers for a single
12209
+ request; this effectively ignores the headers
12210
+ in the spec for a single request.
12211
+ :type _headers: dict, optional
12212
+ :param _host_index: set to override the host_index for a single
12213
+ request; this effectively ignores the host_index
12214
+ in the spec for a single request.
12215
+ :type _host_index: int, optional
12216
+ :return: Returns the result object.
12217
+ """ # noqa: E501
12218
+
12219
+ _param = self._put_custom_event_specification_serialize(
12220
+ event_specification_id=event_specification_id,
12221
+ custom_event_specification=custom_event_specification,
12222
+ allow_restore=allow_restore,
12223
+ _request_auth=_request_auth,
12224
+ _content_type=_content_type,
12225
+ _headers=_headers,
12226
+ _host_index=_host_index
12227
+ )
12228
+
12229
+ _response_types_map: Dict[str, Optional[str]] = {
12230
+ '200': "CustomEventSpecificationWithLastUpdated",
12231
+ }
12232
+ response_data = self.api_client.call_api(
12233
+ *_param,
12234
+ _request_timeout=_request_timeout
12235
+ )
12236
+ return response_data.response
12237
+
12238
+
12239
+ def _put_custom_event_specification_serialize(
12240
+ self,
12241
+ event_specification_id,
12242
+ custom_event_specification,
12243
+ allow_restore,
12244
+ _request_auth,
12245
+ _content_type,
12246
+ _headers,
12247
+ _host_index,
12248
+ ) -> RequestSerialized:
12249
+
12250
+ _host = None
12251
+
12252
+ _collection_formats: Dict[str, str] = {
12253
+ }
12254
+
12255
+ _path_params: Dict[str, str] = {}
12256
+ _query_params: List[Tuple[str, str]] = []
12257
+ _header_params: Dict[str, Optional[str]] = _headers or {}
12258
+ _form_params: List[Tuple[str, str]] = []
12259
+ _files: Dict[
12260
+ str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
12261
+ ] = {}
12262
+ _body_params: Optional[bytes] = None
12263
+
12264
+ # process the path parameters
12265
+ if event_specification_id is not None:
12266
+ _path_params['eventSpecificationId'] = event_specification_id
12267
+ # process the query parameters
12268
+ if allow_restore is not None:
12269
+
12270
+ _query_params.append(('allowRestore', allow_restore))
12271
+
12272
+ # process the header parameters
12273
+ # process the form parameters
12274
+ # process the body parameter
12275
+ if custom_event_specification is not None:
12276
+ _body_params = custom_event_specification
12277
+
12278
+
12279
+ # set the HTTP header `Accept`
12280
+ if 'Accept' not in _header_params:
12281
+ _header_params['Accept'] = self.api_client.select_header_accept(
12282
+ [
12283
+ 'application/json'
12284
+ ]
12285
+ )
12286
+
12287
+ # set the HTTP header `Content-Type`
12288
+ if _content_type:
12289
+ _header_params['Content-Type'] = _content_type
12290
+ else:
12291
+ _default_content_type = (
12292
+ self.api_client.select_header_content_type(
12293
+ [
12294
+ 'application/json'
12295
+ ]
12296
+ )
12297
+ )
12298
+ if _default_content_type is not None:
12299
+ _header_params['Content-Type'] = _default_content_type
12300
+
12301
+ # authentication setting
12302
+ _auth_settings: List[str] = [
12303
+ 'ApiKeyAuth'
12304
+ ]
12305
+
12306
+ return self.api_client.param_serialize(
12307
+ method='PUT',
12308
+ resource_path='/api/events/settings/event-specifications/custom/{eventSpecificationId}',
12309
+ path_params=_path_params,
12310
+ query_params=_query_params,
12311
+ header_params=_header_params,
12312
+ body=_body_params,
12313
+ post_params=_form_params,
12314
+ files=_files,
12315
+ auth_settings=_auth_settings,
12316
+ collection_formats=_collection_formats,
12317
+ _host=_host,
12318
+ _request_auth=_request_auth
12319
+ )
12320
+
12321
+
12322
+
12323
+
12324
+ @validate_call
12325
+ def restore_mobile_app_alert_config(
12326
+ self,
12327
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12328
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12329
+ body: Optional[StrictStr] = None,
12330
+ _request_timeout: Union[
12331
+ None,
12332
+ Annotated[StrictFloat, Field(gt=0)],
12333
+ Tuple[
12334
+ Annotated[StrictFloat, Field(gt=0)],
12335
+ Annotated[StrictFloat, Field(gt=0)]
12336
+ ]
12337
+ ] = None,
12338
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12339
+ _content_type: Optional[StrictStr] = None,
12340
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12341
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12342
+ ) -> None:
12343
+ """Restore Mobile Smart Alert Config
12344
+
12345
+ Restores a Mobile Smart Alert Configuration.
12346
+
12347
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12348
+ :type id: str
12349
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12350
+ :type created: int
12351
+ :param body:
12352
+ :type body: str
12353
+ :param _request_timeout: timeout setting for this request. If one
12354
+ number provided, it will be total request
12355
+ timeout. It can also be a pair (tuple) of
12356
+ (connection, read) timeouts.
12357
+ :type _request_timeout: int, tuple(int, int), optional
12358
+ :param _request_auth: set to override the auth_settings for an a single
12359
+ request; this effectively ignores the
12360
+ authentication in the spec for a single request.
12361
+ :type _request_auth: dict, optional
12362
+ :param _content_type: force content-type for the request.
12363
+ :type _content_type: str, Optional
12364
+ :param _headers: set to override the headers for a single
12365
+ request; this effectively ignores the headers
12366
+ in the spec for a single request.
12367
+ :type _headers: dict, optional
12368
+ :param _host_index: set to override the host_index for a single
12369
+ request; this effectively ignores the host_index
12370
+ in the spec for a single request.
12371
+ :type _host_index: int, optional
12372
+ :return: Returns the result object.
12373
+ """ # noqa: E501
12374
+
12375
+ _param = self._restore_mobile_app_alert_config_serialize(
12376
+ id=id,
12377
+ created=created,
12378
+ body=body,
12379
+ _request_auth=_request_auth,
12380
+ _content_type=_content_type,
12381
+ _headers=_headers,
12382
+ _host_index=_host_index
12383
+ )
12384
+
12385
+ _response_types_map: Dict[str, Optional[str]] = {
12386
+ '204': None,
12387
+ '403': None,
12388
+ '404': None,
12389
+ }
12390
+ response_data = self.api_client.call_api(
12391
+ *_param,
12392
+ _request_timeout=_request_timeout
12393
+ )
12394
+ response_data.read()
12395
+ return self.api_client.response_deserialize(
12396
+ response_data=response_data,
12397
+ response_types_map=_response_types_map,
12398
+ ).data
12399
+
12400
+
12401
+ @validate_call
12402
+ def restore_mobile_app_alert_config_with_http_info(
12403
+ self,
12404
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12405
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12406
+ body: Optional[StrictStr] = None,
12407
+ _request_timeout: Union[
12408
+ None,
12409
+ Annotated[StrictFloat, Field(gt=0)],
12410
+ Tuple[
12411
+ Annotated[StrictFloat, Field(gt=0)],
12412
+ Annotated[StrictFloat, Field(gt=0)]
12413
+ ]
12414
+ ] = None,
12415
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12416
+ _content_type: Optional[StrictStr] = None,
12417
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12418
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12419
+ ) -> ApiResponse[None]:
12420
+ """Restore Mobile Smart Alert Config
12421
+
12422
+ Restores a Mobile Smart Alert Configuration.
12423
+
12424
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12425
+ :type id: str
12426
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12427
+ :type created: int
12428
+ :param body:
12429
+ :type body: str
12430
+ :param _request_timeout: timeout setting for this request. If one
12431
+ number provided, it will be total request
12432
+ timeout. It can also be a pair (tuple) of
12433
+ (connection, read) timeouts.
12434
+ :type _request_timeout: int, tuple(int, int), optional
12435
+ :param _request_auth: set to override the auth_settings for an a single
12436
+ request; this effectively ignores the
12437
+ authentication in the spec for a single request.
12438
+ :type _request_auth: dict, optional
12439
+ :param _content_type: force content-type for the request.
12440
+ :type _content_type: str, Optional
12441
+ :param _headers: set to override the headers for a single
12442
+ request; this effectively ignores the headers
12443
+ in the spec for a single request.
12444
+ :type _headers: dict, optional
12445
+ :param _host_index: set to override the host_index for a single
12446
+ request; this effectively ignores the host_index
12447
+ in the spec for a single request.
12448
+ :type _host_index: int, optional
12449
+ :return: Returns the result object.
12450
+ """ # noqa: E501
12451
+
12452
+ _param = self._restore_mobile_app_alert_config_serialize(
12453
+ id=id,
12454
+ created=created,
12455
+ body=body,
12456
+ _request_auth=_request_auth,
12457
+ _content_type=_content_type,
12458
+ _headers=_headers,
12459
+ _host_index=_host_index
12460
+ )
12461
+
12462
+ _response_types_map: Dict[str, Optional[str]] = {
12463
+ '204': None,
12464
+ '403': None,
12465
+ '404': None,
12466
+ }
12467
+ response_data = self.api_client.call_api(
12468
+ *_param,
12469
+ _request_timeout=_request_timeout
12470
+ )
12471
+ response_data.read()
12472
+ return self.api_client.response_deserialize(
12473
+ response_data=response_data,
12474
+ response_types_map=_response_types_map,
12475
+ )
12476
+
12477
+
12478
+ @validate_call
12479
+ def restore_mobile_app_alert_config_without_preload_content(
12480
+ self,
12481
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to restore.")],
12482
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration.")],
12483
+ body: Optional[StrictStr] = None,
12484
+ _request_timeout: Union[
12485
+ None,
12486
+ Annotated[StrictFloat, Field(gt=0)],
12487
+ Tuple[
12488
+ Annotated[StrictFloat, Field(gt=0)],
12489
+ Annotated[StrictFloat, Field(gt=0)]
12490
+ ]
12491
+ ] = None,
12492
+ _request_auth: Optional[Dict[StrictStr, Any]] = None,
12493
+ _content_type: Optional[StrictStr] = None,
12494
+ _headers: Optional[Dict[StrictStr, Any]] = None,
12495
+ _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12496
+ ) -> RESTResponseType:
12497
+ """Restore Mobile Smart Alert Config
12498
+
12499
+ Restores a Mobile Smart Alert Configuration.
12500
+
12501
+ :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12502
+ :type id: str
12503
+ :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12504
+ :type created: int
12505
+ :param body:
12506
+ :type body: str
11918
12507
  :param _request_timeout: timeout setting for this request. If one
11919
12508
  number provided, it will be total request
11920
12509
  timeout. It can also be a pair (tuple) of
@@ -11937,10 +12526,10 @@ class EventSettingsApi:
11937
12526
  :return: Returns the result object.
11938
12527
  """ # noqa: E501
11939
12528
 
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,
12529
+ _param = self._restore_mobile_app_alert_config_serialize(
12530
+ id=id,
12531
+ created=created,
12532
+ body=body,
11944
12533
  _request_auth=_request_auth,
11945
12534
  _content_type=_content_type,
11946
12535
  _headers=_headers,
@@ -11948,7 +12537,9 @@ class EventSettingsApi:
11948
12537
  )
11949
12538
 
11950
12539
  _response_types_map: Dict[str, Optional[str]] = {
11951
- '200': "CustomEventSpecificationWithLastUpdated",
12540
+ '204': None,
12541
+ '403': None,
12542
+ '404': None,
11952
12543
  }
11953
12544
  response_data = self.api_client.call_api(
11954
12545
  *_param,
@@ -11957,11 +12548,11 @@ class EventSettingsApi:
11957
12548
  return response_data.response
11958
12549
 
11959
12550
 
11960
- def _put_custom_event_specification_serialize(
12551
+ def _restore_mobile_app_alert_config_serialize(
11961
12552
  self,
11962
- event_specification_id,
11963
- custom_event_specification,
11964
- allow_restore,
12553
+ id,
12554
+ created,
12555
+ body,
11965
12556
  _request_auth,
11966
12557
  _content_type,
11967
12558
  _headers,
@@ -11983,27 +12574,18 @@ class EventSettingsApi:
11983
12574
  _body_params: Optional[bytes] = None
11984
12575
 
11985
12576
  # process the path parameters
11986
- if event_specification_id is not None:
11987
- _path_params['eventSpecificationId'] = event_specification_id
12577
+ if id is not None:
12578
+ _path_params['id'] = id
12579
+ if created is not None:
12580
+ _path_params['created'] = created
11988
12581
  # process the query parameters
11989
- if allow_restore is not None:
11990
-
11991
- _query_params.append(('allowRestore', allow_restore))
11992
-
11993
12582
  # process the header parameters
11994
12583
  # process the form parameters
11995
12584
  # process the body parameter
11996
- if custom_event_specification is not None:
11997
- _body_params = custom_event_specification
12585
+ if body is not None:
12586
+ _body_params = body
11998
12587
 
11999
12588
 
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
12589
 
12008
12590
  # set the HTTP header `Content-Type`
12009
12591
  if _content_type:
@@ -12026,7 +12608,7 @@ class EventSettingsApi:
12026
12608
 
12027
12609
  return self.api_client.param_serialize(
12028
12610
  method='PUT',
12029
- resource_path='/api/events/settings/event-specifications/custom/{eventSpecificationId}',
12611
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}/restore/{created}',
12030
12612
  path_params=_path_params,
12031
12613
  query_params=_query_params,
12032
12614
  header_params=_header_params,
@@ -12043,10 +12625,10 @@ class EventSettingsApi:
12043
12625
 
12044
12626
 
12045
12627
  @validate_call
12046
- def restore_mobile_app_alert_config(
12628
+ def restore_website_alert_config(
12047
12629
  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.")],
12630
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12631
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12050
12632
  body: Optional[StrictStr] = None,
12051
12633
  _request_timeout: Union[
12052
12634
  None,
@@ -12061,13 +12643,13 @@ class EventSettingsApi:
12061
12643
  _headers: Optional[Dict[StrictStr, Any]] = None,
12062
12644
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12063
12645
  ) -> None:
12064
- """Restore Mobile Smart Alert Config
12646
+ """Restore Website Smart Alert Config
12065
12647
 
12066
- Restores a Mobile Smart Alert Configuration.
12648
+ Restores a deleted Website Smart Alert Configuration.
12067
12649
 
12068
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12650
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12069
12651
  :type id: str
12070
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12652
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12071
12653
  :type created: int
12072
12654
  :param body:
12073
12655
  :type body: str
@@ -12093,7 +12675,7 @@ class EventSettingsApi:
12093
12675
  :return: Returns the result object.
12094
12676
  """ # noqa: E501
12095
12677
 
12096
- _param = self._restore_mobile_app_alert_config_serialize(
12678
+ _param = self._restore_website_alert_config_serialize(
12097
12679
  id=id,
12098
12680
  created=created,
12099
12681
  body=body,
@@ -12104,9 +12686,9 @@ class EventSettingsApi:
12104
12686
  )
12105
12687
 
12106
12688
  _response_types_map: Dict[str, Optional[str]] = {
12107
- '200': None,
12108
- '400': None,
12689
+ '204': None,
12109
12690
  '403': None,
12691
+ '404': None,
12110
12692
  }
12111
12693
  response_data = self.api_client.call_api(
12112
12694
  *_param,
@@ -12120,10 +12702,10 @@ class EventSettingsApi:
12120
12702
 
12121
12703
 
12122
12704
  @validate_call
12123
- def restore_mobile_app_alert_config_with_http_info(
12705
+ def restore_website_alert_config_with_http_info(
12124
12706
  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.")],
12707
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12708
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12127
12709
  body: Optional[StrictStr] = None,
12128
12710
  _request_timeout: Union[
12129
12711
  None,
@@ -12138,13 +12720,13 @@ class EventSettingsApi:
12138
12720
  _headers: Optional[Dict[StrictStr, Any]] = None,
12139
12721
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12140
12722
  ) -> ApiResponse[None]:
12141
- """Restore Mobile Smart Alert Config
12723
+ """Restore Website Smart Alert Config
12142
12724
 
12143
- Restores a Mobile Smart Alert Configuration.
12725
+ Restores a deleted Website Smart Alert Configuration.
12144
12726
 
12145
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12727
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12146
12728
  :type id: str
12147
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12729
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12148
12730
  :type created: int
12149
12731
  :param body:
12150
12732
  :type body: str
@@ -12170,7 +12752,7 @@ class EventSettingsApi:
12170
12752
  :return: Returns the result object.
12171
12753
  """ # noqa: E501
12172
12754
 
12173
- _param = self._restore_mobile_app_alert_config_serialize(
12755
+ _param = self._restore_website_alert_config_serialize(
12174
12756
  id=id,
12175
12757
  created=created,
12176
12758
  body=body,
@@ -12181,9 +12763,9 @@ class EventSettingsApi:
12181
12763
  )
12182
12764
 
12183
12765
  _response_types_map: Dict[str, Optional[str]] = {
12184
- '200': None,
12185
- '400': None,
12766
+ '204': None,
12186
12767
  '403': None,
12768
+ '404': None,
12187
12769
  }
12188
12770
  response_data = self.api_client.call_api(
12189
12771
  *_param,
@@ -12197,10 +12779,10 @@ class EventSettingsApi:
12197
12779
 
12198
12780
 
12199
12781
  @validate_call
12200
- def restore_mobile_app_alert_config_without_preload_content(
12782
+ def restore_website_alert_config_without_preload_content(
12201
12783
  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.")],
12784
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to restore.")],
12785
+ created: Annotated[StrictInt, Field(description="Unix timestamp representing the creation time of a specific Website Smart Alert Configuration.")],
12204
12786
  body: Optional[StrictStr] = None,
12205
12787
  _request_timeout: Union[
12206
12788
  None,
@@ -12215,13 +12797,13 @@ class EventSettingsApi:
12215
12797
  _headers: Optional[Dict[StrictStr, Any]] = None,
12216
12798
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12217
12799
  ) -> RESTResponseType:
12218
- """Restore Mobile Smart Alert Config
12800
+ """Restore Website Smart Alert Config
12219
12801
 
12220
- Restores a Mobile Smart Alert Configuration.
12802
+ Restores a deleted Website Smart Alert Configuration.
12221
12803
 
12222
- :param id: ID of a specific Mobile Smart Alert Configuration to restore. (required)
12804
+ :param id: ID of a specific Website Smart Alert Configuration to restore. (required)
12223
12805
  :type id: str
12224
- :param created: Unix timestamp representing the creation time of a specific Mobile Smart Alert Configuration. (required)
12806
+ :param created: Unix timestamp representing the creation time of a specific Website Smart Alert Configuration. (required)
12225
12807
  :type created: int
12226
12808
  :param body:
12227
12809
  :type body: str
@@ -12247,7 +12829,7 @@ class EventSettingsApi:
12247
12829
  :return: Returns the result object.
12248
12830
  """ # noqa: E501
12249
12831
 
12250
- _param = self._restore_mobile_app_alert_config_serialize(
12832
+ _param = self._restore_website_alert_config_serialize(
12251
12833
  id=id,
12252
12834
  created=created,
12253
12835
  body=body,
@@ -12258,9 +12840,9 @@ class EventSettingsApi:
12258
12840
  )
12259
12841
 
12260
12842
  _response_types_map: Dict[str, Optional[str]] = {
12261
- '200': None,
12262
- '400': None,
12843
+ '204': None,
12263
12844
  '403': None,
12845
+ '404': None,
12264
12846
  }
12265
12847
  response_data = self.api_client.call_api(
12266
12848
  *_param,
@@ -12269,7 +12851,7 @@ class EventSettingsApi:
12269
12851
  return response_data.response
12270
12852
 
12271
12853
 
12272
- def _restore_mobile_app_alert_config_serialize(
12854
+ def _restore_website_alert_config_serialize(
12273
12855
  self,
12274
12856
  id,
12275
12857
  created,
@@ -12324,11 +12906,12 @@ class EventSettingsApi:
12324
12906
 
12325
12907
  # authentication setting
12326
12908
  _auth_settings: List[str] = [
12909
+ 'ApiKeyAuth'
12327
12910
  ]
12328
12911
 
12329
12912
  return self.api_client.param_serialize(
12330
12913
  method='PUT',
12331
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}/restore/{created}',
12914
+ resource_path='/api/events/settings/website-alert-configs/{id}/restore/{created}',
12332
12915
  path_params=_path_params,
12333
12916
  query_params=_query_params,
12334
12917
  header_params=_header_params,
@@ -12345,11 +12928,9 @@ class EventSettingsApi:
12345
12928
 
12346
12929
 
12347
12930
  @validate_call
12348
- def restore_website_alert_config(
12931
+ def send_test_alerting(
12349
12932
  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,
12933
+ abstract_integration: AbstractIntegration,
12353
12934
  _request_timeout: Union[
12354
12935
  None,
12355
12936
  Annotated[StrictFloat, Field(gt=0)],
@@ -12363,16 +12944,12 @@ class EventSettingsApi:
12363
12944
  _headers: Optional[Dict[StrictStr, Any]] = None,
12364
12945
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12365
12946
  ) -> None:
12366
- """Restore Website Smart Alert Config
12947
+ """Test Alerting Channel
12367
12948
 
12368
- Restores a deleted Website Smart Alert Configuration.
12949
+ 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
12950
 
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
12951
+ :param abstract_integration: (required)
12952
+ :type abstract_integration: AbstractIntegration
12376
12953
  :param _request_timeout: timeout setting for this request. If one
12377
12954
  number provided, it will be total request
12378
12955
  timeout. It can also be a pair (tuple) of
@@ -12395,10 +12972,8 @@ class EventSettingsApi:
12395
12972
  :return: Returns the result object.
12396
12973
  """ # noqa: E501
12397
12974
 
12398
- _param = self._restore_website_alert_config_serialize(
12399
- id=id,
12400
- created=created,
12401
- body=body,
12975
+ _param = self._send_test_alerting_serialize(
12976
+ abstract_integration=abstract_integration,
12402
12977
  _request_auth=_request_auth,
12403
12978
  _content_type=_content_type,
12404
12979
  _headers=_headers,
@@ -12407,8 +12982,6 @@ class EventSettingsApi:
12407
12982
 
12408
12983
  _response_types_map: Dict[str, Optional[str]] = {
12409
12984
  '200': None,
12410
- '400': None,
12411
- '403': None,
12412
12985
  }
12413
12986
  response_data = self.api_client.call_api(
12414
12987
  *_param,
@@ -12422,11 +12995,9 @@ class EventSettingsApi:
12422
12995
 
12423
12996
 
12424
12997
  @validate_call
12425
- def restore_website_alert_config_with_http_info(
12998
+ def send_test_alerting_with_http_info(
12426
12999
  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,
13000
+ abstract_integration: AbstractIntegration,
12430
13001
  _request_timeout: Union[
12431
13002
  None,
12432
13003
  Annotated[StrictFloat, Field(gt=0)],
@@ -12440,16 +13011,12 @@ class EventSettingsApi:
12440
13011
  _headers: Optional[Dict[StrictStr, Any]] = None,
12441
13012
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12442
13013
  ) -> ApiResponse[None]:
12443
- """Restore Website Smart Alert Config
13014
+ """Test Alerting Channel
12444
13015
 
12445
- Restores a deleted Website Smart Alert Configuration.
13016
+ 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
13017
 
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
13018
+ :param abstract_integration: (required)
13019
+ :type abstract_integration: AbstractIntegration
12453
13020
  :param _request_timeout: timeout setting for this request. If one
12454
13021
  number provided, it will be total request
12455
13022
  timeout. It can also be a pair (tuple) of
@@ -12472,10 +13039,8 @@ class EventSettingsApi:
12472
13039
  :return: Returns the result object.
12473
13040
  """ # noqa: E501
12474
13041
 
12475
- _param = self._restore_website_alert_config_serialize(
12476
- id=id,
12477
- created=created,
12478
- body=body,
13042
+ _param = self._send_test_alerting_serialize(
13043
+ abstract_integration=abstract_integration,
12479
13044
  _request_auth=_request_auth,
12480
13045
  _content_type=_content_type,
12481
13046
  _headers=_headers,
@@ -12484,8 +13049,6 @@ class EventSettingsApi:
12484
13049
 
12485
13050
  _response_types_map: Dict[str, Optional[str]] = {
12486
13051
  '200': None,
12487
- '400': None,
12488
- '403': None,
12489
13052
  }
12490
13053
  response_data = self.api_client.call_api(
12491
13054
  *_param,
@@ -12499,11 +13062,9 @@ class EventSettingsApi:
12499
13062
 
12500
13063
 
12501
13064
  @validate_call
12502
- def restore_website_alert_config_without_preload_content(
13065
+ def send_test_alerting_without_preload_content(
12503
13066
  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,
13067
+ abstract_integration: AbstractIntegration,
12507
13068
  _request_timeout: Union[
12508
13069
  None,
12509
13070
  Annotated[StrictFloat, Field(gt=0)],
@@ -12517,16 +13078,12 @@ class EventSettingsApi:
12517
13078
  _headers: Optional[Dict[StrictStr, Any]] = None,
12518
13079
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12519
13080
  ) -> RESTResponseType:
12520
- """Restore Website Smart Alert Config
13081
+ """Test Alerting Channel
12521
13082
 
12522
- Restores a deleted Website Smart Alert Configuration.
13083
+ 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
13084
 
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
13085
+ :param abstract_integration: (required)
13086
+ :type abstract_integration: AbstractIntegration
12530
13087
  :param _request_timeout: timeout setting for this request. If one
12531
13088
  number provided, it will be total request
12532
13089
  timeout. It can also be a pair (tuple) of
@@ -12549,10 +13106,8 @@ class EventSettingsApi:
12549
13106
  :return: Returns the result object.
12550
13107
  """ # noqa: E501
12551
13108
 
12552
- _param = self._restore_website_alert_config_serialize(
12553
- id=id,
12554
- created=created,
12555
- body=body,
13109
+ _param = self._send_test_alerting_serialize(
13110
+ abstract_integration=abstract_integration,
12556
13111
  _request_auth=_request_auth,
12557
13112
  _content_type=_content_type,
12558
13113
  _headers=_headers,
@@ -12561,8 +13116,6 @@ class EventSettingsApi:
12561
13116
 
12562
13117
  _response_types_map: Dict[str, Optional[str]] = {
12563
13118
  '200': None,
12564
- '400': None,
12565
- '403': None,
12566
13119
  }
12567
13120
  response_data = self.api_client.call_api(
12568
13121
  *_param,
@@ -12571,11 +13124,9 @@ class EventSettingsApi:
12571
13124
  return response_data.response
12572
13125
 
12573
13126
 
12574
- def _restore_website_alert_config_serialize(
13127
+ def _send_test_alerting_serialize(
12575
13128
  self,
12576
- id,
12577
- created,
12578
- body,
13129
+ abstract_integration,
12579
13130
  _request_auth,
12580
13131
  _content_type,
12581
13132
  _headers,
@@ -12597,18 +13148,21 @@ class EventSettingsApi:
12597
13148
  _body_params: Optional[bytes] = None
12598
13149
 
12599
13150
  # 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
13151
  # process the query parameters
12605
13152
  # process the header parameters
12606
13153
  # process the form parameters
12607
13154
  # process the body parameter
12608
- if body is not None:
12609
- _body_params = body
13155
+ if abstract_integration is not None:
13156
+ _body_params = abstract_integration
12610
13157
 
12611
13158
 
13159
+ # set the HTTP header `Accept`
13160
+ if 'Accept' not in _header_params:
13161
+ _header_params['Accept'] = self.api_client.select_header_accept(
13162
+ [
13163
+ 'application/json'
13164
+ ]
13165
+ )
12612
13166
 
12613
13167
  # set the HTTP header `Content-Type`
12614
13168
  if _content_type:
@@ -12631,7 +13185,7 @@ class EventSettingsApi:
12631
13185
 
12632
13186
  return self.api_client.param_serialize(
12633
13187
  method='PUT',
12634
- resource_path='/api/events/settings/website-alert-configs/{id}/restore/{created}',
13188
+ resource_path='/api/events/settings/alertingChannels/test',
12635
13189
  path_params=_path_params,
12636
13190
  query_params=_query_params,
12637
13191
  header_params=_header_params,
@@ -12648,9 +13202,10 @@ class EventSettingsApi:
12648
13202
 
12649
13203
 
12650
13204
  @validate_call
12651
- def send_test_alerting(
13205
+ def send_test_alerting_by_id(
12652
13206
  self,
12653
- abstract_integration: AbstractIntegration,
13207
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13208
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12654
13209
  _request_timeout: Union[
12655
13210
  None,
12656
13211
  Annotated[StrictFloat, Field(gt=0)],
@@ -12664,12 +13219,14 @@ class EventSettingsApi:
12664
13219
  _headers: Optional[Dict[StrictStr, Any]] = None,
12665
13220
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12666
13221
  ) -> None:
12667
- """Test Alerting Channel
13222
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12668
13223
 
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.
13224
+ 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
13225
 
12671
- :param abstract_integration: (required)
12672
- :type abstract_integration: AbstractIntegration
13226
+ :param id: ID of the alerting channel to be notified on. (required)
13227
+ :type id: str
13228
+ :param manual_alerting_channel_configuration: (required)
13229
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12673
13230
  :param _request_timeout: timeout setting for this request. If one
12674
13231
  number provided, it will be total request
12675
13232
  timeout. It can also be a pair (tuple) of
@@ -12692,8 +13249,9 @@ class EventSettingsApi:
12692
13249
  :return: Returns the result object.
12693
13250
  """ # noqa: E501
12694
13251
 
12695
- _param = self._send_test_alerting_serialize(
12696
- abstract_integration=abstract_integration,
13252
+ _param = self._send_test_alerting_by_id_serialize(
13253
+ id=id,
13254
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12697
13255
  _request_auth=_request_auth,
12698
13256
  _content_type=_content_type,
12699
13257
  _headers=_headers,
@@ -12714,9 +13272,10 @@ class EventSettingsApi:
12714
13272
 
12715
13273
 
12716
13274
  @validate_call
12717
- def send_test_alerting_with_http_info(
13275
+ def send_test_alerting_by_id_with_http_info(
12718
13276
  self,
12719
- abstract_integration: AbstractIntegration,
13277
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13278
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12720
13279
  _request_timeout: Union[
12721
13280
  None,
12722
13281
  Annotated[StrictFloat, Field(gt=0)],
@@ -12730,12 +13289,14 @@ class EventSettingsApi:
12730
13289
  _headers: Optional[Dict[StrictStr, Any]] = None,
12731
13290
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12732
13291
  ) -> ApiResponse[None]:
12733
- """Test Alerting Channel
13292
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12734
13293
 
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.
13294
+ 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
13295
 
12737
- :param abstract_integration: (required)
12738
- :type abstract_integration: AbstractIntegration
13296
+ :param id: ID of the alerting channel to be notified on. (required)
13297
+ :type id: str
13298
+ :param manual_alerting_channel_configuration: (required)
13299
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12739
13300
  :param _request_timeout: timeout setting for this request. If one
12740
13301
  number provided, it will be total request
12741
13302
  timeout. It can also be a pair (tuple) of
@@ -12758,8 +13319,9 @@ class EventSettingsApi:
12758
13319
  :return: Returns the result object.
12759
13320
  """ # noqa: E501
12760
13321
 
12761
- _param = self._send_test_alerting_serialize(
12762
- abstract_integration=abstract_integration,
13322
+ _param = self._send_test_alerting_by_id_serialize(
13323
+ id=id,
13324
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12763
13325
  _request_auth=_request_auth,
12764
13326
  _content_type=_content_type,
12765
13327
  _headers=_headers,
@@ -12780,9 +13342,10 @@ class EventSettingsApi:
12780
13342
 
12781
13343
 
12782
13344
  @validate_call
12783
- def send_test_alerting_without_preload_content(
13345
+ def send_test_alerting_by_id_without_preload_content(
12784
13346
  self,
12785
- abstract_integration: AbstractIntegration,
13347
+ id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13348
+ manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
12786
13349
  _request_timeout: Union[
12787
13350
  None,
12788
13351
  Annotated[StrictFloat, Field(gt=0)],
@@ -12796,12 +13359,14 @@ class EventSettingsApi:
12796
13359
  _headers: Optional[Dict[StrictStr, Any]] = None,
12797
13360
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12798
13361
  ) -> RESTResponseType:
12799
- """Test Alerting Channel
13362
+ """Notify manually to Alerting Channel. Requires the permission called CanConfigureIntegrations.
12800
13363
 
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.
13364
+ 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
13365
 
12803
- :param abstract_integration: (required)
12804
- :type abstract_integration: AbstractIntegration
13366
+ :param id: ID of the alerting channel to be notified on. (required)
13367
+ :type id: str
13368
+ :param manual_alerting_channel_configuration: (required)
13369
+ :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
12805
13370
  :param _request_timeout: timeout setting for this request. If one
12806
13371
  number provided, it will be total request
12807
13372
  timeout. It can also be a pair (tuple) of
@@ -12824,8 +13389,9 @@ class EventSettingsApi:
12824
13389
  :return: Returns the result object.
12825
13390
  """ # noqa: E501
12826
13391
 
12827
- _param = self._send_test_alerting_serialize(
12828
- abstract_integration=abstract_integration,
13392
+ _param = self._send_test_alerting_by_id_serialize(
13393
+ id=id,
13394
+ manual_alerting_channel_configuration=manual_alerting_channel_configuration,
12829
13395
  _request_auth=_request_auth,
12830
13396
  _content_type=_content_type,
12831
13397
  _headers=_headers,
@@ -12841,9 +13407,10 @@ class EventSettingsApi:
12841
13407
  return response_data.response
12842
13408
 
12843
13409
 
12844
- def _send_test_alerting_serialize(
13410
+ def _send_test_alerting_by_id_serialize(
12845
13411
  self,
12846
- abstract_integration,
13412
+ id,
13413
+ manual_alerting_channel_configuration,
12847
13414
  _request_auth,
12848
13415
  _content_type,
12849
13416
  _headers,
@@ -12865,12 +13432,14 @@ class EventSettingsApi:
12865
13432
  _body_params: Optional[bytes] = None
12866
13433
 
12867
13434
  # process the path parameters
13435
+ if id is not None:
13436
+ _path_params['id'] = id
12868
13437
  # process the query parameters
12869
13438
  # process the header parameters
12870
13439
  # process the form parameters
12871
13440
  # process the body parameter
12872
- if abstract_integration is not None:
12873
- _body_params = abstract_integration
13441
+ if manual_alerting_channel_configuration is not None:
13442
+ _body_params = manual_alerting_channel_configuration
12874
13443
 
12875
13444
 
12876
13445
  # set the HTTP header `Accept`
@@ -12901,8 +13470,8 @@ class EventSettingsApi:
12901
13470
  ]
12902
13471
 
12903
13472
  return self.api_client.param_serialize(
12904
- method='PUT',
12905
- resource_path='/api/events/settings/alertingChannels/test',
13473
+ method='POST',
13474
+ resource_path='/api/events/settings/alertingChannels/notify/{id}',
12906
13475
  path_params=_path_params,
12907
13476
  query_params=_query_params,
12908
13477
  header_params=_header_params,
@@ -12919,10 +13488,10 @@ class EventSettingsApi:
12919
13488
 
12920
13489
 
12921
13490
  @validate_call
12922
- def send_test_alerting_by_id(
13491
+ def update_mobile_app_alert_config(
12923
13492
  self,
12924
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
12925
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13493
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13494
+ mobile_app_alert_config: MobileAppAlertConfig,
12926
13495
  _request_timeout: Union[
12927
13496
  None,
12928
13497
  Annotated[StrictFloat, Field(gt=0)],
@@ -12935,15 +13504,15 @@ class EventSettingsApi:
12935
13504
  _content_type: Optional[StrictStr] = None,
12936
13505
  _headers: Optional[Dict[StrictStr, Any]] = None,
12937
13506
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
12938
- ) -> None:
12939
- """Notify manually to Alerting Channel
13507
+ ) -> WithMetadata:
13508
+ """Update Mobile Smart Alert Config
12940
13509
 
12941
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13510
+ Updates an existing Mobile Smart Alert Configuration.
12942
13511
 
12943
- :param id: ID of the alerting channel to be notified on. (required)
13512
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
12944
13513
  :type id: str
12945
- :param manual_alerting_channel_configuration: (required)
12946
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13514
+ :param mobile_app_alert_config: (required)
13515
+ :type mobile_app_alert_config: MobileAppAlertConfig
12947
13516
  :param _request_timeout: timeout setting for this request. If one
12948
13517
  number provided, it will be total request
12949
13518
  timeout. It can also be a pair (tuple) of
@@ -12966,9 +13535,9 @@ class EventSettingsApi:
12966
13535
  :return: Returns the result object.
12967
13536
  """ # noqa: E501
12968
13537
 
12969
- _param = self._send_test_alerting_by_id_serialize(
13538
+ _param = self._update_mobile_app_alert_config_serialize(
12970
13539
  id=id,
12971
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13540
+ mobile_app_alert_config=mobile_app_alert_config,
12972
13541
  _request_auth=_request_auth,
12973
13542
  _content_type=_content_type,
12974
13543
  _headers=_headers,
@@ -12976,6 +13545,12 @@ class EventSettingsApi:
12976
13545
  )
12977
13546
 
12978
13547
  _response_types_map: Dict[str, Optional[str]] = {
13548
+ '200': "WithMetadata",
13549
+ '204': None,
13550
+ '400': None,
13551
+ '403': None,
13552
+ '422': None,
13553
+ '500': None,
12979
13554
  }
12980
13555
  response_data = self.api_client.call_api(
12981
13556
  *_param,
@@ -12989,10 +13564,10 @@ class EventSettingsApi:
12989
13564
 
12990
13565
 
12991
13566
  @validate_call
12992
- def send_test_alerting_by_id_with_http_info(
13567
+ def update_mobile_app_alert_config_with_http_info(
12993
13568
  self,
12994
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
12995
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13569
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13570
+ mobile_app_alert_config: MobileAppAlertConfig,
12996
13571
  _request_timeout: Union[
12997
13572
  None,
12998
13573
  Annotated[StrictFloat, Field(gt=0)],
@@ -13005,15 +13580,15 @@ class EventSettingsApi:
13005
13580
  _content_type: Optional[StrictStr] = None,
13006
13581
  _headers: Optional[Dict[StrictStr, Any]] = None,
13007
13582
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13008
- ) -> ApiResponse[None]:
13009
- """Notify manually to Alerting Channel
13583
+ ) -> ApiResponse[WithMetadata]:
13584
+ """Update Mobile Smart Alert Config
13010
13585
 
13011
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13586
+ Updates an existing Mobile Smart Alert Configuration.
13012
13587
 
13013
- :param id: ID of the alerting channel to be notified on. (required)
13588
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13014
13589
  :type id: str
13015
- :param manual_alerting_channel_configuration: (required)
13016
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13590
+ :param mobile_app_alert_config: (required)
13591
+ :type mobile_app_alert_config: MobileAppAlertConfig
13017
13592
  :param _request_timeout: timeout setting for this request. If one
13018
13593
  number provided, it will be total request
13019
13594
  timeout. It can also be a pair (tuple) of
@@ -13036,9 +13611,9 @@ class EventSettingsApi:
13036
13611
  :return: Returns the result object.
13037
13612
  """ # noqa: E501
13038
13613
 
13039
- _param = self._send_test_alerting_by_id_serialize(
13614
+ _param = self._update_mobile_app_alert_config_serialize(
13040
13615
  id=id,
13041
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13616
+ mobile_app_alert_config=mobile_app_alert_config,
13042
13617
  _request_auth=_request_auth,
13043
13618
  _content_type=_content_type,
13044
13619
  _headers=_headers,
@@ -13046,6 +13621,12 @@ class EventSettingsApi:
13046
13621
  )
13047
13622
 
13048
13623
  _response_types_map: Dict[str, Optional[str]] = {
13624
+ '200': "WithMetadata",
13625
+ '204': None,
13626
+ '400': None,
13627
+ '403': None,
13628
+ '422': None,
13629
+ '500': None,
13049
13630
  }
13050
13631
  response_data = self.api_client.call_api(
13051
13632
  *_param,
@@ -13059,10 +13640,10 @@ class EventSettingsApi:
13059
13640
 
13060
13641
 
13061
13642
  @validate_call
13062
- def send_test_alerting_by_id_without_preload_content(
13643
+ def update_mobile_app_alert_config_without_preload_content(
13063
13644
  self,
13064
- id: Annotated[StrictStr, Field(description="ID of the alerting channel to be notified on.")],
13065
- manual_alerting_channel_configuration: ManualAlertingChannelConfiguration,
13645
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13646
+ mobile_app_alert_config: MobileAppAlertConfig,
13066
13647
  _request_timeout: Union[
13067
13648
  None,
13068
13649
  Annotated[StrictFloat, Field(gt=0)],
@@ -13076,14 +13657,14 @@ class EventSettingsApi:
13076
13657
  _headers: Optional[Dict[StrictStr, Any]] = None,
13077
13658
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13078
13659
  ) -> RESTResponseType:
13079
- """Notify manually to Alerting Channel
13660
+ """Update Mobile Smart Alert Config
13080
13661
 
13081
- Sends alert for a specific event to an alerting channel.Provided the event Id, an alert could be sent to the alerting channel.
13662
+ Updates an existing Mobile Smart Alert Configuration.
13082
13663
 
13083
- :param id: ID of the alerting channel to be notified on. (required)
13664
+ :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13084
13665
  :type id: str
13085
- :param manual_alerting_channel_configuration: (required)
13086
- :type manual_alerting_channel_configuration: ManualAlertingChannelConfiguration
13666
+ :param mobile_app_alert_config: (required)
13667
+ :type mobile_app_alert_config: MobileAppAlertConfig
13087
13668
  :param _request_timeout: timeout setting for this request. If one
13088
13669
  number provided, it will be total request
13089
13670
  timeout. It can also be a pair (tuple) of
@@ -13106,9 +13687,9 @@ class EventSettingsApi:
13106
13687
  :return: Returns the result object.
13107
13688
  """ # noqa: E501
13108
13689
 
13109
- _param = self._send_test_alerting_by_id_serialize(
13690
+ _param = self._update_mobile_app_alert_config_serialize(
13110
13691
  id=id,
13111
- manual_alerting_channel_configuration=manual_alerting_channel_configuration,
13692
+ mobile_app_alert_config=mobile_app_alert_config,
13112
13693
  _request_auth=_request_auth,
13113
13694
  _content_type=_content_type,
13114
13695
  _headers=_headers,
@@ -13116,6 +13697,12 @@ class EventSettingsApi:
13116
13697
  )
13117
13698
 
13118
13699
  _response_types_map: Dict[str, Optional[str]] = {
13700
+ '200': "WithMetadata",
13701
+ '204': None,
13702
+ '400': None,
13703
+ '403': None,
13704
+ '422': None,
13705
+ '500': None,
13119
13706
  }
13120
13707
  response_data = self.api_client.call_api(
13121
13708
  *_param,
@@ -13124,10 +13711,10 @@ class EventSettingsApi:
13124
13711
  return response_data.response
13125
13712
 
13126
13713
 
13127
- def _send_test_alerting_by_id_serialize(
13714
+ def _update_mobile_app_alert_config_serialize(
13128
13715
  self,
13129
13716
  id,
13130
- manual_alerting_channel_configuration,
13717
+ mobile_app_alert_config,
13131
13718
  _request_auth,
13132
13719
  _content_type,
13133
13720
  _headers,
@@ -13155,8 +13742,8 @@ class EventSettingsApi:
13155
13742
  # process the header parameters
13156
13743
  # process the form parameters
13157
13744
  # process the body parameter
13158
- if manual_alerting_channel_configuration is not None:
13159
- _body_params = manual_alerting_channel_configuration
13745
+ if mobile_app_alert_config is not None:
13746
+ _body_params = mobile_app_alert_config
13160
13747
 
13161
13748
 
13162
13749
  # set the HTTP header `Accept`
@@ -13188,7 +13775,7 @@ class EventSettingsApi:
13188
13775
 
13189
13776
  return self.api_client.param_serialize(
13190
13777
  method='POST',
13191
- resource_path='/api/events/settings/alertingChannels/notify/{id}',
13778
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}',
13192
13779
  path_params=_path_params,
13193
13780
  query_params=_query_params,
13194
13781
  header_params=_header_params,
@@ -13205,10 +13792,9 @@ class EventSettingsApi:
13205
13792
 
13206
13793
 
13207
13794
  @validate_call
13208
- def update_mobile_app_alert_config(
13795
+ def update_mobile_app_historic_baseline(
13209
13796
  self,
13210
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13211
- mobile_app_alert_config: MobileAppAlertConfig,
13797
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13212
13798
  _request_timeout: Union[
13213
13799
  None,
13214
13800
  Annotated[StrictFloat, Field(gt=0)],
@@ -13221,15 +13807,13 @@ class EventSettingsApi:
13221
13807
  _content_type: Optional[StrictStr] = None,
13222
13808
  _headers: Optional[Dict[StrictStr, Any]] = None,
13223
13809
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13224
- ) -> WithMetadata:
13225
- """Update Mobile Smart Alert Config
13810
+ ) -> None:
13811
+ """Recalculate Mobile Smart Alert Config Baseline
13226
13812
 
13227
- Updates an existing Mobile Smart Alert Configuration.
13813
+ 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
13814
 
13229
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13815
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13230
13816
  :type id: str
13231
- :param mobile_app_alert_config: (required)
13232
- :type mobile_app_alert_config: MobileAppAlertConfig
13233
13817
  :param _request_timeout: timeout setting for this request. If one
13234
13818
  number provided, it will be total request
13235
13819
  timeout. It can also be a pair (tuple) of
@@ -13252,9 +13836,8 @@ class EventSettingsApi:
13252
13836
  :return: Returns the result object.
13253
13837
  """ # noqa: E501
13254
13838
 
13255
- _param = self._update_mobile_app_alert_config_serialize(
13839
+ _param = self._update_mobile_app_historic_baseline_serialize(
13256
13840
  id=id,
13257
- mobile_app_alert_config=mobile_app_alert_config,
13258
13841
  _request_auth=_request_auth,
13259
13842
  _content_type=_content_type,
13260
13843
  _headers=_headers,
@@ -13262,12 +13845,12 @@ class EventSettingsApi:
13262
13845
  )
13263
13846
 
13264
13847
  _response_types_map: Dict[str, Optional[str]] = {
13265
- '200': "WithMetadata",
13848
+ '200': None,
13266
13849
  '204': None,
13267
13850
  '400': None,
13268
13851
  '403': None,
13269
- '422': None,
13270
- '500': None,
13852
+ '404': None,
13853
+ '428': None,
13271
13854
  }
13272
13855
  response_data = self.api_client.call_api(
13273
13856
  *_param,
@@ -13281,10 +13864,9 @@ class EventSettingsApi:
13281
13864
 
13282
13865
 
13283
13866
  @validate_call
13284
- def update_mobile_app_alert_config_with_http_info(
13867
+ def update_mobile_app_historic_baseline_with_http_info(
13285
13868
  self,
13286
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13287
- mobile_app_alert_config: MobileAppAlertConfig,
13869
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13288
13870
  _request_timeout: Union[
13289
13871
  None,
13290
13872
  Annotated[StrictFloat, Field(gt=0)],
@@ -13297,15 +13879,13 @@ class EventSettingsApi:
13297
13879
  _content_type: Optional[StrictStr] = None,
13298
13880
  _headers: Optional[Dict[StrictStr, Any]] = None,
13299
13881
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13300
- ) -> ApiResponse[WithMetadata]:
13301
- """Update Mobile Smart Alert Config
13882
+ ) -> ApiResponse[None]:
13883
+ """Recalculate Mobile Smart Alert Config Baseline
13302
13884
 
13303
- Updates an existing Mobile Smart Alert Configuration.
13885
+ 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
13886
 
13305
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13887
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13306
13888
  :type id: str
13307
- :param mobile_app_alert_config: (required)
13308
- :type mobile_app_alert_config: MobileAppAlertConfig
13309
13889
  :param _request_timeout: timeout setting for this request. If one
13310
13890
  number provided, it will be total request
13311
13891
  timeout. It can also be a pair (tuple) of
@@ -13328,9 +13908,8 @@ class EventSettingsApi:
13328
13908
  :return: Returns the result object.
13329
13909
  """ # noqa: E501
13330
13910
 
13331
- _param = self._update_mobile_app_alert_config_serialize(
13911
+ _param = self._update_mobile_app_historic_baseline_serialize(
13332
13912
  id=id,
13333
- mobile_app_alert_config=mobile_app_alert_config,
13334
13913
  _request_auth=_request_auth,
13335
13914
  _content_type=_content_type,
13336
13915
  _headers=_headers,
@@ -13338,12 +13917,12 @@ class EventSettingsApi:
13338
13917
  )
13339
13918
 
13340
13919
  _response_types_map: Dict[str, Optional[str]] = {
13341
- '200': "WithMetadata",
13920
+ '200': None,
13342
13921
  '204': None,
13343
13922
  '400': None,
13344
13923
  '403': None,
13345
- '422': None,
13346
- '500': None,
13924
+ '404': None,
13925
+ '428': None,
13347
13926
  }
13348
13927
  response_data = self.api_client.call_api(
13349
13928
  *_param,
@@ -13357,10 +13936,9 @@ class EventSettingsApi:
13357
13936
 
13358
13937
 
13359
13938
  @validate_call
13360
- def update_mobile_app_alert_config_without_preload_content(
13939
+ def update_mobile_app_historic_baseline_without_preload_content(
13361
13940
  self,
13362
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to update.")],
13363
- mobile_app_alert_config: MobileAppAlertConfig,
13941
+ id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
13364
13942
  _request_timeout: Union[
13365
13943
  None,
13366
13944
  Annotated[StrictFloat, Field(gt=0)],
@@ -13374,14 +13952,12 @@ class EventSettingsApi:
13374
13952
  _headers: Optional[Dict[StrictStr, Any]] = None,
13375
13953
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13376
13954
  ) -> RESTResponseType:
13377
- """Update Mobile Smart Alert Config
13955
+ """Recalculate Mobile Smart Alert Config Baseline
13378
13956
 
13379
- Updates an existing Mobile Smart Alert Configuration.
13957
+ 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
13958
 
13381
- :param id: ID of a specific Mobile Smart Alert Configuration to update. (required)
13959
+ :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
13382
13960
  :type id: str
13383
- :param mobile_app_alert_config: (required)
13384
- :type mobile_app_alert_config: MobileAppAlertConfig
13385
13961
  :param _request_timeout: timeout setting for this request. If one
13386
13962
  number provided, it will be total request
13387
13963
  timeout. It can also be a pair (tuple) of
@@ -13404,9 +13980,8 @@ class EventSettingsApi:
13404
13980
  :return: Returns the result object.
13405
13981
  """ # noqa: E501
13406
13982
 
13407
- _param = self._update_mobile_app_alert_config_serialize(
13983
+ _param = self._update_mobile_app_historic_baseline_serialize(
13408
13984
  id=id,
13409
- mobile_app_alert_config=mobile_app_alert_config,
13410
13985
  _request_auth=_request_auth,
13411
13986
  _content_type=_content_type,
13412
13987
  _headers=_headers,
@@ -13414,12 +13989,12 @@ class EventSettingsApi:
13414
13989
  )
13415
13990
 
13416
13991
  _response_types_map: Dict[str, Optional[str]] = {
13417
- '200': "WithMetadata",
13992
+ '200': None,
13418
13993
  '204': None,
13419
13994
  '400': None,
13420
13995
  '403': None,
13421
- '422': None,
13422
- '500': None,
13996
+ '404': None,
13997
+ '428': None,
13423
13998
  }
13424
13999
  response_data = self.api_client.call_api(
13425
14000
  *_param,
@@ -13428,10 +14003,9 @@ class EventSettingsApi:
13428
14003
  return response_data.response
13429
14004
 
13430
14005
 
13431
- def _update_mobile_app_alert_config_serialize(
14006
+ def _update_mobile_app_historic_baseline_serialize(
13432
14007
  self,
13433
14008
  id,
13434
- mobile_app_alert_config,
13435
14009
  _request_auth,
13436
14010
  _content_type,
13437
14011
  _headers,
@@ -13459,39 +14033,18 @@ class EventSettingsApi:
13459
14033
  # process the header parameters
13460
14034
  # process the form parameters
13461
14035
  # process the body parameter
13462
- if mobile_app_alert_config is not None:
13463
- _body_params = mobile_app_alert_config
13464
14036
 
13465
14037
 
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
14038
 
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
14039
 
13488
14040
  # authentication setting
13489
14041
  _auth_settings: List[str] = [
14042
+ 'ApiKeyAuth'
13490
14043
  ]
13491
14044
 
13492
14045
  return self.api_client.param_serialize(
13493
14046
  method='POST',
13494
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}',
14047
+ resource_path='/api/events/settings/mobile-app-alert-configs/{id}/update-baseline',
13495
14048
  path_params=_path_params,
13496
14049
  query_params=_query_params,
13497
14050
  header_params=_header_params,
@@ -13508,9 +14061,10 @@ class EventSettingsApi:
13508
14061
 
13509
14062
 
13510
14063
  @validate_call
13511
- def update_mobile_app_historic_baseline(
14064
+ def update_website_alert_config(
13512
14065
  self,
13513
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14066
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14067
+ website_alert_config: WebsiteAlertConfig,
13514
14068
  _request_timeout: Union[
13515
14069
  None,
13516
14070
  Annotated[StrictFloat, Field(gt=0)],
@@ -13523,13 +14077,15 @@ class EventSettingsApi:
13523
14077
  _content_type: Optional[StrictStr] = None,
13524
14078
  _headers: Optional[Dict[StrictStr, Any]] = None,
13525
14079
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13526
- ) -> None:
13527
- """Recalculate Mobile Smart Alert Config Baseline
14080
+ ) -> WebsiteAlertConfigWithMetadata:
14081
+ """Update Website Smart Alert Config
13528
14082
 
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.
14083
+ Updates an existing Website Smart Alert Configuration.
13530
14084
 
13531
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14085
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13532
14086
  :type id: str
14087
+ :param website_alert_config: (required)
14088
+ :type website_alert_config: WebsiteAlertConfig
13533
14089
  :param _request_timeout: timeout setting for this request. If one
13534
14090
  number provided, it will be total request
13535
14091
  timeout. It can also be a pair (tuple) of
@@ -13552,8 +14108,9 @@ class EventSettingsApi:
13552
14108
  :return: Returns the result object.
13553
14109
  """ # noqa: E501
13554
14110
 
13555
- _param = self._update_mobile_app_historic_baseline_serialize(
14111
+ _param = self._update_website_alert_config_serialize(
13556
14112
  id=id,
14113
+ website_alert_config=website_alert_config,
13557
14114
  _request_auth=_request_auth,
13558
14115
  _content_type=_content_type,
13559
14116
  _headers=_headers,
@@ -13561,9 +14118,14 @@ class EventSettingsApi:
13561
14118
  )
13562
14119
 
13563
14120
  _response_types_map: Dict[str, Optional[str]] = {
13564
- '200': None,
14121
+ '200': "WebsiteAlertConfigWithMetadata",
14122
+ '204': None,
13565
14123
  '400': None,
13566
14124
  '403': None,
14125
+ '404': None,
14126
+ '422': None,
14127
+ '428': None,
14128
+ '500': None,
13567
14129
  }
13568
14130
  response_data = self.api_client.call_api(
13569
14131
  *_param,
@@ -13577,9 +14139,10 @@ class EventSettingsApi:
13577
14139
 
13578
14140
 
13579
14141
  @validate_call
13580
- def update_mobile_app_historic_baseline_with_http_info(
14142
+ def update_website_alert_config_with_http_info(
13581
14143
  self,
13582
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14144
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14145
+ website_alert_config: WebsiteAlertConfig,
13583
14146
  _request_timeout: Union[
13584
14147
  None,
13585
14148
  Annotated[StrictFloat, Field(gt=0)],
@@ -13592,13 +14155,15 @@ class EventSettingsApi:
13592
14155
  _content_type: Optional[StrictStr] = None,
13593
14156
  _headers: Optional[Dict[StrictStr, Any]] = None,
13594
14157
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13595
- ) -> ApiResponse[None]:
13596
- """Recalculate Mobile Smart Alert Config Baseline
14158
+ ) -> ApiResponse[WebsiteAlertConfigWithMetadata]:
14159
+ """Update Website Smart Alert Config
13597
14160
 
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.
14161
+ Updates an existing Website Smart Alert Configuration.
13599
14162
 
13600
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14163
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13601
14164
  :type id: str
14165
+ :param website_alert_config: (required)
14166
+ :type website_alert_config: WebsiteAlertConfig
13602
14167
  :param _request_timeout: timeout setting for this request. If one
13603
14168
  number provided, it will be total request
13604
14169
  timeout. It can also be a pair (tuple) of
@@ -13621,8 +14186,9 @@ class EventSettingsApi:
13621
14186
  :return: Returns the result object.
13622
14187
  """ # noqa: E501
13623
14188
 
13624
- _param = self._update_mobile_app_historic_baseline_serialize(
14189
+ _param = self._update_website_alert_config_serialize(
13625
14190
  id=id,
14191
+ website_alert_config=website_alert_config,
13626
14192
  _request_auth=_request_auth,
13627
14193
  _content_type=_content_type,
13628
14194
  _headers=_headers,
@@ -13630,9 +14196,14 @@ class EventSettingsApi:
13630
14196
  )
13631
14197
 
13632
14198
  _response_types_map: Dict[str, Optional[str]] = {
13633
- '200': None,
14199
+ '200': "WebsiteAlertConfigWithMetadata",
14200
+ '204': None,
13634
14201
  '400': None,
13635
14202
  '403': None,
14203
+ '404': None,
14204
+ '422': None,
14205
+ '428': None,
14206
+ '500': None,
13636
14207
  }
13637
14208
  response_data = self.api_client.call_api(
13638
14209
  *_param,
@@ -13646,9 +14217,10 @@ class EventSettingsApi:
13646
14217
 
13647
14218
 
13648
14219
  @validate_call
13649
- def update_mobile_app_historic_baseline_without_preload_content(
14220
+ def update_website_alert_config_without_preload_content(
13650
14221
  self,
13651
- id: Annotated[StrictStr, Field(description="ID of a specific Mobile Smart Alert Configuration to recalculate.")],
14222
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
14223
+ website_alert_config: WebsiteAlertConfig,
13652
14224
  _request_timeout: Union[
13653
14225
  None,
13654
14226
  Annotated[StrictFloat, Field(gt=0)],
@@ -13662,12 +14234,14 @@ class EventSettingsApi:
13662
14234
  _headers: Optional[Dict[StrictStr, Any]] = None,
13663
14235
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13664
14236
  ) -> RESTResponseType:
13665
- """Recalculate Mobile Smart Alert Config Baseline
14237
+ """Update Website Smart Alert Config
13666
14238
 
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.
14239
+ Updates an existing Website Smart Alert Configuration.
13668
14240
 
13669
- :param id: ID of a specific Mobile Smart Alert Configuration to recalculate. (required)
14241
+ :param id: ID of a specific Website Smart Alert Configuration to update. (required)
13670
14242
  :type id: str
14243
+ :param website_alert_config: (required)
14244
+ :type website_alert_config: WebsiteAlertConfig
13671
14245
  :param _request_timeout: timeout setting for this request. If one
13672
14246
  number provided, it will be total request
13673
14247
  timeout. It can also be a pair (tuple) of
@@ -13690,8 +14264,9 @@ class EventSettingsApi:
13690
14264
  :return: Returns the result object.
13691
14265
  """ # noqa: E501
13692
14266
 
13693
- _param = self._update_mobile_app_historic_baseline_serialize(
14267
+ _param = self._update_website_alert_config_serialize(
13694
14268
  id=id,
14269
+ website_alert_config=website_alert_config,
13695
14270
  _request_auth=_request_auth,
13696
14271
  _content_type=_content_type,
13697
14272
  _headers=_headers,
@@ -13699,9 +14274,14 @@ class EventSettingsApi:
13699
14274
  )
13700
14275
 
13701
14276
  _response_types_map: Dict[str, Optional[str]] = {
13702
- '200': None,
14277
+ '200': "WebsiteAlertConfigWithMetadata",
14278
+ '204': None,
13703
14279
  '400': None,
13704
14280
  '403': None,
14281
+ '404': None,
14282
+ '422': None,
14283
+ '428': None,
14284
+ '500': None,
13705
14285
  }
13706
14286
  response_data = self.api_client.call_api(
13707
14287
  *_param,
@@ -13710,9 +14290,10 @@ class EventSettingsApi:
13710
14290
  return response_data.response
13711
14291
 
13712
14292
 
13713
- def _update_mobile_app_historic_baseline_serialize(
14293
+ def _update_website_alert_config_serialize(
13714
14294
  self,
13715
14295
  id,
14296
+ website_alert_config,
13716
14297
  _request_auth,
13717
14298
  _content_type,
13718
14299
  _headers,
@@ -13740,17 +14321,40 @@ class EventSettingsApi:
13740
14321
  # process the header parameters
13741
14322
  # process the form parameters
13742
14323
  # process the body parameter
14324
+ if website_alert_config is not None:
14325
+ _body_params = website_alert_config
13743
14326
 
13744
14327
 
14328
+ # set the HTTP header `Accept`
14329
+ if 'Accept' not in _header_params:
14330
+ _header_params['Accept'] = self.api_client.select_header_accept(
14331
+ [
14332
+ 'application/json'
14333
+ ]
14334
+ )
13745
14335
 
14336
+ # set the HTTP header `Content-Type`
14337
+ if _content_type:
14338
+ _header_params['Content-Type'] = _content_type
14339
+ else:
14340
+ _default_content_type = (
14341
+ self.api_client.select_header_content_type(
14342
+ [
14343
+ 'application/json'
14344
+ ]
14345
+ )
14346
+ )
14347
+ if _default_content_type is not None:
14348
+ _header_params['Content-Type'] = _default_content_type
13746
14349
 
13747
14350
  # authentication setting
13748
14351
  _auth_settings: List[str] = [
14352
+ 'ApiKeyAuth'
13749
14353
  ]
13750
14354
 
13751
14355
  return self.api_client.param_serialize(
13752
14356
  method='POST',
13753
- resource_path='/api/events/settings/mobile-app-alert-configs/{id}/update-baseline',
14357
+ resource_path='/api/events/settings/website-alert-configs/{id}',
13754
14358
  path_params=_path_params,
13755
14359
  query_params=_query_params,
13756
14360
  header_params=_header_params,
@@ -13767,10 +14371,9 @@ class EventSettingsApi:
13767
14371
 
13768
14372
 
13769
14373
  @validate_call
13770
- def update_website_alert_config(
14374
+ def update_website_historic_baseline(
13771
14375
  self,
13772
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13773
- website_alert_config: WebsiteAlertConfig,
14376
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13774
14377
  _request_timeout: Union[
13775
14378
  None,
13776
14379
  Annotated[StrictFloat, Field(gt=0)],
@@ -13783,15 +14386,13 @@ class EventSettingsApi:
13783
14386
  _content_type: Optional[StrictStr] = None,
13784
14387
  _headers: Optional[Dict[StrictStr, Any]] = None,
13785
14388
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13786
- ) -> WebsiteAlertConfigWithMetadata:
13787
- """Update Website Smart Alert Config
14389
+ ) -> None:
14390
+ """Recalculate Website Smart Alert Config Baseline
13788
14391
 
13789
- Updates an existing Website Smart Alert Configuration.
14392
+ 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
14393
 
13791
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14394
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13792
14395
  :type id: str
13793
- :param website_alert_config: (required)
13794
- :type website_alert_config: WebsiteAlertConfig
13795
14396
  :param _request_timeout: timeout setting for this request. If one
13796
14397
  number provided, it will be total request
13797
14398
  timeout. It can also be a pair (tuple) of
@@ -13814,9 +14415,8 @@ class EventSettingsApi:
13814
14415
  :return: Returns the result object.
13815
14416
  """ # noqa: E501
13816
14417
 
13817
- _param = self._update_website_alert_config_serialize(
14418
+ _param = self._update_website_historic_baseline_serialize(
13818
14419
  id=id,
13819
- website_alert_config=website_alert_config,
13820
14420
  _request_auth=_request_auth,
13821
14421
  _content_type=_content_type,
13822
14422
  _headers=_headers,
@@ -13824,12 +14424,12 @@ class EventSettingsApi:
13824
14424
  )
13825
14425
 
13826
14426
  _response_types_map: Dict[str, Optional[str]] = {
13827
- '200': "WebsiteAlertConfigWithMetadata",
14427
+ '200': None,
13828
14428
  '204': None,
13829
14429
  '400': None,
13830
14430
  '403': None,
13831
- '422': None,
13832
- '500': None,
14431
+ '404': None,
14432
+ '428': None,
13833
14433
  }
13834
14434
  response_data = self.api_client.call_api(
13835
14435
  *_param,
@@ -13843,10 +14443,9 @@ class EventSettingsApi:
13843
14443
 
13844
14444
 
13845
14445
  @validate_call
13846
- def update_website_alert_config_with_http_info(
14446
+ def update_website_historic_baseline_with_http_info(
13847
14447
  self,
13848
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13849
- website_alert_config: WebsiteAlertConfig,
14448
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13850
14449
  _request_timeout: Union[
13851
14450
  None,
13852
14451
  Annotated[StrictFloat, Field(gt=0)],
@@ -13859,15 +14458,13 @@ class EventSettingsApi:
13859
14458
  _content_type: Optional[StrictStr] = None,
13860
14459
  _headers: Optional[Dict[StrictStr, Any]] = None,
13861
14460
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13862
- ) -> ApiResponse[WebsiteAlertConfigWithMetadata]:
13863
- """Update Website Smart Alert Config
14461
+ ) -> ApiResponse[None]:
14462
+ """Recalculate Website Smart Alert Config Baseline
13864
14463
 
13865
- Updates an existing Website Smart Alert Configuration.
14464
+ 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
14465
 
13867
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14466
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13868
14467
  :type id: str
13869
- :param website_alert_config: (required)
13870
- :type website_alert_config: WebsiteAlertConfig
13871
14468
  :param _request_timeout: timeout setting for this request. If one
13872
14469
  number provided, it will be total request
13873
14470
  timeout. It can also be a pair (tuple) of
@@ -13890,9 +14487,8 @@ class EventSettingsApi:
13890
14487
  :return: Returns the result object.
13891
14488
  """ # noqa: E501
13892
14489
 
13893
- _param = self._update_website_alert_config_serialize(
14490
+ _param = self._update_website_historic_baseline_serialize(
13894
14491
  id=id,
13895
- website_alert_config=website_alert_config,
13896
14492
  _request_auth=_request_auth,
13897
14493
  _content_type=_content_type,
13898
14494
  _headers=_headers,
@@ -13900,12 +14496,12 @@ class EventSettingsApi:
13900
14496
  )
13901
14497
 
13902
14498
  _response_types_map: Dict[str, Optional[str]] = {
13903
- '200': "WebsiteAlertConfigWithMetadata",
14499
+ '200': None,
13904
14500
  '204': None,
13905
14501
  '400': None,
13906
14502
  '403': None,
13907
- '422': None,
13908
- '500': None,
14503
+ '404': None,
14504
+ '428': None,
13909
14505
  }
13910
14506
  response_data = self.api_client.call_api(
13911
14507
  *_param,
@@ -13919,10 +14515,9 @@ class EventSettingsApi:
13919
14515
 
13920
14516
 
13921
14517
  @validate_call
13922
- def update_website_alert_config_without_preload_content(
14518
+ def update_website_historic_baseline_without_preload_content(
13923
14519
  self,
13924
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to update.")],
13925
- website_alert_config: WebsiteAlertConfig,
14520
+ id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
13926
14521
  _request_timeout: Union[
13927
14522
  None,
13928
14523
  Annotated[StrictFloat, Field(gt=0)],
@@ -13936,14 +14531,12 @@ class EventSettingsApi:
13936
14531
  _headers: Optional[Dict[StrictStr, Any]] = None,
13937
14532
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
13938
14533
  ) -> RESTResponseType:
13939
- """Update Website Smart Alert Config
14534
+ """Recalculate Website Smart Alert Config Baseline
13940
14535
 
13941
- Updates an existing Website Smart Alert Configuration.
14536
+ 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
14537
 
13943
- :param id: ID of a specific Website Smart Alert Configuration to update. (required)
14538
+ :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
13944
14539
  :type id: str
13945
- :param website_alert_config: (required)
13946
- :type website_alert_config: WebsiteAlertConfig
13947
14540
  :param _request_timeout: timeout setting for this request. If one
13948
14541
  number provided, it will be total request
13949
14542
  timeout. It can also be a pair (tuple) of
@@ -13966,9 +14559,8 @@ class EventSettingsApi:
13966
14559
  :return: Returns the result object.
13967
14560
  """ # noqa: E501
13968
14561
 
13969
- _param = self._update_website_alert_config_serialize(
14562
+ _param = self._update_website_historic_baseline_serialize(
13970
14563
  id=id,
13971
- website_alert_config=website_alert_config,
13972
14564
  _request_auth=_request_auth,
13973
14565
  _content_type=_content_type,
13974
14566
  _headers=_headers,
@@ -13976,12 +14568,12 @@ class EventSettingsApi:
13976
14568
  )
13977
14569
 
13978
14570
  _response_types_map: Dict[str, Optional[str]] = {
13979
- '200': "WebsiteAlertConfigWithMetadata",
14571
+ '200': None,
13980
14572
  '204': None,
13981
14573
  '400': None,
13982
14574
  '403': None,
13983
- '422': None,
13984
- '500': None,
14575
+ '404': None,
14576
+ '428': None,
13985
14577
  }
13986
14578
  response_data = self.api_client.call_api(
13987
14579
  *_param,
@@ -13990,10 +14582,9 @@ class EventSettingsApi:
13990
14582
  return response_data.response
13991
14583
 
13992
14584
 
13993
- def _update_website_alert_config_serialize(
14585
+ def _update_website_historic_baseline_serialize(
13994
14586
  self,
13995
14587
  id,
13996
- website_alert_config,
13997
14588
  _request_auth,
13998
14589
  _content_type,
13999
14590
  _headers,
@@ -14021,31 +14612,9 @@ class EventSettingsApi:
14021
14612
  # process the header parameters
14022
14613
  # process the form parameters
14023
14614
  # process the body parameter
14024
- if website_alert_config is not None:
14025
- _body_params = website_alert_config
14026
14615
 
14027
14616
 
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
14617
 
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
14618
 
14050
14619
  # authentication setting
14051
14620
  _auth_settings: List[str] = [
@@ -14054,7 +14623,7 @@ class EventSettingsApi:
14054
14623
 
14055
14624
  return self.api_client.param_serialize(
14056
14625
  method='POST',
14057
- resource_path='/api/events/settings/website-alert-configs/{id}',
14626
+ resource_path='/api/events/settings/website-alert-configs/{id}/update-baseline',
14058
14627
  path_params=_path_params,
14059
14628
  query_params=_query_params,
14060
14629
  header_params=_header_params,
@@ -14071,9 +14640,9 @@ class EventSettingsApi:
14071
14640
 
14072
14641
 
14073
14642
  @validate_call
14074
- def update_website_historic_baseline(
14643
+ def upsert_custom_payload_configuration(
14075
14644
  self,
14076
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14645
+ custom_payload_configuration: CustomPayloadConfiguration,
14077
14646
  _request_timeout: Union[
14078
14647
  None,
14079
14648
  Annotated[StrictFloat, Field(gt=0)],
@@ -14086,13 +14655,13 @@ class EventSettingsApi:
14086
14655
  _content_type: Optional[StrictStr] = None,
14087
14656
  _headers: Optional[Dict[StrictStr, Any]] = None,
14088
14657
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14089
- ) -> None:
14090
- """Recalculate Website Smart Alert Config Baseline
14658
+ ) -> List[CustomPayloadWithLastUpdated]:
14659
+ """Create/Update Global Custom Payload Configuration
14091
14660
 
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.
14661
+ Creates or Updates Global Custom Payload Configuration.
14093
14662
 
14094
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14095
- :type id: str
14663
+ :param custom_payload_configuration: (required)
14664
+ :type custom_payload_configuration: CustomPayloadConfiguration
14096
14665
  :param _request_timeout: timeout setting for this request. If one
14097
14666
  number provided, it will be total request
14098
14667
  timeout. It can also be a pair (tuple) of
@@ -14115,8 +14684,8 @@ class EventSettingsApi:
14115
14684
  :return: Returns the result object.
14116
14685
  """ # noqa: E501
14117
14686
 
14118
- _param = self._update_website_historic_baseline_serialize(
14119
- id=id,
14687
+ _param = self._upsert_custom_payload_configuration_serialize(
14688
+ custom_payload_configuration=custom_payload_configuration,
14120
14689
  _request_auth=_request_auth,
14121
14690
  _content_type=_content_type,
14122
14691
  _headers=_headers,
@@ -14124,9 +14693,10 @@ class EventSettingsApi:
14124
14693
  )
14125
14694
 
14126
14695
  _response_types_map: Dict[str, Optional[str]] = {
14127
- '200': None,
14128
- '400': None,
14696
+ '200': "List[CustomPayloadWithLastUpdated]",
14697
+ '401': None,
14129
14698
  '403': None,
14699
+ '422': None,
14130
14700
  }
14131
14701
  response_data = self.api_client.call_api(
14132
14702
  *_param,
@@ -14140,9 +14710,9 @@ class EventSettingsApi:
14140
14710
 
14141
14711
 
14142
14712
  @validate_call
14143
- def update_website_historic_baseline_with_http_info(
14713
+ def upsert_custom_payload_configuration_with_http_info(
14144
14714
  self,
14145
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14715
+ custom_payload_configuration: CustomPayloadConfiguration,
14146
14716
  _request_timeout: Union[
14147
14717
  None,
14148
14718
  Annotated[StrictFloat, Field(gt=0)],
@@ -14155,13 +14725,13 @@ class EventSettingsApi:
14155
14725
  _content_type: Optional[StrictStr] = None,
14156
14726
  _headers: Optional[Dict[StrictStr, Any]] = None,
14157
14727
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14158
- ) -> ApiResponse[None]:
14159
- """Recalculate Website Smart Alert Config Baseline
14728
+ ) -> ApiResponse[List[CustomPayloadWithLastUpdated]]:
14729
+ """Create/Update Global Custom Payload Configuration
14160
14730
 
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.
14731
+ Creates or Updates Global Custom Payload Configuration.
14162
14732
 
14163
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14164
- :type id: str
14733
+ :param custom_payload_configuration: (required)
14734
+ :type custom_payload_configuration: CustomPayloadConfiguration
14165
14735
  :param _request_timeout: timeout setting for this request. If one
14166
14736
  number provided, it will be total request
14167
14737
  timeout. It can also be a pair (tuple) of
@@ -14184,8 +14754,8 @@ class EventSettingsApi:
14184
14754
  :return: Returns the result object.
14185
14755
  """ # noqa: E501
14186
14756
 
14187
- _param = self._update_website_historic_baseline_serialize(
14188
- id=id,
14757
+ _param = self._upsert_custom_payload_configuration_serialize(
14758
+ custom_payload_configuration=custom_payload_configuration,
14189
14759
  _request_auth=_request_auth,
14190
14760
  _content_type=_content_type,
14191
14761
  _headers=_headers,
@@ -14193,9 +14763,10 @@ class EventSettingsApi:
14193
14763
  )
14194
14764
 
14195
14765
  _response_types_map: Dict[str, Optional[str]] = {
14196
- '200': None,
14197
- '400': None,
14766
+ '200': "List[CustomPayloadWithLastUpdated]",
14767
+ '401': None,
14198
14768
  '403': None,
14769
+ '422': None,
14199
14770
  }
14200
14771
  response_data = self.api_client.call_api(
14201
14772
  *_param,
@@ -14209,9 +14780,9 @@ class EventSettingsApi:
14209
14780
 
14210
14781
 
14211
14782
  @validate_call
14212
- def update_website_historic_baseline_without_preload_content(
14783
+ def upsert_custom_payload_configuration_without_preload_content(
14213
14784
  self,
14214
- id: Annotated[StrictStr, Field(description="ID of a specific Website Smart Alert Configuration to recalculate.")],
14785
+ custom_payload_configuration: CustomPayloadConfiguration,
14215
14786
  _request_timeout: Union[
14216
14787
  None,
14217
14788
  Annotated[StrictFloat, Field(gt=0)],
@@ -14225,12 +14796,12 @@ class EventSettingsApi:
14225
14796
  _headers: Optional[Dict[StrictStr, Any]] = None,
14226
14797
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14227
14798
  ) -> RESTResponseType:
14228
- """Recalculate Website Smart Alert Config Baseline
14799
+ """Create/Update Global Custom Payload Configuration
14229
14800
 
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.
14801
+ Creates or Updates Global Custom Payload Configuration.
14231
14802
 
14232
- :param id: ID of a specific Website Smart Alert Configuration to recalculate. (required)
14233
- :type id: str
14803
+ :param custom_payload_configuration: (required)
14804
+ :type custom_payload_configuration: CustomPayloadConfiguration
14234
14805
  :param _request_timeout: timeout setting for this request. If one
14235
14806
  number provided, it will be total request
14236
14807
  timeout. It can also be a pair (tuple) of
@@ -14253,8 +14824,8 @@ class EventSettingsApi:
14253
14824
  :return: Returns the result object.
14254
14825
  """ # noqa: E501
14255
14826
 
14256
- _param = self._update_website_historic_baseline_serialize(
14257
- id=id,
14827
+ _param = self._upsert_custom_payload_configuration_serialize(
14828
+ custom_payload_configuration=custom_payload_configuration,
14258
14829
  _request_auth=_request_auth,
14259
14830
  _content_type=_content_type,
14260
14831
  _headers=_headers,
@@ -14262,9 +14833,10 @@ class EventSettingsApi:
14262
14833
  )
14263
14834
 
14264
14835
  _response_types_map: Dict[str, Optional[str]] = {
14265
- '200': None,
14266
- '400': None,
14836
+ '200': "List[CustomPayloadWithLastUpdated]",
14837
+ '401': None,
14267
14838
  '403': None,
14839
+ '422': None,
14268
14840
  }
14269
14841
  response_data = self.api_client.call_api(
14270
14842
  *_param,
@@ -14273,9 +14845,9 @@ class EventSettingsApi:
14273
14845
  return response_data.response
14274
14846
 
14275
14847
 
14276
- def _update_website_historic_baseline_serialize(
14848
+ def _upsert_custom_payload_configuration_serialize(
14277
14849
  self,
14278
- id,
14850
+ custom_payload_configuration,
14279
14851
  _request_auth,
14280
14852
  _content_type,
14281
14853
  _headers,
@@ -14297,15 +14869,35 @@ class EventSettingsApi:
14297
14869
  _body_params: Optional[bytes] = None
14298
14870
 
14299
14871
  # process the path parameters
14300
- if id is not None:
14301
- _path_params['id'] = id
14302
14872
  # process the query parameters
14303
14873
  # process the header parameters
14304
14874
  # process the form parameters
14305
14875
  # process the body parameter
14876
+ if custom_payload_configuration is not None:
14877
+ _body_params = custom_payload_configuration
14306
14878
 
14307
14879
 
14880
+ # set the HTTP header `Accept`
14881
+ if 'Accept' not in _header_params:
14882
+ _header_params['Accept'] = self.api_client.select_header_accept(
14883
+ [
14884
+ 'application/json'
14885
+ ]
14886
+ )
14308
14887
 
14888
+ # set the HTTP header `Content-Type`
14889
+ if _content_type:
14890
+ _header_params['Content-Type'] = _content_type
14891
+ else:
14892
+ _default_content_type = (
14893
+ self.api_client.select_header_content_type(
14894
+ [
14895
+ 'application/json'
14896
+ ]
14897
+ )
14898
+ )
14899
+ if _default_content_type is not None:
14900
+ _header_params['Content-Type'] = _default_content_type
14309
14901
 
14310
14902
  # authentication setting
14311
14903
  _auth_settings: List[str] = [
@@ -14313,8 +14905,8 @@ class EventSettingsApi:
14313
14905
  ]
14314
14906
 
14315
14907
  return self.api_client.param_serialize(
14316
- method='POST',
14317
- resource_path='/api/events/settings/website-alert-configs/{id}/update-baseline',
14908
+ method='PUT',
14909
+ resource_path='/api/events/settings/custom-payload-configurations',
14318
14910
  path_params=_path_params,
14319
14911
  query_params=_query_params,
14320
14912
  header_params=_header_params,
@@ -14331,7 +14923,7 @@ class EventSettingsApi:
14331
14923
 
14332
14924
 
14333
14925
  @validate_call
14334
- def upsert_custom_payload_configuration(
14926
+ def upsert_custom_payload_configuration_v2(
14335
14927
  self,
14336
14928
  custom_payload_configuration: CustomPayloadConfiguration,
14337
14929
  _request_timeout: Union[
@@ -14346,7 +14938,7 @@ class EventSettingsApi:
14346
14938
  _content_type: Optional[StrictStr] = None,
14347
14939
  _headers: Optional[Dict[StrictStr, Any]] = None,
14348
14940
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14349
- ) -> List[CustomPayloadWithLastUpdated]:
14941
+ ) -> List[CustomPayloadWithVersion]:
14350
14942
  """Create/Update Global Custom Payload Configuration
14351
14943
 
14352
14944
  Creates or Updates Global Custom Payload Configuration.
@@ -14375,7 +14967,7 @@ class EventSettingsApi:
14375
14967
  :return: Returns the result object.
14376
14968
  """ # noqa: E501
14377
14969
 
14378
- _param = self._upsert_custom_payload_configuration_serialize(
14970
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14379
14971
  custom_payload_configuration=custom_payload_configuration,
14380
14972
  _request_auth=_request_auth,
14381
14973
  _content_type=_content_type,
@@ -14384,9 +14976,11 @@ class EventSettingsApi:
14384
14976
  )
14385
14977
 
14386
14978
  _response_types_map: Dict[str, Optional[str]] = {
14387
- '200': "List[CustomPayloadWithLastUpdated]",
14979
+ '200': "List[CustomPayloadWithVersion]",
14980
+ '400': None,
14388
14981
  '401': None,
14389
14982
  '403': None,
14983
+ '409': None,
14390
14984
  '422': None,
14391
14985
  }
14392
14986
  response_data = self.api_client.call_api(
@@ -14401,7 +14995,7 @@ class EventSettingsApi:
14401
14995
 
14402
14996
 
14403
14997
  @validate_call
14404
- def upsert_custom_payload_configuration_with_http_info(
14998
+ def upsert_custom_payload_configuration_v2_with_http_info(
14405
14999
  self,
14406
15000
  custom_payload_configuration: CustomPayloadConfiguration,
14407
15001
  _request_timeout: Union[
@@ -14416,7 +15010,7 @@ class EventSettingsApi:
14416
15010
  _content_type: Optional[StrictStr] = None,
14417
15011
  _headers: Optional[Dict[StrictStr, Any]] = None,
14418
15012
  _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
14419
- ) -> ApiResponse[List[CustomPayloadWithLastUpdated]]:
15013
+ ) -> ApiResponse[List[CustomPayloadWithVersion]]:
14420
15014
  """Create/Update Global Custom Payload Configuration
14421
15015
 
14422
15016
  Creates or Updates Global Custom Payload Configuration.
@@ -14445,7 +15039,7 @@ class EventSettingsApi:
14445
15039
  :return: Returns the result object.
14446
15040
  """ # noqa: E501
14447
15041
 
14448
- _param = self._upsert_custom_payload_configuration_serialize(
15042
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14449
15043
  custom_payload_configuration=custom_payload_configuration,
14450
15044
  _request_auth=_request_auth,
14451
15045
  _content_type=_content_type,
@@ -14454,9 +15048,11 @@ class EventSettingsApi:
14454
15048
  )
14455
15049
 
14456
15050
  _response_types_map: Dict[str, Optional[str]] = {
14457
- '200': "List[CustomPayloadWithLastUpdated]",
15051
+ '200': "List[CustomPayloadWithVersion]",
15052
+ '400': None,
14458
15053
  '401': None,
14459
15054
  '403': None,
15055
+ '409': None,
14460
15056
  '422': None,
14461
15057
  }
14462
15058
  response_data = self.api_client.call_api(
@@ -14471,7 +15067,7 @@ class EventSettingsApi:
14471
15067
 
14472
15068
 
14473
15069
  @validate_call
14474
- def upsert_custom_payload_configuration_without_preload_content(
15070
+ def upsert_custom_payload_configuration_v2_without_preload_content(
14475
15071
  self,
14476
15072
  custom_payload_configuration: CustomPayloadConfiguration,
14477
15073
  _request_timeout: Union[
@@ -14515,7 +15111,7 @@ class EventSettingsApi:
14515
15111
  :return: Returns the result object.
14516
15112
  """ # noqa: E501
14517
15113
 
14518
- _param = self._upsert_custom_payload_configuration_serialize(
15114
+ _param = self._upsert_custom_payload_configuration_v2_serialize(
14519
15115
  custom_payload_configuration=custom_payload_configuration,
14520
15116
  _request_auth=_request_auth,
14521
15117
  _content_type=_content_type,
@@ -14524,9 +15120,11 @@ class EventSettingsApi:
14524
15120
  )
14525
15121
 
14526
15122
  _response_types_map: Dict[str, Optional[str]] = {
14527
- '200': "List[CustomPayloadWithLastUpdated]",
15123
+ '200': "List[CustomPayloadWithVersion]",
15124
+ '400': None,
14528
15125
  '401': None,
14529
15126
  '403': None,
15127
+ '409': None,
14530
15128
  '422': None,
14531
15129
  }
14532
15130
  response_data = self.api_client.call_api(
@@ -14536,7 +15134,7 @@ class EventSettingsApi:
14536
15134
  return response_data.response
14537
15135
 
14538
15136
 
14539
- def _upsert_custom_payload_configuration_serialize(
15137
+ def _upsert_custom_payload_configuration_v2_serialize(
14540
15138
  self,
14541
15139
  custom_payload_configuration,
14542
15140
  _request_auth,
@@ -14597,7 +15195,7 @@ class EventSettingsApi:
14597
15195
 
14598
15196
  return self.api_client.param_serialize(
14599
15197
  method='PUT',
14600
- resource_path='/api/events/settings/custom-payload-configurations',
15198
+ resource_path='/api/events/settings/custom-payload-configurations/v2',
14601
15199
  path_params=_path_params,
14602
15200
  query_params=_query_params,
14603
15201
  header_params=_header_params,