mailslurp_client 15.19.22 → 15.21.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 (401) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/README.md +1 -1
  4. data/lib/mailslurp_client/api/alias_controller_api.rb +10 -10
  5. data/lib/mailslurp_client/api/attachment_controller_api.rb +28 -6
  6. data/lib/mailslurp_client/api/bounce_controller_api.rb +80 -1
  7. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +1 -1
  8. data/lib/mailslurp_client/api/common_actions_controller_api.rb +5 -5
  9. data/lib/mailslurp_client/api/connector_controller_api.rb +1250 -122
  10. data/lib/mailslurp_client/api/consent_controller_api.rb +269 -0
  11. data/lib/mailslurp_client/api/contact_controller_api.rb +1 -1
  12. data/lib/mailslurp_client/api/domain_controller_api.rb +1 -1
  13. data/lib/mailslurp_client/api/email_controller_api.rb +471 -12
  14. data/lib/mailslurp_client/api/email_verification_controller_api.rb +9 -1
  15. data/lib/mailslurp_client/api/expired_controller_api.rb +4 -1
  16. data/lib/mailslurp_client/api/export_controller_api.rb +1 -1
  17. data/lib/mailslurp_client/api/form_controller_api.rb +1 -1
  18. data/lib/mailslurp_client/api/group_controller_api.rb +1 -1
  19. data/lib/mailslurp_client/api/guest_portal_controller_api.rb +569 -0
  20. data/lib/mailslurp_client/api/imap_controller_api.rb +1 -1
  21. data/lib/mailslurp_client/api/inbox_controller_api.rb +929 -115
  22. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +13 -11
  23. data/lib/mailslurp_client/api/inbox_replier_controller_api.rb +82 -1
  24. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +1 -1
  25. data/lib/mailslurp_client/api/mail_server_controller_api.rb +1 -1
  26. data/lib/mailslurp_client/api/missed_email_controller_api.rb +1 -1
  27. data/lib/mailslurp_client/api/o_auth_connection_api.rb +170 -0
  28. data/lib/mailslurp_client/api/phone_controller_api.rb +962 -20
  29. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +1 -1
  30. data/lib/mailslurp_client/api/sms_controller_api.rb +494 -44
  31. data/lib/mailslurp_client/api/sse_controller_api.rb +81 -0
  32. data/lib/mailslurp_client/api/template_controller_api.rb +1 -1
  33. data/lib/mailslurp_client/api/tools_controller_api.rb +192 -1
  34. data/lib/mailslurp_client/api/tracking_controller_api.rb +1 -1
  35. data/lib/mailslurp_client/api/user_controller_api.rb +268 -1
  36. data/lib/mailslurp_client/api/wait_for_controller_api.rb +1 -1
  37. data/lib/mailslurp_client/api/webhook_controller_api.rb +274 -12
  38. data/lib/mailslurp_client/api_client.rb +1 -1
  39. data/lib/mailslurp_client/api_error.rb +1 -1
  40. data/lib/mailslurp_client/configuration.rb +1 -1
  41. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +3 -3
  42. data/lib/mailslurp_client/models/account_bounce_block_dto.rb +16 -2
  43. data/lib/mailslurp_client/models/alias_dto.rb +1 -1
  44. data/lib/mailslurp_client/models/alias_projection.rb +38 -38
  45. data/lib/mailslurp_client/models/{thread_projection.rb → alias_thread_projection.rb} +52 -52
  46. data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_entity_dto.rb} +26 -14
  47. data/lib/mailslurp_client/models/attachment_meta_data.rb +1 -1
  48. data/lib/mailslurp_client/models/attachment_projection.rb +45 -20
  49. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  50. data/lib/mailslurp_client/models/bounce_projection.rb +16 -16
  51. data/lib/mailslurp_client/models/bounce_recipient_projection.rb +11 -11
  52. data/lib/mailslurp_client/models/bounced_email_dto.rb +1 -1
  53. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +1 -1
  54. data/lib/mailslurp_client/models/bulk_send_email_options.rb +1 -1
  55. data/lib/mailslurp_client/models/can_send_email_results.rb +1 -1
  56. data/lib/mailslurp_client/models/check_email_body_feature_support_results.rb +1 -1
  57. data/lib/mailslurp_client/models/check_email_body_results.rb +1 -1
  58. data/lib/mailslurp_client/models/check_email_client_support_options.rb +1 -1
  59. data/lib/mailslurp_client/models/check_email_client_support_results.rb +1 -1
  60. data/lib/mailslurp_client/models/check_email_features_client_support_options.rb +1 -1
  61. data/lib/mailslurp_client/models/check_email_features_client_support_results.rb +1 -1
  62. data/lib/mailslurp_client/models/complaint.rb +1 -1
  63. data/lib/mailslurp_client/models/condition_option.rb +1 -1
  64. data/lib/mailslurp_client/models/connector_dto.rb +12 -98
  65. data/lib/mailslurp_client/models/connector_event_dto.rb +354 -0
  66. data/lib/mailslurp_client/models/{connector_sync_event_projection.rb → connector_event_projection.rb} +72 -37
  67. data/lib/mailslurp_client/models/connector_imap_connection_dto.rb +83 -2
  68. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause.rb → connector_imap_connection_test_result.rb} +33 -19
  69. data/lib/mailslurp_client/models/connector_projection.rb +29 -90
  70. data/lib/mailslurp_client/models/connector_provider_settings_dto.rb +225 -0
  71. data/lib/mailslurp_client/models/connector_smtp_connection_dto.rb +96 -2
  72. data/lib/mailslurp_client/models/{connector_sync_request_result_exception.rb → connector_smtp_connection_test_result.rb} +29 -35
  73. data/lib/mailslurp_client/models/connector_sync_request_result.rb +2 -2
  74. data/lib/mailslurp_client/models/connector_sync_result.rb +20 -9
  75. data/lib/mailslurp_client/models/{connector_sync_event_dto.rb → connector_sync_settings_dto.rb} +50 -53
  76. data/lib/mailslurp_client/models/consent_status_dto.rb +211 -0
  77. data/lib/mailslurp_client/models/contact_dto.rb +1 -1
  78. data/lib/mailslurp_client/models/contact_projection.rb +11 -11
  79. data/lib/mailslurp_client/models/content_match_options.rb +1 -1
  80. data/lib/mailslurp_client/models/count_dto.rb +1 -1
  81. data/lib/mailslurp_client/models/create_alias_options.rb +1 -1
  82. data/lib/mailslurp_client/models/create_connector_imap_connection_options.rb +93 -7
  83. data/lib/mailslurp_client/models/create_connector_options.rb +2 -69
  84. data/lib/mailslurp_client/models/create_connector_smtp_connection_options.rb +94 -5
  85. data/lib/mailslurp_client/models/create_connector_sync_settings_options.rb +265 -0
  86. data/lib/mailslurp_client/models/create_connector_with_options.rb +239 -0
  87. data/lib/mailslurp_client/models/create_contact_options.rb +1 -1
  88. data/lib/mailslurp_client/models/create_domain_options.rb +1 -1
  89. data/lib/mailslurp_client/models/create_emergency_address_options.rb +3 -3
  90. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  91. data/lib/mailslurp_client/models/create_inbox_dto.rb +1 -1
  92. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +1 -1
  93. data/lib/mailslurp_client/models/create_inbox_replier_options.rb +2 -6
  94. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +1 -1
  95. data/lib/mailslurp_client/models/create_o_auth_connection_result.rb +211 -0
  96. data/lib/mailslurp_client/models/create_o_auth_exchange_result.rb +229 -0
  97. data/lib/mailslurp_client/models/create_phone_number_options.rb +284 -0
  98. data/lib/mailslurp_client/models/create_portal_options.rb +233 -0
  99. data/lib/mailslurp_client/models/create_portal_user_options.rb +251 -0
  100. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  101. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
  102. data/lib/mailslurp_client/models/create_webhook_options.rb +21 -8
  103. data/lib/mailslurp_client/models/delivery_status_dto.rb +1 -1
  104. data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
  105. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +1 -1
  106. data/lib/mailslurp_client/models/dns_lookup_options.rb +1 -1
  107. data/lib/mailslurp_client/models/dns_lookup_result.rb +1 -1
  108. data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
  109. data/lib/mailslurp_client/models/dns_lookups_options.rb +1 -1
  110. data/lib/mailslurp_client/models/domain_dto.rb +28 -2
  111. data/lib/mailslurp_client/models/domain_group.rb +1 -1
  112. data/lib/mailslurp_client/models/domain_groups_dto.rb +1 -1
  113. data/lib/mailslurp_client/models/domain_information.rb +1 -1
  114. data/lib/mailslurp_client/models/domain_issues_dto.rb +1 -1
  115. data/lib/mailslurp_client/models/domain_name_record.rb +1 -1
  116. data/lib/mailslurp_client/models/domain_preview.rb +1 -1
  117. data/lib/mailslurp_client/models/download_attachment_dto.rb +1 -1
  118. data/lib/mailslurp_client/models/email.rb +68 -2
  119. data/lib/mailslurp_client/models/email_analysis.rb +1 -1
  120. data/lib/mailslurp_client/models/email_available_result.rb +1 -1
  121. data/lib/mailslurp_client/models/email_content_match_result.rb +1 -1
  122. data/lib/mailslurp_client/models/email_content_part_result.rb +1 -1
  123. data/lib/mailslurp_client/models/email_feature_category_name.rb +1 -1
  124. data/lib/mailslurp_client/models/email_feature_family_name.rb +1 -1
  125. data/lib/mailslurp_client/models/email_feature_family_statistics.rb +1 -1
  126. data/lib/mailslurp_client/models/email_feature_names.rb +1 -1
  127. data/lib/mailslurp_client/models/email_feature_overview.rb +1 -1
  128. data/lib/mailslurp_client/models/email_feature_platform_name.rb +1 -1
  129. data/lib/mailslurp_client/models/email_feature_platform_statistics.rb +1 -1
  130. data/lib/mailslurp_client/models/email_feature_support_flags.rb +1 -1
  131. data/lib/mailslurp_client/models/email_feature_support_result.rb +1 -1
  132. data/lib/mailslurp_client/models/email_feature_support_status_percentage.rb +1 -1
  133. data/lib/mailslurp_client/models/email_feature_version_statistics.rb +1 -1
  134. data/lib/mailslurp_client/models/email_html_dto.rb +1 -1
  135. data/lib/mailslurp_client/models/email_links_result.rb +1 -1
  136. data/lib/mailslurp_client/models/email_preview.rb +112 -6
  137. data/lib/mailslurp_client/models/email_preview_urls.rb +1 -1
  138. data/lib/mailslurp_client/models/email_projection.rb +134 -42
  139. data/lib/mailslurp_client/models/email_recipients.rb +1 -1
  140. data/lib/mailslurp_client/models/email_recipients_projection.rb +231 -0
  141. data/lib/mailslurp_client/models/email_screenshot_result.rb +1 -1
  142. data/lib/mailslurp_client/models/email_text_lines_result.rb +1 -1
  143. data/lib/mailslurp_client/models/email_thread_dto.rb +348 -0
  144. data/lib/mailslurp_client/models/email_thread_item.rb +429 -0
  145. data/lib/mailslurp_client/models/email_thread_items_dto.rb +213 -0
  146. data/lib/mailslurp_client/models/email_thread_projection.rb +441 -0
  147. data/lib/mailslurp_client/models/email_validation_request_dto.rb +1 -1
  148. data/lib/mailslurp_client/models/email_verification_result.rb +1 -1
  149. data/lib/mailslurp_client/models/emergency_address.rb +8 -3
  150. data/lib/mailslurp_client/models/emergency_address_dto.rb +3 -3
  151. data/lib/mailslurp_client/models/empty_response_dto.rb +1 -1
  152. data/lib/mailslurp_client/models/entity_automation_item_projection.rb +295 -0
  153. data/lib/mailslurp_client/models/entity_event_item_projection.rb +303 -0
  154. data/lib/mailslurp_client/models/entity_favourite_item_projection.rb +296 -0
  155. data/lib/mailslurp_client/models/expiration_defaults.rb +1 -1
  156. data/lib/mailslurp_client/models/expired_inbox_dto.rb +1 -1
  157. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +20 -20
  158. data/lib/mailslurp_client/models/export_link.rb +1 -1
  159. data/lib/mailslurp_client/models/export_options.rb +1 -1
  160. data/lib/mailslurp_client/models/fake_email_dto.rb +49 -5
  161. data/lib/mailslurp_client/models/fake_email_preview.rb +16 -2
  162. data/lib/mailslurp_client/models/fake_email_result.rb +1 -1
  163. data/lib/mailslurp_client/models/filter_bounced_recipients_options.rb +1 -1
  164. data/lib/mailslurp_client/models/filter_bounced_recipients_result.rb +1 -1
  165. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +1 -1
  166. data/lib/mailslurp_client/models/forward_email_options.rb +1 -1
  167. data/lib/mailslurp_client/models/generate_bimi_record_options.rb +1 -1
  168. data/lib/mailslurp_client/models/generate_bimi_record_results.rb +1 -1
  169. data/lib/mailslurp_client/models/generate_dmarc_record_options.rb +1 -1
  170. data/lib/mailslurp_client/models/generate_dmarc_record_results.rb +1 -1
  171. data/lib/mailslurp_client/models/generate_mta_sts_record_options.rb +1 -1
  172. data/lib/mailslurp_client/models/generate_mta_sts_record_results.rb +1 -1
  173. data/lib/mailslurp_client/models/generate_tls_reporting_record_options.rb +1 -1
  174. data/lib/mailslurp_client/models/generate_tls_reporting_record_results.rb +1 -1
  175. data/lib/mailslurp_client/models/get_email_screenshot_options.rb +1 -1
  176. data/lib/mailslurp_client/models/gravatar_url.rb +1 -1
  177. data/lib/mailslurp_client/models/group_contacts_dto.rb +1 -1
  178. data/lib/mailslurp_client/models/group_dto.rb +1 -1
  179. data/lib/mailslurp_client/models/group_projection.rb +1 -1
  180. data/lib/mailslurp_client/models/guest_portal_dto.rb +303 -0
  181. data/lib/mailslurp_client/models/guest_portal_user_create_dto.rb +225 -0
  182. data/lib/mailslurp_client/models/guest_portal_user_dto.rb +322 -0
  183. data/lib/mailslurp_client/models/guest_portal_user_projection.rb +309 -0
  184. data/lib/mailslurp_client/models/html_validation_result.rb +1 -1
  185. data/lib/mailslurp_client/models/image_issue.rb +1 -1
  186. data/lib/mailslurp_client/models/imap_access_details.rb +1 -1
  187. data/lib/mailslurp_client/models/imap_email_projection.rb +1 -1
  188. data/lib/mailslurp_client/models/imap_flag_operation_options.rb +1 -1
  189. data/lib/mailslurp_client/models/imap_mailbox_status.rb +1 -1
  190. data/lib/mailslurp_client/models/imap_server_fetch_item.rb +1 -1
  191. data/lib/mailslurp_client/models/imap_server_fetch_result.rb +1 -1
  192. data/lib/mailslurp_client/models/imap_server_get_result.rb +1 -1
  193. data/lib/mailslurp_client/models/imap_server_list_options.rb +1 -1
  194. data/lib/mailslurp_client/models/imap_server_list_result.rb +1 -1
  195. data/lib/mailslurp_client/models/imap_server_mailbox_result.rb +1 -1
  196. data/lib/mailslurp_client/models/imap_server_search_options.rb +1 -1
  197. data/lib/mailslurp_client/models/imap_server_search_result.rb +1 -1
  198. data/lib/mailslurp_client/models/imap_server_status_options.rb +1 -1
  199. data/lib/mailslurp_client/models/imap_server_status_result.rb +1 -1
  200. data/lib/mailslurp_client/models/imap_smtp_access_details.rb +17 -2
  201. data/lib/mailslurp_client/models/imap_smtp_access_servers.rb +1 -1
  202. data/lib/mailslurp_client/models/imap_update_flags_options.rb +1 -1
  203. data/lib/mailslurp_client/models/inbox_by_email_address_result.rb +1 -1
  204. data/lib/mailslurp_client/models/inbox_by_name_result.rb +1 -1
  205. data/lib/mailslurp_client/models/inbox_dto.rb +54 -9
  206. data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
  207. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +2 -6
  208. data/lib/mailslurp_client/models/inbox_forwarder_event_dto.rb +12 -2
  209. data/lib/mailslurp_client/models/inbox_forwarder_event_projection.rb +25 -15
  210. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  211. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +1 -1
  212. data/lib/mailslurp_client/models/inbox_id_item.rb +1 -1
  213. data/lib/mailslurp_client/models/inbox_ids_result.rb +1 -1
  214. data/lib/mailslurp_client/models/inbox_preview.rb +54 -9
  215. data/lib/mailslurp_client/models/inbox_replier_dto.rb +2 -6
  216. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +28 -28
  217. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +1 -1
  218. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  219. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +1 -1
  220. data/lib/mailslurp_client/models/inline_object.rb +2 -12
  221. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  222. data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
  223. data/lib/mailslurp_client/models/link_issue.rb +1 -1
  224. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +16 -16
  225. data/lib/mailslurp_client/models/lookup_bimi_domain_options.rb +1 -1
  226. data/lib/mailslurp_client/models/lookup_bimi_domain_results.rb +1 -1
  227. data/lib/mailslurp_client/models/lookup_dmarc_domain_options.rb +1 -1
  228. data/lib/mailslurp_client/models/lookup_dmarc_domain_results.rb +1 -1
  229. data/lib/mailslurp_client/models/lookup_mta_sts_domain_options.rb +1 -1
  230. data/lib/mailslurp_client/models/lookup_mta_sts_domain_results.rb +1 -1
  231. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_options.rb +1 -1
  232. data/lib/mailslurp_client/models/lookup_tls_reporting_domain_results.rb +1 -1
  233. data/lib/mailslurp_client/models/match_option.rb +1 -1
  234. data/lib/mailslurp_client/models/match_options.rb +1 -1
  235. data/lib/mailslurp_client/models/missed_email_dto.rb +1 -1
  236. data/lib/mailslurp_client/models/missed_email_projection.rb +11 -11
  237. data/lib/mailslurp_client/models/name_server_record.rb +1 -1
  238. data/lib/mailslurp_client/models/new_fake_email_address_result.rb +1 -1
  239. data/lib/mailslurp_client/models/opt_in_consent_options.rb +229 -0
  240. data/lib/mailslurp_client/models/opt_in_consent_send_result.rb +211 -0
  241. data/lib/mailslurp_client/models/{connector_sync_request_result_exception_cause_stack_trace.rb → opt_in_identity_projection.rb} +54 -61
  242. data/lib/mailslurp_client/models/opt_in_sending_consent_dto.rb +239 -0
  243. data/lib/mailslurp_client/models/optional_connector_dto.rb +220 -0
  244. data/lib/mailslurp_client/models/optional_connector_imap_connection_dto.rb +220 -0
  245. data/lib/mailslurp_client/models/optional_connector_smtp_connection_dto.rb +220 -0
  246. data/lib/mailslurp_client/models/optional_connector_sync_settings_dto.rb +220 -0
  247. data/lib/mailslurp_client/models/organization_inbox_projection.rb +68 -8
  248. data/lib/mailslurp_client/models/page_alias.rb +16 -16
  249. data/lib/mailslurp_client/models/{page_connector_sync_events.rb → page_alias_thread_projection.rb} +21 -21
  250. data/lib/mailslurp_client/models/page_attachment_entity.rb +16 -16
  251. data/lib/mailslurp_client/models/page_bounced_email.rb +16 -16
  252. data/lib/mailslurp_client/models/page_bounced_recipients.rb +16 -16
  253. data/lib/mailslurp_client/models/page_complaint.rb +16 -16
  254. data/lib/mailslurp_client/models/page_connector.rb +16 -16
  255. data/lib/mailslurp_client/models/page_connector_events.rb +309 -0
  256. data/lib/mailslurp_client/models/page_contact_projection.rb +16 -16
  257. data/lib/mailslurp_client/models/page_delivery_status.rb +16 -16
  258. data/lib/mailslurp_client/models/page_email_preview.rb +16 -16
  259. data/lib/mailslurp_client/models/page_email_projection.rb +16 -16
  260. data/lib/mailslurp_client/models/page_email_thread_projection.rb +309 -0
  261. data/lib/mailslurp_client/models/page_email_validation_request.rb +16 -16
  262. data/lib/mailslurp_client/models/page_entity_automation_items.rb +309 -0
  263. data/lib/mailslurp_client/models/{page_thread_projection.rb → page_entity_event_items.rb} +21 -21
  264. data/lib/mailslurp_client/models/page_entity_favourite_items.rb +309 -0
  265. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +16 -16
  266. data/lib/mailslurp_client/models/page_group_projection.rb +16 -16
  267. data/lib/mailslurp_client/models/page_guest_portal_users.rb +309 -0
  268. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +16 -16
  269. data/lib/mailslurp_client/models/page_inbox_forwarder_events.rb +16 -16
  270. data/lib/mailslurp_client/models/page_inbox_projection.rb +16 -16
  271. data/lib/mailslurp_client/models/page_inbox_replier_dto.rb +16 -16
  272. data/lib/mailslurp_client/models/page_inbox_replier_events.rb +16 -16
  273. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +16 -16
  274. data/lib/mailslurp_client/models/page_inbox_tags.rb +309 -0
  275. data/lib/mailslurp_client/models/page_list_unsubscribe_recipients.rb +16 -16
  276. data/lib/mailslurp_client/models/page_missed_email_projection.rb +16 -16
  277. data/lib/mailslurp_client/models/page_opt_in_identity_projection.rb +309 -0
  278. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +16 -16
  279. data/lib/mailslurp_client/models/page_phone_message_thread_item_projection.rb +309 -0
  280. data/lib/mailslurp_client/models/page_phone_message_thread_projection.rb +309 -0
  281. data/lib/mailslurp_client/models/page_phone_number_projection.rb +16 -16
  282. data/lib/mailslurp_client/models/page_plus_address_projection.rb +309 -0
  283. data/lib/mailslurp_client/models/page_reputation_items.rb +309 -0
  284. data/lib/mailslurp_client/models/page_scheduled_jobs.rb +16 -16
  285. data/lib/mailslurp_client/models/page_sent_email_projection.rb +16 -16
  286. data/lib/mailslurp_client/models/page_sent_email_with_queue_projection.rb +16 -16
  287. data/lib/mailslurp_client/models/page_sent_sms_projection.rb +309 -0
  288. data/lib/mailslurp_client/models/page_sms_projection.rb +16 -16
  289. data/lib/mailslurp_client/models/page_template_projection.rb +16 -16
  290. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +16 -16
  291. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +16 -16
  292. data/lib/mailslurp_client/models/page_webhook_endpoint_projection.rb +309 -0
  293. data/lib/mailslurp_client/models/page_webhook_projection.rb +16 -16
  294. data/lib/mailslurp_client/models/page_webhook_result.rb +16 -16
  295. data/lib/mailslurp_client/models/pageable_object.rb +20 -20
  296. data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +315 -0
  297. data/lib/mailslurp_client/models/phone_message_thread_projection.rb +315 -0
  298. data/lib/mailslurp_client/models/phone_number_dto.rb +39 -7
  299. data/lib/mailslurp_client/models/phone_number_projection.rb +27 -18
  300. data/lib/mailslurp_client/models/phone_number_validation_dto.rb +254 -0
  301. data/lib/mailslurp_client/models/phone_plan_availability.rb +213 -0
  302. data/lib/mailslurp_client/models/phone_plan_availability_item.rb +271 -0
  303. data/lib/mailslurp_client/models/phone_plan_dto.rb +3 -3
  304. data/lib/mailslurp_client/models/plus_address_dto.rb +295 -0
  305. data/lib/mailslurp_client/models/plus_address_projection.rb +295 -0
  306. data/lib/mailslurp_client/models/provider_settings.rb +347 -0
  307. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  308. data/lib/mailslurp_client/models/recipient.rb +1 -1
  309. data/lib/mailslurp_client/models/recipient_projection.rb +234 -0
  310. data/lib/mailslurp_client/models/reply_for_sms.rb +1 -1
  311. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +1 -1
  312. data/lib/mailslurp_client/models/reply_to_email_options.rb +1 -1
  313. data/lib/mailslurp_client/models/reputation_item_projection.rb +317 -0
  314. data/lib/mailslurp_client/models/scheduled_job.rb +1 -1
  315. data/lib/mailslurp_client/models/scheduled_job_dto.rb +1 -1
  316. data/lib/mailslurp_client/models/search_emails_options.rb +1 -1
  317. data/lib/mailslurp_client/models/search_inboxes_options.rb +3 -3
  318. data/lib/mailslurp_client/models/send_email_body_part.rb +1 -1
  319. data/lib/mailslurp_client/models/send_email_options.rb +13 -2
  320. data/lib/mailslurp_client/models/send_opt_in_consent_email_options.rb +234 -0
  321. data/lib/mailslurp_client/models/send_smtp_envelope_options.rb +1 -1
  322. data/lib/mailslurp_client/models/send_with_queue_result.rb +1 -1
  323. data/lib/mailslurp_client/models/sender.rb +1 -1
  324. data/lib/mailslurp_client/models/sender_projection.rb +235 -0
  325. data/lib/mailslurp_client/models/sent_email_dto.rb +103 -2
  326. data/lib/mailslurp_client/models/sent_email_projection.rb +113 -44
  327. data/lib/mailslurp_client/models/sent_sms_dto.rb +1 -11
  328. data/lib/mailslurp_client/models/sent_sms_projection.rb +305 -0
  329. data/lib/mailslurp_client/models/server_endpoints.rb +1 -1
  330. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +1 -1
  331. data/lib/mailslurp_client/models/set_phone_favourited_options.rb +213 -0
  332. data/lib/mailslurp_client/models/simple_send_email_options.rb +1 -1
  333. data/lib/mailslurp_client/models/sms_dto.rb +25 -2
  334. data/lib/mailslurp_client/models/sms_match_option.rb +1 -1
  335. data/lib/mailslurp_client/models/sms_preview.rb +16 -2
  336. data/lib/mailslurp_client/models/sms_projection.rb +16 -16
  337. data/lib/mailslurp_client/models/sms_reply_options.rb +1 -1
  338. data/lib/mailslurp_client/models/sms_send_options.rb +225 -0
  339. data/lib/mailslurp_client/models/smtp_access_details.rb +1 -1
  340. data/lib/mailslurp_client/models/sort_object.rb +1 -1
  341. data/lib/mailslurp_client/models/spelling_issue.rb +1 -1
  342. data/lib/mailslurp_client/models/template_dto.rb +1 -1
  343. data/lib/mailslurp_client/models/template_preview.rb +1 -1
  344. data/lib/mailslurp_client/models/template_projection.rb +16 -16
  345. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  346. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_options.rb +1 -1
  347. data/lib/mailslurp_client/models/test_inbox_ruleset_receiving_result.rb +1 -1
  348. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_options.rb +1 -1
  349. data/lib/mailslurp_client/models/test_inbox_ruleset_sending_result.rb +1 -1
  350. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  351. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  352. data/lib/mailslurp_client/models/test_phone_number_options.rb +1 -1
  353. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +1 -1
  354. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +22 -22
  355. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +1 -1
  356. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  357. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
  358. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  359. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  360. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  361. data/lib/mailslurp_client/models/update_imap_access_options.rb +1 -1
  362. data/lib/mailslurp_client/models/update_inbox_options.rb +1 -1
  363. data/lib/mailslurp_client/models/update_inbox_replier_options.rb +1 -1
  364. data/lib/mailslurp_client/models/update_phone_number_options.rb +215 -0
  365. data/lib/mailslurp_client/models/update_smtp_access_options.rb +1 -1
  366. data/lib/mailslurp_client/models/upload_attachment_options.rb +1 -1
  367. data/lib/mailslurp_client/models/user_info_dto.rb +1 -1
  368. data/lib/mailslurp_client/models/validate_email_address_list_options.rb +1 -1
  369. data/lib/mailslurp_client/models/validate_email_address_list_result.rb +1 -1
  370. data/lib/mailslurp_client/models/validate_phone_number_options.rb +211 -0
  371. data/lib/mailslurp_client/models/validation_dto.rb +1 -1
  372. data/lib/mailslurp_client/models/validation_message.rb +1 -1
  373. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  374. data/lib/mailslurp_client/models/verify_webhook_signature_options.rb +1 -1
  375. data/lib/mailslurp_client/models/verify_webhook_signature_results.rb +1 -1
  376. data/lib/mailslurp_client/models/wait_for_conditions.rb +1 -1
  377. data/lib/mailslurp_client/models/wait_for_single_sms_options.rb +1 -1
  378. data/lib/mailslurp_client/models/wait_for_sms_conditions.rb +2 -2
  379. data/lib/mailslurp_client/models/webhook_bounce_payload.rb +3 -3
  380. data/lib/mailslurp_client/models/webhook_bounce_recipient_payload.rb +3 -3
  381. data/lib/mailslurp_client/models/webhook_delivery_status_payload.rb +3 -3
  382. data/lib/mailslurp_client/models/webhook_dto.rb +31 -8
  383. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +3 -3
  384. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +3 -3
  385. data/lib/mailslurp_client/models/webhook_endpoint_projection.rb +259 -0
  386. data/lib/mailslurp_client/models/webhook_header_name_value.rb +1 -1
  387. data/lib/mailslurp_client/models/webhook_headers.rb +1 -1
  388. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +3 -3
  389. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +3 -3
  390. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +3 -3
  391. data/lib/mailslurp_client/models/webhook_new_sms_payload.rb +3 -3
  392. data/lib/mailslurp_client/models/webhook_projection.rb +78 -25
  393. data/lib/mailslurp_client/models/webhook_redrive_all_result.rb +1 -1
  394. data/lib/mailslurp_client/models/webhook_redrive_result.rb +1 -1
  395. data/lib/mailslurp_client/models/webhook_result_dto.rb +3 -3
  396. data/lib/mailslurp_client/models/webhook_test_request.rb +1 -1
  397. data/lib/mailslurp_client/models/webhook_test_response.rb +1 -1
  398. data/lib/mailslurp_client/models/webhook_test_result.rb +1 -1
  399. data/lib/mailslurp_client/version.rb +2 -2
  400. data/lib/mailslurp_client.rb +74 -10
  401. metadata +75 -11
