mailslurp_client 15.0.3 → 15.0.4

Sign up to get free protection for your applications and to get access to all the features.
Files changed (158) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/lib/mailslurp_client/api/alias_controller_api.rb +59 -55
  4. data/lib/mailslurp_client/api/attachment_controller_api.rb +49 -60
  5. data/lib/mailslurp_client/api/bounce_controller_api.rb +26 -18
  6. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +15 -15
  7. data/lib/mailslurp_client/api/common_actions_controller_api.rb +128 -67
  8. data/lib/mailslurp_client/api/contact_controller_api.rb +22 -22
  9. data/lib/mailslurp_client/api/domain_controller_api.rb +32 -32
  10. data/lib/mailslurp_client/api/email_controller_api.rb +137 -117
  11. data/lib/mailslurp_client/api/expired_controller_api.rb +19 -19
  12. data/lib/mailslurp_client/api/export_controller_api.rb +38 -38
  13. data/lib/mailslurp_client/api/form_controller_api.rb +16 -18
  14. data/lib/mailslurp_client/api/group_controller_api.rb +52 -52
  15. data/lib/mailslurp_client/api/inbox_controller_api.rb +256 -236
  16. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +33 -29
  17. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +33 -29
  18. data/lib/mailslurp_client/api/mail_server_controller_api.rb +26 -26
  19. data/lib/mailslurp_client/api/missed_email_controller_api.rb +54 -42
  20. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +157 -47
  21. data/lib/mailslurp_client/api/template_controller_api.rb +21 -21
  22. data/lib/mailslurp_client/api/tracking_controller_api.rb +16 -16
  23. data/lib/mailslurp_client/api/wait_for_controller_api.rb +128 -88
  24. data/lib/mailslurp_client/api/webhook_controller_api.rb +102 -86
  25. data/lib/mailslurp_client/configuration.rb +4 -4
  26. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +10 -25
  27. data/lib/mailslurp_client/models/alias_dto.rb +45 -56
  28. data/lib/mailslurp_client/models/alias_projection.rb +42 -72
  29. data/lib/mailslurp_client/models/attachment_entity.rb +34 -54
  30. data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -21
  31. data/lib/mailslurp_client/models/attachment_projection.rb +36 -51
  32. data/lib/mailslurp_client/models/basic_auth_options.rb +0 -10
  33. data/lib/mailslurp_client/models/bounce_projection.rb +13 -23
  34. data/lib/mailslurp_client/models/bounce_recipient.rb +22 -42
  35. data/lib/mailslurp_client/models/bounced_email_dto.rb +56 -76
  36. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -31
  37. data/lib/mailslurp_client/models/bulk_send_email_options.rb +5 -0
  38. data/lib/mailslurp_client/models/condition_option.rb +2 -2
  39. data/lib/mailslurp_client/models/contact_dto.rb +53 -73
  40. data/lib/mailslurp_client/models/contact_projection.rb +42 -52
  41. data/lib/mailslurp_client/models/count_dto.rb +0 -5
  42. data/lib/mailslurp_client/models/create_contact_options.rb +42 -42
  43. data/lib/mailslurp_client/models/create_domain_options.rb +21 -16
  44. data/lib/mailslurp_client/models/create_group_options.rb +0 -5
  45. data/lib/mailslurp_client/models/create_inbox_dto.rb +58 -58
  46. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +19 -14
  47. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +23 -23
  48. data/lib/mailslurp_client/models/create_template_options.rb +0 -10
  49. data/lib/mailslurp_client/models/create_webhook_options.rb +18 -18
  50. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +15 -25
  51. data/lib/mailslurp_client/models/dns_lookup_options.rb +24 -14
  52. data/lib/mailslurp_client/models/dns_lookup_result.rb +23 -42
  53. data/lib/mailslurp_client/models/dns_lookup_results.rb +0 -5
  54. data/lib/mailslurp_client/models/domain_dto.rb +59 -80
  55. data/lib/mailslurp_client/models/domain_name_record.rb +11 -30
  56. data/lib/mailslurp_client/models/domain_preview.rb +26 -50
  57. data/lib/mailslurp_client/models/email.rb +134 -135
  58. data/lib/mailslurp_client/models/email_analysis.rb +28 -28
  59. data/lib/mailslurp_client/models/email_content_match_result.rb +13 -23
  60. data/lib/mailslurp_client/models/email_links_result.rb +13 -23
  61. data/lib/mailslurp_client/models/email_preview.rb +47 -47
  62. data/lib/mailslurp_client/models/email_projection.rb +77 -97
  63. data/lib/mailslurp_client/models/email_recipients.rb +16 -15
  64. data/lib/mailslurp_client/models/email_text_lines_result.rb +13 -23
  65. data/lib/mailslurp_client/models/email_verification_result.rb +16 -36
  66. data/lib/mailslurp_client/models/expiration_defaults.rb +16 -26
  67. data/lib/mailslurp_client/models/expired_inbox_dto.rb +13 -28
  68. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +22 -42
  69. data/lib/mailslurp_client/models/export_link.rb +0 -5
  70. data/lib/mailslurp_client/models/export_options.rb +1 -6
  71. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +13 -23
  72. data/lib/mailslurp_client/models/forward_email_options.rb +36 -31
  73. data/lib/mailslurp_client/models/gravatar_url.rb +13 -23
  74. data/lib/mailslurp_client/models/group_contacts_dto.rb +13 -23
  75. data/lib/mailslurp_client/models/group_dto.rb +22 -37
  76. data/lib/mailslurp_client/models/group_projection.rb +22 -37
  77. data/lib/mailslurp_client/models/html_validation_result.rb +13 -14
  78. data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +47 -57
  79. data/lib/mailslurp_client/models/inbox_exists_dto.rb +0 -5
  80. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -61
  81. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +0 -5
  82. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +13 -23
  83. data/lib/mailslurp_client/models/inbox_preview.rb +38 -38
  84. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +43 -78
  85. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +0 -5
  86. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +13 -18
  87. data/lib/mailslurp_client/models/inline_object.rb +221 -0
  88. data/lib/mailslurp_client/models/ip_address_result.rb +0 -10
  89. data/lib/mailslurp_client/models/json_schema_dto.rb +0 -5
  90. data/lib/mailslurp_client/models/match_option.rb +7 -2
  91. data/lib/mailslurp_client/models/match_options.rb +16 -16
  92. data/lib/mailslurp_client/models/missed_email.rb +67 -102
  93. data/lib/mailslurp_client/models/missed_email_projection.rb +19 -29
  94. data/lib/mailslurp_client/models/name_server_record.rb +10 -30
  95. data/lib/mailslurp_client/models/organization_inbox_projection.rb +44 -44
  96. data/lib/mailslurp_client/models/page_alias.rb +52 -52
  97. data/lib/mailslurp_client/models/page_attachment_entity.rb +52 -52
  98. data/lib/mailslurp_client/models/page_bounced_email.rb +52 -52
  99. data/lib/mailslurp_client/models/page_bounced_recipients.rb +52 -52
  100. data/lib/mailslurp_client/models/page_contact_projection.rb +52 -52
  101. data/lib/mailslurp_client/models/page_email_preview.rb +52 -52
  102. data/lib/mailslurp_client/models/page_email_projection.rb +52 -52
  103. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +52 -52
  104. data/lib/mailslurp_client/models/page_group_projection.rb +52 -52
  105. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +52 -52
  106. data/lib/mailslurp_client/models/page_inbox_projection.rb +52 -52
  107. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +52 -52
  108. data/lib/mailslurp_client/models/page_missed_email_projection.rb +52 -52
  109. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +52 -52
  110. data/lib/mailslurp_client/models/page_sent_email_projection.rb +49 -49
  111. data/lib/mailslurp_client/models/page_template_projection.rb +52 -52
  112. data/lib/mailslurp_client/models/page_thread_projection.rb +52 -52
  113. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +52 -52
  114. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +52 -52
  115. data/lib/mailslurp_client/models/page_webhook_projection.rb +52 -52
  116. data/lib/mailslurp_client/models/page_webhook_result.rb +52 -52
  117. data/lib/mailslurp_client/models/pageable.rb +10 -10
  118. data/lib/mailslurp_client/models/raw_email_json.rb +0 -5
  119. data/lib/mailslurp_client/models/recipient.rb +13 -23
  120. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +38 -37
  121. data/lib/mailslurp_client/models/reply_to_email_options.rb +51 -50
  122. data/lib/mailslurp_client/models/send_email_options.rb +107 -115
  123. data/lib/mailslurp_client/models/sender.rb +14 -23
  124. data/lib/mailslurp_client/models/sent_email_dto.rb +97 -102
  125. data/lib/mailslurp_client/models/sent_email_projection.rb +66 -105
  126. data/lib/mailslurp_client/models/simple_send_email_options.rb +24 -24
  127. data/lib/mailslurp_client/models/template_dto.rb +22 -47
  128. data/lib/mailslurp_client/models/template_projection.rb +16 -41
  129. data/lib/mailslurp_client/models/template_variable.rb +0 -10
  130. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +0 -10
  131. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +0 -10
  132. data/lib/mailslurp_client/models/thread_projection.rb +60 -95
  133. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +43 -68
  134. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +34 -54
  135. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +19 -29
  136. data/lib/mailslurp_client/models/unread_count.rb +0 -5
  137. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +0 -5
  138. data/lib/mailslurp_client/models/update_group_contacts.rb +0 -5
  139. data/lib/mailslurp_client/models/update_inbox_options.rb +26 -26
  140. data/lib/mailslurp_client/models/upload_attachment_options.rb +14 -14
  141. data/lib/mailslurp_client/models/validation_message.rb +1 -5
  142. data/lib/mailslurp_client/models/verify_email_address_options.rb +0 -5
  143. data/lib/mailslurp_client/models/wait_for_conditions.rb +48 -58
  144. data/lib/mailslurp_client/models/webhook_dto.rb +64 -69
  145. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +42 -42
  146. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +49 -49
  147. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +43 -43
  148. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +75 -95
  149. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +84 -84
  150. data/lib/mailslurp_client/models/webhook_projection.rb +36 -61
  151. data/lib/mailslurp_client/models/webhook_redrive_result.rb +13 -23
  152. data/lib/mailslurp_client/models/webhook_result_dto.rb +76 -126
  153. data/lib/mailslurp_client/models/webhook_test_request.rb +21 -36
  154. data/lib/mailslurp_client/models/webhook_test_response.rb +13 -13
  155. data/lib/mailslurp_client/models/webhook_test_result.rb +13 -23
  156. data/lib/mailslurp_client/version.rb +1 -1
  157. data/lib/mailslurp_client.rb +2 -1
  158. metadata +4 -3
