mailslurp_client 15.0.1 → 15.0.5

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 +190 -116
  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 +359 -225
  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 +206 -0
  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 +3 -1
  158. metadata +5 -3
@@ -45,7 +45,7 @@ module MailSlurpClient
45
45
  # header parameters
46
46
  header_params = opts[:header_params] || {}
47
47
  # HTTP header 'Accept' (if needed)
48
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
48
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
49
49
 
50
50
  # form parameters
51
51
  form_params = opts[:form_params] || {}
@@ -107,7 +107,7 @@ module MailSlurpClient
107
107
  # header parameters
108
108
  header_params = opts[:header_params] || {}
109
109
  # HTTP header 'Accept' (if needed)
110
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
110
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
111
111
 
112
112
  # form parameters
113
113
  form_params = opts[:form_params] || {}
@@ -139,29 +139,29 @@ module MailSlurpClient
139
139
 
140
140
  # Get an expired inbox record
141
141
  # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
142
- # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
142
+ # @param id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id [String]
143
143
  # @param [Hash] opts the optional parameters
144
144
  # @return [ExpiredInboxDto]
145
- def get_expired_inbox_record(expired_id, opts = {})
146
- data, _status_code, _headers = get_expired_inbox_record_with_http_info(expired_id, opts)
145
+ def get_expired_inbox_record(id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id, opts = {})
146
+ data, _status_code, _headers = get_expired_inbox_record_with_http_info(id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id, opts)
147
147
  data
148
148
  end
149
149
 
150
150
  # Get an expired inbox record
151
151
  # Inboxes created with an expiration date will expire after the given date and be moved to an ExpiredInbox entity. You can still read emails in the inbox but it can no longer send or receive emails. Fetch the expired inboxes to view the old inboxes properties
152
- # @param expired_id [String] ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)
152
+ # @param id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id [String]
153
153
  # @param [Hash] opts the optional parameters
154
154
  # @return [Array<(ExpiredInboxDto, Integer, Hash)>] ExpiredInboxDto data, response status code and response headers
155
- def get_expired_inbox_record_with_http_info(expired_id, opts = {})
155
+ def get_expired_inbox_record_with_http_info(id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id, opts = {})
156
156
  if @api_client.config.debugging
157
157
  @api_client.config.logger.debug 'Calling API: ExpiredControllerApi.get_expired_inbox_record ...'
158
158
  end
159
- # verify the required parameter 'expired_id' is set
160
- if @api_client.config.client_side_validation && expired_id.nil?
161
- fail ArgumentError, "Missing the required parameter 'expired_id' when calling ExpiredControllerApi.get_expired_inbox_record"
159
+ # verify the required parameter 'id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id' is set
160
+ if @api_client.config.client_side_validation && id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id.nil?
161
+ fail ArgumentError, "Missing the required parameter 'id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id' when calling ExpiredControllerApi.get_expired_inbox_record"
162
162
  end
163
163
  # resource path
164
- local_var_path = '/expired/{expiredId}'.sub('{' + 'expiredId' + '}', CGI.escape(expired_id.to_s))
164
+ local_var_path = '/expired/{expiredId}'.sub('{' + 'ID of the ExpiredInboxRecord you want to retrieve. This is different from the ID of the inbox you are interested in. See other methods for getting ExpiredInboxRecord for an inbox inboxId)' + '}', CGI.escape(id_of_the_expired_inbox_record_you_want_to_retrieve__this_is_different_from_the_id_of_the_inbox_you_are_interested_in__see_other_methods_for_getting_expired_inbox_record_for_an_inbox_inbox_id.to_s))
165
165
 
166
166
  # query parameters
167
167
  query_params = opts[:query_params] || {}
@@ -169,7 +169,7 @@ module MailSlurpClient
169
169
  # header parameters
170
170
  header_params = opts[:header_params] || {}
171
171
  # HTTP header 'Accept' (if needed)
172
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
172
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
173
173
 
174
174
  # form parameters
175
175
  form_params = opts[:form_params] || {}
@@ -202,11 +202,11 @@ module MailSlurpClient
202
202
  # List records of expired inboxes
203
203
  # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
204
204
  # @param [Hash] opts the optional parameters
