mailslurp_client 17.0.0 → 17.2.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 (169) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/lib/mailslurp_client/api/ai_controller_api.rb +318 -0
  4. data/lib/mailslurp_client/api/api_audit_log_controller_api.rb +237 -0
  5. data/lib/mailslurp_client/api/attachment_controller_api.rb +66 -0
  6. data/lib/mailslurp_client/api/bounce_controller_api.rb +126 -0
  7. data/lib/mailslurp_client/api/campaign_probe_controller_api.rb +664 -0
  8. data/lib/mailslurp_client/api/deliverability_test_controller_api.rb +1496 -0
  9. data/lib/mailslurp_client/api/device_previews_controller_api.rb +1012 -0
  10. data/lib/mailslurp_client/api/domain_controller_api.rb +63 -0
  11. data/lib/mailslurp_client/api/domain_monitor_controller_api.rb +848 -0
  12. data/lib/mailslurp_client/api/email_controller_api.rb +270 -138
  13. data/lib/mailslurp_client/api/inbox_controller_api.rb +144 -4
  14. data/lib/mailslurp_client/api/missed_sms_controller_api.rb +221 -0
  15. data/lib/mailslurp_client/api/phone_controller_api.rb +374 -3
  16. data/lib/mailslurp_client/api/sms_controller_api.rb +66 -0
  17. data/lib/mailslurp_client/api/user_controller_api.rb +170 -0
  18. data/lib/mailslurp_client/api/webhook_controller_api.rb +16 -0
  19. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +15 -15
  20. data/lib/mailslurp_client/models/ai_mapping_match_option.rb +308 -0
  21. data/lib/mailslurp_client/models/ai_mapping_match_options.rb +211 -0
  22. data/lib/mailslurp_client/models/ai_transform_mapping_dto.rb +11 -1
  23. data/lib/mailslurp_client/models/ai_transform_mapping_match_result.rb +211 -0
  24. data/lib/mailslurp_client/models/ai_transform_mapping_projection.rb +15 -15
  25. data/lib/mailslurp_client/models/ai_transform_result_dto.rb +47 -21
  26. data/lib/mailslurp_client/models/ai_transform_result_projection_dto.rb +31 -1
  27. data/lib/mailslurp_client/models/alias_projection.rb +29 -29
  28. data/lib/mailslurp_client/models/alias_thread_projection.rb +26 -26
  29. data/lib/mailslurp_client/models/attachment_projection.rb +25 -25
  30. data/lib/mailslurp_client/models/audit_log_event_dto.rb +343 -0
  31. data/lib/mailslurp_client/models/audit_log_page_dto.rb +222 -0
  32. data/lib/mailslurp_client/models/audit_log_search_options.rb +323 -0
  33. data/lib/mailslurp_client/models/bounce_projection.rb +22 -22
  34. data/lib/mailslurp_client/models/campaign_probe_dto.rb +411 -0
  35. data/lib/mailslurp_client/models/campaign_probe_insights_dto.rb +408 -0
  36. data/lib/mailslurp_client/models/campaign_probe_run_dto.rb +644 -0
  37. data/lib/mailslurp_client/models/campaign_probe_run_due_result.rb +315 -0
  38. data/lib/mailslurp_client/models/{create_o_auth_exchange_result.rb → campaign_probe_run_now_result.rb} +24 -28
  39. data/lib/mailslurp_client/models/campaign_probe_series_dto.rb +303 -0
  40. data/lib/mailslurp_client/models/campaign_probe_series_point_dto.rb +295 -0
  41. data/lib/mailslurp_client/models/{create_o_auth_connection_result.rb → cancel_device_preview_run_options.rb} +10 -15
  42. data/lib/mailslurp_client/models/cancel_device_preview_run_result.rb +248 -0
  43. data/lib/mailslurp_client/models/code_candidate.rb +303 -0
  44. data/lib/mailslurp_client/models/conditional_structured_content_result.rb +13 -4
  45. data/lib/mailslurp_client/models/connector_event_projection.rb +15 -15
  46. data/lib/mailslurp_client/models/connector_projection.rb +19 -19
  47. data/lib/mailslurp_client/models/create_ai_transformer_mapping_options.rb +15 -5
  48. data/lib/mailslurp_client/models/create_campaign_probe_options.rb +290 -0
  49. data/lib/mailslurp_client/models/create_campaign_probe_run_options.rb +264 -0
  50. data/lib/mailslurp_client/models/create_deliverability_simulation_job_options.rb +345 -0
  51. data/lib/mailslurp_client/models/create_deliverability_test_options.rb +372 -0
  52. data/lib/mailslurp_client/models/create_device_preview_feedback_options.rb +405 -0
  53. data/lib/mailslurp_client/models/create_device_preview_options.rb +241 -0
  54. data/lib/mailslurp_client/models/create_device_preview_run_result.rb +225 -0
  55. data/lib/mailslurp_client/models/create_domain_monitor_alert_sink_options.rb +308 -0
  56. data/lib/mailslurp_client/models/create_domain_monitor_options.rb +299 -0
  57. data/lib/mailslurp_client/models/create_emergency_address_options.rb +2 -2
  58. data/lib/mailslurp_client/models/create_inbox_retention_policy_for_account_options.rb +239 -0
  59. data/lib/mailslurp_client/models/create_phone_number_options.rb +36 -6
  60. data/lib/mailslurp_client/models/delete_device_preview_run_result.rb +253 -0
  61. data/lib/mailslurp_client/models/delete_result.rb +245 -0
  62. data/lib/mailslurp_client/models/deliverability_analytics_run_dto.rb +426 -0
  63. data/lib/mailslurp_client/models/deliverability_analytics_series_dto.rb +342 -0
  64. data/lib/mailslurp_client/models/deliverability_analytics_series_point_dto.rb +240 -0
  65. data/lib/mailslurp_client/models/deliverability_analytics_summary_dto.rb +380 -0
  66. data/lib/mailslurp_client/models/deliverability_entity_result_dto.rb +360 -0
  67. data/lib/mailslurp_client/models/deliverability_entity_result_page_dto.rb +318 -0
  68. data/lib/mailslurp_client/models/deliverability_expectation.rb +276 -0
  69. data/lib/mailslurp_client/models/deliverability_expectation_result_dto.rb +294 -0
  70. data/lib/mailslurp_client/models/deliverability_failure_entity_hotspot_dto.rb +360 -0
  71. data/lib/mailslurp_client/models/deliverability_failure_hotspots_dto.rb +302 -0
  72. data/lib/mailslurp_client/models/deliverability_failure_phone_dimension_hotspot_dto.rb +306 -0
  73. data/lib/mailslurp_client/models/deliverability_poll_status_result_dto.rb +250 -0
  74. data/lib/mailslurp_client/models/deliverability_selector_options.rb +307 -0
  75. data/lib/mailslurp_client/models/deliverability_simulation_email_options.rb +231 -0
  76. data/lib/mailslurp_client/models/deliverability_simulation_job_config_dto.rb +300 -0
  77. data/lib/mailslurp_client/models/deliverability_simulation_job_dto.rb +494 -0
  78. data/lib/mailslurp_client/models/deliverability_simulation_job_error_summary_dto.rb +224 -0
  79. data/lib/mailslurp_client/models/deliverability_simulation_job_event_dto.rb +344 -0
  80. data/lib/mailslurp_client/models/deliverability_simulation_job_event_page_dto.rb +284 -0
  81. data/lib/mailslurp_client/models/deliverability_simulation_job_top_error_dto.rb +226 -0
  82. data/lib/mailslurp_client/models/deliverability_simulation_sms_options.rb +209 -0
  83. data/lib/mailslurp_client/models/deliverability_test_dto.rb +558 -0
  84. data/lib/mailslurp_client/models/deliverability_test_page_dto.rb +270 -0
  85. data/lib/mailslurp_client/models/device_preview_feedback_dto.rb +456 -0
  86. data/lib/mailslurp_client/models/device_preview_feedback_list_dto.rb +255 -0
  87. data/lib/mailslurp_client/models/device_preview_provider_progress_dto.rb +387 -0
  88. data/lib/mailslurp_client/models/device_preview_run_dto.rb +382 -0
  89. data/lib/mailslurp_client/models/device_preview_run_results_dto.rb +243 -0
  90. data/lib/mailslurp_client/models/device_preview_screenshot_dto.rb +389 -0
  91. data/lib/mailslurp_client/models/device_preview_target_dto.rb +368 -0
  92. data/lib/mailslurp_client/models/domain_monitor_alert_sink_dto.rb +369 -0
  93. data/lib/mailslurp_client/models/domain_monitor_dto.rb +383 -0
  94. data/lib/mailslurp_client/models/domain_monitor_insights_dto.rb +422 -0
  95. data/lib/mailslurp_client/models/domain_monitor_run_dto.rb +492 -0
  96. data/lib/mailslurp_client/models/domain_monitor_run_due_result.rb +287 -0
  97. data/lib/mailslurp_client/models/domain_monitor_run_now_result.rb +225 -0
  98. data/lib/mailslurp_client/models/domain_monitor_series_dto.rb +303 -0
  99. data/lib/mailslurp_client/models/domain_monitor_series_point_dto.rb +309 -0
  100. data/lib/mailslurp_client/models/domain_region_group.rb +261 -0
  101. data/lib/mailslurp_client/models/domain_region_groups_dto.rb +214 -0
  102. data/lib/mailslurp_client/models/domain_region_information.rb +338 -0
  103. data/lib/mailslurp_client/models/email.rb +13 -13
  104. data/lib/mailslurp_client/models/email_projection.rb +66 -56
  105. data/lib/mailslurp_client/models/email_signature.rb +254 -0
  106. data/lib/mailslurp_client/models/email_signature_parse_result.rb +223 -0
  107. data/lib/mailslurp_client/models/email_thread_projection.rb +38 -38
  108. data/lib/mailslurp_client/models/emergency_address.rb +2 -2
  109. data/lib/mailslurp_client/models/emergency_address_dto.rb +2 -2
  110. data/lib/mailslurp_client/models/entity_automation_item_projection.rb +10 -10
  111. data/lib/mailslurp_client/models/entity_event_item_projection.rb +13 -13
  112. data/lib/mailslurp_client/models/export_transformer_options.rb +395 -0
  113. data/lib/mailslurp_client/models/export_transformer_response.rb +259 -0
  114. data/lib/mailslurp_client/models/export_transformer_result_job_dto.rb +331 -0
  115. data/lib/mailslurp_client/models/extract_attachment_text_options.rb +268 -0
  116. data/lib/mailslurp_client/models/extract_attachment_text_result.rb +297 -0
  117. data/lib/mailslurp_client/models/extract_codes_options.rb +304 -0
  118. data/lib/mailslurp_client/models/extract_codes_result.rb +303 -0
  119. data/lib/mailslurp_client/models/guest_portal_user_projection.rb +24 -24
  120. data/lib/mailslurp_client/models/inbox_dto.rb +2 -2
  121. data/lib/mailslurp_client/models/inbox_preview.rb +2 -2
  122. data/lib/mailslurp_client/models/inbox_replier_event_projection.rb +13 -13
  123. data/lib/mailslurp_client/models/inbox_retention_policy_dto.rb +262 -0
  124. data/lib/mailslurp_client/models/inbox_retention_policy_optional_dto.rb +206 -0
  125. data/lib/mailslurp_client/models/invoke_transformer_options.rb +22 -4
  126. data/lib/mailslurp_client/models/list_unsubscribe_recipient_projection.rb +10 -10
  127. data/lib/mailslurp_client/models/missed_email_projection.rb +11 -11
  128. data/lib/mailslurp_client/models/missed_sms_dto.rb +320 -0
  129. data/lib/mailslurp_client/models/missed_sms_projection.rb +282 -0
  130. data/lib/mailslurp_client/models/opt_in_identity_projection.rb +18 -18
  131. data/lib/mailslurp_client/models/organization_inbox_projection.rb +2 -2
  132. data/lib/mailslurp_client/models/page_ai_transform_result_projection.rb +17 -1
  133. data/lib/mailslurp_client/models/page_device_preview_run_projection.rb +309 -0
  134. data/lib/mailslurp_client/models/page_missed_sms_projection.rb +309 -0
  135. data/lib/mailslurp_client/models/page_phone_number_release_projection.rb +309 -0
  136. data/lib/mailslurp_client/models/page_table_data.rb +243 -0
  137. data/lib/mailslurp_client/models/pageable_object.rb +16 -16
  138. data/lib/mailslurp_client/models/pagination.rb +225 -0
  139. data/lib/mailslurp_client/models/phone_message_thread_item_projection.rb +25 -11
  140. data/lib/mailslurp_client/models/phone_message_thread_projection.rb +27 -27
  141. data/lib/mailslurp_client/models/phone_number_dto.rb +27 -6
  142. data/lib/mailslurp_client/models/phone_number_projection.rb +17 -17
  143. data/lib/mailslurp_client/models/phone_number_release_projection.rb +348 -0
  144. data/lib/mailslurp_client/models/phone_plan_availability.rb +42 -4
  145. data/lib/mailslurp_client/models/phone_plan_availability_item.rb +17 -6
  146. data/lib/mailslurp_client/models/phone_plan_dto.rb +2 -2
  147. data/lib/mailslurp_client/models/phone_summary_country_dto.rb +273 -0
  148. data/lib/mailslurp_client/models/phone_summary_dto.rb +271 -0
  149. data/lib/mailslurp_client/models/plan_summary_dto.rb +266 -0
  150. data/lib/mailslurp_client/models/plus_address_projection.rb +15 -15
  151. data/lib/mailslurp_client/models/search_inboxes_options.rb +1 -1
  152. data/lib/mailslurp_client/models/sent_email_projection.rb +67 -67
  153. data/lib/mailslurp_client/models/sort_object.rb +13 -13
  154. data/lib/mailslurp_client/models/template_projection.rb +15 -15
  155. data/lib/mailslurp_client/models/tenant_reputation_finding_dto.rb +322 -0
  156. data/lib/mailslurp_client/models/tenant_reputation_findings_dto.rb +241 -0
  157. data/lib/mailslurp_client/models/tenant_reputation_status_row_dto.rb +372 -0
  158. data/lib/mailslurp_client/models/tenant_reputation_status_summary_dto.rb +241 -0
  159. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +10 -10
  160. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +10 -10
  161. data/lib/mailslurp_client/models/update_campaign_probe_options.rb +290 -0
  162. data/lib/mailslurp_client/models/update_deliverability_test_options.rb +327 -0
  163. data/lib/mailslurp_client/models/update_device_preview_feedback_options.rb +314 -0
  164. data/lib/mailslurp_client/models/update_domain_monitor_options.rb +266 -0
  165. data/lib/mailslurp_client/models/webhook_projection.rb +21 -21
  166. data/lib/mailslurp_client/version.rb +1 -1
  167. data/lib/mailslurp_client.rb +105 -3
  168. metadata +107 -5
  169. data/lib/mailslurp_client/api/o_auth_connection_api.rb +0 -170
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 7efea0f0fed208677397550ab51c2190593e86600b3dd44ead4a04525285d50b
4
- data.tar.gz: 671967e5dab48040ef9692a58308916319a38a3761722a4be5c177ab9657cc54
3
+ metadata.gz: 420aa7c6b2b976ac6856aae33e3c1e40d30b32f42612a5198e89ed2467c0beec
4
+ data.tar.gz: fe12cd04f6055bfbdecc98c83142d8bf6c13506200fce04b10ea14fbcb692b61
5
5
  SHA512:
