mailslurp_client 15.0.3 → 15.0.7
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/LICENSE +1 -1
- data/lib/mailslurp_client/api/alias_controller_api.rb +60 -56
- data/lib/mailslurp_client/api/attachment_controller_api.rb +50 -61
- data/lib/mailslurp_client/api/bounce_controller_api.rb +27 -19
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +16 -16
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +129 -68
- data/lib/mailslurp_client/api/contact_controller_api.rb +23 -23
- data/lib/mailslurp_client/api/domain_controller_api.rb +33 -33
- data/lib/mailslurp_client/api/email_controller_api.rb +145 -122
- data/lib/mailslurp_client/api/expired_controller_api.rb +20 -20
- data/lib/mailslurp_client/api/export_controller_api.rb +39 -39
- data/lib/mailslurp_client/api/form_controller_api.rb +17 -19
- data/lib/mailslurp_client/api/group_controller_api.rb +53 -53
- data/lib/mailslurp_client/api/inbox_controller_api.rb +198 -178
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +34 -30
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +34 -30
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +27 -27
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +55 -43
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +158 -48
- data/lib/mailslurp_client/api/template_controller_api.rb +22 -22
- data/lib/mailslurp_client/api/tracking_controller_api.rb +17 -17
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +129 -89
- data/lib/mailslurp_client/api/webhook_controller_api.rb +103 -87
- data/lib/mailslurp_client/api_client.rb +1 -1
- data/lib/mailslurp_client/api_error.rb +1 -1
- data/lib/mailslurp_client/configuration.rb +3 -3
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +22 -22
- data/lib/mailslurp_client/models/alias_dto.rb +64 -49
- data/lib/mailslurp_client/models/alias_projection.rb +50 -50
- data/lib/mailslurp_client/models/attachment_entity.rb +40 -40
- data/lib/mailslurp_client/models/attachment_meta_data.rb +42 -22
- data/lib/mailslurp_client/models/attachment_projection.rb +38 -33
- data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
- data/lib/mailslurp_client/models/bounce_projection.rb +19 -19
- data/lib/mailslurp_client/models/bounce_recipient.rb +31 -31
- data/lib/mailslurp_client/models/bounced_email_dto.rb +63 -63
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +23 -23
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +11 -1
- data/lib/mailslurp_client/models/condition_option.rb +13 -3
- data/lib/mailslurp_client/models/contact_dto.rb +63 -63
- data/lib/mailslurp_client/models/contact_projection.rb +39 -39
- data/lib/mailslurp_client/models/content_match_options.rb +6 -1
- data/lib/mailslurp_client/models/count_dto.rb +1 -1
- data/lib/mailslurp_client/models/create_alias_options.rb +11 -1
- data/lib/mailslurp_client/models/create_contact_options.rb +43 -43
- data/lib/mailslurp_client/models/create_domain_options.rb +22 -17
- data/lib/mailslurp_client/models/create_group_options.rb +1 -1
- data/lib/mailslurp_client/models/create_inbox_dto.rb +59 -59
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +30 -15
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +39 -24
- data/lib/mailslurp_client/models/create_template_options.rb +1 -1
- data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
- data/lib/mailslurp_client/models/create_webhook_options.rb +24 -19
- data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +21 -21
- data/lib/mailslurp_client/models/dns_lookup_options.rb +30 -15
- data/lib/mailslurp_client/models/dns_lookup_result.rb +34 -33
- data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
- data/lib/mailslurp_client/models/domain_dto.rb +100 -70
- data/lib/mailslurp_client/models/domain_name_record.rb +18 -17
- data/lib/mailslurp_client/models/domain_preview.rb +29 -28
- data/lib/mailslurp_client/models/download_attachment_dto.rb +16 -1
- data/lib/mailslurp_client/models/email.rb +179 -139
- data/lib/mailslurp_client/models/email_analysis.rb +29 -29
- data/lib/mailslurp_client/models/email_content_match_result.rb +19 -19
- data/lib/mailslurp_client/models/email_links_result.rb +19 -19
- data/lib/mailslurp_client/models/email_preview.rb +63 -48
- data/lib/mailslurp_client/models/email_projection.rb +77 -77
- data/lib/mailslurp_client/models/email_recipients.rb +17 -16
- data/lib/mailslurp_client/models/email_text_lines_result.rb +19 -19
- data/lib/mailslurp_client/models/email_verification_result.rb +22 -22
- data/lib/mailslurp_client/models/expiration_defaults.rb +17 -17
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +19 -19
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +33 -33
- data/lib/mailslurp_client/models/export_link.rb +1 -1
- data/lib/mailslurp_client/models/export_options.rb +2 -2
- data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +19 -19
- data/lib/mailslurp_client/models/forward_email_options.rb +37 -32
- data/lib/mailslurp_client/models/gravatar_url.rb +19 -19
- data/lib/mailslurp_client/models/group_contacts_dto.rb +19 -19
- data/lib/mailslurp_client/models/group_dto.rb +28 -28
- data/lib/mailslurp_client/models/group_projection.rb +29 -29
- data/lib/mailslurp_client/models/html_validation_result.rb +27 -12
- data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +72 -57
- data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +48 -48
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +19 -19
- data/lib/mailslurp_client/models/inbox_preview.rb +59 -39
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +61 -61
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +19 -14
- data/lib/mailslurp_client/models/inline_object.rb +221 -0
- data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
- data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
- data/lib/mailslurp_client/models/match_option.rb +18 -3
- data/lib/mailslurp_client/models/match_options.rb +17 -17
- data/lib/mailslurp_client/models/missed_email.rb +77 -77
- data/lib/mailslurp_client/models/missed_email_projection.rb +25 -25
- data/lib/mailslurp_client/models/name_server_record.rb +16 -16
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +70 -45
- data/lib/mailslurp_client/models/page_alias.rb +59 -50
- data/lib/mailslurp_client/models/page_attachment_entity.rb +59 -50
- data/lib/mailslurp_client/models/page_bounced_email.rb +59 -50
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +59 -50
- data/lib/mailslurp_client/models/page_contact_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_email_preview.rb +59 -50
- data/lib/mailslurp_client/models/page_email_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_group_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +59 -50
- data/lib/mailslurp_client/models/page_inbox_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +59 -50
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +86 -47
- data/lib/mailslurp_client/models/page_template_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_thread_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_webhook_projection.rb +59 -50
- data/lib/mailslurp_client/models/page_webhook_result.rb +59 -50
- data/lib/mailslurp_client/models/{pageable.rb → pageable_object.rb} +32 -32
- data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
- data/lib/mailslurp_client/models/recipient.rb +19 -19
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +47 -35
- data/lib/mailslurp_client/models/reply_to_email_options.rb +57 -45
- data/lib/mailslurp_client/models/send_email_options.rb +112 -110
- data/lib/mailslurp_client/models/sender.rb +20 -19
- data/lib/mailslurp_client/models/sent_email_dto.rb +110 -95
- data/lib/mailslurp_client/models/sent_email_projection.rb +88 -87
- data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +6 -1
- data/lib/mailslurp_client/models/simple_send_email_options.rb +30 -25
- data/lib/mailslurp_client/models/sort.rb +1 -1
- data/lib/mailslurp_client/models/template_dto.rb +33 -33
- data/lib/mailslurp_client/models/template_projection.rb +37 -37
- data/lib/mailslurp_client/models/template_variable.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
- data/lib/mailslurp_client/models/thread_projection.rb +71 -71
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +54 -54
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +42 -42
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +25 -25
- data/lib/mailslurp_client/models/unread_count.rb +1 -1
- data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
- data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
- data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
- data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
- data/lib/mailslurp_client/models/update_inbox_options.rb +27 -27
- data/lib/mailslurp_client/models/upload_attachment_options.rb +15 -15
- data/lib/mailslurp_client/models/validation_dto.rb +11 -1
- data/lib/mailslurp_client/models/validation_message.rb +2 -1
- data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
- data/lib/mailslurp_client/models/wait_for_conditions.rb +53 -53
- data/lib/mailslurp_client/models/webhook_dto.rb +105 -65
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +83 -43
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +85 -50
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +79 -44
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +98 -83
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +140 -85
- data/lib/mailslurp_client/models/webhook_projection.rb +47 -47
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +19 -19
- data/lib/mailslurp_client/models/webhook_result_dto.rb +102 -102
- data/lib/mailslurp_client/models/webhook_test_request.rb +28 -28
- data/lib/mailslurp_client/models/webhook_test_response.rb +14 -14
- data/lib/mailslurp_client/models/webhook_test_result.rb +19 -19
- data/lib/mailslurp_client/version.rb +2 -2
- data/lib/mailslurp_client.rb +4 -3
- metadata +5 -4
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -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(['
|
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(['
|
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
|
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(
|
146
|
-
data, _status_code, _headers = get_expired_inbox_record_with_http_info(
|
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
|
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(
|
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 '
|
160
|
-
if @api_client.config.client_side_validation &&
|
161
|
-
fail ArgumentError, "Missing the required parameter '
|
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('{' + '
|
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(['
|
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(['
|
247
|
+
header_params['Accept'] = @api_client.select_header_accept(['*/*'])
|
248
248
|
|
249
249
|
# form parameters
|
250
250
|
form_params = opts[:form_params] || {}
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -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
|
24
|
-
# @param
|
25
|
-
# @param output_format [String]
|
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 [
|
28
|
-
# @option opts [
|
29
|
-
# @option opts [Boolean] :exclude_previously_exported
|
30
|
-
# @option opts [
|
31
|
-
# @option opts [
|
32
|
-
# @return [String]
|
33
|
-
def export_entities(
|
34
|
-
data, _status_code, _headers = export_entities_with_http_info(
|
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
|
40
|
-
# @param
|
41
|
-
# @param output_format [String]
|
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 [
|
44
|
-
# @option opts [
|
45
|
-
# @option opts [Boolean] :exclude_previously_exported
|
46
|
-
# @option opts [
|
47
|
-
# @option opts [
|
48
|
-
# @return [Array<(String
|
49
|
-
def export_entities_with_http_info(
|
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(['
|
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]
|
124
|
-
# @param export_options [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
|
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]
|
135
|
-
# @param export_options [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
|
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(['
|
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
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
#MailSlurp is an API for sending and receiving emails from dynamically allocated email addresses. It's designed for developers and QA teams to test applications, process inbound emails, send templated notifications, attachments, and more. ## Resources - [Homepage](https://www.mailslurp.com) - Get an [API KEY](https://app.mailslurp.com/sign-up/) - Generated [SDK Clients](https://www.mailslurp.com/docs/) - [Examples](https://github.com/mailslurp/examples) repository
|
5
5
|
|
6
6
|
The version of the OpenAPI document: 6.5.2
|
7
|
-
|
7
|
+
Contact: contact@mailslurp.dev
|
8
8
|
Generated by: https://openapi-generator.tech
|
9
9
|
OpenAPI Generator version: 4.3.1
|
10
10
|
|
@@ -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] :
|
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] :
|
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 `_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\">`.
|
40
40
|
# @param [Hash] opts the optional parameters
|
41
|
-
# @option opts [String] :
|
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] :
|
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(['
|
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]
|