205
- # @option opts [DateTime] :before Filter by created at before the given timestamp
206
205
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
207
- # @option opts [DateTime] :since Filter by created at after the given timestamp
208
206
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
209
207
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
208
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
209
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
210
210
  # @return [PageExpiredInboxRecordProjection]
211
211
  def get_expired_inboxes(opts = {})
212
212
  data, _status_code, _headers = get_expired_inboxes_with_http_info(opts)
@@ -216,11 +216,11 @@ module MailSlurpClient
216
216
  # List records of expired inboxes
217
217
  # Inboxes created with an expiration date will expire after the given date. An ExpiredInboxRecord is created that records the inboxes old ID and email address. You can still read emails in the inbox (using the inboxes old ID) but the email address associated with the inbox can no longer send or receive emails. Fetch expired inbox records to view the old inboxes properties
218
218
  # @param [Hash] opts the optional parameters
219
- # @option opts [DateTime] :before Filter by created at before the given timestamp
220
219
  # @option opts [Integer] :page Optional page index in inbox sent email list pagination
221
- # @option opts [DateTime] :since Filter by created at after the given timestamp
222
220
  # @option opts [Integer] :size Optional page size in inbox sent email list pagination
223
221
  # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
222
+ # @option opts [DateTime] :since Filter by created at after the given timestamp
223
+ # @option opts [DateTime] :before Filter by created at before the given timestamp
224
224
  # @return [Array<(PageExpiredInboxRecordProjection, Integer, Hash)>] PageExpiredInboxRecordProjection data, response status code and response headers
225
225
  def get_expired_inboxes_with_http_info(opts = {})
226
226
  if @api_client.config.debugging
@@ -235,16 +235,16 @@ module MailSlurpClient
235
235
 
236
236
  # query parameters
237
237
  query_params = opts[:query_params] || {}
238
- query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
239
238
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
240
- query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
241
239
  query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
242
240
  query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
241
+ query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
242
+ query_params[:'before'] = opts[:'before'] if !opts[:'before'].nil?
243
243
 
244
244
  # header parameters
245
245
  header_params = opts[:header_params] || {}
246
246
  # HTTP header 'Accept' (if needed)
247
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
247
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
248
248
 
249
249
  # form parameters
250
250
  form_params = opts[:form_params] || {}
@@ -20,40 +20,36 @@ module MailSlurpClient
20
20
  @api_client = api_client
21
21
  end
22
22
  # Export inboxes link callable via browser
23
- # @param api_key [String] apiKey
24
- # @param export_type [String] exportType
25
- # @param output_format [String] outputFormat
23
+ # @param export_type [String]
24
+ # @param api_key [String]
25
+ # @param output_format [String]
26
26
  # @param [Hash] opts the optional parameters
27
- # @option opts [DateTime] :created_earliest_time createdEarliestTime
28
- # @option opts [DateTime] :created_oldest_time createdOldestTime
29
- # @option opts [Boolean] :exclude_previously_exported excludePreviouslyExported
30
- # @option opts [String] :filter filter
31
- # @option opts [String] :list_separator_token listSeparatorToken
32
- # @return [String]
33
- def export_entities(api_key, export_type, output_format, opts = {})
34
- data, _status_code, _headers = export_entities_with_http_info(api_key, export_type, output_format, opts)
27
+ # @option opts [String] :filter
28
+ # @option opts [String] :list_separator_token
29
+ # @option opts [Boolean] :exclude_previously_exported
30
+ # @option opts [DateTime] :created_earliest_time
31
+ # @option opts [DateTime] :created_oldest_time
32
+ # @return [Array<String>]
33
+ def export_entities(export_type, api_key, output_format, opts = {})
34
+ data, _status_code, _headers = export_entities_with_http_info(export_type, api_key, output_format, opts)
35
35
  data
36
36
  end
37
37
 
38
38
  # Export inboxes link callable via browser
39
- # @param api_key [String] apiKey
40
- # @param export_type [String] exportType
41
- # @param output_format [String] outputFormat
39
+ # @param export_type [String]
40
+ # @param api_key [String]
41
+ # @param output_format [String]
42
42
  # @param [Hash] opts the optional parameters