@@ -22,17 +22,17 @@ module MailSlurpClient
22
22
  # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
23
23
  # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
26
- # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
27
- # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
28
- # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
29
- # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
30
- # @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
31
- # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
32
- # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
33
- # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
34
- # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field. Note this feature is only available for &#x60;HTTP&#x60; inbox types.
35
- # @return [Inbox]
25
+ # @option opts [String] :a_custom_email_address_to_use_with_the_inbox__defaults_to_null__when_null_mail_slurp_will_assign_a_random_email_address_to_the_inbox_such_as_123mailslurp_com__if_you_use_the_use_domain_pool_option_when_the_email_address_is_null_it_will_generate_an_email_address_with_a_more_varied_domain_ending_such_as_123mailslurp_info_or_123mailslurp_biz__when_a_custom_email_address_is_provided_the_address_is_split_into_a_domain_and_the_domain_is_queried_against_your_user__if_you_have_created_the_domain_in_the_mail_slurp_dashboard_and_verified_it_you_can_use_any_email_address_that_ends_with_the_domain__note_domain_types_must_match_the_inbox_type___so_smtp_inboxes_will_only_work_with_smtp_type_domains__avoid_smtp_inboxes_if_you_need_to_send_emails_as_they_can_only_receive__send_an_email_to_this_address_and_the_inbox_will_receive_and_store_it_for_you__to_retrieve_the_email_use_the_inbox_and_email_controller_endpoints_with_the_inbox_id_
26
+ # @option opts [Array<String>] :tags_that_inbox_has_been_tagged_with__tags_can_be_added_to_inboxes_to_group_different_inboxes_within_an_account__you_can_also_search_for_inboxes_by_tag_in_the_dashboard_ui_
27
+ # @option opts [String] :optional_name_of_the_inbox__displayed_in_the_dashboard_for_easier_search_and_used_as_the_sender_name_when_sending_emails_
28
+ # @option opts [String] :optional_description_of_the_inbox_for_labelling_purposes__is_shown_in_the_dashboard_and_can_be_used_with
29
+ # @option opts [Boolean] :use_the_mail_slurp_domain_name_pool_with_this_inbox_when_creating_the_email_address__defaults_to_null__if_enabled_the_inbox_will_be_an_email_address_with_a_domain_randomly_chosen_from_a_list_of_the_mail_slurp_domains__this_is_useful_when_the_default_mailslurp_com_email_addresses_used_with_inboxes_are_blocked_or_considered_spam_by_a_provider_or_receiving_service__when_domain_pool_is_enabled_an_email_address_will_be_generated_ending_in_mailslurp_worldinfoxyz______this_means_a_tld_is_randomly_selecting_from_a_list_of__biz__info__xyz_etc_to_add_variance_to_the_generated_email_addresses__when_null_or_false_mail_slurp_uses_the_default_behavior_of_mailslurp_com_or_custom_email_address_provided_by_the_email_address_field__note_this_feature_is_only_available_for_http_inbox_types_
30
+ # @option opts [Boolean] :is_the_inbox_a_favorite__marking_an_inbox_as_a_favorite_is_typically_done_in_the_dashboard_for_quick_access_or_filtering
31
+ # @option opts [DateTime] :optional_inbox_expiration_date__if_null_then_this_inbox_is_permanent_and_the_emails_in_it_wont_be_deleted__if_an_expiration_date_is_provided_or_is_required_by_your_plan_the_inbox_will_be_closed_when_the_expiration_time_is_reached__expired_inboxes_still_contain_their_emails_but_can_no_longer_send_or_receive_emails__an_expired_inbox_record_is_created_when_an_inbox_and_the_email_address_and_inbox_id_are_recorded__the_expires_at_property_is_a_timestamp_string_in_iso_date_time_format_yyyy_mm_dd_th_hmmss_sssxxx_
32
+ # @option opts [Integer] :number_of_milliseconds_that_inbox_should_exist_for
33
+ # @option opts [Boolean] :deprecated__team_access_is_always_true__grant_team_access_to_this_inbox_and_the_emails_that_belong_to_it_for_team_members_of_your_organization_
34
+ # @option opts [String] :http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_
35
+ # @return [InboxDto]
36
36
  def create_inbox(opts = {})
37
37
  data, _status_code, _headers = create_inbox_with_http_info(opts)
38
38
  data
@@ -41,45 +41,45 @@ module MailSlurpClient
41
41
  # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either &#x60;SMTP&#x60; or &#x60;HTTP&#x60; inboxes.
42
42
  # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty.
43
43
  # @param [Hash] opts the optional parameters
44
- # @option opts [Boolean] :allow_team_access DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.
45
- # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
46
- # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as &#x60;123@mailslurp.com&#x60;. If you use the &#x60;useDomainPool&#x60; option when the email address is null it will generate an email address with a more varied domain ending such as &#x60;123@mailslurp.info&#x60; or &#x60;123@mailslurp.biz&#x60;. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so &#x60;SMTP&#x60; inboxes will only work with &#x60;SMTP&#x60; type domains. Avoid &#x60;SMTP&#x60; inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.
47
- # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won&#39;t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSXXX.
48
- # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
49
- # @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
50
- # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at &#x60;mx.mailslurp.com&#x60;.
51
- # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
52
- # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
53
- # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field. Note this feature is only available for &#x60;HTTP&#x60; inbox types.
54
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
44
+ # @option opts [String] :a_custom_email_address_to_use_with_the_inbox__defaults_to_null__when_null_mail_slurp_will_assign_a_random_email_address_to_the_inbox_such_as_123mailslurp_com__if_you_use_the_use_domain_pool_option_when_the_email_address_is_null_it_will_generate_an_email_address_with_a_more_varied_domain_ending_such_as_123mailslurp_info_or_123mailslurp_biz__when_a_custom_email_address_is_provided_the_address_is_split_into_a_domain_and_the_domain_is_queried_against_your_user__if_you_have_created_the_domain_in_the_mail_slurp_dashboard_and_verified_it_you_can_use_any_email_address_that_ends_with_the_domain__note_domain_types_must_match_the_inbox_type___so_smtp_inboxes_will_only_work_with_smtp_type_domains__avoid_smtp_inboxes_if_you_need_to_send_emails_as_they_can_only_receive__send_an_email_to_this_address_and_the_inbox_will_receive_and_store_it_for_you__to_retrieve_the_email_use_the_inbox_and_email_controller_endpoints_with_the_inbox_id_
45
+ # @option opts [Array<String>] :tags_that_inbox_has_been_tagged_with__tags_can_be_added_to_inboxes_to_group_different_inboxes_within_an_account__you_can_also_search_for_inboxes_by_tag_in_the_dashboard_ui_
46
+ # @option opts [String] :optional_name_of_the_inbox__displayed_in_the_dashboard_for_easier_search_and_used_as_the_sender_name_when_sending_emails_
47
+ # @option opts [String] :optional_description_of_the_inbox_for_labelling_purposes__is_shown_in_the_dashboard_and_can_be_used_with
48
+ # @option opts [Boolean] :use_the_mail_slurp_domain_name_pool_with_this_inbox_when_creating_the_email_address__defaults_to_null__if_enabled_the_inbox_will_be_an_email_address_with_a_domain_randomly_chosen_from_a_list_of_the_mail_slurp_domains__this_is_useful_when_the_default_mailslurp_com_email_addresses_used_with_inboxes_are_blocked_or_considered_spam_by_a_provider_or_receiving_service__when_domain_pool_is_enabled_an_email_address_will_be_generated_ending_in_mailslurp_worldinfoxyz______this_means_a_tld_is_randomly_selecting_from_a_list_of__biz__info__xyz_etc_to_add_variance_to_the_generated_email_addresses__when_null_or_false_mail_slurp_uses_the_default_behavior_of_mailslurp_com_or_custom_email_address_provided_by_the_email_address_field__note_this_feature_is_only_available_for_http_inbox_types_
49
+ # @option opts [Boolean] :is_the_inbox_a_favorite__marking_an_inbox_as_a_favorite_is_typically_done_in_the_dashboard_for_quick_access_or_filtering
50
+ # @option opts [DateTime] :optional_inbox_expiration_date__if_null_then_this_inbox_is_permanent_and_the_emails_in_it_wont_be_deleted__if_an_expiration_date_is_provided_or_is_required_by_your_plan_the_inbox_will_be_closed_when_the_expiration_time_is_reached__expired_inboxes_still_contain_their_emails_but_can_no_longer_send_or_receive_emails__an_expired_inbox_record_is_created_when_an_inbox_and_the_email_address_and_inbox_id_are_recorded__the_expires_at_property_is_a_timestamp_string_in_iso_date_time_format_yyyy_mm_dd_th_hmmss_sssxxx_
51
+ # @option opts [Integer] :number_of_milliseconds_that_inbox_should_exist_for
52
+ # @option opts [Boolean] :deprecated__team_access_is_always_true__grant_team_access_to_this_inbox_and_the_emails_that_belong_to_it_for_team_members_of_your_organization_
53
+ # @option opts [String] :http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_
54
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
55
55
  def create_inbox_with_http_info(opts = {})
56
56
  if @api_client.config.debugging
57
57
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox ...'
58
58
  end
59
59
  allowable_values = ["HTTP_INBOX", "SMTP_INBOX"]
60
- if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
61
- fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
60
+ if @api_client.config.client_side_validation && opts[:'http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_'] && !allowable_values.include?(opts[:'http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_'])
61
+ fail ArgumentError, "invalid value for \"http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_\", must be one of #{allowable_values}"
62
62
  end
63
63
  # resource path
64
64
  local_var_path = '/inboxes'
65
65
 
66
66
  # query parameters
67
67
  query_params = opts[:query_params] || {}
