mailslurp_client 17.1.0 → 17.3.0

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 (267) hide show
  1. checksums.yaml +4 -4
  2. data/lib/mailslurp_client/api/api_audit_log_controller_api.rb +237 -0
  3. data/lib/mailslurp_client/api/attachment_controller_api.rb +66 -0
  4. data/lib/mailslurp_client/api/bounce_controller_api.rb +126 -0
  5. data/lib/mailslurp_client/api/campaign_probe_controller_api.rb +802 -0
  6. data/lib/mailslurp_client/api/deliverability_test_controller_api.rb +1496 -0
  7. data/lib/mailslurp_client/api/device_previews_controller_api.rb +1012 -0
  8. data/lib/mailslurp_client/api/domain_controller_api.rb +63 -0
  9. data/lib/mailslurp_client/api/domain_monitor_controller_api.rb +1112 -0
  10. data/lib/mailslurp_client/api/email_audit_controller_api.rb +334 -0
  11. data/lib/mailslurp_client/api/email_controller_api.rb +394 -138
  12. data/lib/mailslurp_client/api/inbox_controller_api.rb +144 -4
  13. data/lib/mailslurp_client/api/missed_sms_controller_api.rb +221 -0
  14. data/lib/mailslurp_client/api/phone_controller_api.rb +1314 -83
  15. data/lib/mailslurp_client/api/sms_controller_api.rb +191 -0
  16. data/lib/mailslurp_client/api/tools_controller_api.rb +806 -0
  17. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +15 -15
  18. data/lib/mailslurp_client/models/acquire_phone_pool_lease_options.rb +233 -0
  19. data/lib/mailslurp_client/models/add_phone_pool_numbers_options.rb +213 -0
  20. data/lib/mailslurp_client/models/ai_transform_mapping_projection.rb +39 -39
  21. data/lib/mailslurp_client/models/ai_transform_projection.rb +28 -28
  22. data/lib/mailslurp_client/models/alias_projection.rb +48 -48
  23. data/lib/mailslurp_client/models/alias_thread_projection.rb +44 -44
  24. data/lib/mailslurp_client/models/analyze_dmarc_report_options.rb +248 -0
  25. data/lib/mailslurp_client/models/analyze_dmarc_report_results.rb +386 -0
  26. data/lib/mailslurp_client/models/analyze_email_headers_options.rb +240 -0
  27. data/lib/mailslurp_client/models/analyze_email_headers_results.rb +275 -0
  28. data/lib/mailslurp_client/models/attachment_projection.rb +50 -50
  29. data/lib/mailslurp_client/models/audit_log_event_dto.rb +343 -0
  30. data/lib/mailslurp_client/models/audit_log_page_dto.rb +222 -0
  31. data/lib/mailslurp_client/models/audit_log_search_options.rb +323 -0
  32. data/lib/mailslurp_client/models/available_phone_number_dto.rb +325 -0
  33. data/lib/mailslurp_client/models/available_phone_numbers_result.rb +236 -0
  34. data/lib/mailslurp_client/models/bounce_projection.rb +14 -14
  35. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +10 -10
  36. data/lib/mailslurp_client/models/campaign_probe_dto.rb +411 -0
  37. data/lib/mailslurp_client/models/campaign_probe_insights_dto.rb +408 -0
  38. data/lib/mailslurp_client/models/campaign_probe_run_comparison_dto.rb +397 -0
  39. data/lib/mailslurp_client/models/campaign_probe_run_dto.rb +644 -0
  40. data/lib/mailslurp_client/models/campaign_probe_run_due_result.rb +315 -0
  41. data/lib/mailslurp_client/models/campaign_probe_run_now_result.rb +225 -0
  42. data/lib/mailslurp_client/models/campaign_probe_series_dto.rb +303 -0
  43. data/lib/mailslurp_client/models/campaign_probe_series_point_dto.rb +295 -0
  44. data/lib/mailslurp_client/models/cancel_device_preview_run_options.rb +206 -0
  45. data/lib/mailslurp_client/models/cancel_device_preview_run_result.rb +248 -0
  46. data/lib/mailslurp_client/models/check_campaign_probe_options.rb +371 -0
  47. data/lib/mailslurp_client/models/check_campaign_probe_results.rb +482 -0
  48. data/lib/mailslurp_client/models/check_dns_propagation_options.rb +297 -0
  49. data/lib/mailslurp_client/models/check_dns_propagation_results.rb +361 -0
  50. data/lib/mailslurp_client/models/check_domain_monitor_options.rb +243 -0
  51. data/lib/mailslurp_client/models/check_domain_monitor_results.rb +398 -0
  52. data/lib/mailslurp_client/models/check_email_audit_options.rb +405 -0
  53. data/lib/mailslurp_client/models/check_email_auth_stack_options.rb +248 -0
  54. data/lib/mailslurp_client/models/check_email_auth_stack_results.rb +462 -0
  55. data/lib/mailslurp_client/models/check_email_blacklist_options.rb +241 -0
  56. data/lib/mailslurp_client/models/check_email_blacklist_results.rb +366 -0
  57. data/lib/mailslurp_client/models/code_candidate.rb +303 -0
  58. data/lib/mailslurp_client/models/connector_event_projection.rb +33 -33
  59. data/lib/mailslurp_client/models/connector_projection.rb +42 -42
  60. data/lib/mailslurp_client/models/contact_projection.rb +24 -24
  61. data/lib/mailslurp_client/models/create_campaign_probe_options.rb +290 -0
  62. data/lib/mailslurp_client/models/create_campaign_probe_run_options.rb +264 -0
  63. data/lib/mailslurp_client/models/create_deliverability_simulation_job_options.rb +345 -0
  64. data/lib/mailslurp_client/models/create_deliverability_test_options.rb +372 -0
  65. data/lib/mailslurp_client/models/create_device_preview_feedback_options.rb +405 -0
  66. data/lib/mailslurp_client/models/create_device_preview_options.rb +241 -0
  67. data/lib/mailslurp_client/models/create_device_preview_run_result.rb +225 -0
  68. data/lib/mailslurp_client/models/create_domain_monitor_alert_sink_options.rb +308 -0
  69. data/lib/mailslurp_client/models/create_domain_monitor_options.rb +299 -0
  70. data/lib/mailslurp_client/models/create_email_audit_options.rb +394 -0
  71. data/lib/mailslurp_client/models/create_phone_number_options.rb +25 -4
  72. data/lib/mailslurp_client/models/create_phone_pool_options.rb +220 -0
  73. data/lib/mailslurp_client/models/create_phone_provisioning_job_item_options.rb +256 -0
  74. data/lib/mailslurp_client/models/create_phone_provisioning_job_options.rb +284 -0
  75. data/lib/mailslurp_client/models/delete_device_preview_run_result.rb +253 -0
  76. data/lib/mailslurp_client/models/delete_result.rb +245 -0
  77. data/lib/mailslurp_client/models/deliverability_analytics_run_dto.rb +426 -0
  78. data/lib/mailslurp_client/models/deliverability_analytics_series_dto.rb +342 -0
  79. data/lib/mailslurp_client/models/deliverability_analytics_series_point_dto.rb +240 -0
  80. data/lib/mailslurp_client/models/deliverability_analytics_summary_dto.rb +380 -0
  81. data/lib/mailslurp_client/models/deliverability_entity_result_dto.rb +360 -0
  82. data/lib/mailslurp_client/models/deliverability_entity_result_page_dto.rb +318 -0
  83. data/lib/mailslurp_client/models/deliverability_expectation.rb +276 -0
  84. data/lib/mailslurp_client/models/deliverability_expectation_result_dto.rb +294 -0
  85. data/lib/mailslurp_client/models/deliverability_failure_entity_hotspot_dto.rb +360 -0
  86. data/lib/mailslurp_client/models/deliverability_failure_hotspots_dto.rb +302 -0
  87. data/lib/mailslurp_client/models/deliverability_failure_phone_dimension_hotspot_dto.rb +306 -0
  88. data/lib/mailslurp_client/models/deliverability_poll_status_result_dto.rb +250 -0
  89. data/lib/mailslurp_client/models/deliverability_selector_options.rb +307 -0
  90. data/lib/mailslurp_client/models/deliverability_simulation_email_options.rb +231 -0
  91. data/lib/mailslurp_client/models/deliverability_simulation_job_config_dto.rb +300 -0
  92. data/lib/mailslurp_client/models/deliverability_simulation_job_dto.rb +494 -0
  93. data/lib/mailslurp_client/models/deliverability_simulation_job_error_summary_dto.rb +224 -0
  94. data/lib/mailslurp_client/models/deliverability_simulation_job_event_dto.rb +344 -0
  95. data/lib/mailslurp_client/models/deliverability_simulation_job_event_page_dto.rb +284 -0
  96. data/lib/mailslurp_client/models/deliverability_simulation_job_top_error_dto.rb +226 -0
  97. data/lib/mailslurp_client/models/deliverability_simulation_sms_options.rb +209 -0
  98. data/lib/mailslurp_client/models/deliverability_test_dto.rb +558 -0
  99. data/lib/mailslurp_client/models/deliverability_test_page_dto.rb +270 -0
  100. data/lib/mailslurp_client/models/device_preview_feedback_dto.rb +456 -0
  101. data/lib/mailslurp_client/models/device_preview_feedback_list_dto.rb +255 -0
  102. data/lib/mailslurp_client/models/device_preview_provider_progress_dto.rb +387 -0
  103. data/lib/mailslurp_client/models/device_preview_run_dto.rb +382 -0
  104. data/lib/mailslurp_client/models/device_preview_run_results_dto.rb +243 -0
  105. data/lib/mailslurp_client/models/device_preview_screenshot_dto.rb +389 -0
  106. data/lib/mailslurp_client/models/device_preview_target_dto.rb +368 -0
  107. data/lib/mailslurp_client/models/dmarc_report_metadata.rb +308 -0
  108. data/lib/mailslurp_client/models/dmarc_report_source_summary.rb +274 -0
  109. data/lib/mailslurp_client/models/dns_propagation_resolver_result.rb +252 -0
  110. data/lib/mailslurp_client/models/domain_monitor_alert_sink_dto.rb +369 -0
  111. data/lib/mailslurp_client/models/domain_monitor_dto.rb +383 -0
  112. data/lib/mailslurp_client/models/domain_monitor_insights_dto.rb +422 -0
  113. data/lib/mailslurp_client/models/domain_monitor_run_comparison_dto.rb +369 -0
  114. data/lib/mailslurp_client/models/domain_monitor_run_dto.rb +492 -0
  115. data/lib/mailslurp_client/models/domain_monitor_run_due_result.rb +287 -0
  116. data/lib/mailslurp_client/models/domain_monitor_run_now_result.rb +225 -0
  117. data/lib/mailslurp_client/models/domain_monitor_series_dto.rb +303 -0
  118. data/lib/mailslurp_client/models/domain_monitor_series_point_dto.rb +309 -0
  119. data/lib/mailslurp_client/models/domain_monitor_summary_dto.rb +248 -0
  120. data/lib/mailslurp_client/models/domain_region_group.rb +261 -0
  121. data/lib/mailslurp_client/models/domain_region_groups_dto.rb +214 -0
  122. data/lib/mailslurp_client/models/domain_region_information.rb +338 -0
  123. data/lib/mailslurp_client/models/email_audit_analysis_result.rb +620 -0
  124. data/lib/mailslurp_client/models/email_audit_comparison_dto.rb +411 -0
  125. data/lib/mailslurp_client/models/email_audit_dto.rb +308 -0
  126. data/lib/mailslurp_client/models/email_audit_spelling_issue.rb +276 -0
  127. data/lib/mailslurp_client/models/email_audit_url_issue.rb +236 -0
  128. data/lib/mailslurp_client/models/email_blacklist_ip_result.rb +242 -0
  129. data/lib/mailslurp_client/models/email_blacklist_listing_result.rb +258 -0
  130. data/lib/mailslurp_client/models/email_header_analysis_summary.rb +242 -0
  131. data/lib/mailslurp_client/models/email_header_received_hop.rb +242 -0
  132. data/lib/mailslurp_client/models/email_projection.rb +66 -66
  133. data/lib/mailslurp_client/models/email_signature.rb +254 -0
  134. data/lib/mailslurp_client/models/email_signature_parse_result.rb +223 -0
  135. data/lib/mailslurp_client/models/email_thread_projection.rb +78 -78
  136. data/lib/mailslurp_client/models/entity_automation_item_projection.rb +27 -27
  137. data/lib/mailslurp_client/models/entity_event_item_projection.rb +45 -45
  138. data/lib/mailslurp_client/models/entity_favourite_item_projection.rb +29 -29
  139. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +27 -27
  140. data/lib/mailslurp_client/models/extract_attachment_text_options.rb +268 -0
  141. data/lib/mailslurp_client/models/extract_attachment_text_result.rb +297 -0
  142. data/lib/mailslurp_client/models/extract_codes_options.rb +304 -0
  143. data/lib/mailslurp_client/models/extract_codes_result.rb +303 -0
  144. data/lib/mailslurp_client/models/generate_spf_record_options.rb +357 -0
  145. data/lib/mailslurp_client/models/generate_spf_record_results.rb +318 -0
  146. data/lib/mailslurp_client/models/get_or_create_phone_pool_options.rb +220 -0
  147. data/lib/mailslurp_client/models/group_projection.rb +15 -15
  148. data/lib/mailslurp_client/models/guest_portal_user_projection.rb +50 -50
  149. data/lib/mailslurp_client/models/imap_email_projection.rb +18 -18
  150. data/lib/mailslurp_client/models/inbox_dto.rb +2 -2
  151. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +21 -21
  152. data/lib/mailslurp_client/models/inbox_preview.rb +2 -2
  153. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +33 -33
  154. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +19 -19
  155. data/lib/mailslurp_client/models/lookup_dkim_domain_options.rb +275 -0
  156. data/lib/mailslurp_client/models/lookup_dkim_domain_results.rb +304 -0
  157. data/lib/mailslurp_client/models/lookup_ptr_options.rb +241 -0
  158. data/lib/mailslurp_client/models/lookup_ptr_results.rb +305 -0
  159. data/lib/mailslurp_client/models/lookup_spf_domain_options.rb +240 -0
  160. data/lib/mailslurp_client/models/lookup_spf_domain_results.rb +305 -0
  161. data/lib/mailslurp_client/models/missed_email_projection.rb +28 -28
  162. data/lib/mailslurp_client/models/missed_sms_dto.rb +320 -0
  163. data/lib/mailslurp_client/models/missed_sms_projection.rb +282 -0
  164. data/lib/mailslurp_client/models/opt_in_identity_projection.rb +24 -24
  165. data/lib/mailslurp_client/models/organization_inbox_projection.rb +2 -2
  166. data/lib/mailslurp_client/models/page_ai_transform_mapping_projection.rb +19 -19
  167. data/lib/mailslurp_client/models/page_ai_transform_projection.rb +19 -19
  168. data/lib/mailslurp_client/models/page_ai_transform_result_projection.rb +19 -19
  169. data/lib/mailslurp_client/models/page_alias.rb +19 -19
  170. data/lib/mailslurp_client/models/page_alias_thread_projection.rb +19 -19
  171. data/lib/mailslurp_client/models/page_attachment_entity.rb +19 -19
  172. data/lib/mailslurp_client/models/page_bounced_email.rb +19 -19
  173. data/lib/mailslurp_client/models/page_bounced_recipients.rb +19 -19
  174. data/lib/mailslurp_client/models/page_complaint.rb +19 -19
  175. data/lib/mailslurp_client/models/page_connector.rb +19 -19
  176. data/lib/mailslurp_client/models/page_connector_events.rb +19 -19
  177. data/lib/mailslurp_client/models/page_contact_projection.rb +19 -19
  178. data/lib/mailslurp_client/models/page_delivery_status.rb +19 -19
  179. data/lib/mailslurp_client/models/page_device_preview_run_projection.rb +309 -0
  180. data/lib/mailslurp_client/models/page_email_preview.rb +19 -19
  181. data/lib/mailslurp_client/models/page_email_projection.rb +19 -19
  182. data/lib/mailslurp_client/models/page_email_thread_projection.rb +19 -19
  183. data/lib/mailslurp_client/models/page_email_validation_request.rb +19 -19
  184. data/lib/mailslurp_client/models/page_entity_automation_items.rb +19 -19
  185. data/lib/mailslurp_client/models/page_entity_event_items.rb +19 -19
  186. data/lib/mailslurp_client/models/page_entity_favourite_items.rb +19 -19
  187. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +19 -19
  188. data/lib/mailslurp_client/models/page_group_projection.rb +19 -19
  189. data/lib/mailslurp_client/models/page_guest_portal_users.rb +19 -19
  190. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +19 -19
  191. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +19 -19
  192. data/lib/mailslurp_client/models/page_inbox_projection.rb +19 -19
  193. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +19 -19
  194. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +19 -19
  195. data/lib/mailslurp_client/models/page_inbox_tags.rb +19 -19
  196. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +19 -19
  197. data/lib/mailslurp_client/models/page_missed_email_projection.rb +19 -19
  198. data/lib/mailslurp_client/models/page_missed_sms_projection.rb +309 -0
  199. data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +19 -19
  200. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +19 -19
  201. data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +19 -19
  202. data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +19 -19
  203. data/lib/mailslurp_client/models/page_phone_number_projection.rb +19 -19
  204. data/lib/mailslurp_client/models/page_phone_number_release_projection.rb +19 -19
  205. data/lib/mailslurp_client/models/page_plus_address_projection.rb +19 -19
  206. data/lib/mailslurp_client/models/page_reputation_items.rb +19 -19
  207. data/lib/mailslurp_client/models/page_ruleset_dto.rb +19 -19
  208. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +19 -19
  209. data/lib/mailslurp_client/models/page_sent_email_projection.rb +19 -19
  210. data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +19 -19
  211. data/lib/mailslurp_client/models/page_sent_sms_projection.rb +19 -19
  212. data/lib/mailslurp_client/models/page_sms_projection.rb +19 -19
  213. data/lib/mailslurp_client/models/page_template_projection.rb +19 -19
  214. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +19 -19
  215. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +19 -19
  216. data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +19 -19
  217. data/lib/mailslurp_client/models/page_webhook_projection.rb +19 -19
  218. data/lib/mailslurp_client/models/page_webhook_result.rb +19 -19
  219. data/lib/mailslurp_client/models/pageable_object.rb +22 -22
  220. data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +18 -18
  221. data/lib/mailslurp_client/models/phone_number_dto.rb +49 -4
  222. data/lib/mailslurp_client/models/phone_number_line_type_intelligence_dto.rb +242 -0
  223. data/lib/mailslurp_client/models/phone_number_line_type_lookup_dto.rb +286 -0
  224. data/lib/mailslurp_client/models/phone_number_projection.rb +81 -36
  225. data/lib/mailslurp_client/models/phone_number_release_projection.rb +39 -39
  226. data/lib/mailslurp_client/models/phone_pool_detail_dto.rb +334 -0
  227. data/lib/mailslurp_client/models/phone_pool_dto.rb +318 -0
  228. data/lib/mailslurp_client/models/phone_pool_lease_dto.rb +351 -0
  229. data/lib/mailslurp_client/models/phone_pool_member_dto.rb +333 -0
  230. data/lib/mailslurp_client/models/phone_provider_capabilities_result.rb +284 -0
  231. data/lib/mailslurp_client/models/phone_provisioning_job_dto.rb +434 -0
  232. data/lib/mailslurp_client/models/phone_provisioning_job_item_dto.rb +336 -0
  233. data/lib/mailslurp_client/models/phone_sms_prepaid_credit_dto.rb +340 -0
  234. data/lib/mailslurp_client/models/phone_sms_prepaid_credits_dto.rb +241 -0
  235. data/lib/mailslurp_client/models/plus_address_projection.rb +32 -32
  236. data/lib/mailslurp_client/models/recipient_projection.rb +13 -13
  237. data/lib/mailslurp_client/models/reputation_item_projection.rb +41 -41
  238. data/lib/mailslurp_client/models/search_available_phone_numbers_options.rb +377 -0
  239. data/lib/mailslurp_client/models/search_inboxes_options.rb +1 -1
  240. data/lib/mailslurp_client/models/sender_projection.rb +13 -13
  241. data/lib/mailslurp_client/models/sent_email_projection.rb +50 -50
  242. data/lib/mailslurp_client/models/sent_sms_projection.rb +18 -18
  243. data/lib/mailslurp_client/models/sms_projection.rb +18 -18
  244. data/lib/mailslurp_client/models/smtp_auth_diagnostic_result.rb +235 -0
  245. data/lib/mailslurp_client/models/smtp_diagnostic_step.rb +236 -0
  246. data/lib/mailslurp_client/models/smtp_tls_diagnostic_result.rb +245 -0
  247. data/lib/mailslurp_client/models/sort_object.rb +10 -10
  248. data/lib/mailslurp_client/models/spf_mechanism_result.rb +229 -0
  249. data/lib/mailslurp_client/models/template_projection.rb +41 -41
  250. data/lib/mailslurp_client/models/tenant_reputation_finding_dto.rb +322 -0
  251. data/lib/mailslurp_client/models/tenant_reputation_findings_dto.rb +241 -0
  252. data/lib/mailslurp_client/models/tenant_reputation_status_row_dto.rb +372 -0
  253. data/lib/mailslurp_client/models/tenant_reputation_status_summary_dto.rb +241 -0
  254. data/lib/mailslurp_client/models/test_smtp_server_options.rb +337 -0
  255. data/lib/mailslurp_client/models/test_smtp_server_results.rb +297 -0
  256. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +27 -27
  257. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +27 -27
  258. data/lib/mailslurp_client/models/update_campaign_probe_options.rb +290 -0
  259. data/lib/mailslurp_client/models/update_deliverability_test_options.rb +327 -0
  260. data/lib/mailslurp_client/models/update_device_preview_feedback_options.rb +314 -0
  261. data/lib/mailslurp_client/models/update_domain_monitor_options.rb +266 -0
  262. data/lib/mailslurp_client/models/update_phone_pool_options.rb +215 -0
  263. data/lib/mailslurp_client/models/validation_dto.rb +1 -5
  264. data/lib/mailslurp_client/models/webhook_projection.rb +39 -39
  265. data/lib/mailslurp_client/version.rb +1 -1
  266. data/lib/mailslurp_client.rb +156 -0
  267. metadata +158 -2
