mailslurp_client 15.0.0 → 15.0.4
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 +59 -55
- data/lib/mailslurp_client/api/attachment_controller_api.rb +49 -60
- data/lib/mailslurp_client/api/bounce_controller_api.rb +26 -18
- data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +15 -15
- data/lib/mailslurp_client/api/common_actions_controller_api.rb +128 -67
- data/lib/mailslurp_client/api/contact_controller_api.rb +22 -22
- data/lib/mailslurp_client/api/domain_controller_api.rb +32 -32
- data/lib/mailslurp_client/api/email_controller_api.rb +190 -116
- data/lib/mailslurp_client/api/expired_controller_api.rb +19 -19
- data/lib/mailslurp_client/api/export_controller_api.rb +38 -38
- data/lib/mailslurp_client/api/form_controller_api.rb +16 -18
- data/lib/mailslurp_client/api/group_controller_api.rb +52 -52
- data/lib/mailslurp_client/api/inbox_controller_api.rb +359 -225
- data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +33 -29
- data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +33 -29
- data/lib/mailslurp_client/api/mail_server_controller_api.rb +26 -26
- data/lib/mailslurp_client/api/missed_email_controller_api.rb +54 -42
- data/lib/mailslurp_client/api/sent_emails_controller_api.rb +157 -47
- data/lib/mailslurp_client/api/template_controller_api.rb +21 -21
- data/lib/mailslurp_client/api/tracking_controller_api.rb +16 -16
- data/lib/mailslurp_client/api/wait_for_controller_api.rb +128 -88
- data/lib/mailslurp_client/api/webhook_controller_api.rb +102 -86
- data/lib/mailslurp_client/configuration.rb +4 -4
- data/lib/mailslurp_client/models/abstract_webhook_payload.rb +10 -25
- data/lib/mailslurp_client/models/alias_dto.rb +45 -56
- data/lib/mailslurp_client/models/alias_projection.rb +42 -72
- data/lib/mailslurp_client/models/attachment_entity.rb +34 -54
- data/lib/mailslurp_client/models/attachment_meta_data.rb +21 -21
- data/lib/mailslurp_client/models/attachment_projection.rb +36 -51
- data/lib/mailslurp_client/models/basic_auth_options.rb +0 -10
- data/lib/mailslurp_client/models/bounce_projection.rb +13 -23
- data/lib/mailslurp_client/models/bounce_recipient.rb +22 -42
- data/lib/mailslurp_client/models/bounced_email_dto.rb +56 -76
- data/lib/mailslurp_client/models/bounced_recipient_dto.rb +16 -31
- data/lib/mailslurp_client/models/bulk_send_email_options.rb +5 -0
- data/lib/mailslurp_client/models/condition_option.rb +2 -2
- data/lib/mailslurp_client/models/contact_dto.rb +53 -73
- data/lib/mailslurp_client/models/contact_projection.rb +42 -52
- data/lib/mailslurp_client/models/count_dto.rb +206 -0
- data/lib/mailslurp_client/models/create_contact_options.rb +42 -42
- data/lib/mailslurp_client/models/create_domain_options.rb +21 -16
- data/lib/mailslurp_client/models/create_group_options.rb +0 -5
- data/lib/mailslurp_client/models/create_inbox_dto.rb +58 -58
- data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +19 -14
- data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +23 -23
- data/lib/mailslurp_client/models/create_template_options.rb +0 -10
- data/lib/mailslurp_client/models/create_webhook_options.rb +18 -18
- data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +15 -25
- data/lib/mailslurp_client/models/dns_lookup_options.rb +24 -14
- data/lib/mailslurp_client/models/dns_lookup_result.rb +23 -42
- data/lib/mailslurp_client/models/dns_lookup_results.rb +0 -5
- data/lib/mailslurp_client/models/domain_dto.rb +59 -80
- data/lib/mailslurp_client/models/domain_name_record.rb +11 -30
- data/lib/mailslurp_client/models/domain_preview.rb +26 -50
- data/lib/mailslurp_client/models/email.rb +134 -135
- data/lib/mailslurp_client/models/email_analysis.rb +28 -28
- data/lib/mailslurp_client/models/email_content_match_result.rb +13 -23
- data/lib/mailslurp_client/models/email_links_result.rb +13 -23
- data/lib/mailslurp_client/models/email_preview.rb +47 -47
- data/lib/mailslurp_client/models/email_projection.rb +77 -97
- data/lib/mailslurp_client/models/email_recipients.rb +16 -15
- data/lib/mailslurp_client/models/email_text_lines_result.rb +13 -23
- data/lib/mailslurp_client/models/email_verification_result.rb +16 -36
- data/lib/mailslurp_client/models/expiration_defaults.rb +16 -26
- data/lib/mailslurp_client/models/expired_inbox_dto.rb +13 -28
- data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +22 -42
- data/lib/mailslurp_client/models/export_link.rb +0 -5
- data/lib/mailslurp_client/models/export_options.rb +1 -6
- data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +13 -23
- data/lib/mailslurp_client/models/forward_email_options.rb +36 -31
- data/lib/mailslurp_client/models/gravatar_url.rb +13 -23
- data/lib/mailslurp_client/models/group_contacts_dto.rb +13 -23
- data/lib/mailslurp_client/models/group_dto.rb +22 -37
- data/lib/mailslurp_client/models/group_projection.rb +22 -37
- data/lib/mailslurp_client/models/html_validation_result.rb +13 -14
- data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +47 -57
- data/lib/mailslurp_client/models/inbox_exists_dto.rb +0 -5
- data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +31 -61
- data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +0 -5
- data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +13 -23
- data/lib/mailslurp_client/models/inbox_preview.rb +38 -38
- data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +43 -78
- data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +0 -5
- data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +13 -18
- data/lib/mailslurp_client/models/inline_object.rb +221 -0
- data/lib/mailslurp_client/models/ip_address_result.rb +0 -10
- data/lib/mailslurp_client/models/json_schema_dto.rb +0 -5
- data/lib/mailslurp_client/models/match_option.rb +7 -2
- data/lib/mailslurp_client/models/match_options.rb +16 -16
- data/lib/mailslurp_client/models/missed_email.rb +67 -102
- data/lib/mailslurp_client/models/missed_email_projection.rb +19 -29
- data/lib/mailslurp_client/models/name_server_record.rb +10 -30
- data/lib/mailslurp_client/models/organization_inbox_projection.rb +44 -44
- data/lib/mailslurp_client/models/page_alias.rb +52 -52
- data/lib/mailslurp_client/models/page_attachment_entity.rb +52 -52
- data/lib/mailslurp_client/models/page_bounced_email.rb +52 -52
- data/lib/mailslurp_client/models/page_bounced_recipients.rb +52 -52
- data/lib/mailslurp_client/models/page_contact_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_email_preview.rb +52 -52
- data/lib/mailslurp_client/models/page_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_group_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +52 -52
- data/lib/mailslurp_client/models/page_missed_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_sent_email_projection.rb +49 -49
- data/lib/mailslurp_client/models/page_template_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_thread_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_webhook_projection.rb +52 -52
- data/lib/mailslurp_client/models/page_webhook_result.rb +52 -52
- data/lib/mailslurp_client/models/pageable.rb +10 -10
- data/lib/mailslurp_client/models/raw_email_json.rb +0 -5
- data/lib/mailslurp_client/models/recipient.rb +13 -23
- data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +38 -37
- data/lib/mailslurp_client/models/reply_to_email_options.rb +51 -50
- data/lib/mailslurp_client/models/send_email_options.rb +107 -115
- data/lib/mailslurp_client/models/sender.rb +14 -23
- data/lib/mailslurp_client/models/sent_email_dto.rb +97 -102
- data/lib/mailslurp_client/models/sent_email_projection.rb +66 -105
- data/lib/mailslurp_client/models/simple_send_email_options.rb +24 -24
- data/lib/mailslurp_client/models/template_dto.rb +22 -47
- data/lib/mailslurp_client/models/template_projection.rb +16 -41
- data/lib/mailslurp_client/models/template_variable.rb +0 -10
- data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +0 -10
- data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +0 -10
- data/lib/mailslurp_client/models/thread_projection.rb +60 -95
- data/lib/mailslurp_client/models/tracking_pixel_dto.rb +43 -68
- data/lib/mailslurp_client/models/tracking_pixel_projection.rb +34 -54
- data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +19 -29
- data/lib/mailslurp_client/models/unread_count.rb +0 -5
- data/lib/mailslurp_client/models/unseen_error_count_dto.rb +0 -5
- data/lib/mailslurp_client/models/update_group_contacts.rb +0 -5
- data/lib/mailslurp_client/models/update_inbox_options.rb +26 -26
- data/lib/mailslurp_client/models/upload_attachment_options.rb +14 -14
- data/lib/mailslurp_client/models/validation_message.rb +1 -5
- data/lib/mailslurp_client/models/verify_email_address_options.rb +0 -5
- data/lib/mailslurp_client/models/wait_for_conditions.rb +48 -58
- data/lib/mailslurp_client/models/webhook_dto.rb +64 -69
- data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +42 -42
- data/lib/mailslurp_client/models/webhook_email_read_payload.rb +49 -49
- data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +43 -43
- data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +75 -95
- data/lib/mailslurp_client/models/webhook_new_email_payload.rb +84 -84
- data/lib/mailslurp_client/models/webhook_projection.rb +36 -61
- data/lib/mailslurp_client/models/webhook_redrive_result.rb +13 -23
- data/lib/mailslurp_client/models/webhook_result_dto.rb +76 -126
- data/lib/mailslurp_client/models/webhook_test_request.rb +21 -36
- data/lib/mailslurp_client/models/webhook_test_response.rb +13 -13
- data/lib/mailslurp_client/models/webhook_test_result.rb +13 -23
- data/lib/mailslurp_client/version.rb +1 -1
- data/lib/mailslurp_client.rb +3 -1
- metadata +5 -3
@@ -15,35 +15,35 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# Options for creating an inbox. An inbox has a real email address that can send and receive emails. Inboxes can be permanent or expire at a given time. Inboxes are either `SMTP` or `HTTP` mailboxes. `SMTP` inboxes are receive only and processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes can send and receive and are processed by AWS SES. Inboxes can use a custom email address (by verifying your own domain) or a randomly assigned email ending in either `mailslurp.com` or (if `useDomainPool` is enabled) ending in a similar domain such as `mailslurp.xyz` (selected at random).
|
17
17
|
class CreateInboxDto
|
18
|
-
#
|
19
|
-
attr_accessor :
|
18
|
+
# 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.
|
19
|
+
attr_accessor :email_address
|
20
|
+
|
21
|
+
# Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
|
22
|
+
attr_accessor :name
|
20
23
|
|
21
24
|
# Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
|
22
25
|
attr_accessor :description
|
23
26
|
|
24
|
-
#
|
25
|
-
attr_accessor :
|
27
|
+
# 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.
|
28
|
+
attr_accessor :use_domain_pool
|
29
|
+
|
30
|
+
# 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.
|
31
|
+
attr_accessor :tags
|
26
32
|
|
27
33
|
# 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.
|
28
34
|
attr_accessor :expires_at
|
29
35
|
|
30
|
-
# Number of milliseconds that inbox should exist for
|
31
|
-
attr_accessor :expires_in
|
32
|
-
|
33
36
|
# Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
|
34
37
|
attr_accessor :favourite
|
35
38
|
|
36
|
-
#
|
37
|
-
attr_accessor :
|
38
|
-
|
39
|
-
# Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
|
40
|
-
attr_accessor :name
|
39
|
+
# Number of milliseconds that inbox should exist for
|
40
|
+
attr_accessor :expires_in
|
41
41
|
|
42
|
-
#
|
43
|
-
attr_accessor :
|
42
|
+
# 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.
|
43
|
+
attr_accessor :allow_team_access
|
44
44
|
|
45
|
-
#
|
46
|
-
attr_accessor :
|
45
|
+
# Type of inbox. HTTP inboxes are faster and better for most cases. SMTP inboxes are more suited for public facing inbound messages (but cannot send).
|
46
|
+
attr_accessor :inbox_type
|
47
47
|
|
48
48
|
class EnumAttributeValidator
|
49
49
|
attr_reader :datatype
|
@@ -70,32 +70,32 @@ module MailSlurpClient
|
|
70
70
|
# Attribute mapping from ruby-style variable name to JSON key.
|
71
71
|
def self.attribute_map
|
72
72
|
{
|
73
|
-
:'allow_team_access' => :'allowTeamAccess',
|
74
|
-
:'description' => :'description',
|
75
73
|
:'email_address' => :'emailAddress',
|
76
|
-
:'expires_at' => :'expiresAt',
|
77
|
-
:'expires_in' => :'expiresIn',
|
78
|
-
:'favourite' => :'favourite',
|
79
|
-
:'inbox_type' => :'inboxType',
|
80
74
|
:'name' => :'name',
|
75
|
+
:'description' => :'description',
|
76
|
+
:'use_domain_pool' => :'useDomainPool',
|
81
77
|
:'tags' => :'tags',
|
82
|
-
:'
|
78
|
+
:'expires_at' => :'expiresAt',
|
79
|
+
:'favourite' => :'favourite',
|
80
|
+
:'expires_in' => :'expiresIn',
|
81
|
+
:'allow_team_access' => :'allowTeamAccess',
|
82
|
+
:'inbox_type' => :'inboxType'
|
83
83
|
}
|
84
84
|
end
|
85
85
|
|
86
86
|
# Attribute type mapping.
|
87
87
|
def self.openapi_types
|
88
88
|
{
|
89
|
-
:'allow_team_access' => :'Boolean',
|
90
|
-
:'description' => :'String',
|
91
89
|
:'email_address' => :'String',
|
92
|
-
:'expires_at' => :'DateTime',
|
93
|
-
:'expires_in' => :'Integer',
|
94
|
-
:'favourite' => :'Boolean',
|
95
|
-
:'inbox_type' => :'String',
|
96
90
|
:'name' => :'String',
|
91
|
+
:'description' => :'String',
|
92
|
+
:'use_domain_pool' => :'Boolean',
|
97
93
|
:'tags' => :'Array<String>',
|
98
|
-
:'
|
94
|
+
:'expires_at' => :'DateTime',
|
95
|
+
:'favourite' => :'Boolean',
|
96
|
+
:'expires_in' => :'Integer',
|
97
|
+
:'allow_team_access' => :'Boolean',
|
98
|
+
:'inbox_type' => :'String'
|
99
99
|
}
|
100
100
|
end
|
101
101
|
|
@@ -120,46 +120,46 @@ module MailSlurpClient
|
|
120
120
|
h[k.to_sym] = v
|
121
121
|
}
|
122
122
|
|
123
|
-
if attributes.key?(:'
|
124
|
-
self.
|
123
|
+
if attributes.key?(:'email_address')
|
124
|
+
self.email_address = attributes[:'email_address']
|
125
|
+
end
|
126
|
+
|
127
|
+
if attributes.key?(:'name')
|
128
|
+
self.name = attributes[:'name']
|
125
129
|
end
|
126
130
|
|
127
131
|
if attributes.key?(:'description')
|
128
132
|
self.description = attributes[:'description']
|
129
133
|
end
|
130
134
|
|
131
|
-
if attributes.key?(:'
|
132
|
-
self.
|
135
|
+
if attributes.key?(:'use_domain_pool')
|
136
|
+
self.use_domain_pool = attributes[:'use_domain_pool']
|
133
137
|
end
|
134
138
|
|
135
|
-
if attributes.key?(:'
|
136
|
-
|
139
|
+
if attributes.key?(:'tags')
|
140
|
+
if (value = attributes[:'tags']).is_a?(Array)
|
141
|
+
self.tags = value
|
142
|
+
end
|
137
143
|
end
|
138
144
|
|
139
|
-
if attributes.key?(:'
|
140
|
-
self.
|
145
|
+
if attributes.key?(:'expires_at')
|
146
|
+
self.expires_at = attributes[:'expires_at']
|
141
147
|
end
|
142
148
|
|
143
149
|
if attributes.key?(:'favourite')
|
144
150
|
self.favourite = attributes[:'favourite']
|
145
151
|
end
|
146
152
|
|
147
|
-
if attributes.key?(:'
|
148
|
-
self.
|
149
|
-
end
|
150
|
-
|
151
|
-
if attributes.key?(:'name')
|
152
|
-
self.name = attributes[:'name']
|
153
|
+
if attributes.key?(:'expires_in')
|
154
|
+
self.expires_in = attributes[:'expires_in']
|
153
155
|
end
|
154
156
|
|
155
|
-
if attributes.key?(:'
|
156
|
-
|
157
|
-
self.tags = value
|
158
|
-
end
|
157
|
+
if attributes.key?(:'allow_team_access')
|
158
|
+
self.allow_team_access = attributes[:'allow_team_access']
|
159
159
|
end
|
160
160
|
|
161
|
-
if attributes.key?(:'
|
162
|
-
self.
|
161
|
+
if attributes.key?(:'inbox_type')
|
162
|
+
self.inbox_type = attributes[:'inbox_type']
|
163
163
|
end
|
164
164
|
end
|
165
165
|
|
@@ -193,16 +193,16 @@ module MailSlurpClient
|
|
193
193
|
def ==(o)
|
194
194
|
return true if self.equal?(o)
|
195
195
|
self.class == o.class &&
|
196
|
-
allow_team_access == o.allow_team_access &&
|
197
|
-
description == o.description &&
|
198
196
|
email_address == o.email_address &&
|
199
|
-
expires_at == o.expires_at &&
|
200
|
-
expires_in == o.expires_in &&
|
201
|
-
favourite == o.favourite &&
|
202
|
-
inbox_type == o.inbox_type &&
|
203
197
|
name == o.name &&
|
198
|
+
description == o.description &&
|
199
|
+
use_domain_pool == o.use_domain_pool &&
|
204
200
|
tags == o.tags &&
|
205
|
-
|
201
|
+
expires_at == o.expires_at &&
|
202
|
+
favourite == o.favourite &&
|
203
|
+
expires_in == o.expires_in &&
|
204
|
+
allow_team_access == o.allow_team_access &&
|
205
|
+
inbox_type == o.inbox_type
|
206
206
|
end
|
207
207
|
|
208
208
|
# @see the `==` method
|
@@ -214,7 +214,7 @@ module MailSlurpClient
|
|
214
214
|
# Calculates hash code according to all attributes.
|
215
215
|
# @return [Integer] Hash code
|
216
216
|
def hash
|
217
|
-
[
|
217
|
+
[email_address, name, description, use_domain_pool, tags, expires_at, favourite, expires_in, allow_team_access, inbox_type].hash
|
218
218
|
end
|
219
219
|
|
220
220
|
# Builds the object from hash
|
@@ -18,12 +18,12 @@ module MailSlurpClient
|
|
18
18
|
# Field to match against to trigger inbox forwarding for inbound email
|
19
19
|
attr_accessor :field
|
20
20
|
|
21
|
-
# Email addresses to forward an email to if it matches the field and match criteria of the forwarder
|
22
|
-
attr_accessor :forward_to_recipients
|
23
|
-
|
24
21
|
# String or wildcard style match for field specified when evaluating forwarding rules
|
25
22
|
attr_accessor :match
|
26
23
|
|
24
|
+
# Email addresses to forward an email to if it matches the field and match criteria of the forwarder
|
25
|
+
attr_accessor :forward_to_recipients
|
26
|
+
|
27
27
|
class EnumAttributeValidator
|
28
28
|
attr_reader :datatype
|
29
29
|
attr_reader :allowable_values
|
@@ -50,8 +50,8 @@ module MailSlurpClient
|
|
50
50
|
def self.attribute_map
|
51
51
|
{
|
52
52
|
:'field' => :'field',
|
53
|
-
:'
|
54
|
-
:'
|
53
|
+
:'match' => :'match',
|
54
|
+
:'forward_to_recipients' => :'forwardToRecipients'
|
55
55
|
}
|
56
56
|
end
|
57
57
|
|
@@ -59,8 +59,8 @@ module MailSlurpClient
|
|
59
59
|
def self.openapi_types
|
60
60
|
{
|
61
61
|
:'field' => :'String',
|
62
|
-
:'
|
63
|
-
:'
|
62
|
+
:'match' => :'String',
|
63
|
+
:'forward_to_recipients' => :'Array<String>'
|
64
64
|
}
|
65
65
|
end
|
66
66
|
|
@@ -89,21 +89,25 @@ module MailSlurpClient
|
|
89
89
|
self.field = attributes[:'field']
|
90
90
|
end
|
91
91
|
|
92
|
+
if attributes.key?(:'match')
|
93
|
+
self.match = attributes[:'match']
|
94
|
+
end
|
95
|
+
|
92
96
|
if attributes.key?(:'forward_to_recipients')
|
93
97
|
if (value = attributes[:'forward_to_recipients']).is_a?(Array)
|
94
98
|
self.forward_to_recipients = value
|
95
99
|
end
|
96
100
|
end
|
97
|
-
|
98
|
-
if attributes.key?(:'match')
|
99
|
-
self.match = attributes[:'match']
|
100
|
-
end
|
101
101
|
end
|
102
102
|
|
103
103
|
# Show invalid properties with the reasons. Usually used together with valid?
|
104
104
|
# @return Array for valid properties with the reasons
|
105
105
|
def list_invalid_properties
|
106
106
|
invalid_properties = Array.new
|
107
|
+
if @match.nil?
|
108
|
+
invalid_properties.push('invalid value for "match", match cannot be nil.')
|
109
|
+
end
|
110
|
+
|
107
111
|
invalid_properties
|
108
112
|
end
|
109
113
|
|
@@ -112,6 +116,7 @@ module MailSlurpClient
|
|
112
116
|
def valid?
|
113
117
|
field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
|
114
118
|
return false unless field_validator.valid?(@field)
|
119
|
+
return false if @match.nil?
|
115
120
|
true
|
116
121
|
end
|
117
122
|
|
@@ -131,8 +136,8 @@ module MailSlurpClient
|
|
131
136
|
return true if self.equal?(o)
|
132
137
|
self.class == o.class &&
|
133
138
|
field == o.field &&
|
134
|
-
|
135
|
-
|
139
|
+
match == o.match &&
|
140
|
+
forward_to_recipients == o.forward_to_recipients
|
136
141
|
end
|
137
142
|
|
138
143
|
# @see the `==` method
|
@@ -144,7 +149,7 @@ module MailSlurpClient
|
|
144
149
|
# Calculates hash code according to all attributes.
|
145
150
|
# @return [Integer] Hash code
|
146
151
|
def hash
|
147
|
-
[field,
|
152
|
+
[field, match, forward_to_recipients].hash
|
148
153
|
end
|
149
154
|
|
150
155
|
# Builds the object from hash
|
@@ -15,12 +15,12 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# Options for creating inbox rulesets. Inbox rulesets can be used to block, allow, filter, or forward emails when sending or receiving using the inbox.
|
17
17
|
class CreateInboxRulesetOptions
|
18
|
-
# Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action.
|
19
|
-
attr_accessor :action
|
20
|
-
|
21
18
|
# What type of emails actions to apply ruleset to. Either `SENDING_EMAILS` or `RECEIVING_EMAILS` will apply action and target to any sending or receiving of emails respectively.
|
22
19
|
attr_accessor :scope
|
23
20
|
|
21
|
+
# Action to be taken when the ruleset matches an email for the given scope. For example: `BLOCK` action with target `*` and scope `SENDING_EMAILS` blocks sending to all recipients. Note `ALLOW` takes precedent over `BLOCK`. `FILTER_REMOVE` is like block but will remove offending email addresses during a send or receive event instead of blocking the action.
|
22
|
+
attr_accessor :action
|
23
|
+
|
24
24
|
# Target to match emails with. Can be a wild-card type pattern or a valid email address. For instance `*@gmail.com` matches all gmail addresses while `test@gmail.com` matches one address exactly. The target is applied to every recipient field email address when `SENDING_EMAILS` is the scope and is applied to sender of email when `RECEIVING_EMAILS`.
|
25
25
|
attr_accessor :target
|
26
26
|
|
@@ -49,8 +49,8 @@ module MailSlurpClient
|
|
49
49
|
# Attribute mapping from ruby-style variable name to JSON key.
|
50
50
|
def self.attribute_map
|
51
51
|
{
|
52
|
-
:'action' => :'action',
|
53
52
|
:'scope' => :'scope',
|
53
|
+
:'action' => :'action',
|
54
54
|
:'target' => :'target'
|
55
55
|
}
|
56
56
|
end
|
@@ -58,8 +58,8 @@ module MailSlurpClient
|
|
58
58
|
# Attribute type mapping.
|
59
59
|
def self.openapi_types
|
60
60
|
{
|
61
|
-
:'action' => :'String',
|
62
61
|
:'scope' => :'String',
|
62
|
+
:'action' => :'String',
|
63
63
|
:'target' => :'String'
|
64
64
|
}
|
65
65
|
end
|
@@ -85,14 +85,14 @@ module MailSlurpClient
|
|
85
85
|
h[k.to_sym] = v
|
86
86
|
}
|
87
87
|
|
88
|
-
if attributes.key?(:'action')
|
89
|
-
self.action = attributes[:'action']
|
90
|
-
end
|
91
|
-
|
92
88
|
if attributes.key?(:'scope')
|
93
89
|
self.scope = attributes[:'scope']
|
94
90
|
end
|
95
91
|
|
92
|
+
if attributes.key?(:'action')
|
93
|
+
self.action = attributes[:'action']
|
94
|
+
end
|
95
|
+
|
96
96
|
if attributes.key?(:'target')
|
97
97
|
self.target = attributes[:'target']
|
98
98
|
end
|
@@ -108,23 +108,13 @@ module MailSlurpClient
|
|
108
108
|
# Check to see if the all the properties in the model are valid
|
109
109
|
# @return true if the model is valid
|
110
110
|
def valid?
|
111
|
-
action_validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
|
112
|
-
return false unless action_validator.valid?(@action)
|
113
111
|
scope_validator = EnumAttributeValidator.new('String', ["RECEIVING_EMAILS", "SENDING_EMAILS"])
|
114
112
|
return false unless scope_validator.valid?(@scope)
|
113
|
+
action_validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
|
114
|
+
return false unless action_validator.valid?(@action)
|
115
115
|
true
|
116
116
|
end
|
117
117
|
|
118
|
-
# Custom attribute writer method checking allowed values (enum).
|
119
|
-
# @param [Object] action Object to be assigned
|
120
|
-
def action=(action)
|
121
|
-
validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
|
122
|
-
unless validator.valid?(action)
|
123
|
-
fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
|
124
|
-
end
|
125
|
-
@action = action
|
126
|
-
end
|
127
|
-
|
128
118
|
# Custom attribute writer method checking allowed values (enum).
|
129
119
|
# @param [Object] scope Object to be assigned
|
130
120
|
def scope=(scope)
|
@@ -135,13 +125,23 @@ module MailSlurpClient
|
|
135
125
|
@scope = scope
|
136
126
|
end
|
137
127
|
|
128
|
+
# Custom attribute writer method checking allowed values (enum).
|
129
|
+
# @param [Object] action Object to be assigned
|
130
|
+
def action=(action)
|
131
|
+
validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
|
132
|
+
unless validator.valid?(action)
|
133
|
+
fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
|
134
|
+
end
|
135
|
+
@action = action
|
136
|
+
end
|
137
|
+
|
138
138
|
# Checks equality by comparing each attribute.
|
139
139
|
# @param [Object] Object to be compared
|
140
140
|
def ==(o)
|
141
141
|
return true if self.equal?(o)
|
142
142
|
self.class == o.class &&
|
143
|
-
action == o.action &&
|
144
143
|
scope == o.scope &&
|
144
|
+
action == o.action &&
|
145
145
|
target == o.target
|
146
146
|
end
|
147
147
|
|
@@ -154,7 +154,7 @@ module MailSlurpClient
|
|
154
154
|
# Calculates hash code according to all attributes.
|
155
155
|
# @return [Integer] Hash code
|
156
156
|
def hash
|
157
|
-
[
|
157
|
+
[scope, action, target].hash
|
158
158
|
end
|
159
159
|
|
160
160
|
# Builds the object from hash
|
@@ -68,22 +68,12 @@ module MailSlurpClient
|
|
68
68
|
# @return Array for valid properties with the reasons
|
69
69
|
def list_invalid_properties
|
70
70
|
invalid_properties = Array.new
|
71
|
-
if @name.nil?
|
72
|
-
invalid_properties.push('invalid value for "name", name cannot be nil.')
|
73
|
-
end
|
74
|
-
|
75
|
-
if @content.nil?
|
76
|
-
invalid_properties.push('invalid value for "content", content cannot be nil.')
|
77
|
-
end
|
78
|
-
|
79
71
|
invalid_properties
|
80
72
|
end
|
81
73
|
|
82
74
|
# Check to see if the all the properties in the model are valid
|
83
75
|
# @return true if the model is valid
|
84
76
|
def valid?
|
85
|
-
return false if @name.nil?
|
86
|
-
return false if @content.nil?
|
87
77
|
true
|
88
78
|
end
|
89
79
|
|
@@ -15,16 +15,16 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# Options for creating a webhook. Webhooks can be attached to inboxes and MailSlurp will POST a webhook payload to the URL specified whenever the inbox receives an email. Webhooks are great for processing many inbound emails.
|
17
17
|
class CreateWebhookOptions
|
18
|
-
|
18
|
+
# Public URL on your server that MailSlurp can post WebhookNotification payload to when an email is received or an event is trigger. The payload of the submitted JSON is dependent on the webhook event type. The default `EMAIL_RECEIVED` payload is described by `https://api.mailslurp.com/schemas/webhook-payload`. The other events, `NEW_EMAIL`, `NEW_CONTACT`, and `NEW_ATTACHMENT` are described by `https://api.mailslurp.com/schemas/webhook-new-email-payload`, `https://api.mailslurp.com/schemas/webhook-new-contact-payload`,`https://api.mailslurp.com/schemas/webhook-new-attachment-payload` respectively.
|
19
|
+
attr_accessor :url
|
19
20
|
|
20
|
-
|
21
|
-
attr_accessor :event_name
|
21
|
+
attr_accessor :basic_auth
|
22
22
|
|
23
23
|
# Optional name for the webhook
|
24
24
|
attr_accessor :name
|
25
25
|
|
26
|
-
#
|
27
|
-
attr_accessor :
|
26
|
+
# Optional webhook event name. Default is `EMAIL_RECEIVED` and is triggered when an email is received by the inbox associated with the webhook. Payload differ according to the webhook event name. The other events are `NEW_EMAIL`, `NEW_CONTACT`, and `NEW_ATTACHMENT` and `EMAIL_OPENED`. `EMAIL_OPENED` requires the use of tracking pixels when sending. See the email tracking guide for more information.
|
27
|
+
attr_accessor :event_name
|
28
28
|
|
29
29
|
class EnumAttributeValidator
|
30
30
|
attr_reader :datatype
|
@@ -51,20 +51,20 @@ module MailSlurpClient
|
|
51
51
|
# Attribute mapping from ruby-style variable name to JSON key.
|
52
52
|
def self.attribute_map
|
53
53
|
{
|
54
|
+
:'url' => :'url',
|
54
55
|
:'basic_auth' => :'basicAuth',
|
55
|
-
:'event_name' => :'eventName',
|
56
56
|
:'name' => :'name',
|
57
|
-
:'
|
57
|
+
:'event_name' => :'eventName'
|
58
58
|
}
|
59
59
|
end
|
60
60
|
|
61
61
|
# Attribute type mapping.
|
62
62
|
def self.openapi_types
|
63
63
|
{
|
64
|
+
:'url' => :'String',
|
64
65
|
:'basic_auth' => :'BasicAuthOptions',
|
65
|
-
:'event_name' => :'String',
|
66
66
|
:'name' => :'String',
|
67
|
-
:'
|
67
|
+
:'event_name' => :'String'
|
68
68
|
}
|
69
69
|
end
|
70
70
|
|
@@ -89,20 +89,20 @@ module MailSlurpClient
|
|
89
89
|
h[k.to_sym] = v
|
90
90
|
}
|
91
91
|
|
92
|
-
if attributes.key?(:'
|
93
|
-
self.
|
92
|
+
if attributes.key?(:'url')
|
93
|
+
self.url = attributes[:'url']
|
94
94
|
end
|
95
95
|
|
96
|
-
if attributes.key?(:'
|
97
|
-
self.
|
96
|
+
if attributes.key?(:'basic_auth')
|
97
|
+
self.basic_auth = attributes[:'basic_auth']
|
98
98
|
end
|
99
99
|
|
100
100
|
if attributes.key?(:'name')
|
101
101
|
self.name = attributes[:'name']
|
102
102
|
end
|
103
103
|
|
104
|
-
if attributes.key?(:'
|
105
|
-
self.
|
104
|
+
if attributes.key?(:'event_name')
|
105
|
+
self.event_name = attributes[:'event_name']
|
106
106
|
end
|
107
107
|
end
|
108
108
|
|
@@ -136,10 +136,10 @@ module MailSlurpClient
|
|
136
136
|
def ==(o)
|
137
137
|
return true if self.equal?(o)
|
138
138
|
self.class == o.class &&
|
139
|
+
url == o.url &&
|
139
140
|
basic_auth == o.basic_auth &&
|
140
|
-
event_name == o.event_name &&
|
141
141
|
name == o.name &&
|
142
|
-
|
142
|
+
event_name == o.event_name
|
143
143
|
end
|
144
144
|
|
145
145
|
# @see the `==` method
|
@@ -151,7 +151,7 @@ module MailSlurpClient
|
|
151
151
|
# Calculates hash code according to all attributes.
|
152
152
|
# @return [Integer] Hash code
|
153
153
|
def hash
|
154
|
-
[
|
154
|
+
[url, basic_auth, name, event_name].hash
|
155
155
|
end
|
156
156
|
|
157
157
|
# Builds the object from hash
|
@@ -15,27 +15,27 @@ require 'date'
|
|
15
15
|
module MailSlurpClient
|
16
16
|
# Name Server lookup result
|
17
17
|
class DescribeMailServerDomainResult
|
18
|
+
attr_accessor :mx_records
|
19
|
+
|
18
20
|
attr_accessor :domain
|
19
21
|
|
20
22
|
attr_accessor :message
|
21
23
|
|
22
|
-
attr_accessor :mx_records
|
23
|
-
|
24
24
|
# Attribute mapping from ruby-style variable name to JSON key.
|
25
25
|
def self.attribute_map
|
26
26
|
{
|
27
|
+
:'mx_records' => :'mxRecords',
|
27
28
|
:'domain' => :'domain',
|
28
|
-
:'message' => :'message'
|
29
|
-
:'mx_records' => :'mxRecords'
|
29
|
+
:'message' => :'message'
|
30
30
|
}
|
31
31
|
end
|
32
32
|
|
33
33
|
# Attribute type mapping.
|
34
34
|
def self.openapi_types
|
35
35
|
{
|
36
|
+
:'mx_records' => :'Array<NameServerRecord>',
|
36
37
|
:'domain' => :'String',
|
37
|
-
:'message' => :'String'
|
38
|
-
:'mx_records' => :'Array<NameServerRecord>'
|
38
|
+
:'message' => :'String'
|
39
39
|
}
|
40
40
|
end
|
41
41
|
|
@@ -60,6 +60,12 @@ module MailSlurpClient
|
|
60
60
|
h[k.to_sym] = v
|
61
61
|
}
|
62
62
|
|
63
|
+
if attributes.key?(:'mx_records')
|
64
|
+
if (value = attributes[:'mx_records']).is_a?(Array)
|
65
|
+
self.mx_records = value
|
66
|
+
end
|
67
|
+
end
|
68
|
+
|
63
69
|
if attributes.key?(:'domain')
|
64
70
|
self.domain = attributes[:'domain']
|
65
71
|
end
|
@@ -67,34 +73,18 @@ module MailSlurpClient
|
|
67
73
|
if attributes.key?(:'message')
|
68
74
|
self.message = attributes[:'message']
|
69
75
|
end
|
70
|
-
|
71
|
-
if attributes.key?(:'mx_records')
|
72
|
-
if (value = attributes[:'mx_records']).is_a?(Array)
|
73
|
-
self.mx_records = value
|
74
|
-
end
|
75
|
-
end
|
76
76
|
end
|
77
77
|
|
78
78
|
# Show invalid properties with the reasons. Usually used together with valid?
|
79
79
|
# @return Array for valid properties with the reasons
|
80
80
|
def list_invalid_properties
|
81
81
|
invalid_properties = Array.new
|
82
|
-
if @domain.nil?
|
83
|
-
invalid_properties.push('invalid value for "domain", domain cannot be nil.')
|
84
|
-
end
|
85
|
-
|
86
|
-
if @mx_records.nil?
|
87
|
-
invalid_properties.push('invalid value for "mx_records", mx_records cannot be nil.')
|
88
|
-
end
|
89
|
-
|
90
82
|
invalid_properties
|
91
83
|
end
|
92
84
|
|
93
85
|
# Check to see if the all the properties in the model are valid
|
94
86
|
# @return true if the model is valid
|
95
87
|
def valid?
|
96
|
-
return false if @domain.nil?
|
97
|
-
return false if @mx_records.nil?
|
98
88
|
true
|
99
89
|
end
|
100
90
|
|
@@ -103,9 +93,9 @@ module MailSlurpClient
|
|
103
93
|
def ==(o)
|
104
94
|
return true if self.equal?(o)
|
105
95
|
self.class == o.class &&
|
96
|
+
mx_records == o.mx_records &&
|
106
97
|
domain == o.domain &&
|
107
|
-
message == o.message
|
108
|
-
mx_records == o.mx_records
|
98
|
+
message == o.message
|
109
99
|
end
|
110
100
|
|
111
101
|
# @see the `==` method
|
@@ -117,7 +107,7 @@ module MailSlurpClient
|
|
117
107
|
# Calculates hash code according to all attributes.
|
118
108
|
# @return [Integer] Hash code
|
119
109
|
def hash
|
120
|
-
[domain, message
|
110
|
+
[mx_records, domain, message].hash
|
121
111
|
end
|
122
112
|
|
123
113
|
# Builds the object from hash
|