6
- metadata.gz: 81bffcbfaea650d9c9e62f7af40f5e73f68a3230d4eda2e23eff8d6728d169111f531e779aeaf9f3256bdd6526bdf0ab89c0c32510faa3d4493a3d8b34ea8752
7
- data.tar.gz: 97d1bfc227445f10eccb4c21436a2e2d0fc0b3246a691d61f0ec599ae6885d4b4225aaa4b036782c7395598bc7fbc1e0cd0f11f1ce239ec2da84c03d47a5ac34
6
+ metadata.gz: 277c2ceb738ef6a049061d64ceedff9dcb815a69b20775b4acc1312a8e6632d50f6ed41a528c4e9e19bf7df8ab703cba70e35432b41d0b810130f4dc08d23da5
7
+ data.tar.gz: 78791f3a6a24b92e3d66b7bbd04d14f9a854663f14f29f6eebd73be33e0b2602cc0d5cada55aa0fb51e7b7e3046389cf83053b196f410f5d69b7165081c3eb11
data/LICENSE CHANGED
@@ -1,4 +1,4 @@
1
- Copyright 2025 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
1
+ Copyright 2026 MailSlurp Email API (Provided by Pettman OÜ, Estonia)
2
2
 
3
3
  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4
4
 
@@ -375,6 +375,70 @@ module MailSlurpClient
375
375
  return data, status_code, headers