43
- # @option opts [DateTime] :created_earliest_time createdEarliestTime
44
- # @option opts [DateTime] :created_oldest_time createdOldestTime
45
- # @option opts [Boolean] :exclude_previously_exported excludePreviouslyExported
46
- # @option opts [String] :filter filter
47
- # @option opts [String] :list_separator_token listSeparatorToken
48
- # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
49
- def export_entities_with_http_info(api_key, export_type, output_format, opts = {})
43
+ # @option opts [String] :filter
44
+ # @option opts [String] :list_separator_token
45
+ # @option opts [Boolean] :exclude_previously_exported
46
+ # @option opts [DateTime] :created_earliest_time
47
+ # @option opts [DateTime] :created_oldest_time
48
+ # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
49
+ def export_entities_with_http_info(export_type, api_key, output_format, opts = {})
50
50
  if @api_client.config.debugging
51
51
  @api_client.config.logger.debug 'Calling API: ExportControllerApi.export_entities ...'
52
52
  end
53
- # verify the required parameter 'api_key' is set
54
- if @api_client.config.client_side_validation && api_key.nil?
55
- fail ArgumentError, "Missing the required parameter 'api_key' when calling ExportControllerApi.export_entities"
56
- end
57
53
  # verify the required parameter 'export_type' is set
58
54
  if @api_client.config.client_side_validation && export_type.nil?
59
55
  fail ArgumentError, "Missing the required parameter 'export_type' when calling ExportControllerApi.export_entities"
@@ -63,6 +59,10 @@ module MailSlurpClient
63
59
  if @api_client.config.client_side_validation && !allowable_values.include?(export_type)
64
60
  fail ArgumentError, "invalid value for \"export_type\", must be one of #{allowable_values}"
65
61
  end
62
+ # verify the required parameter 'api_key' is set
63
+ if @api_client.config.client_side_validation && api_key.nil?
64
+ fail ArgumentError, "Missing the required parameter 'api_key' when calling ExportControllerApi.export_entities"
65
+ end
66
66
  # verify the required parameter 'output_format' is set
67
67
  if @api_client.config.client_side_validation && output_format.nil?
68
68
  fail ArgumentError, "Missing the required parameter 'output_format' when calling ExportControllerApi.export_entities"
@@ -77,19 +77,19 @@ module MailSlurpClient
77
77
 
78
78
  # query parameters
79
79
  query_params = opts[:query_params] || {}
80
- query_params[:'apiKey'] = api_key
81
80
  query_params[:'exportType'] = export_type
81
+ query_params[:'apiKey'] = api_key
82
82
  query_params[:'outputFormat'] = output_format
83
- query_params[:'createdEarliestTime'] = opts[:'created_earliest_time'] if !opts[:'created_earliest_time'].nil?
84
- query_params[:'createdOldestTime'] = opts[:'created_oldest_time'] if !opts[:'created_oldest_time'].nil?
85
- query_params[:'excludePreviouslyExported'] = opts[:'exclude_previously_exported'] if !opts[:'exclude_previously_exported'].nil?
86
83
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].nil?
87
84
  query_params[:'listSeparatorToken'] = opts[:'list_separator_token'] if !opts[:'list_separator_token'].nil?
85
+ query_params[:'excludePreviouslyExported'] = opts[:'exclude_previously_exported'] if !opts[:'exclude_previously_exported'].nil?
86
+ query_params[:'createdEarliestTime'] = opts[:'created_earliest_time'] if !opts[:'created_earliest_time'].nil?
87
+ query_params[:'createdOldestTime'] = opts[:'created_oldest_time'] if !opts[:'created_oldest_time'].nil?
88
88
 
89
89
  # header parameters
90
90
  header_params = opts[:header_params] || {}
91
91
  # HTTP header 'Accept' (if needed)
92
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
92
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
93
93
 
94
94
  # form parameters
95
95
  form_params = opts[:form_params] || {}
@@ -98,7 +98,7 @@ module MailSlurpClient
98
98
  post_body = opts[:body]
99
99
 
100
100
  # return_type
101
- return_type = opts[:return_type] || 'String'
101
+ return_type = opts[:return_type] || 'Array<String>'
102
102
 
103
103
  # auth_names
104
104
  auth_names = opts[:auth_names] || ['API_KEY']
@@ -120,10 +120,10 @@ module MailSlurpClient
120
120
  end