@@ -1,7 +1,7 @@
1
1
  =begin
2
2
  #MailSlurp API
3
3
 
4
- #MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. 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
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
5
 
6
6
  The version of the OpenAPI document: 6.5.2
7
7
  Contact: contact@mailslurp.dev
@@ -19,6 +19,8 @@ module MailSlurpClient
19
19
  def initialize(api_client = ApiClient.default)
20
20
  @api_client = api_client
21
21
  end
22
+ # Create an emergency address
23
+ # Add an emergency address to a phone number
22
24
  # @param create_emergency_address_options [CreateEmergencyAddressOptions]
23
25
  # @param [Hash] opts the optional parameters
24
26
  # @return [EmergencyAddress]
@@ -27,6 +29,8 @@ module MailSlurpClient
27
29
  data
28
30
  end
29
31
 
32
+ # Create an emergency address
33
+ # Add an emergency address to a phone number
30
34
  # @param create_emergency_address_options [CreateEmergencyAddressOptions]
31
35
  # @param [Hash] opts the optional parameters
32
36
  # @return [Array<(EmergencyAddress, Integer, Hash)>] EmergencyAddress data, response status code and response headers
@@ -79,6 +83,72 @@ module MailSlurpClient
79
83
  return data, status_code, headers
80
84
  end