376
376
  end
377
377
 
378
+ # Export transformer results
379
+ # Export AI transformer results in formats such as Excel, CSV, XML etc.
380
+ # @param export_transformer_options [ExportTransformerOptions]
381
+ # @param [Hash] opts the optional parameters
382
+ # @return [ExportTransformerResponse]
383
+ def export_transformer_results(export_transformer_options, opts = {})
384
+ data, _status_code, _headers = export_transformer_results_with_http_info(export_transformer_options, opts)
385
+ data
386
+ end
387
+
388
+ # Export transformer results
389
+ # Export AI transformer results in formats such as Excel, CSV, XML etc.
390
+ # @param export_transformer_options [ExportTransformerOptions]
391
+ # @param [Hash] opts the optional parameters
392
+ # @return [Array<(ExportTransformerResponse, Integer, Hash)>] ExportTransformerResponse data, response status code and response headers
393
+ def export_transformer_results_with_http_info(export_transformer_options, opts = {})
394
+ if @api_client.config.debugging
395
+ @api_client.config.logger.debug 'Calling API: AIControllerApi.export_transformer_results ...'
396
+ end
397
+ # verify the required parameter 'export_transformer_options' is set
398
+ if @api_client.config.client_side_validation && export_transformer_options.nil?
399
+ fail ArgumentError, "Missing the required parameter 'export_transformer_options' when calling AIControllerApi.export_transformer_results"
400
+ end
401
+ # resource path
402
+ local_var_path = '/ai/transformer/results/export'
403
+
404
+ # query parameters
405
+ query_params = opts[:query_params] || {}
406
+
407
+ # header parameters
408
+ header_params = opts[:header_params] || {}
409
+ # HTTP header 'Accept' (if needed)
410
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
411
+ # HTTP header 'Content-Type'
412
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
413
+
414
+ # form parameters
415
+ form_params = opts[:form_params] || {}
416
+
417
+ # http body (model)
418
+ post_body = opts[:body] || @api_client.object_to_http_body(export_transformer_options)
419
+
420
+ # return_type
421
+ return_type = opts[:return_type] || 'ExportTransformerResponse'
422
+
423
+ # auth_names
424
+ auth_names = opts[:auth_names] || ['API_KEY']
425
+
426
+ new_options = opts.merge(
427
+ :header_params => header_params,
428
+ :query_params => query_params,
429
+ :form_params => form_params,
430
+ :body => post_body,
431
+ :auth_names => auth_names,
432
+ :return_type => return_type
433
+ )
434
+
435
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
436
+ if @api_client.config.debugging
437
+ @api_client.config.logger.debug "API called: AIControllerApi#export_transformer_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
438
+ end
439
+ return data, status_code, headers
440
+ end
441
+
378
442
  # Generate structured content for an attachment