@@ -0,0 +1,1112 @@
1
+ =begin
2
+ #MailSlurp API
3
+
4
+ #MailSlurp is an API for sending and receiving emails and SMS from dynamically allocated email addresses and phone numbers. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://docs.mailslurp.com/) - [Examples](https://github.com/mailslurp/examples) repository
5
+
6
+ The version of the OpenAPI document: 6.5.2
7
+ Contact: contact@mailslurp.dev
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 4.3.1
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module MailSlurpClient
16
+ class DomainMonitorControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Compare two monitor runs
23
+ # @param monitor_id [String]
24
+ # @param run_id [String]
25
+ # @param other_run_id [String]
26
+ # @param [Hash] opts the optional parameters
27
+ # @return [DomainMonitorRunComparisonDto]
28
+ def compare_domain_monitor_runs(monitor_id, run_id, other_run_id, opts = {})
29
+ data, _status_code, _headers = compare_domain_monitor_runs_with_http_info(monitor_id, run_id, other_run_id, opts)
30
+ data
31
+ end
32
+
33
+ # Compare two monitor runs
34
+ # @param monitor_id [String]
35
+ # @param run_id [String]
36
+ # @param other_run_id [String]
37
+ # @param [Hash] opts the optional parameters
38
+ # @return [Array<(DomainMonitorRunComparisonDto, Integer, Hash)>] DomainMonitorRunComparisonDto data, response status code and response headers
39
+ def compare_domain_monitor_runs_with_http_info(monitor_id, run_id, other_run_id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.compare_domain_monitor_runs ...'
42
+ end
43
+ # verify the required parameter 'monitor_id' is set
44
+ if @api_client.config.client_side_validation && monitor_id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
46
+ end
47
+ # verify the required parameter 'run_id' is set
48
+ if @api_client.config.client_side_validation && run_id.nil?
49
+ fail ArgumentError, "Missing the required parameter 'run_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
50
+ end
51
+ # verify the required parameter 'other_run_id' is set
52
+ if @api_client.config.client_side_validation && other_run_id.nil?
53
+ fail ArgumentError, "Missing the required parameter 'other_run_id' when calling DomainMonitorControllerApi.compare_domain_monitor_runs"
54
+ end
55
+ # resource path
56
+ local_var_path = '/domain-monitor/monitors/{monitorId}/runs/{runId}/compare/{otherRunId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_id.to_s)).sub('{' + 'otherRunId' + '}', CGI.escape(other_run_id.to_s))
57
+
58
+ # query parameters
59
+ query_params = opts[:query_params] || {}
60
+
61
+ # header parameters
62
+ header_params = opts[:header_params] || {}
63
+ # HTTP header 'Accept' (if needed)
64
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
65
+
66
+ # form parameters
67
+ form_params = opts[:form_params] || {}
68
+
69
+ # http body (model)
70
+ post_body = opts[:body]
71
+
72
+ # return_type
73
+ return_type = opts[:return_type] || 'DomainMonitorRunComparisonDto'
74
+
75
+ # auth_names
76
+ auth_names = opts[:auth_names] || ['API_KEY']
77
+
78
+ new_options = opts.merge(
79
+ :header_params => header_params,
80
+ :query_params => query_params,
81
+ :form_params => form_params,
82
+ :body => post_body,
83
+ :auth_names => auth_names,
84
+ :return_type => return_type
85
+ )
86
+
87
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
88
+ if @api_client.config.debugging
89
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#compare_domain_monitor_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
90
+ end
91
+ return data, status_code, headers
92
+ end
93
+
94
+ # Create domain monitor
95
+ # @param create_domain_monitor_options [CreateDomainMonitorOptions]
96
+ # @param [Hash] opts the optional parameters
97
+ # @return [DomainMonitorDto]
98
+ def create_domain_monitor(create_domain_monitor_options, opts = {})
99
+ data, _status_code, _headers = create_domain_monitor_with_http_info(create_domain_monitor_options, opts)
100
+ data
101
+ end
102
+
103
+ # Create domain monitor
104
+ # @param create_domain_monitor_options [CreateDomainMonitorOptions]
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(DomainMonitorDto, Integer, Hash)>] DomainMonitorDto data, response status code and response headers
107
+ def create_domain_monitor_with_http_info(create_domain_monitor_options, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.create_domain_monitor ...'
110
+ end
111
+ # verify the required parameter 'create_domain_monitor_options' is set
112
+ if @api_client.config.client_side_validation && create_domain_monitor_options.nil?
113
+ fail ArgumentError, "Missing the required parameter 'create_domain_monitor_options' when calling DomainMonitorControllerApi.create_domain_monitor"
114
+ end
115
+ # resource path
116
+ local_var_path = '/domain-monitor/monitors'
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
125
+ # HTTP header 'Content-Type'
126
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
127
+
128
+ # form parameters
129
+ form_params = opts[:form_params] || {}
130
+
131
+ # http body (model)
132
+ post_body = opts[:body] || @api_client.object_to_http_body(create_domain_monitor_options)
133
+
134
+ # return_type
135
+ return_type = opts[:return_type] || 'DomainMonitorDto'
136
+
137
+ # auth_names
138
+ auth_names = opts[:auth_names] || ['API_KEY']
139
+
140
+ new_options = opts.merge(
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#create_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Create alert sink for monitor
157
+ # @param monitor_id [String]
158
+ # @param create_domain_monitor_alert_sink_options [CreateDomainMonitorAlertSinkOptions]
159
+ # @param [Hash] opts the optional parameters
160
+ # @return [DomainMonitorAlertSinkDto]
161
+ def create_domain_monitor_alert_sink(monitor_id, create_domain_monitor_alert_sink_options, opts = {})
162
+ data, _status_code, _headers = create_domain_monitor_alert_sink_with_http_info(monitor_id, create_domain_monitor_alert_sink_options, opts)
163
+ data
164
+ end
165
+
166
+ # Create alert sink for monitor
167
+ # @param monitor_id [String]
168
+ # @param create_domain_monitor_alert_sink_options [CreateDomainMonitorAlertSinkOptions]
169
+ # @param [Hash] opts the optional parameters
170
+ # @return [Array<(DomainMonitorAlertSinkDto, Integer, Hash)>] DomainMonitorAlertSinkDto data, response status code and response headers
171
+ def create_domain_monitor_alert_sink_with_http_info(monitor_id, create_domain_monitor_alert_sink_options, opts = {})
172
+ if @api_client.config.debugging
173
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.create_domain_monitor_alert_sink ...'
174
+ end
175
+ # verify the required parameter 'monitor_id' is set
176
+ if @api_client.config.client_side_validation && monitor_id.nil?
177
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.create_domain_monitor_alert_sink"
178
+ end
179
+ # verify the required parameter 'create_domain_monitor_alert_sink_options' is set
180
+ if @api_client.config.client_side_validation && create_domain_monitor_alert_sink_options.nil?
181
+ fail ArgumentError, "Missing the required parameter 'create_domain_monitor_alert_sink_options' when calling DomainMonitorControllerApi.create_domain_monitor_alert_sink"
182
+ end
183
+ # resource path
184
+ local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
185
+
186
+ # query parameters
187
+ query_params = opts[:query_params] || {}
188
+
189
+ # header parameters
190
+ header_params = opts[:header_params] || {}
191
+ # HTTP header 'Accept' (if needed)
192
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
193
+ # HTTP header 'Content-Type'
194
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
195
+
196
+ # form parameters
197
+ form_params = opts[:form_params] || {}
198
+
199
+ # http body (model)
200
+ post_body = opts[:body] || @api_client.object_to_http_body(create_domain_monitor_alert_sink_options)
201
+
202
+ # return_type
203
+ return_type = opts[:return_type] || 'DomainMonitorAlertSinkDto'
204
+
205
+ # auth_names
206
+ auth_names = opts[:auth_names] || ['API_KEY']
207
+
208
+ new_options = opts.merge(
209
+ :header_params => header_params,
210
+ :query_params => query_params,
211
+ :form_params => form_params,
212
+ :body => post_body,
213
+ :auth_names => auth_names,
214
+ :return_type => return_type
215
+ )
216
+
217
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
218
+ if @api_client.config.debugging
219
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#create_domain_monitor_alert_sink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
220
+ end
221
+ return data, status_code, headers
222
+ end
223
+
224
+ # Delete domain monitor
225
+ # @param monitor_id [String]
226
+ # @param [Hash] opts the optional parameters
227
+ # @return [nil]
228
+ def delete_domain_monitor(monitor_id, opts = {})
229
+ delete_domain_monitor_with_http_info(monitor_id, opts)
230
+ nil
231
+ end
232
+
233
+ # Delete domain monitor
234
+ # @param monitor_id [String]
235
+ # @param [Hash] opts the optional parameters
236
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
237
+ def delete_domain_monitor_with_http_info(monitor_id, opts = {})
238
+ if @api_client.config.debugging
239
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.delete_domain_monitor ...'
240
+ end
241
+ # verify the required parameter 'monitor_id' is set
242
+ if @api_client.config.client_side_validation && monitor_id.nil?
243
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.delete_domain_monitor"
244
+ end
245
+ # resource path
246
+ local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
247
+
248
+ # query parameters
249
+ query_params = opts[:query_params] || {}
250
+
251
+ # header parameters
252
+ header_params = opts[:header_params] || {}
253
+
254
+ # form parameters
255
+ form_params = opts[:form_params] || {}
256
+
257
+ # http body (model)
258
+ post_body = opts[:body]
259
+
260
+ # return_type
261
+ return_type = opts[:return_type]
262
+
263
+ # auth_names
264
+ auth_names = opts[:auth_names] || ['API_KEY']
265
+
266
+ new_options = opts.merge(
267
+ :header_params => header_params,
268
+ :query_params => query_params,
269
+ :form_params => form_params,
270
+ :body => post_body,
271
+ :auth_names => auth_names,
272
+ :return_type => return_type
273
+ )
274
+
275
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
276
+ if @api_client.config.debugging
277
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#delete_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
278
+ end
279
+ return data, status_code, headers
280
+ end
281
+
282
+ # Delete monitor alert sink
283
+ # @param monitor_id [String]
284
+ # @param sink_id [String]
285
+ # @param [Hash] opts the optional parameters
286
+ # @return [nil]
287
+ def delete_domain_monitor_alert_sink(monitor_id, sink_id, opts = {})
288
+ delete_domain_monitor_alert_sink_with_http_info(monitor_id, sink_id, opts)
289
+ nil
290
+ end
291
+
292
+ # Delete monitor alert sink
293
+ # @param monitor_id [String]
294
+ # @param sink_id [String]
295
+ # @param [Hash] opts the optional parameters
296
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
297
+ def delete_domain_monitor_alert_sink_with_http_info(monitor_id, sink_id, opts = {})
298
+ if @api_client.config.debugging
299
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.delete_domain_monitor_alert_sink ...'
300
+ end
301
+ # verify the required parameter 'monitor_id' is set
302
+ if @api_client.config.client_side_validation && monitor_id.nil?
303
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.delete_domain_monitor_alert_sink"
304
+ end
305
+ # verify the required parameter 'sink_id' is set
306
+ if @api_client.config.client_side_validation && sink_id.nil?
307
+ fail ArgumentError, "Missing the required parameter 'sink_id' when calling DomainMonitorControllerApi.delete_domain_monitor_alert_sink"
308
+ end
309
+ # resource path
310
+ local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks/{sinkId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'sinkId' + '}', CGI.escape(sink_id.to_s))
311
+
312
+ # query parameters
313
+ query_params = opts[:query_params] || {}
314
+
315
+ # header parameters
316
+ header_params = opts[:header_params] || {}
317
+
318
+ # form parameters
319
+ form_params = opts[:form_params] || {}
320
+
321
+ # http body (model)
322
+ post_body = opts[:body]
323
+
324
+ # return_type
325
+ return_type = opts[:return_type]
326
+
327
+ # auth_names
328
+ auth_names = opts[:auth_names] || ['API_KEY']
329
+
330
+ new_options = opts.merge(
331
+ :header_params => header_params,
332
+ :query_params => query_params,
333
+ :form_params => form_params,
334
+ :body => post_body,
335
+ :auth_names => auth_names,
336
+ :return_type => return_type
337
+ )
338
+
339
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
340
+ if @api_client.config.debugging
341
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#delete_domain_monitor_alert_sink\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
342
+ end
343
+ return data, status_code, headers
344
+ end
345
+
346
+ # Get domain monitor
347
+ # @param monitor_id [String]
348
+ # @param [Hash] opts the optional parameters
349
+ # @return [DomainMonitorDto]
350
+ def get_domain_monitor(monitor_id, opts = {})
351
+ data, _status_code, _headers = get_domain_monitor_with_http_info(monitor_id, opts)
352
+ data
353
+ end
354
+
355
+ # Get domain monitor
356
+ # @param monitor_id [String]
357
+ # @param [Hash] opts the optional parameters
358
+ # @return [Array<(DomainMonitorDto, Integer, Hash)>] DomainMonitorDto data, response status code and response headers
359
+ def get_domain_monitor_with_http_info(monitor_id, opts = {})
360
+ if @api_client.config.debugging
361
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor ...'
362
+ end
363
+ # verify the required parameter 'monitor_id' is set
364
+ if @api_client.config.client_side_validation && monitor_id.nil?
365
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor"
366
+ end
367
+ # resource path
368
+ local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
369
+
370
+ # query parameters
371
+ query_params = opts[:query_params] || {}
372
+
373
+ # header parameters
374
+ header_params = opts[:header_params] || {}
375
+ # HTTP header 'Accept' (if needed)
376
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
377
+
378
+ # form parameters
379
+ form_params = opts[:form_params] || {}
380
+
381
+ # http body (model)
382
+ post_body = opts[:body]
383
+
384
+ # return_type
385
+ return_type = opts[:return_type] || 'DomainMonitorDto'
386
+
387
+ # auth_names
388
+ auth_names = opts[:auth_names] || ['API_KEY']
389
+
390
+ new_options = opts.merge(
391
+ :header_params => header_params,
392
+ :query_params => query_params,
393
+ :form_params => form_params,
394
+ :body => post_body,
395
+ :auth_names => auth_names,
396
+ :return_type => return_type
397
+ )
398
+
399
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
400
+ if @api_client.config.debugging
401
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
402
+ end
403
+ return data, status_code, headers
404
+ end
405
+
406
+ # List alert sinks for monitor
407
+ # @param monitor_id [String]
408
+ # @param [Hash] opts the optional parameters
409
+ # @return [Array<DomainMonitorAlertSinkDto>]
410
+ def get_domain_monitor_alert_sinks(monitor_id, opts = {})
411
+ data, _status_code, _headers = get_domain_monitor_alert_sinks_with_http_info(monitor_id, opts)
412
+ data
413
+ end
414
+
415
+ # List alert sinks for monitor
416
+ # @param monitor_id [String]
417
+ # @param [Hash] opts the optional parameters
418
+ # @return [Array<(Array<DomainMonitorAlertSinkDto>, Integer, Hash)>] Array<DomainMonitorAlertSinkDto> data, response status code and response headers
419
+ def get_domain_monitor_alert_sinks_with_http_info(monitor_id, opts = {})
420
+ if @api_client.config.debugging
421
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_alert_sinks ...'
422
+ end
423
+ # verify the required parameter 'monitor_id' is set
424
+ if @api_client.config.client_side_validation && monitor_id.nil?
425
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_alert_sinks"
426
+ end
427
+ # resource path
428
+ local_var_path = '/domain-monitor/monitors/{monitorId}/alert-sinks'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
429
+
430
+ # query parameters
431
+ query_params = opts[:query_params] || {}
432
+
433
+ # header parameters
434
+ header_params = opts[:header_params] || {}
435
+ # HTTP header 'Accept' (if needed)
436
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
437
+
438
+ # form parameters
439
+ form_params = opts[:form_params] || {}
440
+
441
+ # http body (model)
442
+ post_body = opts[:body]
443
+
444
+ # return_type
445
+ return_type = opts[:return_type] || 'Array<DomainMonitorAlertSinkDto>'
446
+
447
+ # auth_names
448
+ auth_names = opts[:auth_names] || ['API_KEY']
449
+
450
+ new_options = opts.merge(
451
+ :header_params => header_params,
452
+ :query_params => query_params,
453
+ :form_params => form_params,
454
+ :body => post_body,
455
+ :auth_names => auth_names,
456
+ :return_type => return_type
457
+ )
458
+
459
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
460
+ if @api_client.config.debugging
461
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_alert_sinks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
462
+ end
463
+ return data, status_code, headers
464
+ end
465
+
466
+ # Get current auth stack for monitor domain
467
+ # @param monitor_id [String]
468
+ # @param [Hash] opts the optional parameters
469
+ # @option opts [String] :dkim_selector
470
+ # @return [CheckEmailAuthStackResults]
471
+ def get_domain_monitor_auth_stack(monitor_id, opts = {})
472
+ data, _status_code, _headers = get_domain_monitor_auth_stack_with_http_info(monitor_id, opts)
473
+ data
474
+ end
475
+
476
+ # Get current auth stack for monitor domain
477
+ # @param monitor_id [String]
478
+ # @param [Hash] opts the optional parameters
479
+ # @option opts [String] :dkim_selector
480
+ # @return [Array<(CheckEmailAuthStackResults, Integer, Hash)>] CheckEmailAuthStackResults data, response status code and response headers
481
+ def get_domain_monitor_auth_stack_with_http_info(monitor_id, opts = {})
482
+ if @api_client.config.debugging
483
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_auth_stack ...'
484
+ end
485
+ # verify the required parameter 'monitor_id' is set
486
+ if @api_client.config.client_side_validation && monitor_id.nil?
487
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_auth_stack"
488
+ end
489
+ # resource path
490
+ local_var_path = '/domain-monitor/monitors/{monitorId}/auth-stack'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
491
+
492
+ # query parameters
493
+ query_params = opts[:query_params] || {}
494
+ query_params[:'dkimSelector'] = opts[:'dkim_selector'] if !opts[:'dkim_selector'].nil?
495
+
496
+ # header parameters
497
+ header_params = opts[:header_params] || {}
498
+ # HTTP header 'Accept' (if needed)
499
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
500
+
501
+ # form parameters
502
+ form_params = opts[:form_params] || {}
503
+
504
+ # http body (model)
505
+ post_body = opts[:body]
506
+
507
+ # return_type
508
+ return_type = opts[:return_type] || 'CheckEmailAuthStackResults'
509
+
510
+ # auth_names
511
+ auth_names = opts[:auth_names] || ['API_KEY']
512
+
513
+ new_options = opts.merge(
514
+ :header_params => header_params,
515
+ :query_params => query_params,
516
+ :form_params => form_params,
517
+ :body => post_body,
518
+ :auth_names => auth_names,
519
+ :return_type => return_type
520
+ )
521
+
522
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
523
+ if @api_client.config.debugging
524
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_auth_stack\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
525
+ end
526
+ return data, status_code, headers
527
+ end
528
+
529
+ # Get monitor insights
530
+ # @param monitor_id [String]
531
+ # @param [Hash] opts the optional parameters
532
+ # @option opts [DateTime] :since
533
+ # @option opts [DateTime] :before
534
+ # @return [DomainMonitorInsightsDto]
535
+ def get_domain_monitor_insights(monitor_id, opts = {})
536
+ data, _status_code, _headers = get_domain_monitor_insights_with_http_info(monitor_id, opts)
537
+ data
538
+ end
539
+
540
+ # Get monitor insights
541
+ # @param monitor_id [String]
542
+ # @param [Hash] opts the optional parameters
543
+ # @option opts [DateTime] :since
544
+ # @option opts [DateTime] :before
545
+ # @return [Array<(DomainMonitorInsightsDto, Integer, Hash)>] DomainMonitorInsightsDto data, response status code and response headers
546
+ def get_domain_monitor_insights_with_http_info(monitor_id, opts = {})
547
+ if @api_client.config.debugging
548
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_insights ...'
549
+ end
550
+ # verify the required parameter 'monitor_id' is set
551
+ if @api_client.config.client_side_validation && monitor_id.nil?
552
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_insights"
553
+ end
554
+ # resource path
555
+ local_var_path = '/domain-monitor/monitors/{monitorId}/insights'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
556
+
557
+ # query parameters
558
+ query_params = opts[:query_params] || {}
559
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
560
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
561
+
562
+ # header parameters
563
+ header_params = opts[:header_params] || {}
564
+ # HTTP header 'Accept' (if needed)
565
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
566
+
567
+ # form parameters
568
+ form_params = opts[:form_params] || {}
569
+
570
+ # http body (model)
571
+ post_body = opts[:body]
572
+
573
+ # return_type
574
+ return_type = opts[:return_type] || 'DomainMonitorInsightsDto'
575
+
576
+ # auth_names
577
+ auth_names = opts[:auth_names] || ['API_KEY']
578
+
579
+ new_options = opts.merge(
580
+ :header_params => header_params,
581
+ :query_params => query_params,
582
+ :form_params => form_params,
583
+ :body => post_body,
584
+ :auth_names => auth_names,
585
+ :return_type => return_type
586
+ )
587
+
588
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
589
+ if @api_client.config.debugging
590
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_insights\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
591
+ end
592
+ return data, status_code, headers
593
+ end
594
+
595
+ # Get monitor run
596
+ # @param monitor_id [String]
597
+ # @param run_id [String]
598
+ # @param [Hash] opts the optional parameters
599
+ # @return [DomainMonitorRunDto]
600
+ def get_domain_monitor_run(monitor_id, run_id, opts = {})
601
+ data, _status_code, _headers = get_domain_monitor_run_with_http_info(monitor_id, run_id, opts)
602
+ data
603
+ end
604
+
605
+ # Get monitor run
606
+ # @param monitor_id [String]
607
+ # @param run_id [String]
608
+ # @param [Hash] opts the optional parameters
609
+ # @return [Array<(DomainMonitorRunDto, Integer, Hash)>] DomainMonitorRunDto data, response status code and response headers
610
+ def get_domain_monitor_run_with_http_info(monitor_id, run_id, opts = {})
611
+ if @api_client.config.debugging
612
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_run ...'
613
+ end
614
+ # verify the required parameter 'monitor_id' is set
615
+ if @api_client.config.client_side_validation && monitor_id.nil?
616
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_run"
617
+ end
618
+ # verify the required parameter 'run_id' is set
619
+ if @api_client.config.client_side_validation && run_id.nil?
620
+ fail ArgumentError, "Missing the required parameter 'run_id' when calling DomainMonitorControllerApi.get_domain_monitor_run"
621
+ end
622
+ # resource path
623
+ local_var_path = '/domain-monitor/monitors/{monitorId}/runs/{runId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s)).sub('{' + 'runId' + '}', CGI.escape(run_id.to_s))
624
+
625
+ # query parameters
626
+ query_params = opts[:query_params] || {}
627
+
628
+ # header parameters
629
+ header_params = opts[:header_params] || {}
630
+ # HTTP header 'Accept' (if needed)
631
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
632
+
633
+ # form parameters
634
+ form_params = opts[:form_params] || {}
635
+
636
+ # http body (model)
637
+ post_body = opts[:body]
638
+
639
+ # return_type
640
+ return_type = opts[:return_type] || 'DomainMonitorRunDto'
641
+
642
+ # auth_names
643
+ auth_names = opts[:auth_names] || ['API_KEY']
644
+
645
+ new_options = opts.merge(
646
+ :header_params => header_params,
647
+ :query_params => query_params,
648
+ :form_params => form_params,
649
+ :body => post_body,
650
+ :auth_names => auth_names,
651
+ :return_type => return_type
652
+ )
653
+
654
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
655
+ if @api_client.config.debugging
656
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_run\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
657
+ end
658
+ return data, status_code, headers
659
+ end
660
+
661
+ # List monitor runs
662
+ # @param monitor_id [String]
663
+ # @param [Hash] opts the optional parameters
664
+ # @option opts [DateTime] :since
665
+ # @option opts [DateTime] :before
666
+ # @option opts [String] :status
667
+ # @option opts [Integer] :limit
668
+ # @return [Array<DomainMonitorRunDto>]
669
+ def get_domain_monitor_runs(monitor_id, opts = {})
670
+ data, _status_code, _headers = get_domain_monitor_runs_with_http_info(monitor_id, opts)
671
+ data
672
+ end
673
+
674
+ # List monitor runs
675
+ # @param monitor_id [String]
676
+ # @param [Hash] opts the optional parameters
677
+ # @option opts [DateTime] :since
678
+ # @option opts [DateTime] :before
679
+ # @option opts [String] :status
680
+ # @option opts [Integer] :limit
681
+ # @return [Array<(Array<DomainMonitorRunDto>, Integer, Hash)>] Array<DomainMonitorRunDto> data, response status code and response headers
682
+ def get_domain_monitor_runs_with_http_info(monitor_id, opts = {})
683
+ if @api_client.config.debugging
684
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_runs ...'
685
+ end
686
+ # verify the required parameter 'monitor_id' is set
687
+ if @api_client.config.client_side_validation && monitor_id.nil?
688
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_runs"
689
+ end
690
+ allowable_values = ["HEALTHY", "DEGRADED", "CRITICAL", "FAILED"]
691
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
692
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
693
+ end
694
+ # resource path
695
+ local_var_path = '/domain-monitor/monitors/{monitorId}/runs'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
696
+
697
+ # query parameters
698
+ query_params = opts[:query_params] || {}
699
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
700
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
701
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
702
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
703
+
704
+ # header parameters
705
+ header_params = opts[:header_params] || {}
706
+ # HTTP header 'Accept' (if needed)
707
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
708
+
709
+ # form parameters
710
+ form_params = opts[:form_params] || {}
711
+
712
+ # http body (model)
713
+ post_body = opts[:body]
714
+
715
+ # return_type
716
+ return_type = opts[:return_type] || 'Array<DomainMonitorRunDto>'
717
+
718
+ # auth_names
719
+ auth_names = opts[:auth_names] || ['API_KEY']
720
+
721
+ new_options = opts.merge(
722
+ :header_params => header_params,
723
+ :query_params => query_params,
724
+ :form_params => form_params,
725
+ :body => post_body,
726
+ :auth_names => auth_names,
727
+ :return_type => return_type
728
+ )
729
+
730
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
731
+ if @api_client.config.debugging
732
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_runs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
733
+ end
734
+ return data, status_code, headers
735
+ end
736
+
737
+ # Get monitor trend series
738
+ # @param monitor_id [String]
739
+ # @param [Hash] opts the optional parameters
740
+ # @option opts [DateTime] :since
741
+ # @option opts [DateTime] :before
742
+ # @option opts [String] :bucket (default to 'DAY')
743
+ # @return [DomainMonitorSeriesDto]
744
+ def get_domain_monitor_series(monitor_id, opts = {})
745
+ data, _status_code, _headers = get_domain_monitor_series_with_http_info(monitor_id, opts)
746
+ data
747
+ end
748
+
749
+ # Get monitor trend series
750
+ # @param monitor_id [String]
751
+ # @param [Hash] opts the optional parameters
752
+ # @option opts [DateTime] :since
753
+ # @option opts [DateTime] :before
754
+ # @option opts [String] :bucket
755
+ # @return [Array<(DomainMonitorSeriesDto, Integer, Hash)>] DomainMonitorSeriesDto data, response status code and response headers
756
+ def get_domain_monitor_series_with_http_info(monitor_id, opts = {})
757
+ if @api_client.config.debugging
758
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_series ...'
759
+ end
760
+ # verify the required parameter 'monitor_id' is set
761
+ if @api_client.config.client_side_validation && monitor_id.nil?
762
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_series"
763
+ end
764
+ allowable_values = ["HOUR", "DAY"]
765
+ if @api_client.config.client_side_validation && opts[:'bucket'] && !allowable_values.include?(opts[:'bucket'])
766
+ fail ArgumentError, "invalid value for \"bucket\", must be one of #{allowable_values}"
767
+ end
768
+ # resource path
769
+ local_var_path = '/domain-monitor/monitors/{monitorId}/series'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
770
+
771
+ # query parameters
772
+ query_params = opts[:query_params] || {}
773
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
774
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
775
+ query_params[:'bucket'] = opts[:'bucket'] if !opts[:'bucket'].nil?
776
+
777
+ # header parameters
778
+ header_params = opts[:header_params] || {}
779
+ # HTTP header 'Accept' (if needed)
780
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
781
+
782
+ # form parameters
783
+ form_params = opts[:form_params] || {}
784
+
785
+ # http body (model)
786
+ post_body = opts[:body]
787
+
788
+ # return_type
789
+ return_type = opts[:return_type] || 'DomainMonitorSeriesDto'
790
+
791
+ # auth_names
792
+ auth_names = opts[:auth_names] || ['API_KEY']
793
+
794
+ new_options = opts.merge(
795
+ :header_params => header_params,
796
+ :query_params => query_params,
797
+ :form_params => form_params,
798
+ :body => post_body,
799
+ :auth_names => auth_names,
800
+ :return_type => return_type
801
+ )
802
+
803
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
804
+ if @api_client.config.debugging
805
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_series\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
806
+ end
807
+ return data, status_code, headers
808
+ end
809
+
810
+ # Get domain monitor summary
811
+ # @param monitor_id [String]
812
+ # @param [Hash] opts the optional parameters
813
+ # @option opts [String] :dkim_selector
814
+ # @return [DomainMonitorSummaryDto]
815
+ def get_domain_monitor_summary(monitor_id, opts = {})
816
+ data, _status_code, _headers = get_domain_monitor_summary_with_http_info(monitor_id, opts)
817
+ data
818
+ end
819
+
820
+ # Get domain monitor summary
821
+ # @param monitor_id [String]
822
+ # @param [Hash] opts the optional parameters
823
+ # @option opts [String] :dkim_selector
824
+ # @return [Array<(DomainMonitorSummaryDto, Integer, Hash)>] DomainMonitorSummaryDto data, response status code and response headers
825
+ def get_domain_monitor_summary_with_http_info(monitor_id, opts = {})
826
+ if @api_client.config.debugging
827
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitor_summary ...'
828
+ end
829
+ # verify the required parameter 'monitor_id' is set
830
+ if @api_client.config.client_side_validation && monitor_id.nil?
831
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.get_domain_monitor_summary"
832
+ end
833
+ # resource path
834
+ local_var_path = '/domain-monitor/monitors/{monitorId}/summary'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
835
+
836
+ # query parameters
837
+ query_params = opts[:query_params] || {}
838
+ query_params[:'dkimSelector'] = opts[:'dkim_selector'] if !opts[:'dkim_selector'].nil?
839
+
840
+ # header parameters
841
+ header_params = opts[:header_params] || {}
842
+ # HTTP header 'Accept' (if needed)
843
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
844
+
845
+ # form parameters
846
+ form_params = opts[:form_params] || {}
847
+
848
+ # http body (model)
849
+ post_body = opts[:body]
850
+
851
+ # return_type
852
+ return_type = opts[:return_type] || 'DomainMonitorSummaryDto'
853
+
854
+ # auth_names
855
+ auth_names = opts[:auth_names] || ['API_KEY']
856
+
857
+ new_options = opts.merge(
858
+ :header_params => header_params,
859
+ :query_params => query_params,
860
+ :form_params => form_params,
861
+ :body => post_body,
862
+ :auth_names => auth_names,
863
+ :return_type => return_type
864
+ )
865
+
866
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
867
+ if @api_client.config.debugging
868
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitor_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
869
+ end
870
+ return data, status_code, headers
871
+ end
872
+
873
+ # List domain monitors
874
+ # @param [Hash] opts the optional parameters
875
+ # @return [Array<DomainMonitorDto>]
876
+ def get_domain_monitors(opts = {})
877
+ data, _status_code, _headers = get_domain_monitors_with_http_info(opts)
878
+ data
879
+ end
880
+
881
+ # List domain monitors
882
+ # @param [Hash] opts the optional parameters
883
+ # @return [Array<(Array<DomainMonitorDto>, Integer, Hash)>] Array<DomainMonitorDto> data, response status code and response headers
884
+ def get_domain_monitors_with_http_info(opts = {})
885
+ if @api_client.config.debugging
886
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.get_domain_monitors ...'
887
+ end
888
+ # resource path
889
+ local_var_path = '/domain-monitor/monitors'
890
+
891
+ # query parameters
892
+ query_params = opts[:query_params] || {}
893
+
894
+ # header parameters
895
+ header_params = opts[:header_params] || {}
896
+ # HTTP header 'Accept' (if needed)
897
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
898
+
899
+ # form parameters
900
+ form_params = opts[:form_params] || {}
901
+
902
+ # http body (model)
903
+ post_body = opts[:body]
904
+
905
+ # return_type
906
+ return_type = opts[:return_type] || 'Array<DomainMonitorDto>'
907
+
908
+ # auth_names
909
+ auth_names = opts[:auth_names] || ['API_KEY']
910
+
911
+ new_options = opts.merge(
912
+ :header_params => header_params,
913
+ :query_params => query_params,
914
+ :form_params => form_params,
915
+ :body => post_body,
916
+ :auth_names => auth_names,
917
+ :return_type => return_type
918
+ )
919
+
920
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
921
+ if @api_client.config.debugging
922
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#get_domain_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
923
+ end
924
+ return data, status_code, headers
925
+ end
926
+
927
+ # Run monitor now
928
+ # @param monitor_id [String]
929
+ # @param [Hash] opts the optional parameters
930
+ # @return [DomainMonitorRunNowResult]
931
+ def run_domain_monitor_now(monitor_id, opts = {})
932
+ data, _status_code, _headers = run_domain_monitor_now_with_http_info(monitor_id, opts)
933
+ data
934
+ end
935
+
936
+ # Run monitor now
937
+ # @param monitor_id [String]
938
+ # @param [Hash] opts the optional parameters
939
+ # @return [Array<(DomainMonitorRunNowResult, Integer, Hash)>] DomainMonitorRunNowResult data, response status code and response headers
940
+ def run_domain_monitor_now_with_http_info(monitor_id, opts = {})
941
+ if @api_client.config.debugging
942
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.run_domain_monitor_now ...'
943
+ end
944
+ # verify the required parameter 'monitor_id' is set
945
+ if @api_client.config.client_side_validation && monitor_id.nil?
946
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.run_domain_monitor_now"
947
+ end
948
+ # resource path
949
+ local_var_path = '/domain-monitor/monitors/{monitorId}/run-now'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
950
+
951
+ # query parameters
952
+ query_params = opts[:query_params] || {}
953
+
954
+ # header parameters
955
+ header_params = opts[:header_params] || {}
956
+ # HTTP header 'Accept' (if needed)
957
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
958
+
959
+ # form parameters
960
+ form_params = opts[:form_params] || {}
961
+
962
+ # http body (model)
963
+ post_body = opts[:body]
964
+
965
+ # return_type
966
+ return_type = opts[:return_type] || 'DomainMonitorRunNowResult'
967
+
968
+ # auth_names
969
+ auth_names = opts[:auth_names] || ['API_KEY']
970
+
971
+ new_options = opts.merge(
972
+ :header_params => header_params,
973
+ :query_params => query_params,
974
+ :form_params => form_params,
975
+ :body => post_body,
976
+ :auth_names => auth_names,
977
+ :return_type => return_type
978
+ )
979
+
980
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
981
+ if @api_client.config.debugging
982
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#run_domain_monitor_now\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
983
+ end
984
+ return data, status_code, headers
985
+ end
986
+
987
+ # Run due monitors for user
988
+ # @param [Hash] opts the optional parameters
989
+ # @option opts [Integer] :max_runs
990
+ # @return [DomainMonitorRunDueResult]
991
+ def run_due_domain_monitors(opts = {})
992
+ data, _status_code, _headers = run_due_domain_monitors_with_http_info(opts)
993
+ data
994
+ end
995
+
996
+ # Run due monitors for user
997
+ # @param [Hash] opts the optional parameters
998
+ # @option opts [Integer] :max_runs
999
+ # @return [Array<(DomainMonitorRunDueResult, Integer, Hash)>] DomainMonitorRunDueResult data, response status code and response headers
1000
+ def run_due_domain_monitors_with_http_info(opts = {})
1001
+ if @api_client.config.debugging
1002
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.run_due_domain_monitors ...'
1003
+ end
1004
+ # resource path
1005
+ local_var_path = '/domain-monitor/monitors/run-due'
1006
+
1007
+ # query parameters
1008
+ query_params = opts[:query_params] || {}
1009
+ query_params[:'maxRuns'] = opts[:'max_runs'] if !opts[:'max_runs'].nil?
1010
+
1011
+ # header parameters
1012
+ header_params = opts[:header_params] || {}
1013
+ # HTTP header 'Accept' (if needed)
1014
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1015
+
1016
+ # form parameters
1017
+ form_params = opts[:form_params] || {}
1018
+
1019
+ # http body (model)
1020
+ post_body = opts[:body]
1021
+
1022
+ # return_type
1023
+ return_type = opts[:return_type] || 'DomainMonitorRunDueResult'
1024
+
1025
+ # auth_names
1026
+ auth_names = opts[:auth_names] || ['API_KEY']
1027
+
1028
+ new_options = opts.merge(
1029
+ :header_params => header_params,
1030
+ :query_params => query_params,
1031
+ :form_params => form_params,
1032
+ :body => post_body,
1033
+ :auth_names => auth_names,
1034
+ :return_type => return_type
1035
+ )
1036
+
1037
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1038
+ if @api_client.config.debugging
1039
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#run_due_domain_monitors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1040
+ end
1041
+ return data, status_code, headers
1042
+ end
1043
+
1044
+ # Update domain monitor
1045
+ # @param monitor_id [String]
1046
+ # @param update_domain_monitor_options [UpdateDomainMonitorOptions]
1047
+ # @param [Hash] opts the optional parameters
1048
+ # @return [DomainMonitorDto]
1049
+ def update_domain_monitor(monitor_id, update_domain_monitor_options, opts = {})
1050
+ data, _status_code, _headers = update_domain_monitor_with_http_info(monitor_id, update_domain_monitor_options, opts)
1051
+ data
1052
+ end
1053
+
1054
+ # Update domain monitor
1055
+ # @param monitor_id [String]
1056
+ # @param update_domain_monitor_options [UpdateDomainMonitorOptions]
1057
+ # @param [Hash] opts the optional parameters
1058
+ # @return [Array<(DomainMonitorDto, Integer, Hash)>] DomainMonitorDto data, response status code and response headers
1059
+ def update_domain_monitor_with_http_info(monitor_id, update_domain_monitor_options, opts = {})
1060
+ if @api_client.config.debugging
1061
+ @api_client.config.logger.debug 'Calling API: DomainMonitorControllerApi.update_domain_monitor ...'
1062
+ end
1063
+ # verify the required parameter 'monitor_id' is set
1064
+ if @api_client.config.client_side_validation && monitor_id.nil?
1065
+ fail ArgumentError, "Missing the required parameter 'monitor_id' when calling DomainMonitorControllerApi.update_domain_monitor"
1066
+ end
1067
+ # verify the required parameter 'update_domain_monitor_options' is set
1068
+ if @api_client.config.client_side_validation && update_domain_monitor_options.nil?
1069
+ fail ArgumentError, "Missing the required parameter 'update_domain_monitor_options' when calling DomainMonitorControllerApi.update_domain_monitor"
1070
+ end
1071
+ # resource path
1072
+ local_var_path = '/domain-monitor/monitors/{monitorId}'.sub('{' + 'monitorId' + '}', CGI.escape(monitor_id.to_s))
1073
+
1074
+ # query parameters
1075
+ query_params = opts[:query_params] || {}
1076
+
1077
+ # header parameters
1078
+ header_params = opts[:header_params] || {}
1079
+ # HTTP header 'Accept' (if needed)
1080
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1081
+ # HTTP header 'Content-Type'
1082
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1083
+
1084
+ # form parameters
1085
+ form_params = opts[:form_params] || {}
1086
+
1087
+ # http body (model)
1088
+ post_body = opts[:body] || @api_client.object_to_http_body(update_domain_monitor_options)
1089
+
1090
+ # return_type
1091
+ return_type = opts[:return_type] || 'DomainMonitorDto'
1092
+
1093
+ # auth_names
1094
+ auth_names = opts[:auth_names] || ['API_KEY']
1095
+
1096
+ new_options = opts.merge(
1097
+ :header_params => header_params,
1098
+ :query_params => query_params,
1099
+ :form_params => form_params,
1100
+ :body => post_body,
1101
+ :auth_names => auth_names,
1102
+ :return_type => return_type
1103
+ )
1104
+
1105
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1106
+ if @api_client.config.debugging
1107
+ @api_client.config.logger.debug "API called: DomainMonitorControllerApi#update_domain_monitor\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1108
+ end
1109
+ return data, status_code, headers
1110
+ end
1111
+ end
1112
+ end