81
85
 
86
+ # Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
87
+ # Create new phone number
88
+ # @param create_phone_number_options [CreatePhoneNumberOptions]
89
+ # @param [Hash] opts the optional parameters
90
+ # @return [PhoneNumberDto]
91
+ def create_phone_number(create_phone_number_options, opts = {})
92
+ data, _status_code, _headers = create_phone_number_with_http_info(create_phone_number_options, opts)
93
+ data
94
+ end
95
+
96
+ # Add phone number to your account. Only works if you have already added a plan and an initial phone number in your account and acknowledged the pricing and terms of service by enabling API phone creation.
97
+ # Create new phone number
98
+ # @param create_phone_number_options [CreatePhoneNumberOptions]
99
+ # @param [Hash] opts the optional parameters
100
+ # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
101
+ def create_phone_number_with_http_info(create_phone_number_options, opts = {})
102
+ if @api_client.config.debugging
103
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.create_phone_number ...'
104
+ end
105
+ # verify the required parameter 'create_phone_number_options' is set
106
+ if @api_client.config.client_side_validation && create_phone_number_options.nil?
107
+ fail ArgumentError, "Missing the required parameter 'create_phone_number_options' when calling PhoneControllerApi.create_phone_number"
108
+ end
109
+ # resource path
110
+ local_var_path = '/phone'
111
+
112
+ # query parameters
113
+ query_params = opts[:query_params] || {}
114
+
115
+ # header parameters
116
+ header_params = opts[:header_params] || {}
117
+ # HTTP header 'Accept' (if needed)
118
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
119
+ # HTTP header 'Content-Type'
120
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
121
+
122
+ # form parameters
123
+ form_params = opts[:form_params] || {}
124
+
125
+ # http body (model)
126
+ post_body = opts[:body] || @api_client.object_to_http_body(create_phone_number_options)
127
+
128
+ # return_type
129
+ return_type = opts[:return_type] || 'PhoneNumberDto'
130
+
131
+ # auth_names
132
+ auth_names = opts[:auth_names] || ['API_KEY']
133
+
134
+ new_options = opts.merge(
135
+ :header_params => header_params,
136
+ :query_params => query_params,
137
+ :form_params => form_params,
138
+ :body => post_body,
139
+ :auth_names => auth_names,
140
+ :return_type => return_type
141
+ )
142
+
143
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
144
+ if @api_client.config.debugging
145
+ @api_client.config.logger.debug "API called: PhoneControllerApi#create_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
146
+ end
147
+ return data, status_code, headers
148
+ end
149
+
150
+ # Delete an emergency address
151
+ # Delete an emergency address
82
152
  # @param address_id [String]