379
443
  # Use output schemas to extract data from an attachment using AI
380
444
  # @param generate_structured_content_attachment_options [GenerateStructuredContentAttachmentOptions]
@@ -567,6 +631,68 @@ module MailSlurpClient
567
631
  return data, status_code, headers
568
632
  end
569
633
 
634
+ # Get export transformer results job
635
+ # Get the job status for an export
636
+ # @param id [String]
637
+ # @param [Hash] opts the optional parameters
638
+ # @return [ExportTransformerResultJobDto]
639
+ def get_export_transformer_results_job(id, opts = {})
640
+ data, _status_code, _headers = get_export_transformer_results_job_with_http_info(id, opts)
641
+ data
642
+ end
643
+
644
+ # Get export transformer results job
645
+ # Get the job status for an export
646
+ # @param id [String]
647
+ # @param [Hash] opts the optional parameters
648
+ # @return [Array<(ExportTransformerResultJobDto, Integer, Hash)>] ExportTransformerResultJobDto data, response status code and response headers
649
+ def get_export_transformer_results_job_with_http_info(id, opts = {})
650
+ if @api_client.config.debugging
651
+ @api_client.config.logger.debug 'Calling API: AIControllerApi.get_export_transformer_results_job ...'
652
+ end
653
+ # verify the required parameter 'id' is set
654
+ if @api_client.config.client_side_validation && id.nil?
655
+ fail ArgumentError, "Missing the required parameter 'id' when calling AIControllerApi.get_export_transformer_results_job"
656
+ end
657
+ # resource path
658
+ local_var_path = '/ai/transformer/results/export/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
659
+
660
+ # query parameters
661
+ query_params = opts[:query_params] || {}
662
+
663
+ # header parameters
664
+ header_params = opts[:header_params] || {}
665
+ # HTTP header 'Accept' (if needed)
666
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
667
+
668
+ # form parameters
669
+ form_params = opts[:form_params] || {}
670
+
671
+ # http body (model)
672
+ post_body = opts[:body]
673
+
674
+ # return_type
675
+ return_type = opts[:return_type] || 'ExportTransformerResultJobDto'
676
+
677
+ # auth_names
678
+ auth_names = opts[:auth_names] || ['API_KEY']
679
+
680
+ new_options = opts.merge(
681
+ :header_params => header_params,
682
+ :query_params => query_params,
683
+ :form_params => form_params,
684
+ :body => post_body,
685
+ :auth_names => auth_names,
686
+ :return_type => return_type
687
+ )
688
+
689
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
690
+ if @api_client.config.debugging
691
+ @api_client.config.logger.debug "API called: AIControllerApi#get_export_transformer_results_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
692
+ end
693
+ return data, status_code, headers
694
+ end
695
+
570
696
  # Get a transformer
