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.
Files changed (170) hide show
  1. checksums.yaml +4 -4
  2. data/LICENSE +1 -1
  3. data/lib/mailslurp_client/api/alias_controller_api.rb +60 -56
  4. data/lib/mailslurp_client/api/attachment_controller_api.rb +50 -61
  5. data/lib/mailslurp_client/api/bounce_controller_api.rb +27 -19
  6. data/lib/mailslurp_client/api/bulk_actions_controller_api.rb +16 -16
  7. data/lib/mailslurp_client/api/common_actions_controller_api.rb +129 -68
  8. data/lib/mailslurp_client/api/contact_controller_api.rb +23 -23
  9. data/lib/mailslurp_client/api/domain_controller_api.rb +33 -33
  10. data/lib/mailslurp_client/api/email_controller_api.rb +145 -122
  11. data/lib/mailslurp_client/api/expired_controller_api.rb +20 -20
  12. data/lib/mailslurp_client/api/export_controller_api.rb +39 -39
  13. data/lib/mailslurp_client/api/form_controller_api.rb +17 -19
  14. data/lib/mailslurp_client/api/group_controller_api.rb +53 -53
  15. data/lib/mailslurp_client/api/inbox_controller_api.rb +198 -178
  16. data/lib/mailslurp_client/api/inbox_forwarder_controller_api.rb +34 -30
  17. data/lib/mailslurp_client/api/inbox_ruleset_controller_api.rb +34 -30
  18. data/lib/mailslurp_client/api/mail_server_controller_api.rb +27 -27
  19. data/lib/mailslurp_client/api/missed_email_controller_api.rb +55 -43
  20. data/lib/mailslurp_client/api/sent_emails_controller_api.rb +158 -48
  21. data/lib/mailslurp_client/api/template_controller_api.rb +22 -22
  22. data/lib/mailslurp_client/api/tracking_controller_api.rb +17 -17
  23. data/lib/mailslurp_client/api/wait_for_controller_api.rb +129 -89
  24. data/lib/mailslurp_client/api/webhook_controller_api.rb +103 -87
  25. data/lib/mailslurp_client/api_client.rb +1 -1
  26. data/lib/mailslurp_client/api_error.rb +1 -1
  27. data/lib/mailslurp_client/configuration.rb +3 -3
  28. data/lib/mailslurp_client/models/abstract_webhook_payload.rb +22 -22
  29. data/lib/mailslurp_client/models/alias_dto.rb +64 -49
  30. data/lib/mailslurp_client/models/alias_projection.rb +50 -50
  31. data/lib/mailslurp_client/models/attachment_entity.rb +40 -40
  32. data/lib/mailslurp_client/models/attachment_meta_data.rb +42 -22
  33. data/lib/mailslurp_client/models/attachment_projection.rb +38 -33
  34. data/lib/mailslurp_client/models/basic_auth_options.rb +1 -1
  35. data/lib/mailslurp_client/models/bounce_projection.rb +19 -19
  36. data/lib/mailslurp_client/models/bounce_recipient.rb +31 -31
  37. data/lib/mailslurp_client/models/bounced_email_dto.rb +63 -63
  38. data/lib/mailslurp_client/models/bounced_recipient_dto.rb +23 -23
  39. data/lib/mailslurp_client/models/bulk_send_email_options.rb +11 -1
  40. data/lib/mailslurp_client/models/condition_option.rb +13 -3
  41. data/lib/mailslurp_client/models/contact_dto.rb +63 -63
  42. data/lib/mailslurp_client/models/contact_projection.rb +39 -39
  43. data/lib/mailslurp_client/models/content_match_options.rb +6 -1
  44. data/lib/mailslurp_client/models/count_dto.rb +1 -1
  45. data/lib/mailslurp_client/models/create_alias_options.rb +11 -1
  46. data/lib/mailslurp_client/models/create_contact_options.rb +43 -43
  47. data/lib/mailslurp_client/models/create_domain_options.rb +22 -17
  48. data/lib/mailslurp_client/models/create_group_options.rb +1 -1
  49. data/lib/mailslurp_client/models/create_inbox_dto.rb +59 -59
  50. data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb +30 -15
  51. data/lib/mailslurp_client/models/create_inbox_ruleset_options.rb +39 -24
  52. data/lib/mailslurp_client/models/create_template_options.rb +1 -1
  53. data/lib/mailslurp_client/models/create_tracking_pixel_options.rb +1 -1
  54. data/lib/mailslurp_client/models/create_webhook_options.rb +24 -19
  55. data/lib/mailslurp_client/models/describe_domain_options.rb +1 -1
  56. data/lib/mailslurp_client/models/describe_mail_server_domain_result.rb +21 -21
  57. data/lib/mailslurp_client/models/dns_lookup_options.rb +30 -15
  58. data/lib/mailslurp_client/models/dns_lookup_result.rb +34 -33
  59. data/lib/mailslurp_client/models/dns_lookup_results.rb +1 -1
  60. data/lib/mailslurp_client/models/domain_dto.rb +100 -70
  61. data/lib/mailslurp_client/models/domain_name_record.rb +18 -17
  62. data/lib/mailslurp_client/models/domain_preview.rb +29 -28
  63. data/lib/mailslurp_client/models/download_attachment_dto.rb +16 -1
  64. data/lib/mailslurp_client/models/email.rb +179 -139
  65. data/lib/mailslurp_client/models/email_analysis.rb +29 -29
  66. data/lib/mailslurp_client/models/email_content_match_result.rb +19 -19
  67. data/lib/mailslurp_client/models/email_links_result.rb +19 -19
  68. data/lib/mailslurp_client/models/email_preview.rb +63 -48
  69. data/lib/mailslurp_client/models/email_projection.rb +77 -77
  70. data/lib/mailslurp_client/models/email_recipients.rb +17 -16
  71. data/lib/mailslurp_client/models/email_text_lines_result.rb +19 -19
  72. data/lib/mailslurp_client/models/email_verification_result.rb +22 -22
  73. data/lib/mailslurp_client/models/expiration_defaults.rb +17 -17
  74. data/lib/mailslurp_client/models/expired_inbox_dto.rb +19 -19
  75. data/lib/mailslurp_client/models/expired_inbox_record_projection.rb +33 -33
  76. data/lib/mailslurp_client/models/export_link.rb +1 -1
  77. data/lib/mailslurp_client/models/export_options.rb +2 -2
  78. data/lib/mailslurp_client/models/flush_expired_inboxes_result.rb +19 -19
  79. data/lib/mailslurp_client/models/forward_email_options.rb +37 -32
  80. data/lib/mailslurp_client/models/gravatar_url.rb +19 -19
  81. data/lib/mailslurp_client/models/group_contacts_dto.rb +19 -19
  82. data/lib/mailslurp_client/models/group_dto.rb +28 -28
  83. data/lib/mailslurp_client/models/group_projection.rb +29 -29
  84. data/lib/mailslurp_client/models/html_validation_result.rb +27 -12
  85. data/lib/mailslurp_client/models/{inbox.rb → inbox_dto.rb} +72 -57
  86. data/lib/mailslurp_client/models/inbox_exists_dto.rb +1 -1
  87. data/lib/mailslurp_client/models/inbox_forwarder_dto.rb +48 -48
  88. data/lib/mailslurp_client/models/inbox_forwarder_test_options.rb +1 -1
  89. data/lib/mailslurp_client/models/inbox_forwarder_test_result.rb +19 -19
  90. data/lib/mailslurp_client/models/inbox_preview.rb +59 -39
  91. data/lib/mailslurp_client/models/inbox_ruleset_dto.rb +61 -61
  92. data/lib/mailslurp_client/models/inbox_ruleset_test_options.rb +1 -1
  93. data/lib/mailslurp_client/models/inbox_ruleset_test_result.rb +19 -14
  94. data/lib/mailslurp_client/models/inline_object.rb +221 -0
  95. data/lib/mailslurp_client/models/ip_address_result.rb +1 -1
  96. data/lib/mailslurp_client/models/json_schema_dto.rb +1 -1
  97. data/lib/mailslurp_client/models/match_option.rb +18 -3
  98. data/lib/mailslurp_client/models/match_options.rb +17 -17
  99. data/lib/mailslurp_client/models/missed_email.rb +77 -77
  100. data/lib/mailslurp_client/models/missed_email_projection.rb +25 -25
  101. data/lib/mailslurp_client/models/name_server_record.rb +16 -16
  102. data/lib/mailslurp_client/models/organization_inbox_projection.rb +70 -45
  103. data/lib/mailslurp_client/models/page_alias.rb +59 -50
  104. data/lib/mailslurp_client/models/page_attachment_entity.rb +59 -50
  105. data/lib/mailslurp_client/models/page_bounced_email.rb +59 -50
  106. data/lib/mailslurp_client/models/page_bounced_recipients.rb +59 -50
  107. data/lib/mailslurp_client/models/page_contact_projection.rb +59 -50
  108. data/lib/mailslurp_client/models/page_email_preview.rb +59 -50
  109. data/lib/mailslurp_client/models/page_email_projection.rb +59 -50
  110. data/lib/mailslurp_client/models/page_expired_inbox_record_projection.rb +59 -50
  111. data/lib/mailslurp_client/models/page_group_projection.rb +59 -50
  112. data/lib/mailslurp_client/models/page_inbox_forwarder_dto.rb +59 -50
  113. data/lib/mailslurp_client/models/page_inbox_projection.rb +59 -50
  114. data/lib/mailslurp_client/models/page_inbox_ruleset_dto.rb +59 -50
  115. data/lib/mailslurp_client/models/page_missed_email_projection.rb +59 -50
  116. data/lib/mailslurp_client/models/page_organization_inbox_projection.rb +59 -50
  117. data/lib/mailslurp_client/models/page_sent_email_projection.rb +86 -47
  118. data/lib/mailslurp_client/models/page_template_projection.rb +59 -50
  119. data/lib/mailslurp_client/models/page_thread_projection.rb +59 -50
  120. data/lib/mailslurp_client/models/page_tracking_pixel_projection.rb +59 -50
  121. data/lib/mailslurp_client/models/page_unknown_missed_email_projection.rb +59 -50
  122. data/lib/mailslurp_client/models/page_webhook_projection.rb +59 -50
  123. data/lib/mailslurp_client/models/page_webhook_result.rb +59 -50
  124. data/lib/mailslurp_client/models/{pageable.rb → pageable_object.rb} +32 -32
  125. data/lib/mailslurp_client/models/raw_email_json.rb +1 -1
  126. data/lib/mailslurp_client/models/recipient.rb +19 -19
  127. data/lib/mailslurp_client/models/reply_to_alias_email_options.rb +47 -35
  128. data/lib/mailslurp_client/models/reply_to_email_options.rb +57 -45
  129. data/lib/mailslurp_client/models/send_email_options.rb +112 -110
  130. data/lib/mailslurp_client/models/sender.rb +20 -19
  131. data/lib/mailslurp_client/models/sent_email_dto.rb +110 -95
  132. data/lib/mailslurp_client/models/sent_email_projection.rb +88 -87
  133. data/lib/mailslurp_client/models/set_inbox_favourited_options.rb +6 -1
  134. data/lib/mailslurp_client/models/simple_send_email_options.rb +30 -25
  135. data/lib/mailslurp_client/models/sort.rb +1 -1
  136. data/lib/mailslurp_client/models/template_dto.rb +33 -33
  137. data/lib/mailslurp_client/models/template_projection.rb +37 -37
  138. data/lib/mailslurp_client/models/template_variable.rb +1 -1
  139. data/lib/mailslurp_client/models/test_new_inbox_forwarder_options.rb +1 -1
  140. data/lib/mailslurp_client/models/test_new_inbox_ruleset_options.rb +1 -1
  141. data/lib/mailslurp_client/models/thread_projection.rb +71 -71
  142. data/lib/mailslurp_client/models/tracking_pixel_dto.rb +54 -54
  143. data/lib/mailslurp_client/models/tracking_pixel_projection.rb +42 -42
  144. data/lib/mailslurp_client/models/unknown_missed_email_projection.rb +25 -25
  145. data/lib/mailslurp_client/models/unread_count.rb +1 -1
  146. data/lib/mailslurp_client/models/unseen_error_count_dto.rb +1 -1
  147. data/lib/mailslurp_client/models/update_alias_options.rb +1 -1
  148. data/lib/mailslurp_client/models/update_domain_options.rb +1 -1
  149. data/lib/mailslurp_client/models/update_group_contacts.rb +1 -1
  150. data/lib/mailslurp_client/models/update_inbox_options.rb +27 -27
  151. data/lib/mailslurp_client/models/upload_attachment_options.rb +15 -15
  152. data/lib/mailslurp_client/models/validation_dto.rb +11 -1
  153. data/lib/mailslurp_client/models/validation_message.rb +2 -1
  154. data/lib/mailslurp_client/models/verify_email_address_options.rb +1 -1
  155. data/lib/mailslurp_client/models/wait_for_conditions.rb +53 -53
  156. data/lib/mailslurp_client/models/webhook_dto.rb +105 -65
  157. data/lib/mailslurp_client/models/webhook_email_opened_payload.rb +83 -43
  158. data/lib/mailslurp_client/models/webhook_email_read_payload.rb +85 -50
  159. data/lib/mailslurp_client/models/webhook_new_attachment_payload.rb +79 -44
  160. data/lib/mailslurp_client/models/webhook_new_contact_payload.rb +98 -83
  161. data/lib/mailslurp_client/models/webhook_new_email_payload.rb +140 -85
  162. data/lib/mailslurp_client/models/webhook_projection.rb +47 -47
  163. data/lib/mailslurp_client/models/webhook_redrive_result.rb +19 -19
  164. data/lib/mailslurp_client/models/webhook_result_dto.rb +102 -102
  165. data/lib/mailslurp_client/models/webhook_test_request.rb +28 -28
  166. data/lib/mailslurp_client/models/webhook_test_response.rb +14 -14
  167. data/lib/mailslurp_client/models/webhook_test_result.rb +19 -19
  168. data/lib/mailslurp_client/version.rb +2 -2
  169. data/lib/mailslurp_client.rb +4 -3
  170. 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
 