68
- query_params[:'allowTeamAccess'] = opts[:'allow_team_access'] if !opts[:'allow_team_access'].nil?
69
- query_params[:'description'] = opts[:'description'] if !opts[:'description'].nil?
70
- query_params[:'emailAddress'] = opts[:'email_address'] if !opts[:'email_address'].nil?
71
- query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
72
- query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
73
- query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
74
- query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
75
- query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
76
- query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
77
- query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?
68
+ query_params[:'A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. Avoid `SMTP` inboxes if you need to send emails as they can only receive. Send an email to this address and the inbox will receive and store it for you. To retrieve the email use the Inbox and Email Controller endpoints with the inbox ID.'] = opts[:'a_custom_email_address_to_use_with_the_inbox__defaults_to_null__when_null_mail_slurp_will_assign_a_random_email_address_to_the_inbox_such_as_123mailslurp_com__if_you_use_the_use_domain_pool_option_when_the_email_address_is_null_it_will_generate_an_email_address_with_a_more_varied_domain_ending_such_as_123mailslurp_info_or_123mailslurp_biz__when_a_custom_email_address_is_provided_the_address_is_split_into_a_domain_and_the_domain_is_queried_against_your_user__if_you_have_created_the_domain_in_the_mail_slurp_dashboard_and_verified_it_you_can_use_any_email_address_that_ends_with_the_domain__note_domain_types_must_match_the_inbox_type___so_smtp_inboxes_will_only_work_with_smtp_type_domains__avoid_smtp_inboxes_if_you_need_to_send_emails_as_they_can_only_receive__send_an_email_to_this_address_and_the_inbox_will_receive_and_store_it_for_you__to_retrieve_the_email_use_the_inbox_and_email_controller_endpoints_with_the_inbox_id_'] if !opts[:'a_custom_email_address_to_use_with_the_inbox__defaults_to_null__when_null_mail_slurp_will_assign_a_random_email_address_to_the_inbox_such_as_123mailslurp_com__if_you_use_the_use_domain_pool_option_when_the_email_address_is_null_it_will_generate_an_email_address_with_a_more_varied_domain_ending_such_as_123mailslurp_info_or_123mailslurp_biz__when_a_custom_email_address_is_provided_the_address_is_split_into_a_domain_and_the_domain_is_queried_against_your_user__if_you_have_created_the_domain_in_the_mail_slurp_dashboard_and_verified_it_you_can_use_any_email_address_that_ends_with_the_domain__note_domain_types_must_match_the_inbox_type___so_smtp_inboxes_will_only_work_with_smtp_type_domains__avoid_smtp_inboxes_if_you_need_to_send_emails_as_they_can_only_receive__send_an_email_to_this_address_and_the_inbox_will_receive_and_store_it_for_you__to_retrieve_the_email_use_the_inbox_and_email_controller_endpoints_with_the_inbox_id_'].nil?
69
+ query_params[:'Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.'] = @api_client.build_collection_param(opts[:'tags_that_inbox_has_been_tagged_with__tags_can_be_added_to_inboxes_to_group_different_inboxes_within_an_account__you_can_also_search_for_inboxes_by_tag_in_the_dashboard_ui_'], :multi) if !opts[:'tags_that_inbox_has_been_tagged_with__tags_can_be_added_to_inboxes_to_group_different_inboxes_within_an_account__you_can_also_search_for_inboxes_by_tag_in_the_dashboard_ui_'].nil?
70
+ query_params[:'Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.'] = opts[:'optional_name_of_the_inbox__displayed_in_the_dashboard_for_easier_search_and_used_as_the_sender_name_when_sending_emails_'] if !opts[:'optional_name_of_the_inbox__displayed_in_the_dashboard_for_easier_search_and_used_as_the_sender_name_when_sending_emails_'].nil?
71
+ query_params[:'Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with'] = opts[:'optional_description_of_the_inbox_for_labelling_purposes__is_shown_in_the_dashboard_and_can_be_used_with'] if !opts[:'optional_description_of_the_inbox_for_labelling_purposes__is_shown_in_the_dashboard_and_can_be_used_with'].nil?
72
+ query_params[:'Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default `@mailslurp.com` email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in `@mailslurp.{world,info,xyz,...}` . This means a TLD is randomly selecting from a list of `.biz`, `.info`, `.xyz` etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of `@mailslurp.com` or custom email address provided by the emailAddress field. Note this feature is only available for `HTTP` inbox types.'] = opts[:'use_the_mail_slurp_domain_name_pool_with_this_inbox_when_creating_the_email_address__defaults_to_null__if_enabled_the_inbox_will_be_an_email_address_with_a_domain_randomly_chosen_from_a_list_of_the_mail_slurp_domains__this_is_useful_when_the_default_mailslurp_com_email_addresses_used_with_inboxes_are_blocked_or_considered_spam_by_a_provider_or_receiving_service__when_domain_pool_is_enabled_an_email_address_will_be_generated_ending_in_mailslurp_worldinfoxyz______this_means_a_tld_is_randomly_selecting_from_a_list_of__biz__info__xyz_etc_to_add_variance_to_the_generated_email_addresses__when_null_or_false_mail_slurp_uses_the_default_behavior_of_mailslurp_com_or_custom_email_address_provided_by_the_email_address_field__note_this_feature_is_only_available_for_http_inbox_types_'] if !opts[:'use_the_mail_slurp_domain_name_pool_with_this_inbox_when_creating_the_email_address__defaults_to_null__if_enabled_the_inbox_will_be_an_email_address_with_a_domain_randomly_chosen_from_a_list_of_the_mail_slurp_domains__this_is_useful_when_the_default_mailslurp_com_email_addresses_used_with_inboxes_are_blocked_or_considered_spam_by_a_provider_or_receiving_service__when_domain_pool_is_enabled_an_email_address_will_be_generated_ending_in_mailslurp_worldinfoxyz______this_means_a_tld_is_randomly_selecting_from_a_list_of__biz__info__xyz_etc_to_add_variance_to_the_generated_email_addresses__when_null_or_false_mail_slurp_uses_the_default_behavior_of_mailslurp_com_or_custom_email_address_provided_by_the_email_address_field__note_this_feature_is_only_available_for_http_inbox_types_'].nil?
73
+ query_params[:'Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering'] = opts[:'is_the_inbox_a_favorite__marking_an_inbox_as_a_favorite_is_typically_done_in_the_dashboard_for_quick_access_or_filtering'] if !opts[:'is_the_inbox_a_favorite__marking_an_inbox_as_a_favorite_is_typically_done_in_the_dashboard_for_quick_access_or_filtering'].nil?
74
+ query_params[:'Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.'] = opts[:'optional_inbox_expiration_date__if_null_then_this_inbox_is_permanent_and_the_emails_in_it_wont_be_deleted__if_an_expiration_date_is_provided_or_is_required_by_your_plan_the_inbox_will_be_closed_when_the_expiration_time_is_reached__expired_inboxes_still_contain_their_emails_but_can_no_longer_send_or_receive_emails__an_expired_inbox_record_is_created_when_an_inbox_and_the_email_address_and_inbox_id_are_recorded__the_expires_at_property_is_a_timestamp_string_in_iso_date_time_format_yyyy_mm_dd_th_hmmss_sssxxx_'] if !opts[:'optional_inbox_expiration_date__if_null_then_this_inbox_is_permanent_and_the_emails_in_it_wont_be_deleted__if_an_expiration_date_is_provided_or_is_required_by_your_plan_the_inbox_will_be_closed_when_the_expiration_time_is_reached__expired_inboxes_still_contain_their_emails_but_can_no_longer_send_or_receive_emails__an_expired_inbox_record_is_created_when_an_inbox_and_the_email_address_and_inbox_id_are_recorded__the_expires_at_property_is_a_timestamp_string_in_iso_date_time_format_yyyy_mm_dd_th_hmmss_sssxxx_'].nil?
75
+ query_params[:'Number of milliseconds that inbox should exist for'] = opts[:'number_of_milliseconds_that_inbox_should_exist_for'] if !opts[:'number_of_milliseconds_that_inbox_should_exist_for'].nil?
76
+ query_params[:'DEPRECATED (team access is always true). Grant team access to this inbox and the emails that belong to it for team members of your organization.'] = opts[:'deprecated__team_access_is_always_true__grant_team_access_to_this_inbox_and_the_emails_that_belong_to_it_for_team_members_of_your_organization_'] if !opts[:'deprecated__team_access_is_always_true__grant_team_access_to_this_inbox_and_the_emails_that_belong_to_it_for_team_members_of_your_organization_'].nil?
77
+ query_params[:'HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.'] = opts[:'http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_'] if !opts[:'http__default_or_smtp_inbox_type__http_inboxes_are_default_and_best_solution_for_most_cases__smtp_inboxes_are_more_reliable_for_public_inbound_email_consumption__but_do_not_support_sending_emails__when_using_custom_domains_the_domain_type_must_match_the_inbox_type__http_inboxes_are_processed_by_aws_ses_while_smtp_inboxes_use_a_custom_mail_server_running_at_mx_mailslurp_com_'].nil?
78
78
 
79
79
  # header parameters
80
80
  header_params = opts[:header_params] || {}
81
81
  # HTTP header 'Accept' (if needed)
82
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
82
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
83
83
 
84
84
  # form parameters
85
85
  form_params = opts[:form_params] || {}
@@ -88,7 +88,7 @@ module MailSlurpClient
88
88
  post_body = opts[:body]
89
89
 
90
90
  # return_type
91
- return_type = opts[:return_type] || 'Inbox'
91
+ return_type = opts[:return_type] || 'InboxDto'
92
92
 
93
93
  # auth_names
94
94
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -111,8 +111,8 @@ module MailSlurpClient
111
111
 
112
112
  # Create an inbox ruleset
113
113
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
114
- # @param inbox_id [String] inboxId
115
- # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
114
+ # @param inbox_id [String]
115
+ # @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
116
116
  # @param [Hash] opts the optional parameters
117
117
  # @return [InboxRulesetDto]
118
118
  def create_inbox_ruleset(inbox_id, create_inbox_ruleset_options, opts = {})
@@ -122,8 +122,8 @@ module MailSlurpClient
122
122
 
123
123
  # Create an inbox ruleset
124
124
  # Create a new inbox rule for forwarding, blocking, and allowing emails when sending and receiving
125
- # @param inbox_id [String] inboxId
126
- # @param create_inbox_ruleset_options [CreateInboxRulesetOptions] createInboxRulesetOptions
125
+ # @param inbox_id [String]
126
+ # @param create_inbox_ruleset_options [CreateInboxRulesetOptions]
127
127
  # @param [Hash] opts the optional parameters
128
128
  # @return [Array<(InboxRulesetDto, Integer, Hash)>] InboxRulesetDto data, response status code and response headers
129
129
  def create_inbox_ruleset_with_http_info(inbox_id, create_inbox_ruleset_options, opts = {})
@@ -147,7 +147,7 @@ module MailSlurpClient
147
147
  # header parameters