571
697
  # Get AI transformer and schemas by ID
572
698
  # @param id [String]
@@ -842,6 +968,9 @@ module MailSlurpClient
842
968
  # Get transformer results
843
969
  # Get AI transformer results
844
970
  # @param [Hash] opts the optional parameters
971
+ # @option opts [String] :email_id
972
+ # @option opts [String] :sms_id
973
+ # @option opts [String] :attachment_id
845
974
  # @option opts [String] :ai_transform_id
846
975
  # @option opts [String] :ai_transform_mapping_id
847
976
  # @option opts [String] :entity_id
@@ -858,6 +987,9 @@ module MailSlurpClient
858
987
  # Get transformer results
859
988
  # Get AI transformer results
860
989
  # @param [Hash] opts the optional parameters
990
+ # @option opts [String] :email_id
991
+ # @option opts [String] :sms_id
992
+ # @option opts [String] :attachment_id
861
993
  # @option opts [String] :ai_transform_id
862
994
  # @option opts [String] :ai_transform_mapping_id
863
995
  # @option opts [String] :entity_id
@@ -887,6 +1019,9 @@ module MailSlurpClient
887
1019
 
888
1020
  # query parameters
889
1021
  query_params = opts[:query_params] || {}
1022
+ query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
1023
+ query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
1024
+ query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
890
1025
  query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
891
1026
  query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
892
1027
  query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
@@ -928,6 +1063,118 @@ module MailSlurpClient
928
1063
  return data, status_code, headers
929
1064
  end
930
1065
 