83
153
  # @param [Hash] opts the optional parameters
84
154
  # @return [EmptyResponseDto]
@@ -87,6 +157,8 @@ module MailSlurpClient
87
157
  data
88
158
  end
89
159
 
160
+ # Delete an emergency address
161
+ # Delete an emergency address
90
162
  # @param address_id [String]
91
163
  # @param [Hash] opts the optional parameters
92
164
  # @return [Array<(EmptyResponseDto, Integer, Hash)>] EmptyResponseDto data, response status code and response headers
@@ -137,6 +209,8 @@ module MailSlurpClient
137
209
  return data, status_code, headers
138
210
  end
139
211
 
212
+ # Delete a phone number
213
+ # Remove phone number from account
140
214
  # @param phone_number_id [String]
141
215
  # @param [Hash] opts the optional parameters
142
216
  # @return [nil]
@@ -145,6 +219,8 @@ module MailSlurpClient
145
219
  nil
146
220
  end
147
221
 
222
+ # Delete a phone number
223
+ # Remove phone number from account
148
224
  # @param phone_number_id [String]
149
225
  # @param [Hash] opts the optional parameters
150
226
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -193,6 +269,126 @@ module MailSlurpClient
193
269
  return data, status_code, headers
194
270
  end
195
271
 
272
+ # Get the latest messages for all phones
273
+ # List all message threads for all phones
274
+ # @param [Hash] opts the optional parameters
275
+ # @option opts [Integer] :page (default to 0)
276
+ # @option opts [Integer] :size (default to 20)
277
+ # @return [PagePhoneMessageThreadProjection]
278
+ def get_all_phone_message_threads(opts = {})
279
+ data, _status_code, _headers = get_all_phone_message_threads_with_http_info(opts)
280
+ data
281
+ end
282
+
283
+ # Get the latest messages for all phones
284
+ # List all message threads for all phones
285
+ # @param [Hash] opts the optional parameters
286
+ # @option opts [Integer] :page
287
+ # @option opts [Integer] :size
288
+ # @return [Array<(PagePhoneMessageThreadProjection, Integer, Hash)>] PagePhoneMessageThreadProjection data, response status code and response headers
289
+ def get_all_phone_message_threads_with_http_info(opts = {})
290
+ if @api_client.config.debugging
291
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_all_phone_message_threads ...'
292
+ end
293
+ # resource path
294
+ local_var_path = '/phone/numbers/message-threads'
295
+
296
+ # query parameters
297
+ query_params = opts[:query_params] || {}
298
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
299
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
300
+
301
+ # header parameters
302
+ header_params = opts[:header_params] || {}
303
+ # HTTP header 'Accept' (if needed)
304
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
305
+
306
+ # form parameters
307
+ form_params = opts[:form_params] || {}
308
+
309
+ # http body (model)
310
+ post_body = opts[:body]
311
+
312
+ # return_type
313
+ return_type = opts[:return_type] || 'PagePhoneMessageThreadProjection'
314
+
315
+ # auth_names
316
+ auth_names = opts[:auth_names] || ['API_KEY']
317
+
318
+ new_options = opts.merge(
319
+ :header_params => header_params,
320
+ :query_params => query_params,
321
+ :form_params => form_params,
322
+ :body => post_body,
323
+ :auth_names => auth_names,
324
+ :return_type => return_type
325
+ )
326
+
327
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
328
+ if @api_client.config.debugging
329
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_all_phone_message_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
330
+ end
331
+ return data, status_code, headers
332
+ end
333
+
334
+ # Get consent status
335
+ # Get the status of phone usage consent
336
+ # @param [Hash] opts the optional parameters
337
+ # @return [ConsentStatusDto]
338
+ def get_consent_status(opts = {})
339
+ data, _status_code, _headers = get_consent_status_with_http_info(opts)
340
+ data
341
+ end
342
+
343
+ # Get consent status
344
+ # Get the status of phone usage consent
345
+ # @param [Hash] opts the optional parameters
346
+ # @return [Array<(ConsentStatusDto, Integer, Hash)>] ConsentStatusDto data, response status code and response headers
347
+ def get_consent_status_with_http_info(opts = {})
348
+ if @api_client.config.debugging
349
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_consent_status ...'
350
+ end
351
+ # resource path
352
+ local_var_path = '/phone/consent'
353
+
354
+ # query parameters
355
+ query_params = opts[:query_params] || {}
356
+
357
+ # header parameters
358
+ header_params = opts[:header_params] || {}
359
+ # HTTP header 'Accept' (if needed)
360
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
361
+
362
+ # form parameters
363
+ form_params = opts[:form_params] || {}
364
+
365
+ # http body (model)
366
+ post_body = opts[:body]
367
+
368
+ # return_type
369
+ return_type = opts[:return_type] || 'ConsentStatusDto'
370
+
371
+ # auth_names
372
+ auth_names = opts[:auth_names] || ['API_KEY']
373
+
374
+ new_options = opts.merge(
375
+ :header_params => header_params,
376
+ :query_params => query_params,
377
+ :form_params => form_params,
378
+ :body => post_body,
379
+ :auth_names => auth_names,
380
+ :return_type => return_type
381
+ )
382
+
383
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
384
+ if @api_client.config.debugging
385
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_consent_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
386
+ end
387
+ return data, status_code, headers
388
+ end
389
+
390
+ # Get an emergency address
391
+ # Fetch an emergency address by ID
196
392
  # @param address_id [String]