148
148
  header_params = opts[:header_params] || {}
149
149
  # HTTP header 'Accept' (if needed)
150
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
150
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
151
151
  # HTTP header 'Content-Type'
152
152
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
153
153
 
@@ -181,7 +181,7 @@ module MailSlurpClient
181
181
 
182
182
  # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
183
183
  # @param [Hash] opts the optional parameters
184
- # @return [Inbox]
184
+ # @return [InboxDto]
185
185
  def create_inbox_with_defaults(opts = {})
186
186
  data, _status_code, _headers = create_inbox_with_defaults_with_http_info(opts)
187
187
  data
@@ -189,7 +189,7 @@ module MailSlurpClient
189
189
 
190
190
  # Create an inbox with default options. Uses MailSlurp domain pool address and is private.
191
191
  # @param [Hash] opts the optional parameters
192
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
192
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
193
193
  def create_inbox_with_defaults_with_http_info(opts = {})
194
194
  if @api_client.config.debugging
195
195
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_defaults ...'
@@ -203,7 +203,7 @@ module MailSlurpClient
203
203
  # header parameters
204
204
  header_params = opts[:header_params] || {}
205
205
  # HTTP header 'Accept' (if needed)
206
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
206
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
207
207
 
208
208
  # form parameters
209
209
  form_params = opts[:form_params] || {}
@@ -212,7 +212,7 @@ module MailSlurpClient
212
212
  post_body = opts[:body]
213
213
 
214
214
  # return_type
215
- return_type = opts[:return_type] || 'Inbox'
215
+ return_type = opts[:return_type] || 'InboxDto'
216
216
 
217
217
  # auth_names
218
218
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -235,9 +235,9 @@ module MailSlurpClient
235
235
 
236
236
  # Create an inbox with options. Extended options for inbox creation.
237
237
  # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
238
- # @param create_inbox_dto [CreateInboxDto] createInboxDto
238
+ # @param create_inbox_dto [CreateInboxDto]
239
239
  # @param [Hash] opts the optional parameters
240
- # @return [Inbox]
240
+ # @return [InboxDto]
241
241
  def create_inbox_with_options(create_inbox_dto, opts = {})
242
242
  data, _status_code, _headers = create_inbox_with_options_with_http_info(create_inbox_dto, opts)
243
243
  data
@@ -245,9 +245,9 @@ module MailSlurpClient
245
245
 
246
246
  # Create an inbox with options. Extended options for inbox creation.
247
247
  # Additional endpoint that allows inbox creation with request body options. Can be more flexible that other methods for some clients.
248
- # @param create_inbox_dto [CreateInboxDto] createInboxDto
248
+ # @param create_inbox_dto [CreateInboxDto]
249
249
  # @param [Hash] opts the optional parameters
250
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
250
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
251
251
  def create_inbox_with_options_with_http_info(create_inbox_dto, opts = {})
252
252
  if @api_client.config.debugging
253
253
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox_with_options ...'
@@ -265,7 +265,7 @@ module MailSlurpClient
265
265
  # header parameters
266
266
  header_params = opts[:header_params] || {}
267
267
  # HTTP header 'Accept' (if needed)
268
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
268
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
269
269
  # HTTP header 'Content-Type'
270
270
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
271
271
 
@@ -276,7 +276,7 @@ module MailSlurpClient
276
276
  post_body = opts[:body] || @api_client.object_to_http_body(create_inbox_dto)
277
277
 
278
278
  # return_type
279
- return_type = opts[:return_type] || 'Inbox'
279
+ return_type = opts[:return_type] || 'InboxDto'
280
280
 
281
281
  # auth_names
282
282
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -353,7 +353,7 @@ module MailSlurpClient
353
353
 
354
354
  # Delete inbox
355
355
  # Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
356
- # @param inbox_id [String] inboxId
356
+ # @param inbox_id [String]
357
357
  # @param [Hash] opts the optional parameters
358
358
  # @return [nil]
359
359
  def delete_inbox(inbox_id, opts = {})
@@ -363,7 +363,7 @@ module MailSlurpClient
363
363
 
364
364
  # Delete inbox
365
365
  # Permanently delete an inbox and associated email address as well as all emails within the given inbox. This action cannot be undone. Note: deleting an inbox will not affect your account usage. Monthly inbox usage is based on how many inboxes you create within 30 days, not how many exist at time of request.
366
- # @param inbox_id [String] inboxId
366
+ # @param inbox_id [String]
367
367
  # @param [Hash] opts the optional parameters
368
368
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
369
369
  def delete_inbox_with_http_info(inbox_id, opts = {})
@@ -444,7 +444,7 @@ module MailSlurpClient
444
444
  # header parameters
445
445
  header_params = opts[:header_params] || {}
446
446
  # HTTP header 'Accept' (if needed)
447
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
447
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
448
448
 
449
449
  # form parameters
450
450
  form_params = opts[:form_params] || {}
@@ -503,7 +503,7 @@ module MailSlurpClient
503
503
  # header parameters
504
504
  header_params = opts[:header_params] || {}
505
505
  # HTTP header 'Accept' (if needed)
506
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
506
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
507
507
 
508
508
  # form parameters
509
509
  form_params = opts[:form_params] || {}
@@ -536,15 +536,15 @@ module MailSlurpClient
536
536
  # List All Inboxes Paginated
537
537
  # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
538
538
  # @param [Hash] opts the optional parameters
539
- # @option opts [DateTime] :before Optional filter by created before given date time
540
- # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
541
539
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
542
- # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
543
- # @option opts [DateTime] :since Optional filter by created after given date time
544
540
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
545
541
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
542
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
543
+ # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
546
544
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
547
- # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access. (default to false)
545
+ # @option opts [Boolean] :deprecated__optionally_filter_by_team_access_
546
+ # @option opts [DateTime] :since Optional filter by created after given date time
547
+ # @option opts [DateTime] :before Optional filter by created before given date time
548
548
  # @return [PageInboxProjection]
549
549
  def get_all_inboxes(opts = {})
550
550
  data, _status_code, _headers = get_all_inboxes_with_http_info(opts)
@@ -554,15 +554,15 @@ module MailSlurpClient
554
554
  # List All Inboxes Paginated
555
555
  # List inboxes in paginated form. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative &#x60;getInboxes&#x60; method returns a full list of inboxes but is limited to 100 results.
556
556
  # @param [Hash] opts the optional parameters
557
- # @option opts [DateTime] :before Optional filter by created before given date time
558
- # @option opts [Boolean] :favourite Optionally filter results for favourites only
559
557
  # @option opts [Integer] :page Optional page index in list pagination
560
- # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
561
- # @option opts [DateTime] :since Optional filter by created after given date time
562
558
  # @option opts [Integer] :size Optional page size in list pagination
563
559
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
560
+ # @option opts [Boolean] :favourite Optionally filter results for favourites only
561
+ # @option opts [String] :search Optionally filter by search words partial matching ID, tags, name, and email address
564
562
  # @option opts [String] :tag Optionally filter by tags. Will return inboxes that include given tags
565
- # @option opts [Boolean] :team_access DEPRECATED. Optionally filter by team access.
563
+ # @option opts [Boolean] :deprecated__optionally_filter_by_team_access_
564
+ # @option opts [DateTime] :since Optional filter by created after given date time
565
+ # @option opts [DateTime] :before Optional filter by created before given date time
566
566
  # @return [Array<(PageInboxProjection, Integer, Hash)>] PageInboxProjection data, response status code and response headers
567
567
  def get_all_inboxes_with_http_info(opts = {})
568
568
  if @api_client.config.debugging
@@ -577,20 +577,20 @@ module MailSlurpClient
577
577
 
578
578
  # query parameters
579
579
  query_params = opts[:query_params] || {}
580
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
581
- query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
582
580
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
583
- query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
584
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
585
581
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
586
582
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
583
+ query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
584
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
587
585
  query_params[:'tag'] = opts[:'tag'] if !opts[:'tag'].nil?
588
- query_params[:'teamAccess'] = opts[:'team_access'] if !opts[:'team_access'].nil?
586
+ query_params[:'DEPRECATED. Optionally filter by team access.'] = opts[:'deprecated__optionally_filter_by_team_access_'] if !opts[:'deprecated__optionally_filter_by_team_access_'].nil?
587
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
588
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
589
589
 
590
590
  # header parameters
591
591
  header_params = opts[:header_params] || {}
592
592
  # HTTP header 'Accept' (if needed)
593
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
593
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
594
594
 
595
595
  # form parameters
596
596
  form_params = opts[:form_params] || {}
@@ -622,68 +622,76 @@ module MailSlurpClient
622
622
 
623
623
  # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
624
624
  # List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
625
- # @param inbox_id [String] Id of inbox that emails belongs to
625
+ # @param id_of_inbox_that_emails_belongs_to [String]
626
626
  # @param [Hash] opts the optional parameters
627
- # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
628
- # @option opts [Integer] :delay_timeout delayTimeout
627
+ # @option opts [Integer] :alias_for_limit__assessed_first_before_assessing_any_passed_limit_
629
628
  # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
630
- # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
629
+ # @option opts [String] :sort_the_results_by_received_date_and_direction_asc_or_desc
631
630
  # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
632
- # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
633
- # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
634
- # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
635
- # @option opts [Boolean] :unread_only unreadOnly
631
+ # @option opts [Integer] :delay_timeout
632
+ # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
633
+ # @option opts [Boolean] :unread_only
634
+ # @option opts [DateTime] :exclude_emails_received_after_this_iso_8601_date_time
635
+ # @option opts [DateTime] :exclude_emails_received_before_this_iso_8601_date_time
636
636
  # @return [Array<EmailPreview>]
637
- def get_emails(inbox_id, opts = {})
638
- data, _status_code, _headers = get_emails_with_http_info(inbox_id, opts)
637
+ def get_emails(id_of_inbox_that_emails_belongs_to, opts = {})
638
+ data, _status_code, _headers = get_emails_with_http_info(id_of_inbox_that_emails_belongs_to, opts)
639
639
  data
640
640
  end
641
641
 
642
642
  # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
643
643
  # List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached
644
- # @param inbox_id [String] Id of inbox that emails belongs to
644
+ # @param id_of_inbox_that_emails_belongs_to [String]
645
645
  # @param [Hash] opts the optional parameters