@@ -15,16 +15,16 @@ require 'date'
15
15
  module MailSlurpClient
16
16
  # Options for creating a domain to use with MailSlurp. You must have ownership access to this domain in order to verify it. Domains will not function correctly until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help. Domains can be either `HTTP` or `SMTP` type. The type of domain determines which inboxes can be used with it. `SMTP` inboxes use a mail server running `mx.mailslurp.com` while `HTTP` inboxes are handled by AWS SES.
17
17
  class CreateDomainOptions
18
- # Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
19
- attr_accessor :created_catch_all_inbox
18
+ # The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
19
+ attr_accessor :domain
20
20
 
21
21
  # Optional description of the domain.
22
22
  attr_accessor :description
23
23
 
24
- # The top level domain you wish to use with MailSlurp. Do not specify subdomain just the top level. So `test.com` covers all subdomains such as `mail.test.com`. Don't include a protocol such as `http://`. Once added you must complete the verification steps by adding the returned records to your domain.
25
- attr_accessor :domain
24
+ # Whether to create a catch all inbox for the domain. Any email sent to an address using your domain that cannot be matched to an existing inbox you created with the domain will be routed to the created catch all inbox. You can access emails using the regular methods on this inbox ID.
25
+ attr_accessor :created_catch_all_inbox
26
26
 