1066
+ # Get transformer results table
1067
+ # Get AI transformer results in table format
1068
+ # @param include_meta_data [Boolean]
1069
+ # @param flatten_arrays_to_rows [Boolean]
1070
+ # @param [Hash] opts the optional parameters
1071
+ # @option opts [String] :email_id
1072
+ # @option opts [String] :sms_id
1073
+ # @option opts [String] :attachment_id
1074
+ # @option opts [String] :ai_transform_id
1075
+ # @option opts [String] :ai_transform_mapping_id
1076
+ # @option opts [String] :entity_id
1077
+ # @option opts [String] :entity_type
1078
+ # @option opts [Integer] :page (default to 0)
1079
+ # @option opts [Integer] :size Optional page size. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
1080
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1081
+ # @return [PageTableData]
1082
+ def get_transformer_results_table(include_meta_data, flatten_arrays_to_rows, opts = {})
1083
+ data, _status_code, _headers = get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts)
1084
+ data
1085
+ end
1086
+
1087
+ # Get transformer results table
1088
+ # Get AI transformer results in table format
1089
+ # @param include_meta_data [Boolean]
1090
+ # @param flatten_arrays_to_rows [Boolean]
1091
+ # @param [Hash] opts the optional parameters
1092
+ # @option opts [String] :email_id
1093
+ # @option opts [String] :sms_id
1094
+ # @option opts [String] :attachment_id
1095
+ # @option opts [String] :ai_transform_id
1096
+ # @option opts [String] :ai_transform_mapping_id
1097
+ # @option opts [String] :entity_id
1098
+ # @option opts [String] :entity_type
1099
+ # @option opts [Integer] :page
1100
+ # @option opts [Integer] :size Optional page size. Maximum size is 100. Use page index and sort to page through larger results
1101
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1102
+ # @return [Array<(PageTableData, Integer, Hash)>] PageTableData data, response status code and response headers
1103
+ def get_transformer_results_table_with_http_info(include_meta_data, flatten_arrays_to_rows, opts = {})
1104
+ if @api_client.config.debugging
1105
+ @api_client.config.logger.debug 'Calling API: AIControllerApi.get_transformer_results_table ...'
1106
+ end
1107
+ # verify the required parameter 'include_meta_data' is set
1108
+ if @api_client.config.client_side_validation && include_meta_data.nil?
1109
+ fail ArgumentError, "Missing the required parameter 'include_meta_data' when calling AIControllerApi.get_transformer_results_table"
1110
+ end
1111
+ # verify the required parameter 'flatten_arrays_to_rows' is set
1112
+ if @api_client.config.client_side_validation && flatten_arrays_to_rows.nil?
1113
+ fail ArgumentError, "Missing the required parameter 'flatten_arrays_to_rows' when calling AIControllerApi.get_transformer_results_table"
1114
+ end
1115
+ allowable_values = ["INBOX", "PHONE"]
1116
+ if @api_client.config.client_side_validation && opts[:'entity_type'] && !allowable_values.include?(opts[:'entity_type'])
1117
+ fail ArgumentError, "invalid value for \"entity_type\", must be one of #{allowable_values}"
1118
+ end
1119
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
1120
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling AIControllerApi.get_transformer_results_table, must be smaller than or equal to 100.'
1121
+ end
1122
+
1123
+ allowable_values = ["ASC", "DESC"]
1124
+ if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1125
+ fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
1126
+ end
1127
+ # resource path
1128
+ local_var_path = '/ai/transformer/results/table'
1129
+
1130
+ # query parameters
1131
+ query_params = opts[:query_params] || {}
1132
+ query_params[:'includeMetaData'] = include_meta_data
1133
+ query_params[:'flattenArraysToRows'] = flatten_arrays_to_rows
1134
+ query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
1135
+ query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
1136
+ query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
1137
+ query_params[:'aiTransformId'] = opts[:'ai_transform_id'] if !opts[:'ai_transform_id'].nil?
1138
+ query_params[:'aiTransformMappingId'] = opts[:'ai_transform_mapping_id'] if !opts[:'ai_transform_mapping_id'].nil?
1139
+ query_params[:'entityId'] = opts[:'entity_id'] if !opts[:'entity_id'].nil?
1140
+ query_params[:'entityType'] = opts[:'entity_type'] if !opts[:'entity_type'].nil?
1141
+ query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1142
+ query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1143
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1144
+
1145
+ # header parameters
1146
+ header_params = opts[:header_params] || {}
1147
+ # HTTP header 'Accept' (if needed)
1148
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1149
+
1150
+ # form parameters
1151
+ form_params = opts[:form_params] || {}
1152
+
1153
+ # http body (model)
1154
+ post_body = opts[:body]
1155
+
1156
+ # return_type
1157
+ return_type = opts[:return_type] || 'PageTableData'
1158
+
1159
+ # auth_names
1160
+ auth_names = opts[:auth_names] || ['API_KEY']
1161
+
1162
+ new_options = opts.merge(
1163
+ :header_params => header_params,
1164
+ :query_params => query_params,
1165
+ :form_params => form_params,
1166
+ :body => post_body,
1167
+ :auth_names => auth_names,
1168
+ :return_type => return_type
1169
+ )
1170
+
1171
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1172
+ if @api_client.config.debugging
1173
+ @api_client.config.logger.debug "API called: AIControllerApi#get_transformer_results_table\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1174
+ end
1175
+ return data, status_code, headers
1176
+ end
1177
+
931
1178
  # List transformers
932
1179
  # List all AI transforms
933
1180
  # @param [Hash] opts the optional parameters
@@ -1068,6 +1315,77 @@ module MailSlurpClient
1068
1315
  return data, status_code, headers
1069
1316
  end
1070
1317
 
1318
+ # Test transformer mapping match result
1319
+ # Evaluate transform mapping match conditions for given email, sms, or attachment
1320
+ # @param id [String] ID of transform mapping
1321
+ # @param [Hash] opts the optional parameters
1322
+ # @option opts [String] :email_id
1323
+ # @option opts [String] :sms_id
1324
+ # @option opts [String] :attachment_id
1325
+ # @return [AITransformMappingMatchResult]
1326
+ def test_transformer_mapping_match(id, opts = {})
1327
+ data, _status_code, _headers = test_transformer_mapping_match_with_http_info(id, opts)
1328
+ data
1329
+ end
1330
+
1331
+ # Test transformer mapping match result
1332
+ # Evaluate transform mapping match conditions for given email, sms, or attachment
1333
+ # @param id [String] ID of transform mapping
1334
+ # @param [Hash] opts the optional parameters
1335
+ # @option opts [String] :email_id
1336
+ # @option opts [String] :sms_id
1337
+ # @option opts [String] :attachment_id
1338
+ # @return [Array<(AITransformMappingMatchResult, Integer, Hash)>] AITransformMappingMatchResult data, response status code and response headers
1339
+ def test_transformer_mapping_match_with_http_info(id, opts = {})
1340
+ if @api_client.config.debugging
1341
+ @api_client.config.logger.debug 'Calling API: AIControllerApi.test_transformer_mapping_match ...'
1342
+ end
1343
+ # verify the required parameter 'id' is set
1344
+ if @api_client.config.client_side_validation && id.nil?
1345
+ fail ArgumentError, "Missing the required parameter 'id' when calling AIControllerApi.test_transformer_mapping_match"
1346
+ end
1347
+ # resource path
1348
+ local_var_path = '/ai/transformer/mappings/{id}/match'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1349
+
1350
+ # query parameters
1351
+ query_params = opts[:query_params] || {}
1352
+ query_params[:'emailId'] = opts[:'email_id'] if !opts[:'email_id'].nil?
1353
+ query_params[:'smsId'] = opts[:'sms_id'] if !opts[:'sms_id'].nil?
1354
+ query_params[:'attachmentId'] = opts[:'attachment_id'] if !opts[:'attachment_id'].nil?
1355
+
1356
+ # header parameters
1357
+ header_params = opts[:header_params] || {}
1358
+ # HTTP header 'Accept' (if needed)
1359
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1360
+
1361
+ # form parameters
1362
+ form_params = opts[:form_params] || {}
1363
+
1364
+ # http body (model)
1365
+ post_body = opts[:body]
1366
+
1367
+ # return_type
1368
+ return_type = opts[:return_type] || 'AITransformMappingMatchResult'
1369
+
1370
+ # auth_names
1371
+ auth_names = opts[:auth_names] || ['API_KEY']
1372
+
1373
+ new_options = opts.merge(
1374
+ :header_params => header_params,
1375
+ :query_params => query_params,
1376
+ :form_params => form_params,
1377
+ :body => post_body,
1378
+ :auth_names => auth_names,
1379
+ :return_type => return_type
1380
+ )
1381
+
1382
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1383
+ if @api_client.config.debugging
1384
+ @api_client.config.logger.debug "API called: AIControllerApi#test_transformer_mapping_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1385
+ end
1386
+ return data, status_code, headers
1387
+ end
1388
+
1071
1389
  # Validate structured content schema