121
121
 
122
122
  # Get export link
123
- # @param export_type [String] exportType
124
- # @param export_options [ExportOptions] exportOptions
123
+ # @param export_type [String]
124
+ # @param export_options [ExportOptions]
125
125
  # @param [Hash] opts the optional parameters
126
- # @option opts [String] :api_key apiKey
126
+ # @option opts [String] :api_key
127
127
  # @return [ExportLink]
128
128
  def get_export_link(export_type, export_options, opts = {})
129
129
  data, _status_code, _headers = get_export_link_with_http_info(export_type, export_options, opts)
@@ -131,10 +131,10 @@ module MailSlurpClient
131
131
  end
132
132
 
133
133
  # Get export link
134
- # @param export_type [String] exportType
135
- # @param export_options [ExportOptions] exportOptions
134
+ # @param export_type [String]
135
+ # @param export_options [ExportOptions]
136
136
  # @param [Hash] opts the optional parameters
137
- # @option opts [String] :api_key apiKey
137
+ # @option opts [String] :api_key
138
138
  # @return [Array<(ExportLink, Integer, Hash)>] ExportLink data, response status code and response headers
139
139
  def get_export_link_with_http_info(export_type, export_options, opts = {})
140
140
  if @api_client.config.debugging
@@ -164,7 +164,7 @@ module MailSlurpClient
164
164
  # header parameters
165
165
  header_params = opts[:header_params] || {}
166
166
  # HTTP header 'Accept' (if needed)
167
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
167
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
168
168
  # HTTP header 'Content-Type'
169
169
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
170
170
 
@@ -22,12 +22,12 @@ module MailSlurpClient
22
22
  # Submit a form to be parsed and sent as an email to an address determined by the form fields
23
23
  # This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a `_to` email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding `name` attributes or as URL query parameters such as `?_to=test@example.com` The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts `application/x-www-form-urlencoded`, and `multipart/form-data` content-types. #### HTML Example ```html <form action=\"https://api.mailslurp.com/forms\" method=\"post\" > <input name=\"_to\" type=\"hidden\" value=\"test@example.com\"/> <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` #### URL Example ```html <form action=\"https://api.mailslurp.com/forms?_to=test@example.com\" method=\"post\" > <textarea name=\"feedback\"></textarea> <button type=\"submit\">Submit</button> </form> ``` The email address is specified by a `_to` field OR is extracted from an email alias specified by a `_toAlias` field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the `enctype` attribute, for instance: `<form enctype=\"multipart/form-data\">`.
24
24
  # @param [Hash] opts the optional parameters
25
- # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
26
- # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
27
- # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
25
+ # @option opts [String] :_to The email address that submitted form should be sent to.
28
26
  # @option opts [String] :_subject Optional subject of the email that will be sent.
27
+ # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
28
+ # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
29
29
  # @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
30
- # @option opts [String] :_to The email address that submitted form should be sent to.
30
+ # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
31
31
  # @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
32
32
  # @return [String]
33
33
  def submit_form(opts = {})
@@ -38,12 +38,12 @@ module MailSlurpClient
38
38
  # Submit a form to be parsed and sent as an email to an address determined by the form fields
39
39
  # This endpoint allows you to submit HTML forms and receive the field values and files via email. #### Parameters The endpoint looks for special meta parameters in the form fields OR in the URL request parameters. The meta parameters can be used to specify the behaviour of the email. You must provide at-least a &#x60;_to&#x60; email address to tell the endpoint where the form should be emailed. These can be submitted as hidden HTML input fields with the corresponding &#x60;name&#x60; attributes or as URL query parameters such as &#x60;?_to&#x3D;test@example.com&#x60; The endpoint takes all other form fields that are named and includes them in the message body of the email. Files are sent as attachments. #### Submitting This endpoint accepts form submission via POST method. It accepts &#x60;application/x-www-form-urlencoded&#x60;, and &#x60;multipart/form-data&#x60; content-types. #### HTML Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://api.mailslurp.com/forms\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;input name&#x3D;\&quot;_to\&quot; type&#x3D;\&quot;hidden\&quot; value&#x3D;\&quot;test@example.com\&quot;/&gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; #### URL Example &#x60;&#x60;&#x60;html &lt;form action&#x3D;\&quot;https://api.mailslurp.com/forms?_to&#x3D;test@example.com\&quot; method&#x3D;\&quot;post\&quot; &gt; &lt;textarea name&#x3D;\&quot;feedback\&quot;&gt;&lt;/textarea&gt; &lt;button type&#x3D;\&quot;submit\&quot;&gt;Submit&lt;/button&gt; &lt;/form&gt; &#x60;&#x60;&#x60; The email address is specified by a &#x60;_to&#x60; field OR is extracted from an email alias specified by a &#x60;_toAlias&#x60; field (see the alias controller for more information). Endpoint accepts . You can specify a content type in HTML forms using the &#x60;enctype&#x60; attribute, for instance: &#x60;&lt;form enctype&#x3D;\&quot;multipart/form-data\&quot;&gt;&#x60;.