197
393
  # @param [Hash] opts the optional parameters
198
394
  # @return [EmergencyAddress]
@@ -201,6 +397,8 @@ module MailSlurpClient
201
397
  data
202
398
  end
203
399
 
400
+ # Get an emergency address
401
+ # Fetch an emergency address by ID
204
402
  # @param address_id [String]
205
403
  # @param [Hash] opts the optional parameters
206
404
  # @return [Array<(EmergencyAddress, Integer, Hash)>] EmergencyAddress data, response status code and response headers
@@ -251,6 +449,8 @@ module MailSlurpClient
251
449
  return data, status_code, headers
252
450
  end
253
451
 
452
+ # Get emergency addresses
453
+ # List emergency addresses
254
454
  # @param [Hash] opts the optional parameters
255
455
  # @return [Array<EmergencyAddressDto>]
256
456
  def get_emergency_addresses(opts = {})
@@ -258,6 +458,8 @@ module MailSlurpClient
258
458
  data
259
459
  end
260
460
 
461
+ # Get emergency addresses
462
+ # List emergency addresses
261
463
  # @param [Hash] opts the optional parameters
262
464
  # @return [Array<(Array<EmergencyAddressDto>, Integer, Hash)>] Array<EmergencyAddressDto> data, response status code and response headers
263
465
  def get_emergency_addresses_with_http_info(opts = {})
@@ -303,6 +505,150 @@ module MailSlurpClient
303
505
  return data, status_code, headers
304
506
  end
305
507
 
508
+ # Get messages in a phone thread
509
+ # List message thread messages for a phone message thread
510
+ # @param phone_number_id [String]
511
+ # @param other_number [String]
512
+ # @param [Hash] opts the optional parameters
513
+ # @option opts [Integer] :page (default to 0)
514
+ # @option opts [Integer] :size (default to 20)
515
+ # @return [PagePhoneMessageThreadItemProjection]
516
+ def get_phone_message_thread_items(phone_number_id, other_number, opts = {})
517
+ data, _status_code, _headers = get_phone_message_thread_items_with_http_info(phone_number_id, other_number, opts)
518
+ data
519
+ end
520
+
521
+ # Get messages in a phone thread
522
+ # List message thread messages for a phone message thread
523
+ # @param phone_number_id [String]
524
+ # @param other_number [String]
525
+ # @param [Hash] opts the optional parameters
526
+ # @option opts [Integer] :page
527
+ # @option opts [Integer] :size
528
+ # @return [Array<(PagePhoneMessageThreadItemProjection, Integer, Hash)>] PagePhoneMessageThreadItemProjection data, response status code and response headers
529
+ def get_phone_message_thread_items_with_http_info(phone_number_id, other_number, opts = {})
530
+ if @api_client.config.debugging
531
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_message_thread_items ...'
532
+ end
533
+ # verify the required parameter 'phone_number_id' is set
534
+ if @api_client.config.client_side_validation && phone_number_id.nil?
535
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_phone_message_thread_items"
536
+ end
537
+ # verify the required parameter 'other_number' is set
538
+ if @api_client.config.client_side_validation && other_number.nil?
539
+ fail ArgumentError, "Missing the required parameter 'other_number' when calling PhoneControllerApi.get_phone_message_thread_items"
540
+ end
541
+ # resource path
542
+ local_var_path = '/phone/numbers/{phoneNumberId}/message-threads/{otherNumber}'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s)).sub('{' + 'otherNumber' + '}', CGI.escape(other_number.to_s))
543
+
544
+ # query parameters
545
+ query_params = opts[:query_params] || {}
546
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
547
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
548
+
549
+ # header parameters
550
+ header_params = opts[:header_params] || {}
551
+ # HTTP header 'Accept' (if needed)
552
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
553
+
554
+ # form parameters
555
+ form_params = opts[:form_params] || {}
556
+
557
+ # http body (model)
558
+ post_body = opts[:body]
559
+
560
+ # return_type
561
+ return_type = opts[:return_type] || 'PagePhoneMessageThreadItemProjection'
562
+
563
+ # auth_names
564
+ auth_names = opts[:auth_names] || ['API_KEY']
565
+
566
+ new_options = opts.merge(
567
+ :header_params => header_params,
568
+ :query_params => query_params,
569
+ :form_params => form_params,
570
+ :body => post_body,
571
+ :auth_names => auth_names,
572
+ :return_type => return_type
573
+ )
574
+
575
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
576
+ if @api_client.config.debugging
577
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_phone_message_thread_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
578
+ end
579
+ return data, status_code, headers
580
+ end
581
+
582
+ # Get the latest message preview for a thread
583
+ # List message threads for a phone
584
+ # @param phone_number_id [String]
585
+ # @param [Hash] opts the optional parameters
586
+ # @option opts [Integer] :page (default to 0)
587
+ # @option opts [Integer] :size (default to 20)
588
+ # @return [PagePhoneMessageThreadProjection]
589
+ def get_phone_message_threads(phone_number_id, opts = {})
590
+ data, _status_code, _headers = get_phone_message_threads_with_http_info(phone_number_id, opts)
591
+ data
592
+ end
593
+
594
+ # Get the latest message preview for a thread
595
+ # List message threads for a phone
596
+ # @param phone_number_id [String]
597
+ # @param [Hash] opts the optional parameters
598
+ # @option opts [Integer] :page
599
+ # @option opts [Integer] :size
600
+ # @return [Array<(PagePhoneMessageThreadProjection, Integer, Hash)>] PagePhoneMessageThreadProjection data, response status code and response headers
601
+ def get_phone_message_threads_with_http_info(phone_number_id, opts = {})
602
+ if @api_client.config.debugging
603
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_message_threads ...'
604
+ end
605
+ # verify the required parameter 'phone_number_id' is set
606
+ if @api_client.config.client_side_validation && phone_number_id.nil?
607
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_phone_message_threads"
608
+ end
609
+ # resource path
610
+ local_var_path = '/phone/numbers/{phoneNumberId}/message-threads'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
611
+
612
+ # query parameters
613
+ query_params = opts[:query_params] || {}
614
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
615
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
616
+
617
+ # header parameters
618
+ header_params = opts[:header_params] || {}
619
+ # HTTP header 'Accept' (if needed)
620
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
621
+
622
+ # form parameters
623
+ form_params = opts[:form_params] || {}
624
+
625
+ # http body (model)
626
+ post_body = opts[:body]
627
+
628
+ # return_type
629
+ return_type = opts[:return_type] || 'PagePhoneMessageThreadProjection'
630
+
631
+ # auth_names
632
+ auth_names = opts[:auth_names] || ['API_KEY']
633
+
634
+ new_options = opts.merge(
635
+ :header_params => header_params,
636
+ :query_params => query_params,
637
+ :form_params => form_params,
638
+ :body => post_body,
639
+ :auth_names => auth_names,
640
+ :return_type => return_type
641
+ )
642
+
643
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
644
+ if @api_client.config.debugging
645
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_phone_message_threads\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
646
+ end
647
+ return data, status_code, headers
648
+ end
649
+
650
+ # Get a phone number by ID
651
+ # Get a phone number by ID
306
652
  # @param phone_number_id [String]
307
653
  # @param [Hash] opts the optional parameters
308
654
  # @return [PhoneNumberDto]
@@ -311,6 +657,8 @@ module MailSlurpClient
311
657
  data
312
658
  end
313
659
 
660
+ # Get a phone number by ID
661
+ # Get a phone number by ID
314
662
  # @param phone_number_id [String]
315
663
  # @param [Hash] opts the optional parameters
316
664
  # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
@@ -361,6 +709,8 @@ module MailSlurpClient
361
709
  return data, status_code, headers
362
710
  end
363
711
 
712
+ # Get phone numbers
713
+ # List phone numbers for account
364
714
  # @param [Hash] opts the optional parameters
365
715
  # @option opts [String] :phone_country Optional phone country
366
716
  # @option opts [Integer] :page Optional page index for list pagination (default to 0)
@@ -368,12 +718,17 @@ module MailSlurpClient
368
718
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
369
719
  # @option opts [DateTime] :since Filter by created at after the given timestamp
370
720
  # @option opts [DateTime] :before Filter by created at before the given timestamp