27
- # Domain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record. SMTP domains can only be used with SMTP inboxes. SMTP inboxes are more reliable for public inbound emails while HTTP inboxes are more suitable for testing.
27
+ # Type of domain. Dictates type of inbox that can be created with domain. HTTP means inboxes are processed using SES while SMTP inboxes use a custom SMTP mail server. SMTP does not support sending so use HTTP for sending emails.
28
28
  attr_accessor :domain_type
29
29
 
30
30
  class EnumAttributeValidator
@@ -52,9 +52,9 @@ module MailSlurpClient
52
52
  # Attribute mapping from ruby-style variable name to JSON key.
53
53
  def self.attribute_map
54
54
  {
55
- :'created_catch_all_inbox' => :'createdCatchAllInbox',
56
- :'description' => :'description',
57
55
  :'domain' => :'domain',
56
+ :'description' => :'description',
57
+ :'created_catch_all_inbox' => :'createdCatchAllInbox',
58
58
  :'domain_type' => :'domainType'
59
59
  }
60
60
  end
@@ -62,9 +62,9 @@ module MailSlurpClient
62
62
  # Attribute type mapping.
63
63
  def self.openapi_types
64
64
  {
65
- :'created_catch_all_inbox' => :'Boolean',
66
- :'description' => :'String',
67
65
  :'domain' => :'String',
66
+ :'description' => :'String',
67
+ :'created_catch_all_inbox' => :'Boolean',
68
68
  :'domain_type' => :'String'
69
69
  }