646
- # @option opts [DateTime] :before Exclude emails received after this ISO 8601 date time
647
- # @option opts [Integer] :delay_timeout delayTimeout
646
+ # @option opts [Integer] :alias_for_limit__assessed_first_before_assessing_any_passed_limit_
648
647
  # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
649
- # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
648
+ # @option opts [String] :sort_the_results_by_received_date_and_direction_asc_or_desc
650
649
  # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
651
- # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
652
- # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
653
- # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
654
- # @option opts [Boolean] :unread_only unreadOnly
650
+ # @option opts [Integer] :delay_timeout
651
+ # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
652
+ # @option opts [Boolean] :unread_only
653
+ # @option opts [DateTime] :exclude_emails_received_after_this_iso_8601_date_time
654
+ # @option opts [DateTime] :exclude_emails_received_before_this_iso_8601_date_time
655
655
  # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
656
- def get_emails_with_http_info(inbox_id, opts = {})
656
+ def get_emails_with_http_info(id_of_inbox_that_emails_belongs_to, opts = {})
657
657
  if @api_client.config.debugging
658
658
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_emails ...'
659
659
  end
660
- # verify the required parameter 'inbox_id' is set
661
- if @api_client.config.client_side_validation && inbox_id.nil?
662
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_emails"
660
+ # verify the required parameter 'id_of_inbox_that_emails_belongs_to' is set
661
+ if @api_client.config.client_side_validation && id_of_inbox_that_emails_belongs_to.nil?
662
+ fail ArgumentError, "Missing the required parameter 'id_of_inbox_that_emails_belongs_to' when calling InboxControllerApi.get_emails"
663
+ end
664
+ if @api_client.config.client_side_validation && !opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'].nil? && opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'] > 100
665
+ fail ArgumentError, 'invalid value for "opts[:"alias_for_limit__assessed_first_before_assessing_any_passed_limit_"]" when calling InboxControllerApi.get_emails, must be smaller than or equal to 100.'
663
666
  end
667
+
668
+ if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
669
+ fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling InboxControllerApi.get_emails, must be smaller than or equal to 100.'
670
+ end
671
+
664
672
  allowable_values = ["ASC", "DESC"]
665
- if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
666
- fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
673
+ if @api_client.config.client_side_validation && opts[:'sort_the_results_by_received_date_and_direction_asc_or_desc'] && !allowable_values.include?(opts[:'sort_the_results_by_received_date_and_direction_asc_or_desc'])
674
+ fail ArgumentError, "invalid value for \"sort_the_results_by_received_date_and_direction_asc_or_desc\", must be one of #{allowable_values}"
667
675
  end
668
676
  # resource path
669
- local_var_path = '/inboxes/{inboxId}/emails'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
677
+ local_var_path = '/inboxes/{inboxId}/emails'.sub('{' + 'Id of inbox that emails belongs to' + '}', CGI.escape(id_of_inbox_that_emails_belongs_to.to_s))
670
678
 
671
679
  # query parameters
672
680
  query_params = opts[:query_params] || {}
673
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
674
- query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
681
+ query_params[:'Alias for limit. Assessed first before assessing any passed limit.'] = opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'] if !opts[:'alias_for_limit__assessed_first_before_assessing_any_passed_limit_'].nil?
675
682
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
676
- query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
683
+ query_params[:'Sort the results by received date and direction ASC or DESC'] = opts[:'sort_the_results_by_received_date_and_direction_asc_or_desc'] if !opts[:'sort_the_results_by_received_date_and_direction_asc_or_desc'].nil?
677
684
  query_params[:'retryTimeout'] = opts[:'retry_timeout'] if !opts[:'retry_timeout'].nil?
678
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
679
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
680
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
685
+ query_params[:'delayTimeout'] = opts[:'delay_timeout'] if !opts[:'delay_timeout'].nil?
686
+ query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
681
687
  query_params[:'unreadOnly'] = opts[:'unread_only'] if !opts[:'unread_only'].nil?
688
+ query_params[:'Exclude emails received after this ISO 8601 date time'] = opts[:'exclude_emails_received_after_this_iso_8601_date_time'] if !opts[:'exclude_emails_received_after_this_iso_8601_date_time'].nil?
689
+ query_params[:'Exclude emails received before this ISO 8601 date time'] = opts[:'exclude_emails_received_before_this_iso_8601_date_time'] if !opts[:'exclude_emails_received_before_this_iso_8601_date_time'].nil?
682
690
 
683
691
  # header parameters
684
692
  header_params = opts[:header_params] || {}
685
693
  # HTTP header 'Accept' (if needed)
686
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
694
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
687
695
 
688
696
  # form parameters
689
697
  form_params = opts[:form_params] || {}
@@ -715,9 +723,9 @@ module MailSlurpClient
715
723
 
716
724
  # Get Inbox. Returns properties of an inbox.
717
725
  # Returns an inbox's properties, including its email address and ID.
718
- # @param inbox_id [String] inboxId
726
+ # @param inbox_id [String]
719
727
  # @param [Hash] opts the optional parameters
720
- # @return [Inbox]
728
+ # @return [InboxDto]
721
729
  def get_inbox(inbox_id, opts = {})
722
730
  data, _status_code, _headers = get_inbox_with_http_info(inbox_id, opts)
723
731
  data
@@ -725,9 +733,9 @@ module MailSlurpClient
725
733
 
726
734
  # Get Inbox. Returns properties of an inbox.
727
735
  # Returns an inbox&#39;s properties, including its email address and ID.
728
- # @param inbox_id [String] inboxId
736
+ # @param inbox_id [String]
729
737
  # @param [Hash] opts the optional parameters
730
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
738
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
731
739
  def get_inbox_with_http_info(inbox_id, opts = {})
732
740
  if @api_client.config.debugging
733
741
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox ...'
@@ -745,7 +753,7 @@ module MailSlurpClient
745
753
  # header parameters
746
754
  header_params = opts[:header_params] || {}
747
755
  # HTTP header 'Accept' (if needed)
748
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
756
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
749
757
 
750
758
  # form parameters
751
759
  form_params = opts[:form_params] || {}
@@ -754,7 +762,7 @@ module MailSlurpClient
754
762
  post_body = opts[:body]
755
763
 
756
764
  # return_type
757
- return_type = opts[:return_type] || 'Inbox'
765
+ return_type = opts[:return_type] || 'InboxDto'
758
766
 
759
767
  # auth_names
760
768
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -799,7 +807,7 @@ module MailSlurpClient
799
807
  # header parameters
800
808
  header_params = opts[:header_params] || {}
801
809
  # HTTP header 'Accept' (if needed)
802
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
810
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
803
811
 
804
812
  # form parameters
805
813
  form_params = opts[:form_params] || {}
@@ -830,28 +838,28 @@ module MailSlurpClient
830
838
  end
831
839
 
832
840
  # Get email count in inbox
833
- # @param inbox_id [String] Id of inbox that emails belongs to
841
+ # @param id_of_inbox_that_emails_belongs_to [String]
834
842
  # @param [Hash] opts the optional parameters
835
843
  # @return [CountDto]
836
- def get_inbox_email_count(inbox_id, opts = {})
837
- data, _status_code, _headers = get_inbox_email_count_with_http_info(inbox_id, opts)
844
+ def get_inbox_email_count(id_of_inbox_that_emails_belongs_to, opts = {})
845
+ data, _status_code, _headers = get_inbox_email_count_with_http_info(id_of_inbox_that_emails_belongs_to, opts)
838
846
  data
839
847
  end
840
848
 
841
849
  # Get email count in inbox
842
- # @param inbox_id [String] Id of inbox that emails belongs to
850
+ # @param id_of_inbox_that_emails_belongs_to [String]
843
851
  # @param [Hash] opts the optional parameters
844
852
  # @return [Array<(CountDto, Integer, Hash)>] CountDto data, response status code and response headers
845
- def get_inbox_email_count_with_http_info(inbox_id, opts = {})
853
+ def get_inbox_email_count_with_http_info(id_of_inbox_that_emails_belongs_to, opts = {})
846
854
  if @api_client.config.debugging
847
855
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_email_count ...'
848
856
  end
849
- # verify the required parameter 'inbox_id' is set
850
- if @api_client.config.client_side_validation && inbox_id.nil?
851
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_email_count"
857
+ # verify the required parameter 'id_of_inbox_that_emails_belongs_to' is set
858
+ if @api_client.config.client_side_validation && id_of_inbox_that_emails_belongs_to.nil?
859
+ fail ArgumentError, "Missing the required parameter 'id_of_inbox_that_emails_belongs_to' when calling InboxControllerApi.get_inbox_email_count"
852
860
  end
853
861
  # resource path
854
- local_var_path = '/inboxes/{inboxId}/emails/count'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
862
+ local_var_path = '/inboxes/{inboxId}/emails/count'.sub('{' + 'Id of inbox that emails belongs to' + '}', CGI.escape(id_of_inbox_that_emails_belongs_to.to_s))
855
863
 
856
864
  # query parameters
857
865
  query_params = opts[:query_params] || {}
@@ -859,7 +867,7 @@ module MailSlurpClient
859
867
  # header parameters
860
868
  header_params = opts[:header_params] || {}
861
869
  # HTTP header 'Accept' (if needed)
862
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
870
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
863
871
 
864
872
  # form parameters
865
873
  form_params = opts[:form_params] || {}
@@ -891,56 +899,56 @@ module MailSlurpClient
891
899
 
892
900
  # Get inbox emails paginated
893
901
  # Get a paginated list of emails in an inbox. Does not hold connections open.
894
- # @param inbox_id [String] Id of inbox that emails belongs to
902
+ # @param id_of_inbox_that_emails_belongs_to [String]
895
903
  # @param [Hash] opts the optional parameters
896
- # @option opts [DateTime] :before Optional filter by received before given date time
897
904
  # @option opts [Integer] :page Optional page index in inbox emails list pagination (default to 0)
898
- # @option opts [DateTime] :since Optional filter by received after given date time
899
905
  # @option opts [Integer] :size Optional page size in inbox emails list pagination (default to 20)
900
906
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
907
+ # @option opts [DateTime] :since Optional filter by received after given date time
908
+ # @option opts [DateTime] :before Optional filter by received before given date time
901
909
  # @return [PageEmailPreview]
902
- def get_inbox_emails_paginated(inbox_id, opts = {})
903
- data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(inbox_id, opts)
910
+ def get_inbox_emails_paginated(id_of_inbox_that_emails_belongs_to, opts = {})
911
+ data, _status_code, _headers = get_inbox_emails_paginated_with_http_info(id_of_inbox_that_emails_belongs_to, opts)
904
912
  data