721
+ # @option opts [String] :search Optional search filter
722
+ # @option opts [Array<String>] :include Optional phoneIds to include in result
723
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
371
724
  # @return [PagePhoneNumberProjection]
372
725
  def get_phone_numbers(opts = {})
373
726
  data, _status_code, _headers = get_phone_numbers_with_http_info(opts)
374
727
  data
375
728
  end
376
729
 
730
+ # Get phone numbers
731
+ # List phone numbers for account
377
732
  # @param [Hash] opts the optional parameters
378
733
  # @option opts [String] :phone_country Optional phone country
379
734
  # @option opts [Integer] :page Optional page index for list pagination
@@ -381,12 +736,15 @@ module MailSlurpClient
381
736
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
382
737
  # @option opts [DateTime] :since Filter by created at after the given timestamp
383
738
  # @option opts [DateTime] :before Filter by created at before the given timestamp
739
+ # @option opts [String] :search Optional search filter
740
+ # @option opts [Array<String>] :include Optional phoneIds to include in result
741
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only
384
742
  # @return [Array<(PagePhoneNumberProjection, Integer, Hash)>] PagePhoneNumberProjection data, response status code and response headers
385
743
  def get_phone_numbers_with_http_info(opts = {})
386
744
  if @api_client.config.debugging
387
745
  @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_numbers ...'
388
746
  end
389
- allowable_values = ["US", "GB", "AU"]
747
+ allowable_values = ["US", "GB", "AU", "CA", "EE", "HK", "PL", "CH", "PT", "NL", "IL", "SE"]
390
748
  if @api_client.config.client_side_validation && opts[:'phone_country'] && !allowable_values.include?(opts[:'phone_country'])
391
749
  fail ArgumentError, "invalid value for \"phone_country\", must be one of #{allowable_values}"
392
750
  end
@@ -405,6 +763,9 @@ module MailSlurpClient
405
763
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
406
764
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
407
765
  query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
766
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
767
+ query_params[:'include'] = @api_client.build_collection_param(opts[:'include'], :multi) if !opts[:'include'].nil?
768
+ query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
408
769
 
409
770
  # header parameters
410
771
  header_params = opts[:header_params] || {}
@@ -439,6 +800,8 @@ module MailSlurpClient
439
800
  return data, status_code, headers
440
801
  end
441
802
 
803
+ # Get phone plans
804
+ # Get phone number plans
442
805
  # @param [Hash] opts the optional parameters
443
806
  # @return [Array<PhonePlanDto>]
444
807
  def get_phone_plans(opts = {})
@@ -446,6 +809,8 @@ module MailSlurpClient
446
809
  data
447
810
  end
448
811
 
812
+ # Get phone plans
813
+ # Get phone number plans
449
814
  # @param [Hash] opts the optional parameters
450
815
  # @return [Array<(Array<PhonePlanDto>, Integer, Hash)>] Array<PhonePlanDto> data, response status code and response headers
451
816
  def get_phone_plans_with_http_info(opts = {})
@@ -491,30 +856,473 @@ module MailSlurpClient
491
856
  return data, status_code, headers
492
857
  end
493
858
 
494
- # @param phone_number_id [String]
495
- # @param test_phone_number_options [TestPhoneNumberOptions]
859
+ # Get phone plans availability
496
860
  # @param [Hash] opts the optional parameters
497
- # @option opts [String] :x_test_id
498
- # @return [nil]
499
- def test_phone_number_send_sms(phone_number_id, test_phone_number_options, opts = {})
500
- test_phone_number_send_sms_with_http_info(phone_number_id, test_phone_number_options, opts)
501
- nil
861
+ # @return [PhonePlanAvailability]
862
+ def get_phone_plans_availability(opts = {})
863
+ data, _status_code, _headers = get_phone_plans_availability_with_http_info(opts)
864
+ data
502
865
  end
503
866
 
504
- # @param phone_number_id [String]
505
- # @param test_phone_number_options [TestPhoneNumberOptions]
867
+ # Get phone plans availability
506
868
  # @param [Hash] opts the optional parameters
507
- # @option opts [String] :x_test_id
508
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
509
- def test_phone_number_send_sms_with_http_info(phone_number_id, test_phone_number_options, opts = {})
869
+ # @return [Array<(PhonePlanAvailability, Integer, Hash)>] PhonePlanAvailability data, response status code and response headers
870
+ def get_phone_plans_availability_with_http_info(opts = {})
510
871
  if @api_client.config.debugging
511
- @api_client.config.logger.debug 'Calling API: PhoneControllerApi.test_phone_number_send_sms ...'
512
- end
513
- # verify the required parameter 'phone_number_id' is set
514
- if @api_client.config.client_side_validation && phone_number_id.nil?
515
- fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.test_phone_number_send_sms"
872
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_phone_plans_availability ...'
516
873
  end