70
70
  end
@@ -90,16 +90,16 @@ module MailSlurpClient
90
90
  h[k.to_sym] = v
91
91
  }
92
92
 
93
- if attributes.key?(:'created_catch_all_inbox')
94
- self.created_catch_all_inbox = attributes[:'created_catch_all_inbox']
93
+ if attributes.key?(:'domain')
94
+ self.domain = attributes[:'domain']
95
95
  end
96
96
 
97
97
  if attributes.key?(:'description')
98
98
  self.description = attributes[:'description']
99
99
  end
100
100
 
101
- if attributes.key?(:'domain')
102
- self.domain = attributes[:'domain']
101
+ if attributes.key?(:'created_catch_all_inbox')
102
+ self.created_catch_all_inbox = attributes[:'created_catch_all_inbox']
103
103
  end
104
104
 
105
105
  if attributes.key?(:'domain_type')
@@ -111,12 +111,17 @@ module MailSlurpClient
111
111
  # @return Array for valid properties with the reasons
112
112
  def list_invalid_properties
113
113
  invalid_properties = Array.new
114
+ if @domain.nil?
115
+ invalid_properties.push('invalid value for "domain", domain cannot be nil.')
116
+ end
117
+
114
118
  invalid_properties
115
119
  end
116
120
 
117
121
  # Check to see if the all the properties in the model are valid