40
40
  # @param [Hash] opts the optional parameters
41
- # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
42
- # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
43
- # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
41
+ # @option opts [String] :_to The email address that submitted form should be sent to.
44
42
  # @option opts [String] :_subject Optional subject of the email that will be sent.
43
+ # @option opts [String] :_redirect_to Optional URL to redirect form submitter to after submission. If not present user will see a success message.
44
+ # @option opts [String] :_email_address Email address of the submitting user. Include this if you wish to record the submitters email address and reply to it later.
45
45
  # @option opts [String] :_success_message Optional success message to display if no _redirectTo present.
46
- # @option opts [String] :_to The email address that submitted form should be sent to.
46
+ # @option opts [String] :_spam_check Optional but recommended field that catches spammers out. Include as a hidden form field but LEAVE EMPTY. Spam-bots will usually fill every field. If the _spamCheck field is filled the form submission will be ignored.
47
47
  # @option opts [String] :other_parameters All other parameters or fields will be accepted and attached to the sent email. This includes files and any HTML form field with a name. These fields will become the body of the email that is sent.
48
48
  # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers
49
49
  def submit_form_with_http_info(opts = {})
@@ -55,23 +55,21 @@ module MailSlurpClient
55
55
 
56
56
  # query parameters
57
57
  query_params = opts[:query_params] || {}
58
+ query_params[:'_to'] = opts[:'_to'] if !opts[:'_to'].nil?
59
+ query_params[:'_subject'] = opts[:'_subject'] if !opts[:'_subject'].nil?
60
+ query_params[:'_redirectTo'] = opts[:'_redirect_to'] if !opts[:'_redirect_to'].nil?
61
+ query_params[:'_emailAddress'] = opts[:'_email_address'] if !opts[:'_email_address'].nil?
62
+ query_params[:'_successMessage'] = opts[:'_success_message'] if !opts[:'_success_message'].nil?
63
+ query_params[:'_spamCheck'] = opts[:'_spam_check'] if !opts[:'_spam_check'].nil?
64
+ query_params[:'otherParameters'] = opts[:'other_parameters'] if !opts[:'other_parameters'].nil?
58
65
 
59
66
  # header parameters
60
67
  header_params = opts[:header_params] || {}
61
68
  # HTTP header 'Accept' (if needed)
62
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
63
- # HTTP header 'Content-Type'
64
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data', 'application/x-www-form-urlencoded'])
69
+ header_params['Accept'] = @api_client.select_header_accept(['*/*'])
65
70
 
66
71
  # form parameters
67
72
  form_params = opts[:form_params] || {}
68
- form_params['_emailAddress'] = opts[:'_email_address'] if !opts[:'_email_address'].nil?
69
- form_params['_redirectTo'] = opts[:'_redirect_to'] if !opts[:'_redirect_to'].nil?
70
- form_params['_spamCheck'] = opts[:'_spam_check'] if !opts[:'_spam_check'].nil?
71
- form_params['_subject'] = opts[:'_subject'] if !opts[:'_subject'].nil?
72
- form_params['_successMessage'] = opts[:'_success_message'] if !opts[:'_success_message'].nil?
73
- form_params['_to'] = opts[:'_to'] if !opts[:'_to'].nil?
74
- form_params['otherParameters'] = opts[:'other_parameters'] if !opts[:'other_parameters'].nil?
75
73
 
76
74
  # http body (model)
77
75
  post_body = opts[:body]