517
- # verify the required parameter 'test_phone_number_options' is set
874
+ # resource path
875
+ local_var_path = '/phone/plans/availability'
876
+
877
+ # query parameters
878
+ query_params = opts[:query_params] || {}
879
+
880
+ # header parameters
881
+ header_params = opts[:header_params] || {}
882
+ # HTTP header 'Accept' (if needed)
883
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
884
+
885
+ # form parameters
886
+ form_params = opts[:form_params] || {}
887
+
888
+ # http body (model)
889
+ post_body = opts[:body]
890
+
891
+ # return_type
892
+ return_type = opts[:return_type] || 'PhonePlanAvailability'
893
+
894
+ # auth_names
895
+ auth_names = opts[:auth_names] || ['API_KEY']
896
+
897
+ new_options = opts.merge(
898
+ :header_params => header_params,
899
+ :query_params => query_params,
900
+ :form_params => form_params,
901
+ :body => post_body,
902
+ :auth_names => auth_names,
903
+ :return_type => return_type
904
+ )
905
+
906
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
907
+ if @api_client.config.debugging
908
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_phone_plans_availability\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
909
+ end
910
+ return data, status_code, headers
911
+ end
912
+
913
+ # List sent TXT messages for a phone number
914
+ # Get sent SMS messages for a phone number
915
+ # @param phone_number_id [String]
916
+ # @param [Hash] opts the optional parameters
917
+ # @option opts [Integer] :page Optional page index in SMS list pagination (default to 0)
918
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
919
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
920
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
921
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
922
+ # @option opts [String] :search Optional search filter
923
+ # @return [PageSentSmsProjection]
924
+ def get_sent_sms_by_phone_number(phone_number_id, opts = {})
925
+ data, _status_code, _headers = get_sent_sms_by_phone_number_with_http_info(phone_number_id, opts)
926
+ data
927
+ end
928
+
929
+ # List sent TXT messages for a phone number
930
+ # Get sent SMS messages for a phone number
931
+ # @param phone_number_id [String]
932
+ # @param [Hash] opts the optional parameters
933
+ # @option opts [Integer] :page Optional page index in SMS list pagination
934
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
935
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
936
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
937
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
938
+ # @option opts [String] :search Optional search filter
939
+ # @return [Array<(PageSentSmsProjection, Integer, Hash)>] PageSentSmsProjection data, response status code and response headers
940
+ def get_sent_sms_by_phone_number_with_http_info(phone_number_id, opts = {})
941
+ if @api_client.config.debugging
942
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_sent_sms_by_phone_number ...'
943
+ end
944
+ # verify the required parameter 'phone_number_id' is set
945
+ if @api_client.config.client_side_validation && phone_number_id.nil?
946
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_sent_sms_by_phone_number"
947
+ end
948
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
949
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling PhoneControllerApi.get_sent_sms_by_phone_number, must be smaller than or equal to 100.'
950
+ end
951
+
952
+ allowable_values = ["ASC", "DESC"]
953
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
954
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
955
+ end
956
+ # resource path
957
+ local_var_path = '/phone/numbers/{phoneNumberId}/sms-sent'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
958
+
959
+ # query parameters
960
+ query_params = opts[:query_params] || {}
961
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
962
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
963
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
964
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
965
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
966
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
967
+
968
+ # header parameters
969
+ header_params = opts[:header_params] || {}
970
+ # HTTP header 'Accept' (if needed)
971
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
972
+
973
+ # form parameters
974
+ form_params = opts[:form_params] || {}
975
+
976
+ # http body (model)
977
+ post_body = opts[:body]
978
+
979
+ # return_type
980
+ return_type = opts[:return_type] || 'PageSentSmsProjection'
981
+
982
+ # auth_names
983
+ auth_names = opts[:auth_names] || ['API_KEY']
984
+
985
+ new_options = opts.merge(
986
+ :header_params => header_params,
987
+ :query_params => query_params,
988
+ :form_params => form_params,
989
+ :body => post_body,
990
+ :auth_names => auth_names,
991
+ :return_type => return_type
992
+ )
993
+
994
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
995
+ if @api_client.config.debugging
996
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_sent_sms_by_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
997
+ end
998
+ return data, status_code, headers
999
+ end
1000
+
1001
+ # List SMS messages for a phone number
1002
+ # Get SMS messages for a phone number
1003
+ # @param phone_number_id [String]
1004
+ # @param [Hash] opts the optional parameters
1005
+ # @option opts [Integer] :page Optional page index in SMS list pagination (default to 0)
1006
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
1007
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1008
+ # @option opts [Boolean] :unread_only Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly (default to false)
1009
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
1010
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
1011
+ # @option opts [String] :search Optional search filter
1012
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
1013
+ # @return [PageSmsProjection]
1014
+ def get_sms_by_phone_number(phone_number_id, opts = {})
1015
+ data, _status_code, _headers = get_sms_by_phone_number_with_http_info(phone_number_id, opts)
1016
+ data
1017
+ end
1018
+
1019
+ # List SMS messages for a phone number
1020
+ # Get SMS messages for a phone number
1021
+ # @param phone_number_id [String]
1022
+ # @param [Hash] opts the optional parameters
1023
+ # @option opts [Integer] :page Optional page index in SMS list pagination
1024
+ # @option opts [Integer] :size Optional page size in SMS list pagination. Maximum size is 100. Use page index and sort to page through larger results
1025
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1026
+ # @option opts [Boolean] :unread_only Optional filter for unread SMS only. All SMS are considered unread until they are viewed in the dashboard or requested directly
1027
+ # @option opts [DateTime] :since Optional filter SMSs received after given date time
1028
+ # @option opts [DateTime] :before Optional filter SMSs received before given date time
1029
+ # @option opts [String] :search Optional search filter
1030
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only
1031
+ # @return [Array<(PageSmsProjection, Integer, Hash)>] PageSmsProjection data, response status code and response headers
1032
+ def get_sms_by_phone_number_with_http_info(phone_number_id, opts = {})
1033
+ if @api_client.config.debugging
1034
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.get_sms_by_phone_number ...'
1035
+ end
1036
+ # verify the required parameter 'phone_number_id' is set
1037
+ if @api_client.config.client_side_validation && phone_number_id.nil?
1038
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.get_sms_by_phone_number"
1039
+ end
1040
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
1041
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling PhoneControllerApi.get_sms_by_phone_number, must be smaller than or equal to 100.'
1042
+ end
1043
+
1044
+ allowable_values = ["ASC", "DESC"]
1045
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1046
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1047
+ end
1048
+ # resource path
1049
+ local_var_path = '/phone/numbers/{phoneNumberId}/sms'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
1050
+
1051
+ # query parameters
1052
+ query_params = opts[:query_params] || {}
1053
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1054
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1055
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1056
+ query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
1057
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1058
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1059
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
1060
+ query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
1061
+
1062
+ # header parameters
1063
+ header_params = opts[:header_params] || {}
1064
+ # HTTP header 'Accept' (if needed)
1065
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1066
+
1067
+ # form parameters
1068
+ form_params = opts[:form_params] || {}
1069
+
1070
+ # http body (model)
1071
+ post_body = opts[:body]
1072
+
1073
+ # return_type
1074
+ return_type = opts[:return_type] || 'PageSmsProjection'
1075
+
1076
+ # auth_names
1077
+ auth_names = opts[:auth_names] || ['API_KEY']
1078
+
1079
+ new_options = opts.merge(
1080
+ :header_params => header_params,
1081
+ :query_params => query_params,
1082
+ :form_params => form_params,
1083
+ :body => post_body,
1084
+ :auth_names => auth_names,
1085
+ :return_type => return_type
1086
+ )
1087
+
1088
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1089
+ if @api_client.config.debugging
1090
+ @api_client.config.logger.debug "API called: PhoneControllerApi#get_sms_by_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1091
+ end
1092
+ return data, status_code, headers
1093
+ end
1094
+
1095
+ # Send TXT message from a phone number
1096
+ # Send SMS from a phone number
1097
+ # @param phone_number_id [String]
1098
+ # @param sms_send_options [SmsSendOptions]
1099
+ # @param [Hash] opts the optional parameters
1100
+ # @return [SentSmsDto]
1101
+ def send_sms_from_phone_number(phone_number_id, sms_send_options, opts = {})
1102
+ data, _status_code, _headers = send_sms_from_phone_number_with_http_info(phone_number_id, sms_send_options, opts)
1103
+ data
1104
+ end
1105
+
1106
+ # Send TXT message from a phone number
1107
+ # Send SMS from a phone number
1108
+ # @param phone_number_id [String]
1109
+ # @param sms_send_options [SmsSendOptions]
1110
+ # @param [Hash] opts the optional parameters
1111
+ # @return [Array<(SentSmsDto, Integer, Hash)>] SentSmsDto data, response status code and response headers
1112
+ def send_sms_from_phone_number_with_http_info(phone_number_id, sms_send_options, opts = {})
1113
+ if @api_client.config.debugging
1114
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.send_sms_from_phone_number ...'
1115
+ end
1116
+ # verify the required parameter 'phone_number_id' is set
1117
+ if @api_client.config.client_side_validation && phone_number_id.nil?
1118
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.send_sms_from_phone_number"
1119
+ end
1120
+ # verify the required parameter 'sms_send_options' is set
1121
+ if @api_client.config.client_side_validation && sms_send_options.nil?
1122
+ fail ArgumentError, "Missing the required parameter 'sms_send_options' when calling PhoneControllerApi.send_sms_from_phone_number"
1123
+ end
1124
+ # resource path
1125
+ local_var_path = '/phone/numbers/{phoneNumberId}/sms'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
1126
+
1127
+ # query parameters
1128
+ query_params = opts[:query_params] || {}
1129
+
1130
+ # header parameters
1131
+ header_params = opts[:header_params] || {}
1132
+ # HTTP header 'Accept' (if needed)
1133
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1134
+ # HTTP header 'Content-Type'
1135
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1136
+
1137
+ # form parameters
1138
+ form_params = opts[:form_params] || {}
1139
+
1140
+ # http body (model)
1141
+ post_body = opts[:body] || @api_client.object_to_http_body(sms_send_options)
1142
+
1143
+ # return_type
1144
+ return_type = opts[:return_type] || 'SentSmsDto'
1145
+
1146
+ # auth_names
1147
+ auth_names = opts[:auth_names] || ['API_KEY']
1148
+
1149
+ new_options = opts.merge(
1150
+ :header_params => header_params,
1151
+ :query_params => query_params,
1152
+ :form_params => form_params,
1153
+ :body => post_body,
1154
+ :auth_names => auth_names,
1155
+ :return_type => return_type
1156
+ )
1157
+
1158
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1159
+ if @api_client.config.debugging
1160
+ @api_client.config.logger.debug "API called: PhoneControllerApi#send_sms_from_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1161
+ end
1162
+ return data, status_code, headers
1163
+ end
1164
+
1165
+ # Set consent status
1166
+ # Give or revoke consent for phone usage
1167
+ # @param agree [Boolean]
1168
+ # @param [Hash] opts the optional parameters
1169
+ # @return [ConsentStatusDto]
1170
+ def set_consent_status(agree, opts = {})
1171
+ data, _status_code, _headers = set_consent_status_with_http_info(agree, opts)
1172
+ data
1173
+ end
1174
+
1175
+ # Set consent status
1176
+ # Give or revoke consent for phone usage
1177
+ # @param agree [Boolean]
1178
+ # @param [Hash] opts the optional parameters
1179
+ # @return [Array<(ConsentStatusDto, Integer, Hash)>] ConsentStatusDto data, response status code and response headers
1180
+ def set_consent_status_with_http_info(agree, opts = {})
1181
+ if @api_client.config.debugging
1182
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.set_consent_status ...'
1183
+ end
1184
+ # verify the required parameter 'agree' is set
1185
+ if @api_client.config.client_side_validation && agree.nil?
1186
+ fail ArgumentError, "Missing the required parameter 'agree' when calling PhoneControllerApi.set_consent_status"
1187
+ end
1188
+ # resource path
1189
+ local_var_path = '/phone/consent'
1190
+
1191
+ # query parameters
1192
+ query_params = opts[:query_params] || {}
1193
+ query_params[:'agree'] = agree
1194
+
1195
+ # header parameters
1196
+ header_params = opts[:header_params] || {}
1197
+ # HTTP header 'Accept' (if needed)
1198
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1199
+
1200
+ # form parameters
1201
+ form_params = opts[:form_params] || {}
1202
+
1203
+ # http body (model)
1204
+ post_body = opts[:body]
1205
+
1206
+ # return_type
1207
+ return_type = opts[:return_type] || 'ConsentStatusDto'
1208
+
1209
+ # auth_names
1210
+ auth_names = opts[:auth_names] || ['API_KEY']
1211
+
1212
+ new_options = opts.merge(
1213
+ :header_params => header_params,
1214
+ :query_params => query_params,
1215
+ :form_params => form_params,
1216
+ :body => post_body,
1217
+ :auth_names => auth_names,
1218
+ :return_type => return_type
1219
+ )
1220
+
1221
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1222
+ if @api_client.config.debugging
1223
+ @api_client.config.logger.debug "API called: PhoneControllerApi#set_consent_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1224
+ end
1225
+ return data, status_code, headers
1226
+ end
1227
+
1228
+ # Set phone favourited state
1229
+ # Set and return new favorite state for a phone
1230
+ # @param phone_number_id [String] ID of phone to set favourite state
1231
+ # @param set_phone_favourited_options [SetPhoneFavouritedOptions]
1232
+ # @param [Hash] opts the optional parameters
1233
+ # @return [PhoneNumberDto]
1234
+ def set_phone_favourited(phone_number_id, set_phone_favourited_options, opts = {})
1235
+ data, _status_code, _headers = set_phone_favourited_with_http_info(phone_number_id, set_phone_favourited_options, opts)
1236
+ data
1237
+ end
1238
+
1239
+ # Set phone favourited state
1240
+ # Set and return new favorite state for a phone
1241
+ # @param phone_number_id [String] ID of phone to set favourite state
1242
+ # @param set_phone_favourited_options [SetPhoneFavouritedOptions]
1243
+ # @param [Hash] opts the optional parameters
1244
+ # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
1245
+ def set_phone_favourited_with_http_info(phone_number_id, set_phone_favourited_options, opts = {})
1246
+ if @api_client.config.debugging
1247
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.set_phone_favourited ...'
1248
+ end
1249
+ # verify the required parameter 'phone_number_id' is set
1250
+ if @api_client.config.client_side_validation && phone_number_id.nil?
1251
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.set_phone_favourited"
1252
+ end
1253
+ # verify the required parameter 'set_phone_favourited_options' is set
1254
+ if @api_client.config.client_side_validation && set_phone_favourited_options.nil?
1255
+ fail ArgumentError, "Missing the required parameter 'set_phone_favourited_options' when calling PhoneControllerApi.set_phone_favourited"
1256
+ end
1257
+ # resource path
1258
+ local_var_path = '/phone/numbers/{phoneNumberId}/favourite'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
1259
+
1260
+ # query parameters
1261
+ query_params = opts[:query_params] || {}
1262
+
1263
+ # header parameters
1264
+ header_params = opts[:header_params] || {}
1265
+ # HTTP header 'Accept' (if needed)
1266
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1267
+ # HTTP header 'Content-Type'
1268
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1269
+
1270
+ # form parameters
1271
+ form_params = opts[:form_params] || {}
1272
+
1273
+ # http body (model)
1274
+ post_body = opts[:body] || @api_client.object_to_http_body(set_phone_favourited_options)
1275
+
1276
+ # return_type
1277
+ return_type = opts[:return_type] || 'PhoneNumberDto'
1278
+
1279
+ # auth_names
1280
+ auth_names = opts[:auth_names] || ['API_KEY']
1281
+
1282
+ new_options = opts.merge(
1283
+ :header_params => header_params,
1284
+ :query_params => query_params,
1285
+ :form_params => form_params,
1286
+ :body => post_body,
1287
+ :auth_names => auth_names,
1288
+ :return_type => return_type
1289
+ )
1290
+
1291
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1292
+ if @api_client.config.debugging
1293
+ @api_client.config.logger.debug "API called: PhoneControllerApi#set_phone_favourited\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1294
+ end
1295
+ return data, status_code, headers
1296
+ end
1297
+
1298
+ # Test sending an SMS to a number
1299
+ # Test a phone number by sending an SMS to it
1300
+ # @param phone_number_id [String]
1301
+ # @param test_phone_number_options [TestPhoneNumberOptions]
1302
+ # @param [Hash] opts the optional parameters
1303
+ # @option opts [String] :x_test_id
1304
+ # @return [nil]
1305
+ def test_phone_number_send_sms(phone_number_id, test_phone_number_options, opts = {})
1306
+ test_phone_number_send_sms_with_http_info(phone_number_id, test_phone_number_options, opts)
1307
+ nil
1308
+ end
1309
+
1310
+ # Test sending an SMS to a number
1311
+ # Test a phone number by sending an SMS to it
1312
+ # @param phone_number_id [String]
1313
+ # @param test_phone_number_options [TestPhoneNumberOptions]
1314
+ # @param [Hash] opts the optional parameters
1315
+ # @option opts [String] :x_test_id
1316
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1317
+ def test_phone_number_send_sms_with_http_info(phone_number_id, test_phone_number_options, opts = {})
1318
+ if @api_client.config.debugging
1319
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.test_phone_number_send_sms ...'
1320
+ end
1321
+ # verify the required parameter 'phone_number_id' is set
1322
+ if @api_client.config.client_side_validation && phone_number_id.nil?
1323
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.test_phone_number_send_sms"
1324
+ end
1325
+ # verify the required parameter 'test_phone_number_options' is set
518
1326
  if @api_client.config.client_side_validation && test_phone_number_options.nil?