118
122
  # @return true if the model is valid
119
123
  def valid?
124
+ return false if @domain.nil?
120
125
  domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
121
126
  return false unless domain_type_validator.valid?(@domain_type)
122
127
  true
@@ -137,9 +142,9 @@ module MailSlurpClient
137
142
  def ==(o)
138
143
  return true if self.equal?(o)
139
144
  self.class == o.class &&
140
- created_catch_all_inbox == o.created_catch_all_inbox &&
141
- description == o.description &&
142
145
  domain == o.domain &&
146
+ description == o.description &&
147
+ created_catch_all_inbox == o.created_catch_all_inbox &&
143
148
  domain_type == o.domain_type
144
149
  end
145
150
 
@@ -152,7 +157,7 @@ module MailSlurpClient
152
157
  # Calculates hash code according to all attributes.
153
158
  # @return [Integer] Hash code
154
159
  def hash
155
- [created_catch_all_inbox, description, domain, domain_type].hash
160
+ [domain, description, created_catch_all_inbox, domain_type].hash
156
161
  end
157
162
 
158
163
  # Builds the object from hash
@@ -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
 
@@ -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
 
@@ -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
- # 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.
19
- attr_accessor :allow_team_access
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
- # 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.
25
- attr_accessor :email_address
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
- # HTTP (default) or SMTP inbox type. HTTP inboxes are default and best solution for most cases. SMTP inboxes are more reliable for public inbound email consumption (but do not support sending emails). When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at `mx.mailslurp.com`.
37
- attr_accessor :inbox_type
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
- # 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.
43
- attr_accessor :tags
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
- # 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.
46
- attr_accessor :use_domain_pool
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
- :'use_domain_pool' => :'useDomainPool'
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
- :'use_domain_pool' => :'Boolean'
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?(:'allow_team_access')
124
- self.allow_team_access = attributes[:'allow_team_access']
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?(:'email_address')
132
- self.email_address = attributes[:'email_address']
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?(:'expires_at')
136
- self.expires_at = attributes[:'expires_at']
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?(:'expires_in')
140
- self.expires_in = attributes[:'expires_in']
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?(:'inbox_type')
148
- self.inbox_type = attributes[:'inbox_type']
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?(:'tags')
156
- if (value = attributes[:'tags']).is_a?(Array)
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?(:'use_domain_pool')
162
- self.use_domain_pool = attributes[:'use_domain_pool']
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
- use_domain_pool == o.use_domain_pool
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
- [allow_team_access, description, email_address, expires_at, expires_in, favourite, inbox_type, name, tags, use_domain_pool].hash
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
@@ -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
 
@@ -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
- :'forward_to_recipients' => :'forwardToRecipients',
54
- :'match' => :'match'
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
- :'forward_to_recipients' => :'Array<String>',
63
- :'match' => :'String'
62
+ :'match' => :'String',
63
+ :'forward_to_recipients' => :'Array<String>'
64
64
  }
65
65
  end
66
66
 