905
913
  end
906
914
 
907
915
  # Get inbox emails paginated
908
916
  # Get a paginated list of emails in an inbox. Does not hold connections open.
909
- # @param inbox_id [String] Id of inbox that emails belongs to
917
+ # @param id_of_inbox_that_emails_belongs_to [String]
910
918
  # @param [Hash] opts the optional parameters
911
- # @option opts [DateTime] :before Optional filter by received before given date time
912
919
  # @option opts [Integer] :page Optional page index in inbox emails list pagination
913
- # @option opts [DateTime] :since Optional filter by received after given date time
914
920
  # @option opts [Integer] :size Optional page size in inbox emails list pagination
915
921
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
922
+ # @option opts [DateTime] :since Optional filter by received after given date time
923
+ # @option opts [DateTime] :before Optional filter by received before given date time
916
924
  # @return [Array<(PageEmailPreview, Integer, Hash)>] PageEmailPreview data, response status code and response headers
917
- def get_inbox_emails_paginated_with_http_info(inbox_id, opts = {})
925
+ def get_inbox_emails_paginated_with_http_info(id_of_inbox_that_emails_belongs_to, opts = {})
918
926
  if @api_client.config.debugging
919
927
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inbox_emails_paginated ...'
920
928
  end
921
- # verify the required parameter 'inbox_id' is set
922
- if @api_client.config.client_side_validation && inbox_id.nil?
923
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.get_inbox_emails_paginated"
929
+ # verify the required parameter 'id_of_inbox_that_emails_belongs_to' is set
930
+ if @api_client.config.client_side_validation && id_of_inbox_that_emails_belongs_to.nil?
931
+ fail ArgumentError, "Missing the required parameter 'id_of_inbox_that_emails_belongs_to' when calling InboxControllerApi.get_inbox_emails_paginated"
924
932
  end
925
933
  allowable_values = ["ASC", "DESC"]
926
934
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
927
935
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
928
936
  end
929
937
  # resource path
930
- local_var_path = '/inboxes/{inboxId}/emails/paginated'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
938
+ local_var_path = '/inboxes/{inboxId}/emails/paginated'.sub('{' + 'Id of inbox that emails belongs to' + '}', CGI.escape(id_of_inbox_that_emails_belongs_to.to_s))
931
939
 
932
940
  # query parameters
933
941
  query_params = opts[:query_params] || {}
934
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
935
942
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
936
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
937
943
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
938
944
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
945
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
946
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
939
947
 
940
948
  # header parameters
941
949
  header_params = opts[:header_params] || {}
942
950
  # HTTP header 'Accept' (if needed)
943
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
951
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
944
952
 
945
953
  # form parameters
946
954
  form_params = opts[:form_params] || {}
@@ -972,14 +980,14 @@ module MailSlurpClient
972
980
 
973
981
  # Get Inbox Sent Emails
974
982
  # Returns an inbox's sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
975
- # @param inbox_id [String] inboxId
983
+ # @param inbox_id [String]
976
984
  # @param [Hash] opts the optional parameters
977
- # @option opts [DateTime] :before Optional filter by sent before given date time
978
985
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
986
+ # @option opts [Integer] :optional_page_size_in_inbox_sent_email_list_pagination (default to 20)
987
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
979
988
  # @option opts [String] :search_filter Optional sent email search
980
989
  # @option opts [DateTime] :since Optional filter by sent after given date time
981
- # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
982
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
990
+ # @option opts [DateTime] :before Optional filter by sent before given date time
983
991
  # @return [PageSentEmailProjection]
984
992
  def get_inbox_sent_emails(inbox_id, opts = {})
985
993
  data, _status_code, _headers = get_inbox_sent_emails_with_http_info(inbox_id, opts)
@@ -988,14 +996,14 @@ module MailSlurpClient
988
996
 
989
997
  # Get Inbox Sent Emails
990
998
  # Returns an inbox&#39;s sent email receipts. Call individual sent email endpoints for more details. Note for privacy reasons the full body of sent emails is never stored. An MD5 hash hex is available for comparison instead.
991
- # @param inbox_id [String] inboxId
999
+ # @param inbox_id [String]
992
1000
  # @param [Hash] opts the optional parameters
993
- # @option opts [DateTime] :before Optional filter by sent before given date time
994
1001
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
1002
+ # @option opts [Integer] :optional_page_size_in_inbox_sent_email_list_pagination
1003
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
995
1004
  # @option opts [String] :search_filter Optional sent email search
996
1005
  # @option opts [DateTime] :since Optional filter by sent after given date time
997
- # @option opts [Integer] :size Optional page size in inbox sent email list pagination
998
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1006
+ # @option opts [DateTime] :before Optional filter by sent before given date time
999
1007
  # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
1000
1008
  def get_inbox_sent_emails_with_http_info(inbox_id, opts = {})
1001
1009
  if @api_client.config.debugging
@@ -1014,17 +1022,17 @@ module MailSlurpClient
1014
1022
 
1015
1023
  # query parameters
1016
1024
  query_params = opts[:query_params] || {}
1017
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1018
1025
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1026
+ query_params[:'Optional page size in inbox sent email list pagination'] = opts[:'optional_page_size_in_inbox_sent_email_list_pagination'] if !opts[:'optional_page_size_in_inbox_sent_email_list_pagination'].nil?
1027
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1019
1028
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1020
1029
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1021
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1022
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1030
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1023
1031
 
1024
1032
  # header parameters
1025
1033
  header_params = opts[:header_params] || {}
1026
1034
  # HTTP header 'Accept' (if needed)
1027
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1035
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1028
1036
 
1029
1037
  # form parameters
1030
1038
  form_params = opts[:form_params] || {}
@@ -1080,7 +1088,7 @@ module MailSlurpClient
1080
1088
  # header parameters
1081
1089
  header_params = opts[:header_params] || {}
1082
1090
  # HTTP header 'Accept' (if needed)
1083
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1091
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1084
1092
 
1085
1093
  # form parameters
1086
1094
  form_params = opts[:form_params] || {}
@@ -1113,11 +1121,11 @@ module MailSlurpClient
1113
1121
  # List Inboxes and email addresses
1114
1122
  # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended and allows paginated access using a limit and sort parameter.
1115
1123
  # @param [Hash] opts the optional parameters
1116
- # @option opts [DateTime] :before Optional filter by created before given date time
1117
- # @option opts [DateTime] :since Optional filter by created after given date time
1118
1124
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
1119
1125
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1120
- # @return [Array<Inbox>]
1126
+ # @option opts [DateTime] :since Optional filter by created after given date time
1127
+ # @option opts [DateTime] :before Optional filter by created before given date time
1128
+ # @return [Array<InboxDto>]
1121
1129
  def get_inboxes(opts = {})
1122
1130
  data, _status_code, _headers = get_inboxes_with_http_info(opts)
1123
1131
  data
@@ -1126,15 +1134,19 @@ module MailSlurpClient
1126
1134
  # List Inboxes and email addresses
1127
1135
  # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended and allows paginated access using a limit and sort parameter.
1128
1136
  # @param [Hash] opts the optional parameters
1129
- # @option opts [DateTime] :before Optional filter by created before given date time
1130
- # @option opts [DateTime] :since Optional filter by created after given date time
1131
1137
  # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
1132
1138
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1133
- # @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
1139
+ # @option opts [DateTime] :since Optional filter by created after given date time
1140
+ # @option opts [DateTime] :before Optional filter by created before given date time
1141
+ # @return [Array<(Array<InboxDto>, Integer, Hash)>] Array<InboxDto> data, response status code and response headers
1134
1142
  def get_inboxes_with_http_info(opts = {})
1135
1143
  if @api_client.config.debugging
1136
1144
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
1137
1145
  end
1146
+ if @api_client.config.client_side_validation && !opts[:'size'].nil? && opts[:'size'] > 100
1147
+ fail ArgumentError, 'invalid value for "opts[:"size"]" when calling InboxControllerApi.get_inboxes, must be smaller than or equal to 100.'
1148
+ end
1149
+
1138
1150
  allowable_values = ["ASC", "DESC"]
1139
1151
  if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
1140
1152
  fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
@@ -1144,15 +1156,15 @@ module MailSlurpClient
1144
1156
 
1145
1157
  # query parameters
1146
1158
  query_params = opts[:query_params] || {}
1147
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1148
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1149
1159
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1150
1160
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1161
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1162
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1151
1163
 
1152
1164
  # header parameters
1153
1165
  header_params = opts[:header_params] || {}
1154
1166
  # HTTP header 'Accept' (if needed)
1155
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1167
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1156
1168
 
1157
1169
  # form parameters
1158
1170
  form_params = opts[:form_params] || {}
@@ -1161,7 +1173,7 @@ module MailSlurpClient
1161
1173
  post_body = opts[:body]
1162
1174
 
1163
1175
  # return_type
1164
- return_type = opts[:return_type] || 'Array<Inbox>'
1176
+ return_type = opts[:return_type] || 'Array<InboxDto>'
1165
1177
 
1166
1178
  # auth_names
1167
1179
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -1185,12 +1197,12 @@ module MailSlurpClient
1185
1197
  # List Organization Inboxes Paginated
1186
1198
  # List organization inboxes in paginated form. These are inboxes created with `allowTeamAccess` flag enabled. Organization inboxes are `readOnly` for non-admin users. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
1187
1199
  # @param [Hash] opts the optional parameters
1188
- # @option opts [DateTime] :before Optional filter by created before given date time
1189
1200
  # @option opts [Integer] :page Optional page index in list pagination (default to 0)
1190
- # @option opts [String] :search_filter Optional search filter
1191
- # @option opts [DateTime] :since Optional filter by created after given date time
1192
1201
  # @option opts [Integer] :size Optional page size in list pagination (default to 20)
1193
1202
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1203
+ # @option opts [String] :search_filter Optional search filter
1204
+ # @option opts [DateTime] :since Optional filter by created after given date time
1205
+ # @option opts [DateTime] :before Optional filter by created before given date time
1194
1206
  # @return [PageOrganizationInboxProjection]
1195
1207
  def get_organization_inboxes(opts = {})
1196
1208
  data, _status_code, _headers = get_organization_inboxes_with_http_info(opts)
@@ -1200,12 +1212,12 @@ module MailSlurpClient
1200
1212
  # List Organization Inboxes Paginated