1072
1390
  # Check if a schema is valid and can be used to extract data using AI
1073
1391
  # @param structured_output_schema [StructuredOutputSchema]
@@ -0,0 +1,237 @@
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 ApiAuditLogControllerApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # @param event_id [String]
23
+ # @param [Hash] opts the optional parameters
24
+ # @option opts [DateTime] :since
25
+ # @option opts [DateTime] :before
26
+ # @return [AuditLogEventDto]
27
+ def get_audit_log_by_event_id(event_id, opts = {})
28
+ data, _status_code, _headers = get_audit_log_by_event_id_with_http_info(event_id, opts)
29
+ data
30
+ end
31
+
32
+ # @param event_id [String]
33
+ # @param [Hash] opts the optional parameters
34
+ # @option opts [DateTime] :since
35
+ # @option opts [DateTime] :before
36
+ # @return [Array<(AuditLogEventDto, Integer, Hash)>] AuditLogEventDto data, response status code and response headers
37
+ def get_audit_log_by_event_id_with_http_info(event_id, opts = {})
38
+ if @api_client.config.debugging
39
+ @api_client.config.logger.debug 'Calling API: ApiAuditLogControllerApi.get_audit_log_by_event_id ...'
40
+ end
41
+ # verify the required parameter 'event_id' is set
42
+ if @api_client.config.client_side_validation && event_id.nil?
43
+ fail ArgumentError, "Missing the required parameter 'event_id' when calling ApiAuditLogControllerApi.get_audit_log_by_event_id"
44
+ end
45
+ # resource path
46
+ local_var_path = '/audit-logs/{eventId}'.sub('{' + 'eventId' + '}', CGI.escape(event_id.to_s))
47
+
48
+ # query parameters
49
+ query_params = opts[:query_params] || {}
50
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
51
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
57
+
58
+ # form parameters
59
+ form_params = opts[:form_params] || {}
60
+
61
+ # http body (model)
62
+ post_body = opts[:body]
63
+
64
+ # return_type
65
+ return_type = opts[:return_type] || 'AuditLogEventDto'
66
+
67
+ # auth_names
68
+ auth_names = opts[:auth_names] || ['API_KEY']
69
+
70
+ new_options = opts.merge(
71
+ :header_params => header_params,
72
+ :query_params => query_params,
73
+ :form_params => form_params,
74
+ :body => post_body,
75
+ :auth_names => auth_names,
76
+ :return_type => return_type
77
+ )
78
+
79
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
80
+ if @api_client.config.debugging
81
+ @api_client.config.logger.debug "API called: ApiAuditLogControllerApi#get_audit_log_by_event_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
82
+ end
83
+ return data, status_code, headers
84
+ end
85
+
86
+ # @param [Hash] opts the optional parameters
87
+ # @option opts [DateTime] :since
88
+ # @option opts [DateTime] :before
89
+ # @option opts [String] :action
90
+ # @option opts [String] :user_id
91
+ # @option opts [String] :actor_user_id
92
+ # @option opts [String] :target_user_id
93
+ # @option opts [String] :resource_type
94
+ # @option opts [String] :resource_id
95
+ # @option opts [String] :outcome
96
+ # @option opts [String] :request_id
97
+ # @option opts [String] :ip_address
98
+ # @option opts [Integer] :page_size
99
+ # @option opts [String] :cursor
100
+ # @return [AuditLogPageDto]
101
+ def get_audit_logs(opts = {})
102
+ data, _status_code, _headers = get_audit_logs_with_http_info(opts)
103
+ data
104
+ end
105
+
106
+ # @param [Hash] opts the optional parameters
107
+ # @option opts [DateTime] :since
108
+ # @option opts [DateTime] :before
109
+ # @option opts [String] :action
110
+ # @option opts [String] :user_id
111
+ # @option opts [String] :actor_user_id
112
+ # @option opts [String] :target_user_id
113
+ # @option opts [String] :resource_type
114
+ # @option opts [String] :resource_id
115
+ # @option opts [String] :outcome
116
+ # @option opts [String] :request_id
117
+ # @option opts [String] :ip_address
118
+ # @option opts [Integer] :page_size
119
+ # @option opts [String] :cursor
120
+ # @return [Array<(AuditLogPageDto, Integer, Hash)>] AuditLogPageDto data, response status code and response headers
121
+ def get_audit_logs_with_http_info(opts = {})
122
+ if @api_client.config.debugging
123
+ @api_client.config.logger.debug 'Calling API: ApiAuditLogControllerApi.get_audit_logs ...'
124
+ end
125
+ # resource path
126
+ local_var_path = '/audit-logs'
127
+
128
+ # query parameters
129
+ query_params = opts[:query_params] || {}
130
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
131
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
132
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
133
+ query_params[:'userId'] = opts[:'user_id'] if !opts[:'user_id'].nil?
134
+ query_params[:'actorUserId'] = opts[:'actor_user_id'] if !opts[:'actor_user_id'].nil?
135
+ query_params[:'targetUserId'] = opts[:'target_user_id'] if !opts[:'target_user_id'].nil?
136
+ query_params[:'resourceType'] = opts[:'resource_type'] if !opts[:'resource_type'].nil?
137
+ query_params[:'resourceId'] = opts[:'resource_id'] if !opts[:'resource_id'].nil?
138
+ query_params[:'outcome'] = opts[:'outcome'] if !opts[:'outcome'].nil?
139
+ query_params[:'requestId'] = opts[:'request_id'] if !opts[:'request_id'].nil?
140
+ query_params[:'ipAddress'] = opts[:'ip_address'] if !opts[:'ip_address'].nil?
141
+ query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
142
+ query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
143
+
144
+ # header parameters
145
+ header_params = opts[:header_params] || {}
146
+ # HTTP header 'Accept' (if needed)
147
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
148
+
149
+ # form parameters
150
+ form_params = opts[:form_params] || {}
151
+
152
+ # http body (model)
153
+ post_body = opts[:body]
154
+
155
+ # return_type
156
+ return_type = opts[:return_type] || 'AuditLogPageDto'
157
+
158
+ # auth_names
159
+ auth_names = opts[:auth_names] || ['API_KEY']
160
+
161
+ new_options = opts.merge(
162
+ :header_params => header_params,
163
+ :query_params => query_params,
164
+ :form_params => form_params,
165
+ :body => post_body,
166
+ :auth_names => auth_names,
167
+ :return_type => return_type
168
+ )
169
+
170
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug "API called: ApiAuditLogControllerApi#get_audit_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
173
+ end
174
+ return data, status_code, headers
175
+ end
176
+
177
+ # @param audit_log_search_options [AuditLogSearchOptions]
178
+ # @param [Hash] opts the optional parameters
179
+ # @return [AuditLogPageDto]
180
+ def search_audit_logs(audit_log_search_options, opts = {})
181
+ data, _status_code, _headers = search_audit_logs_with_http_info(audit_log_search_options, opts)
182
+ data
183
+ end
184
+
185
+ # @param audit_log_search_options [AuditLogSearchOptions]
186
+ # @param [Hash] opts the optional parameters
187
+ # @return [Array<(AuditLogPageDto, Integer, Hash)>] AuditLogPageDto data, response status code and response headers
188
+ def search_audit_logs_with_http_info(audit_log_search_options, opts = {})
189
+ if @api_client.config.debugging
190
+ @api_client.config.logger.debug 'Calling API: ApiAuditLogControllerApi.search_audit_logs ...'
191
+ end
192
+ # verify the required parameter 'audit_log_search_options' is set
193
+ if @api_client.config.client_side_validation && audit_log_search_options.nil?
194
+ fail ArgumentError, "Missing the required parameter 'audit_log_search_options' when calling ApiAuditLogControllerApi.search_audit_logs"
195
+ end
196
+ # resource path
197
+ local_var_path = '/audit-logs/search'
198
+
199
+ # query parameters
200
+ query_params = opts[:query_params] || {}
201
+
202
+ # header parameters
203
+ header_params = opts[:header_params] || {}
204
+ # HTTP header 'Accept' (if needed)
205
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
206
+ # HTTP header 'Content-Type'
207
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
208
+
209
+ # form parameters
210
+ form_params = opts[:form_params] || {}
211
+
212
+ # http body (model)
213
+ post_body = opts[:body] || @api_client.object_to_http_body(audit_log_search_options)
214
+
215
+ # return_type
216
+ return_type = opts[:return_type] || 'AuditLogPageDto'
217
+
218
+ # auth_names
219
+ auth_names = opts[:auth_names] || ['API_KEY']
220
+
221
+ new_options = opts.merge(
222
+ :header_params => header_params,
223
+ :query_params => query_params,
224
+ :form_params => form_params,
225
+ :body => post_body,
226
+ :auth_names => auth_names,
227
+ :return_type => return_type
228
+ )
229
+
230
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
231
+ if @api_client.config.debugging
232
+ @api_client.config.logger.debug "API called: ApiAuditLogControllerApi#search_audit_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
233
+ end
234
+ return data, status_code, headers
235
+ end
236
+ end
237
+ end