@@ -89,29 +89,44 @@ 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 @field.nil?
108
+ invalid_properties.push('invalid value for "field", field cannot be nil.')
109
+ end
110
+
111
+ if @match.nil?
112
+ invalid_properties.push('invalid value for "match", match cannot be nil.')
113
+ end
114
+
115
+ if @forward_to_recipients.nil?
116
+ invalid_properties.push('invalid value for "forward_to_recipients", forward_to_recipients cannot be nil.')
117
+ end
118
+
107
119
  invalid_properties
108
120
  end
109
121
 
110
122
  # Check to see if the all the properties in the model are valid
111
123
  # @return true if the model is valid
112
124
  def valid?
125
+ return false if @field.nil?
113
126
  field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
114
127
  return false unless field_validator.valid?(@field)
128
+ return false if @match.nil?
129
+ return false if @forward_to_recipients.nil?
115
130
  true
116
131
  end
117
132
 
@@ -131,8 +146,8 @@ module MailSlurpClient
131
146
  return true if self.equal?(o)
132
147
  self.class == o.class &&
133
148
  field == o.field &&
134
- forward_to_recipients == o.forward_to_recipients &&
135
- match == o.match
149
+ match == o.match &&
150
+ forward_to_recipients == o.forward_to_recipients
136
151
  end
137
152
 
138
153
  # @see the `==` method
@@ -144,7 +159,7 @@ module MailSlurpClient
144
159
  # Calculates hash code according to all attributes.
145
160
  # @return [Integer] Hash code
146
161
  def hash
147
- [field, forward_to_recipients, match].hash
162
+ [field, match, forward_to_recipients].hash
148
163
  end
149
164
 
150
165
  # Builds the object from hash
@@ -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
 
@@ -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
@@ -102,29 +102,34 @@ module MailSlurpClient
102
102
  # @return Array for valid properties with the reasons
103
103
  def list_invalid_properties
104
104
  invalid_properties = Array.new
105
+ if @scope.nil?
106
+ invalid_properties.push('invalid value for "scope", scope cannot be nil.')
107
+ end
108
+
109
+ if @action.nil?
110
+ invalid_properties.push('invalid value for "action", action cannot be nil.')
111
+ end
112
+
113
+ if @target.nil?
114
+ invalid_properties.push('invalid value for "target", target cannot be nil.')
115
+ end
116
+
105
117
  invalid_properties
106
118
  end
107
119
 
108
120
  # Check to see if the all the properties in the model are valid
109
121
  # @return true if the model is valid
110
122
  def valid?
111
- action_validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
112
- return false unless action_validator.valid?(@action)
123
+ return false if @scope.nil?
113
124
  scope_validator = EnumAttributeValidator.new('String', ["RECEIVING_EMAILS", "SENDING_EMAILS"])
114
125
  return false unless scope_validator.valid?(@scope)
126
+ return false if @action.nil?
127
+ action_validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
128
+ return false unless action_validator.valid?(@action)
129
+ return false if @target.nil?
115
130
  true
116
131
  end
117
132
 
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
133
  # Custom attribute writer method checking allowed values (enum).
129
134
  # @param [Object] scope Object to be assigned
130
135
  def scope=(scope)
@@ -135,13 +140,23 @@ module MailSlurpClient
135
140
  @scope = scope
136
141
  end
137
142
 
143
+ # Custom attribute writer method checking allowed values (enum).
144
+ # @param [Object] action Object to be assigned
145
+ def action=(action)
146
+ validator = EnumAttributeValidator.new('String', ["BLOCK", "ALLOW", "FILTER_REMOVE"])
147
+ unless validator.valid?(action)
148
+ fail ArgumentError, "invalid value for \"action\", must be one of #{validator.allowable_values}."
149
+ end
150
+ @action = action
151
+ end
152
+
138
153
  # Checks equality by comparing each attribute.
139
154
  # @param [Object] Object to be compared
140
155
  def ==(o)
141
156
  return true if self.equal?(o)
142
157
  self.class == o.class &&
143
- action == o.action &&
144
158
  scope == o.scope &&
159
+ action == o.action &&
145
160
  target == o.target
146
161
  end
147
162
 
@@ -154,7 +169,7 @@ module MailSlurpClient
154
169
  # Calculates hash code according to all attributes.
155
170
  # @return [Integer] Hash code
156
171
  def hash
157
- [action, scope, target].hash
172
+ [scope, action, target].hash
158
173
  end
159
174
 
160
175
  # Builds the object from hash
@@ -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
 
@@ -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