1201
1213
  # List organization inboxes in paginated form. These are inboxes created with &#x60;allowTeamAccess&#x60; flag enabled. Organization inboxes are &#x60;readOnly&#x60; for non-admin users. The results are available on the &#x60;content&#x60; property of the returned object. This method allows for page index (zero based), page size (how many results to return), and a sort direction (based on createdAt time).
1202
1214
  # @param [Hash] opts the optional parameters
1203
- # @option opts [DateTime] :before Optional filter by created before given date time
1204
1215
  # @option opts [Integer] :page Optional page index in list pagination
1205
- # @option opts [String] :search_filter Optional search filter
1206
- # @option opts [DateTime] :since Optional filter by created after given date time
1207
1216
  # @option opts [Integer] :size Optional page size in list pagination
1208
1217
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1218
+ # @option opts [String] :search_filter Optional search filter
1219
+ # @option opts [DateTime] :since Optional filter by created after given date time
1220
+ # @option opts [DateTime] :before Optional filter by created before given date time
1209
1221
  # @return [Array<(PageOrganizationInboxProjection, Integer, Hash)>] PageOrganizationInboxProjection data, response status code and response headers
1210
1222
  def get_organization_inboxes_with_http_info(opts = {})
1211
1223
  if @api_client.config.debugging
@@ -1220,17 +1232,17 @@ module MailSlurpClient
1220
1232
 
1221
1233
  # query parameters
1222
1234
  query_params = opts[:query_params] || {}
1223
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1224
1235
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1225
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1226
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1227
1236
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1228
1237
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1238
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1239
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1240
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1229
1241
 
1230
1242
  # header parameters
1231
1243
  header_params = opts[:header_params] || {}
1232
1244
  # HTTP header 'Accept' (if needed)
1233
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1245
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1234
1246
 
1235
1247
  # form parameters
1236
1248
  form_params = opts[:form_params] || {}
@@ -1262,14 +1274,14 @@ module MailSlurpClient
1262
1274
 
1263
1275
  # List inbox rulesets
1264
1276
  # List all rulesets attached to an inbox
1265
- # @param inbox_id [String] inboxId
1277
+ # @param inbox_id [String]
1266
1278
  # @param [Hash] opts the optional parameters
1267
- # @option opts [DateTime] :before Optional filter by created before given date time
1268
1279
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination (default to 0)
1269
- # @option opts [String] :search_filter Optional search filter
1270
- # @option opts [DateTime] :since Optional filter by created after given date time
1271
1280
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination (default to 20)
1272
1281
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1282
+ # @option opts [String] :search_filter Optional search filter
1283
+ # @option opts [DateTime] :since Optional filter by created after given date time
1284
+ # @option opts [DateTime] :before Optional filter by created before given date time
1273
1285
  # @return [PageInboxRulesetDto]
1274
1286
  def list_inbox_rulesets(inbox_id, opts = {})
1275
1287
  data, _status_code, _headers = list_inbox_rulesets_with_http_info(inbox_id, opts)
@@ -1278,14 +1290,14 @@ module MailSlurpClient
1278
1290
 
1279
1291
  # List inbox rulesets
1280
1292
  # List all rulesets attached to an inbox
1281
- # @param inbox_id [String] inboxId
1293
+ # @param inbox_id [String]
1282
1294
  # @param [Hash] opts the optional parameters
1283
- # @option opts [DateTime] :before Optional filter by created before given date time
1284
1295
  # @option opts [Integer] :page Optional page index in inbox ruleset list pagination
1285
- # @option opts [String] :search_filter Optional search filter
1286
- # @option opts [DateTime] :since Optional filter by created after given date time
1287
1296
  # @option opts [Integer] :size Optional page size in inbox ruleset list pagination
1288
1297
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1298
+ # @option opts [String] :search_filter Optional search filter
1299
+ # @option opts [DateTime] :since Optional filter by created after given date time
1300
+ # @option opts [DateTime] :before Optional filter by created before given date time
1289
1301
  # @return [Array<(PageInboxRulesetDto, Integer, Hash)>] PageInboxRulesetDto data, response status code and response headers
1290
1302
  def list_inbox_rulesets_with_http_info(inbox_id, opts = {})
1291
1303
  if @api_client.config.debugging
@@ -1304,17 +1316,17 @@ module MailSlurpClient
1304
1316
 
1305
1317
  # query parameters
1306
1318
  query_params = opts[:query_params] || {}
1307
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1308
1319
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1309
- query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1310
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1311
1320
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1312
1321
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1322
+ query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1323
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1324
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1313
1325
 
1314
1326
  # header parameters
1315
1327
  header_params = opts[:header_params] || {}
1316
1328
  # HTTP header 'Accept' (if needed)
1317
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1329
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1318
1330
 
1319
1331
  # form parameters
1320
1332
  form_params = opts[:form_params] || {}
@@ -1346,14 +1358,14 @@ module MailSlurpClient
1346
1358
 
1347
1359
  # List inbox tracking pixels
1348
1360
  # List all tracking pixels sent from an inbox
1349
- # @param inbox_id [String] inboxId
1361
+ # @param inbox_id [String]
1350
1362
  # @param [Hash] opts the optional parameters
1351
- # @option opts [DateTime] :before Optional filter by created before given date time
1352
1363
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination (default to 0)
1364
+ # @option opts [Integer] :optional_page_size_in_inbox_tracking_pixel_list_pagination (default to 20)
1365
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1353
1366
  # @option opts [String] :search_filter Optional search filter
1354
1367
  # @option opts [DateTime] :since Optional filter by created after given date time
1355
- # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination (default to 20)
1356
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
1368
+ # @option opts [DateTime] :before Optional filter by created before given date time
1357
1369
  # @return [PageTrackingPixelProjection]
1358
1370
  def list_inbox_tracking_pixels(inbox_id, opts = {})
1359
1371
  data, _status_code, _headers = list_inbox_tracking_pixels_with_http_info(inbox_id, opts)
@@ -1362,14 +1374,14 @@ module MailSlurpClient
1362
1374
 
1363
1375
  # List inbox tracking pixels
1364
1376
  # List all tracking pixels sent from an inbox
1365
- # @param inbox_id [String] inboxId
1377
+ # @param inbox_id [String]
1366
1378
  # @param [Hash] opts the optional parameters
1367
- # @option opts [DateTime] :before Optional filter by created before given date time
1368
1379
  # @option opts [Integer] :page Optional page index in inbox tracking pixel list pagination
1380
+ # @option opts [Integer] :optional_page_size_in_inbox_tracking_pixel_list_pagination
1381
+ # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1369
1382
  # @option opts [String] :search_filter Optional search filter
1370
1383
  # @option opts [DateTime] :since Optional filter by created after given date time
1371
- # @option opts [Integer] :size Optional page size in inbox tracking pixel list pagination
1372
- # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
1384
+ # @option opts [DateTime] :before Optional filter by created before given date time
1373
1385
  # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
1374
1386
  def list_inbox_tracking_pixels_with_http_info(inbox_id, opts = {})
1375
1387
  if @api_client.config.debugging
@@ -1388,17 +1400,17 @@ module MailSlurpClient
1388
1400
 
1389
1401
  # query parameters
1390
1402
  query_params = opts[:query_params] || {}
1391
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1392
1403
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
1404
+ query_params[:'Optional page size in inbox tracking pixel list pagination'] = opts[:'optional_page_size_in_inbox_tracking_pixel_list_pagination'] if !opts[:'optional_page_size_in_inbox_tracking_pixel_list_pagination'].nil?
1405
+ query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1393
1406
  query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
1394
1407
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
1395
- query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
1396
- query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
1408
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
1397
1409
 
1398
1410
  # header parameters
1399
1411
  header_params = opts[:header_params] || {}
1400
1412
  # HTTP header 'Accept' (if needed)
1401
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1413
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1402
1414
 
1403
1415
  # form parameters
1404
1416
  form_params = opts[:form_params] || {}
@@ -1430,31 +1442,35 @@ module MailSlurpClient
1430
1442
 
1431
1443
  # Send Email
1432
1444
  # Send an email from an inbox's email address. The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
1433
- # @param inbox_id [String] ID of the inbox you want to send the email from
1445
+ # @param id_of_the_inbox_you_want_to_send_the_email_from [String]
1446
+ # @param send_email_options [SendEmailOptions]
1434
1447
  # @param [Hash] opts the optional parameters
1435
- # @option opts [SendEmailOptions] :send_email_options Options for the email
1436
1448
  # @return [nil]
1437
- def send_email(inbox_id, opts = {})
1438
- send_email_with_http_info(inbox_id, opts)
1449
+ def send_email(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts = {})
1450
+ send_email_with_http_info(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts)
1439
1451
  nil
1440
1452
  end
1441
1453
 
1442
1454
  # Send Email
1443
1455
  # Send an email from an inbox&#39;s email address. The request body should contain the &#x60;SendEmailOptions&#x60; that include recipients, attachments, body etc. See &#x60;SendEmailOptions&#x60; for all available properties. Note the &#x60;inboxId&#x60; refers to the inbox&#39;s id not the inbox&#39;s email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method &#x60;sendEmailAndConfirm&#x60;.
1444
- # @param inbox_id [String] ID of the inbox you want to send the email from
1456
+ # @param id_of_the_inbox_you_want_to_send_the_email_from [String]
1457
+ # @param send_email_options [SendEmailOptions]
1445
1458
  # @param [Hash] opts the optional parameters
1446
- # @option opts [SendEmailOptions] :send_email_options Options for the email
1447
1459
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1448
- def send_email_with_http_info(inbox_id, opts = {})
1460
+ def send_email_with_http_info(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts = {})
1449
1461
  if @api_client.config.debugging
1450
1462
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email ...'
1451
1463
  end
1452
- # verify the required parameter 'inbox_id' is set
1453
- if @api_client.config.client_side_validation && inbox_id.nil?
1454
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email"
1464
+ # verify the required parameter 'id_of_the_inbox_you_want_to_send_the_email_from' is set
1465
+ if @api_client.config.client_side_validation && id_of_the_inbox_you_want_to_send_the_email_from.nil?
1466
+ fail ArgumentError, "Missing the required parameter 'id_of_the_inbox_you_want_to_send_the_email_from' when calling InboxControllerApi.send_email"
1467
+ end
1468
+ # verify the required parameter 'send_email_options' is set
1469
+ if @api_client.config.client_side_validation && send_email_options.nil?
1470
+ fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email"
1455
1471
  end
1456
1472
  # resource path