519
1327
  fail ArgumentError, "Missing the required parameter 'test_phone_number_options' when calling PhoneControllerApi.test_phone_number_send_sms"
520
1328
  end
@@ -557,5 +1365,139 @@ module MailSlurpClient
557
1365
  end
558
1366
  return data, status_code, headers
559
1367
  end
1368
+
1369
+ # Update a phone number
1370
+ # Set field for phone number
1371
+ # @param phone_number_id [String] ID of phone to set favourite state
1372
+ # @param update_phone_number_options [UpdatePhoneNumberOptions]
1373
+ # @param [Hash] opts the optional parameters
1374
+ # @return [PhoneNumberDto]
1375
+ def update_phone_number(phone_number_id, update_phone_number_options, opts = {})
1376
+ data, _status_code, _headers = update_phone_number_with_http_info(phone_number_id, update_phone_number_options, opts)
1377
+ data
1378
+ end
1379
+
1380
+ # Update a phone number
1381
+ # Set field for phone number
1382
+ # @param phone_number_id [String] ID of phone to set favourite state
1383
+ # @param update_phone_number_options [UpdatePhoneNumberOptions]
1384
+ # @param [Hash] opts the optional parameters
1385
+ # @return [Array<(PhoneNumberDto, Integer, Hash)>] PhoneNumberDto data, response status code and response headers
1386
+ def update_phone_number_with_http_info(phone_number_id, update_phone_number_options, opts = {})
1387
+ if @api_client.config.debugging
1388
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.update_phone_number ...'
1389
+ end
1390
+ # verify the required parameter 'phone_number_id' is set
1391
+ if @api_client.config.client_side_validation && phone_number_id.nil?
1392
+ fail ArgumentError, "Missing the required parameter 'phone_number_id' when calling PhoneControllerApi.update_phone_number"
1393
+ end
1394
+ # verify the required parameter 'update_phone_number_options' is set
1395
+ if @api_client.config.client_side_validation && update_phone_number_options.nil?
1396
+ fail ArgumentError, "Missing the required parameter 'update_phone_number_options' when calling PhoneControllerApi.update_phone_number"
1397
+ end
1398
+ # resource path
1399
+ local_var_path = '/phone/numbers/{phoneNumberId}'.sub('{' + 'phoneNumberId' + '}', CGI.escape(phone_number_id.to_s))
1400
+
1401
+ # query parameters
1402
+ query_params = opts[:query_params] || {}
1403
+
1404
+ # header parameters
1405
+ header_params = opts[:header_params] || {}
1406
+ # HTTP header 'Accept' (if needed)
1407
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1408
+ # HTTP header 'Content-Type'
1409
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1410
+
1411
+ # form parameters
1412
+ form_params = opts[:form_params] || {}
1413
+
1414
+ # http body (model)
1415
+ post_body = opts[:body] || @api_client.object_to_http_body(update_phone_number_options)
1416
+
1417
+ # return_type
1418
+ return_type = opts[:return_type] || 'PhoneNumberDto'
1419
+
1420
+ # auth_names
1421
+ auth_names = opts[:auth_names] || ['API_KEY']
1422
+
1423
+ new_options = opts.merge(
1424
+ :header_params => header_params,
1425
+ :query_params => query_params,
1426
+ :form_params => form_params,
1427
+ :body => post_body,
1428
+ :auth_names => auth_names,
1429
+ :return_type => return_type
1430
+ )
1431
+
1432
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1433
+ if @api_client.config.debugging
1434
+ @api_client.config.logger.debug "API called: PhoneControllerApi#update_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1435
+ end
1436
+ return data, status_code, headers
1437
+ end
1438
+
1439
+ # Verify validity of a phone number
1440
+ # Validate a phone number
1441
+ # @param validate_phone_number_options [ValidatePhoneNumberOptions]
1442
+ # @param [Hash] opts the optional parameters
1443
+ # @return [PhoneNumberValidationDto]
1444
+ def validate_phone_number(validate_phone_number_options, opts = {})
1445
+ data, _status_code, _headers = validate_phone_number_with_http_info(validate_phone_number_options, opts)
1446
+ data
1447
+ end
1448
+
1449
+ # Verify validity of a phone number
1450
+ # Validate a phone number
1451
+ # @param validate_phone_number_options [ValidatePhoneNumberOptions]
1452
+ # @param [Hash] opts the optional parameters
1453
+ # @return [Array<(PhoneNumberValidationDto, Integer, Hash)>] PhoneNumberValidationDto data, response status code and response headers
1454
+ def validate_phone_number_with_http_info(validate_phone_number_options, opts = {})
1455
+ if @api_client.config.debugging
1456
+ @api_client.config.logger.debug 'Calling API: PhoneControllerApi.validate_phone_number ...'
1457
+ end
1458
+ # verify the required parameter 'validate_phone_number_options' is set
1459
+ if @api_client.config.client_side_validation && validate_phone_number_options.nil?
1460
+ fail ArgumentError, "Missing the required parameter 'validate_phone_number_options' when calling PhoneControllerApi.validate_phone_number"
1461
+ end
1462
+ # resource path
1463
+ local_var_path = '/phone/validate'
1464
+
1465
+ # query parameters
1466
+ query_params = opts[:query_params] || {}
1467
+
1468
+ # header parameters
1469
+ header_params = opts[:header_params] || {}
1470
+ # HTTP header 'Accept' (if needed)
1471
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1472
+ # HTTP header 'Content-Type'
1473
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1474
+
1475
+ # form parameters
1476
+ form_params = opts[:form_params] || {}
1477
+
1478
+ # http body (model)
1479
+ post_body = opts[:body] || @api_client.object_to_http_body(validate_phone_number_options)
1480
+
1481
+ # return_type
1482
+ return_type = opts[:return_type] || 'PhoneNumberValidationDto'
1483
+
1484
+ # auth_names
1485
+ auth_names = opts[:auth_names] || ['API_KEY']
1486
+
1487
+ new_options = opts.merge(
1488
+ :header_params => header_params,
1489
+ :query_params => query_params,
1490
+ :form_params => form_params,
1491
+ :body => post_body,
1492
+ :auth_names => auth_names,
1493
+ :return_type => return_type
1494
+ )
1495
+
1496
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1497
+ if @api_client.config.debugging
1498
+ @api_client.config.logger.debug "API called: PhoneControllerApi#validate_phone_number\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1499
+ end
1500
+ return data, status_code, headers
1501
+ end
560
1502
  end
561
1503
  end