1457
- local_var_path = '/inboxes/{inboxId}'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
1473
+ local_var_path = '/inboxes/{inboxId}'.sub('{' + 'ID of the inbox you want to send the email from' + '}', CGI.escape(id_of_the_inbox_you_want_to_send_the_email_from.to_s))
1458
1474
 
1459
1475
  # query parameters
1460
1476
  query_params = opts[:query_params] || {}
@@ -1468,7 +1484,7 @@ module MailSlurpClient
1468
1484
  form_params = opts[:form_params] || {}
1469
1485
 
1470
1486
  # http body (model)
1471
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'send_email_options'])
1487
+ post_body = opts[:body] || @api_client.object_to_http_body(send_email_options)
1472
1488
 
1473
1489
  # return_type
1474
1490
  return_type = opts[:return_type]
@@ -1494,31 +1510,35 @@ module MailSlurpClient
1494
1510
 
1495
1511
  # Send email and return sent confirmation
1496
1512
  # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with a link to the sent object created for it.
1497
- # @param inbox_id [String] ID of the inbox you want to send the email from
1513
+ # @param id_of_the_inbox_you_want_to_send_the_email_from [String]
1514
+ # @param send_email_options [SendEmailOptions]
1498
1515
  # @param [Hash] opts the optional parameters
1499
- # @option opts [SendEmailOptions] :send_email_options Options for the email
1500
1516
  # @return [SentEmailDto]
1501
- def send_email_and_confirm(inbox_id, opts = {})
1502
- data, _status_code, _headers = send_email_and_confirm_with_http_info(inbox_id, opts)
1517
+ def send_email_and_confirm(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts = {})
1518
+ data, _status_code, _headers = send_email_and_confirm_with_http_info(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts)
1503
1519
  data
1504
1520
  end
1505
1521
 
1506
1522
  # Send email and return sent confirmation
1507
1523
  # Sister method for standard &#x60;sendEmail&#x60; method with the benefit of returning a &#x60;SentEmail&#x60; entity confirming the successful sending of the email with a link to the sent object created for it.
1508
- # @param inbox_id [String] ID of the inbox you want to send the email from
1524
+ # @param id_of_the_inbox_you_want_to_send_the_email_from [String]
1525
+ # @param send_email_options [SendEmailOptions]
1509
1526
  # @param [Hash] opts the optional parameters
1510
- # @option opts [SendEmailOptions] :send_email_options Options for the email
1511
1527
  # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
1512
- def send_email_and_confirm_with_http_info(inbox_id, opts = {})
1528
+ def send_email_and_confirm_with_http_info(id_of_the_inbox_you_want_to_send_the_email_from, send_email_options, opts = {})
1513
1529
  if @api_client.config.debugging
1514
1530
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_and_confirm ...'
1515
1531
  end
1516
- # verify the required parameter 'inbox_id' is set
1517
- if @api_client.config.client_side_validation && inbox_id.nil?
1518
- fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email_and_confirm"
1532
+ # verify the required parameter 'id_of_the_inbox_you_want_to_send_the_email_from' is set
1533
+ if @api_client.config.client_side_validation && id_of_the_inbox_you_want_to_send_the_email_from.nil?
1534
+ fail ArgumentError, "Missing the required parameter 'id_of_the_inbox_you_want_to_send_the_email_from' when calling InboxControllerApi.send_email_and_confirm"
1535
+ end
1536
+ # verify the required parameter 'send_email_options' is set
1537
+ if @api_client.config.client_side_validation && send_email_options.nil?
1538
+ fail ArgumentError, "Missing the required parameter 'send_email_options' when calling InboxControllerApi.send_email_and_confirm"
1519
1539
  end
1520
1540
  # resource path
1521
- local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
1541
+ local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + 'ID of the inbox you want to send the email from' + '}', CGI.escape(id_of_the_inbox_you_want_to_send_the_email_from.to_s))
1522
1542
 
1523
1543
  # query parameters
1524
1544
  query_params = opts[:query_params] || {}
@@ -1526,7 +1546,7 @@ module MailSlurpClient
1526
1546
  # header parameters
1527
1547
  header_params = opts[:header_params] || {}
1528
1548
  # HTTP header 'Accept' (if needed)
1529
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1549
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1530
1550
  # HTTP header 'Content-Type'
1531
1551
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1532
1552
 
@@ -1534,7 +1554,7 @@ module MailSlurpClient
1534
1554
  form_params = opts[:form_params] || {}
1535
1555
 
1536
1556
  # http body (model)
1537
- post_body = opts[:body] || @api_client.object_to_http_body(opts[:'send_email_options'])
1557
+ post_body = opts[:body] || @api_client.object_to_http_body(send_email_options)
1538
1558
 
1539
1559
  # return_type
1540
1560
  return_type = opts[:return_type] || 'SentEmailDto'
@@ -1560,7 +1580,7 @@ module MailSlurpClient
1560
1580
 
1561
1581
  # Send a test email to inbox
1562
1582
  # Send an inbox a test email to test email receiving is working
1563
- # @param inbox_id [String] inboxId
1583
+ # @param inbox_id [String]
1564
1584
  # @param [Hash] opts the optional parameters
1565
1585
  # @return [nil]
1566
1586
  def send_test_email(inbox_id, opts = {})
@@ -1570,7 +1590,7 @@ module MailSlurpClient
1570
1590
 
1571
1591
  # Send a test email to inbox
1572
1592
  # Send an inbox a test email to test email receiving is working
1573
- # @param inbox_id [String] inboxId
1593
+ # @param inbox_id [String]
1574
1594
  # @param [Hash] opts the optional parameters
1575
1595
  # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1576
1596
  def send_test_email_with_http_info(inbox_id, opts = {})
@@ -1620,10 +1640,10 @@ module MailSlurpClient
1620
1640
 
1621
1641
  # Set inbox favourited state
1622
1642
  # Set and return new favourite state for an inbox
1623
- # @param inbox_id [String] inboxId
1624
- # @param set_inbox_favourited_options [SetInboxFavouritedOptions] setInboxFavouritedOptions
1643
+ # @param inbox_id [String]
1644
+ # @param set_inbox_favourited_options [SetInboxFavouritedOptions]
1625
1645
  # @param [Hash] opts the optional parameters
1626
- # @return [Inbox]
1646
+ # @return [InboxDto]
1627
1647
  def set_inbox_favourited(inbox_id, set_inbox_favourited_options, opts = {})
1628
1648
  data, _status_code, _headers = set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, opts)
1629
1649
  data
@@ -1631,10 +1651,10 @@ module MailSlurpClient
1631
1651
 
1632
1652
  # Set inbox favourited state
1633
1653
  # Set and return new favourite state for an inbox
1634
- # @param inbox_id [String] inboxId
1635
- # @param set_inbox_favourited_options [SetInboxFavouritedOptions] setInboxFavouritedOptions
1654
+ # @param inbox_id [String]
1655
+ # @param set_inbox_favourited_options [SetInboxFavouritedOptions]
1636
1656
  # @param [Hash] opts the optional parameters
1637
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
1657
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
1638
1658
  def set_inbox_favourited_with_http_info(inbox_id, set_inbox_favourited_options, opts = {})
1639
1659
  if @api_client.config.debugging
1640
1660
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.set_inbox_favourited ...'
@@ -1656,7 +1676,7 @@ module MailSlurpClient
1656
1676
  # header parameters
1657
1677
  header_params = opts[:header_params] || {}
1658
1678
  # HTTP header 'Accept' (if needed)
1659
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1679
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1660
1680
  # HTTP header 'Content-Type'
1661
1681
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1662
1682
 
@@ -1667,7 +1687,7 @@ module MailSlurpClient
1667
1687
  post_body = opts[:body] || @api_client.object_to_http_body(set_inbox_favourited_options)
1668
1688
 
1669
1689
  # return_type
1670
- return_type = opts[:return_type] || 'Inbox'
1690
+ return_type = opts[:return_type] || 'InboxDto'
1671
1691
 
1672
1692
  # auth_names
1673
1693
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -1690,10 +1710,10 @@ module MailSlurpClient
1690
1710
 
1691
1711
  # Update Inbox. Change name and description. Email address is not editable.
1692
1712
  # Update editable fields on an inbox
1693
- # @param inbox_id [String] inboxId
1694
- # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
1713
+ # @param inbox_id [String]
1714
+ # @param update_inbox_options [UpdateInboxOptions]
1695
1715
  # @param [Hash] opts the optional parameters
1696
- # @return [Inbox]
1716
+ # @return [InboxDto]
1697
1717
  def update_inbox(inbox_id, update_inbox_options, opts = {})
1698
1718
  data, _status_code, _headers = update_inbox_with_http_info(inbox_id, update_inbox_options, opts)
1699
1719
  data
@@ -1701,10 +1721,10 @@ module MailSlurpClient
1701
1721
 
1702
1722
  # Update Inbox. Change name and description. Email address is not editable.
1703
1723
  # Update editable fields on an inbox
1704
- # @param inbox_id [String] inboxId
1705
- # @param update_inbox_options [UpdateInboxOptions] updateInboxOptions
1724
+ # @param inbox_id [String]
1725
+ # @param update_inbox_options [UpdateInboxOptions]
1706
1726
  # @param [Hash] opts the optional parameters
1707
- # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
1727
+ # @return [Array<(InboxDto, Integer, Hash)>] InboxDto data, response status code and response headers
1708
1728
  def update_inbox_with_http_info(inbox_id, update_inbox_options, opts = {})
1709
1729
  if @api_client.config.debugging
1710
1730
  @api_client.config.logger.debug 'Calling API: InboxControllerApi.update_inbox ...'
@@ -1726,7 +1746,7 @@ module MailSlurpClient
1726
1746
  # header parameters
1727
1747
  header_params = opts[:header_params] || {}
1728
1748
  # HTTP header 'Accept' (if needed)
1729
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1749
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
1730
1750
  # HTTP header 'Content-Type'
1731
1751
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1732
1752
 
@@ -1737,7 +1757,7 @@ module MailSlurpClient
1737
1757
  post_body = opts[:body] || @api_client.object_to_http_body(update_inbox_options)
1738
1758
 
1739
1759
  # return_type
1740
- return_type = opts[:return_type] || 'Inbox'
1760
+ return_type = opts[:return_type] || 'InboxDto'
1741
1761
 
1742
1762
  # auth_names
1743
1763
  auth_names = opts[:auth_names] || ['API_KEY']