mailslurp_client 11.13.0 → 12.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a234ba673c835d62d7726836c068fd3832297aa3e86449bb526db415ed747d5e
-  data.tar.gz: b561674c80f4a202926e1e75334b30a83bbb8cda88c77cce5b0826d98c942157
+  metadata.gz: 680e803f1dded14fd5a2950806c2151fc3b3491bb6f54d34f7f6aa059698fa1b
+  data.tar.gz: 167978e04b87d5de123a191af703e22088637f914dcfc926bf4a8d8188d7a843
 SHA512:
-  metadata.gz: 45918cda7418664374d96caa8fe2e2b99bf3a4b32653a646756fc5c3dd37cdee25944fcf9a777d8bec24445e4cfe6e43f87bb1dc5c30bb2e9c6332e13e74522f
-  data.tar.gz: 46e56a81ca1ae8ce524830cdad10e037afd69c2cb2e345df4847485189eb029b49d9164bf808789af54e73ce8542bb5fb4bc5343bb4e72e967c8ed8e36e6f747
+  metadata.gz: 0aae09815da7765057f48b07fe81fa598668b056c392ad24bbcbe0930d601e8f273b46b393acf715487ca91a0597a412d11246565f1b4cba3e13b699fc444d7f
+  data.tar.gz: e06902b5725220bd679d7152d755ec013faf95714664f4d7fc8ec35a53983c5aecfd42cef7c4364410825948bb5d36fbaa7afbcfa440e8a09597dca1a21c4884

data/lib/mailslurp_client.rb

@@ -20,8 +20,8 @@ require 'mailslurp_client/configuration'
 require 'mailslurp_client/models/abstract_webhook_payload'
 require 'mailslurp_client/models/alias_dto'
 require 'mailslurp_client/models/alias_projection'
-require 'mailslurp_client/models/attachment_entity'
 require 'mailslurp_client/models/attachment_meta_data'
+require 'mailslurp_client/models/attachment_projection'
 require 'mailslurp_client/models/basic_auth_options'
 require 'mailslurp_client/models/bulk_send_email_options'
 require 'mailslurp_client/models/contact_dto'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -268,6 +268,7 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [Integer] :page Optional page index event list pagination (default to 0)
     # @option opts [Integer] :size Optional page size event list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
@@ -280,6 +281,7 @@ module MailSlurpClient
     # Get email attachments
     # Get all attachments in paginated response. Each entity contains meta data for the attachment such as `name` and `content-type`. Use the `attachmentId` and the download endpoints to get the file contents.
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :file_name_filter Optional file name and content type search filter
     # @option opts [Integer] :page Optional page index event list pagination
     # @option opts [Integer] :size Optional page size event list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
@@ -297,6 +299,7 @@ module MailSlurpClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'fileNameFilter'] = opts[:'file_name_filter'] if !opts[:'file_name_filter'].nil?
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -204,7 +204,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
+    # Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -215,7 +215,7 @@ module MailSlurpClient
       data
     end
 
-    # Get email attachment as base64 encoded string alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
+    # Get email attachment as base64 encoded string as an alternative to binary responses. Decode the `base64FileContents` as a `utf-8` encoded string or array of bytes depending on the `contentType`.
     # Returns the specified attachment for a given email as a base 64 encoded string. The response type is application/json. This method is similar to the `downloadAttachment` method but allows some clients to get around issues with binary responses.
     # @param attachment_id [String] ID of attachment
     # @param email_id [String] ID of email
@@ -397,7 +397,7 @@ module MailSlurpClient
     end
 
     # Forward email to recipients
-    # Forward an existing email to new recipients.
+    # Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
@@ -408,7 +408,7 @@ module MailSlurpClient
     end
 
     # Forward email to recipients
-    # Forward an existing email to new recipients.
+    # Forward an existing email to new recipients. The sender of the email will be the inbox that received the email you are forwarding. You can override the sender with the `from` option. Note you must have access to the from address in MailSlurp to use the override. For more control consider fetching the email and sending it a new using the send email endpoints.
     # @param email_id [String] ID of email
     # @param forward_email_options [ForwardEmailOptions] forwardEmailOptions
     # @param [Hash] opts the optional parameters
@@ -532,7 +532,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all email attachment metadata. Metadata includes name and attachment size.
+    # Get all email attachment metadata. Metadata includes name and size of attachments.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -542,7 +542,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all email attachment metadata. Metadata includes name and attachment size.
+    # Get all email attachment metadata. Metadata includes name and size of attachments.
     # Returns an array of attachment metadata such as name and content-type for a given email if present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
@@ -927,7 +927,7 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get all emails in all inboxes. Email API list all.
+    # Get all emails in all inboxes in paginated form. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -941,7 +941,7 @@ module MailSlurpClient
       data
     end
 
-    # Get all emails in all inboxes. Email API list all.
+    # Get all emails in all inboxes in paginated form. Email API list all.
     # By default returns all emails across all inboxes sorted by ascending created at date. Responses are paginated. You can restrict results to a list of inbox IDs. You can also filter out read messages
     # @param [Hash] opts the optional parameters
     # @option opts [Array<String>] :inbox_id Optional inbox ids to filter by. Can be repeated. By default will use all inboxes belonging to your account.
@@ -1446,7 +1446,7 @@ module MailSlurpClient
     end
 
     # Validate email HTML contents
-    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [ValidationDto]
@@ -1456,7 +1456,7 @@ module MailSlurpClient
     end
 
     # Validate email HTML contents
-    # Validate the HTML content of email if HTML is found. Considered valid if no HTML.
+    # Validate the HTML content of email if HTML is found. Considered valid if no HTML is present.
     # @param email_id [String] ID of email
     # @param [Hash] opts the optional parameters
     # @return [Array<(ValidationDto, Integer, Hash)>] ValidationDto data, response status code and response headers

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -19,41 +19,47 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either `SMTP` or `HTTP` inboxes.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
     # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
-    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. 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.
+    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as `123@mailslurp.com`. If you use the `useDomainPool` option when the email address is null it will generate an email address with a more varied domain ending such as `123@mailslurp.info` or `123@mailslurp.biz`. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so `SMTP` inboxes will only work with `SMTP` type domains. 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.
     # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won't be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd'T'HH:mm:ss.SSSXXX.
     # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
-    # @option opts [Boolean] :favourite Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
-    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search
+    # @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
+    # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are best for testing while SMTP inboxes are more reliable for public inbound email consumption. 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`.
+    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
     # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
-    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field.
+    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field. Note this feature is only available for &#x60;HTTP&#x60; inbox types.
     # @return [Inbox]
     def create_inbox(opts = {})
       data, _status_code, _headers = create_inbox_with_http_info(opts)
       data
     end
 
-    # Create an inbox email address. An inbox has a real email address and can send and receive emails.
+    # Create an inbox email address. An inbox has a real email address and can send and receive emails. Inboxes can be either &#x60;SMTP&#x60; or &#x60;HTTP&#x60; inboxes.
     # Create a new inbox and with a randomized email address to send and receive from. Pass emailAddress parameter if you wish to use a specific email address. Creating an inbox is required before sending or receiving emails. If writing tests it is recommended that you create a new inbox during each test method so that it is unique and empty. 
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :allow_team_access Grant team access to this inbox and the emails that belong to it for team members of your organization.
     # @option opts [String] :description Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
-    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as &#x60;123@mailslurp.com&#x60;. If you use the &#x60;useDomainPool&#x60; option when the email address is null it will generate an email address with a more varied domain ending such as &#x60;123@mailslurp.info&#x60; or &#x60;123@mailslurp.biz&#x60;. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. 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.
+    # @option opts [String] :email_address A custom email address to use with the inbox. Defaults to null. When null MailSlurp will assign a random email address to the inbox such as &#x60;123@mailslurp.com&#x60;. If you use the &#x60;useDomainPool&#x60; option when the email address is null it will generate an email address with a more varied domain ending such as &#x60;123@mailslurp.info&#x60; or &#x60;123@mailslurp.biz&#x60;. When a custom email address is provided the address is split into a domain and the domain is queried against your user. If you have created the domain in the MailSlurp dashboard and verified it you can use any email address that ends with the domain. Note domain types must match the inbox type - so &#x60;SMTP&#x60; inboxes will only work with &#x60;SMTP&#x60; type domains. 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.
     # @option opts [DateTime] :expires_at Optional inbox expiration date. If null then this inbox is permanent and the emails in it won&#39;t be deleted. If an expiration date is provided or is required by your plan the inbox will be closed when the expiration time is reached. Expired inboxes still contain their emails but can no longer send or receive emails. An ExpiredInboxRecord is created when an inbox and the email address and inbox ID are recorded. The expiresAt property is a timestamp string in ISO DateTime Format yyyy-MM-dd&#39;T&#39;HH:mm:ss.SSSXXX.
     # @option opts [Integer] :expires_in Number of milliseconds that inbox should exist for
-    # @option opts [Boolean] :favourite Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
-    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search
+    # @option opts [Boolean] :favourite Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
+    # @option opts [String] :inbox_type HTTP (default) or SMTP inbox type. HTTP inboxes are best for testing while SMTP inboxes are more reliable for public inbound email consumption. When using custom domains the domain type must match the inbox type. HTTP inboxes are processed by AWS SES while SMTP inboxes use a custom mail server running at &#x60;mx.mailslurp.com&#x60;.
+    # @option opts [String] :name Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
     # @option opts [Array<String>] :tags Tags that inbox has been tagged with. Tags can be added to inboxes to group different inboxes within an account. You can also search for inboxes by tag in the dashboard UI.
-    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field.
+    # @option opts [Boolean] :use_domain_pool Use the MailSlurp domain name pool with this inbox when creating the email address. Defaults to null. If enabled the inbox will be an email address with a domain randomly chosen from a list of the MailSlurp domains. This is useful when the default &#x60;@mailslurp.com&#x60; email addresses used with inboxes are blocked or considered spam by a provider or receiving service. When domain pool is enabled an email address will be generated ending in &#x60;@mailslurp.{world,info,xyz,...}&#x60; . This means a TLD is randomly selecting from a list of &#x60;.biz&#x60;, &#x60;.info&#x60;, &#x60;.xyz&#x60; etc to add variance to the generated email addresses. When null or false MailSlurp uses the default behavior of &#x60;@mailslurp.com&#x60; or custom email address provided by the emailAddress field. Note this feature is only available for &#x60;HTTP&#x60; inbox types.
     # @return [Array<(Inbox, Integer, Hash)>] Inbox data, response status code and response headers
     def create_inbox_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InboxControllerApi.create_inbox ...'
       end
+      allowable_values = ["HTTP_INBOX", "SMTP_INBOX"]
+      if @api_client.config.client_side_validation && opts[:'inbox_type'] && !allowable_values.include?(opts[:'inbox_type'])
+        fail ArgumentError, "invalid value for \"inbox_type\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/inboxes'
 
@@ -65,6 +71,7 @@ module MailSlurpClient
       query_params[:'expiresAt'] = opts[:'expires_at'] if !opts[:'expires_at'].nil?
       query_params[:'expiresIn'] = opts[:'expires_in'] if !opts[:'expires_in'].nil?
       query_params[:'favourite'] = opts[:'favourite'] if !opts[:'favourite'].nil?
+      query_params[:'inboxType'] = opts[:'inbox_type'] if !opts[:'inbox_type'].nil?
       query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
       query_params[:'tags'] = @api_client.build_collection_param(opts[:'tags'], :multi) if !opts[:'tags'].nil?
       query_params[:'useDomainPool'] = opts[:'use_domain_pool'] if !opts[:'use_domain_pool'].nil?

data/lib/mailslurp_client/models/{attachment_entity.rb → attachment_projection.rb}

@@ -13,17 +13,18 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  class AttachmentEntity
+  class AttachmentProjection
+    # Attachment ID
     attr_accessor :attachment_id
 
+    # Content length of attachment in bytes
     attr_accessor :content_length
 
+    # Content type of attachment.
     attr_accessor :content_type
 
     attr_accessor :created_at
 
-    attr_accessor :id
-
     attr_accessor :name
 
     attr_accessor :updated_at
@@ -37,7 +38,6 @@ module MailSlurpClient
         :'content_length' => :'contentLength',
         :'content_type' => :'contentType',
         :'created_at' => :'createdAt',
-        :'id' => :'id',
         :'name' => :'name',
         :'updated_at' => :'updatedAt',
         :'user_id' => :'userId'
@@ -51,7 +51,6 @@ module MailSlurpClient
         :'content_length' => :'Integer',
         :'content_type' => :'String',
         :'created_at' => :'DateTime',
-        :'id' => :'String',
         :'name' => :'String',
         :'updated_at' => :'DateTime',
         :'user_id' => :'String'
@@ -68,13 +67,13 @@ module MailSlurpClient
     # @param [Hash] attributes Model attributes in the form of hash
     def initialize(attributes = {})
       if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::AttachmentEntity` initialize method"
+        fail ArgumentError, "The input argument (attributes) must be a hash in `MailSlurpClient::AttachmentProjection` initialize method"
       end
 
       # check to see if the attribute exists and convert string to symbol for hash key
       attributes = attributes.each_with_object({}) { |(k, v), h|
         if (!self.class.attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::AttachmentEntity`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+          fail ArgumentError, "`#{k}` is not a valid attribute in `MailSlurpClient::AttachmentProjection`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
         end
         h[k.to_sym] = v
       }
@@ -95,10 +94,6 @@ module MailSlurpClient
         self.created_at = attributes[:'created_at']
       end
 
-      if attributes.key?(:'id')
-        self.id = attributes[:'id']
-      end
-
       if attributes.key?(:'name')
         self.name = attributes[:'name']
       end
@@ -116,10 +111,6 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @attachment_id.nil?
-        invalid_properties.push('invalid value for "attachment_id", attachment_id cannot be nil.')
-      end
-
       if @created_at.nil?
         invalid_properties.push('invalid value for "created_at", created_at cannot be nil.')
       end
@@ -138,7 +129,6 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      return false if @attachment_id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
@@ -154,7 +144,6 @@ module MailSlurpClient
           content_length == o.content_length &&
           content_type == o.content_type &&
           created_at == o.created_at &&
-          id == o.id &&
           name == o.name &&
           updated_at == o.updated_at &&
           user_id == o.user_id
@@ -169,7 +158,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [attachment_id, content_length, content_type, created_at, id, name, updated_at, user_id].hash
+      [attachment_id, content_length, content_type, created_at, name, updated_at, user_id].hash
     end
 
     # Builds the object from hash

data/lib/mailslurp_client/models/create_domain_options.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # 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 functionally currently until the domain has been verified. See https://www.mailslurp.com/guides/custom-domains for help.
+  # 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.
   class CreateDomainOptions
     # 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.
     attr_accessor :created_catch_all_inbox
@@ -24,7 +24,7 @@ module MailSlurpClient
     # 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.
     attr_accessor :domain
 
-    # Domain type to create. HTTP or SMTP domain. HTTP domain uses MailSlurps SES MX records. SMTP uses a custom SMTP server MX record
+    # 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.
     attr_accessor :domain_type
 
     class EnumAttributeValidator

data/lib/mailslurp_client/models/create_inbox_dto.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # 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. They 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 then ending in a similar domains such as `mailslurp.xyz` (selected at random). 
+  # 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. Use `SMTP` for public facing mailboxes and `HTTP` for test email accounts. `SMTP` inboxes are processed by a mail server running at `mx.mailslurp.com` while `HTTP` inboxes 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). 
   class CreateInboxDto
     # Grant team access to this inbox and the emails that belong to it for team members of your organization.
     attr_accessor :allow_team_access
@@ -21,7 +21,7 @@ module MailSlurpClient
     # Optional description of the inbox for labelling purposes. Is shown in the dashboard and can be used with
     attr_accessor :description
 
-    # 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. 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.
+    # 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. 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.
     attr_accessor :email_address
 
     # 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.
@@ -30,19 +30,19 @@ module MailSlurpClient
     # Number of milliseconds that inbox should exist for
     attr_accessor :expires_in
 
-    # Is the inbox favorited. Favouriting inboxes is typically done in the dashboard for quick access or filtering
+    # Is the inbox a favorite. Marking an inbox as a favorite is typically done in the dashboard for quick access or filtering
     attr_accessor :favourite
 
-    # HTTP or SMTP inbox
+    # HTTP (default) or SMTP inbox type. HTTP inboxes are best for testing while SMTP inboxes are more reliable for public inbound email consumption. 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`.
     attr_accessor :inbox_type
 
-    # Optional name of the inbox. Displayed in the dashboard for easier search
+    # Optional name of the inbox. Displayed in the dashboard for easier search and used as the sender name when sending emails.
     attr_accessor :name
 
     # 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.
     attr_accessor :tags
 
-    # 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.
+    # 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.
     attr_accessor :use_domain_pool
 
     class EnumAttributeValidator

data/lib/mailslurp_client/models/domain_dto.rb

@@ -29,6 +29,9 @@ module MailSlurpClient
     # List of DNS domain name records (C, MX, TXT) etc that you must add to the DNS server associated with your domain provider.
     attr_accessor :domain_name_records
 
+    # The type of domain. SMTP or HTTP domains differ in what inboxes can be used with them.
+    attr_accessor :domain_type
+
     attr_accessor :id
 
     # Whether domain has been verified or not. If the domain is not verified after 72 hours there is most likely an issue with the domains DNS records.
@@ -41,6 +44,28 @@ module MailSlurpClient
     # Verification tokens
     attr_accessor :verification_token
 
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
@@ -49,6 +74,7 @@ module MailSlurpClient
         :'dkim_tokens' => :'dkimTokens',
         :'domain' => :'domain',
         :'domain_name_records' => :'domainNameRecords',
+        :'domain_type' => :'domainType',
         :'id' => :'id',
         :'is_verified' => :'isVerified',
         :'updated_at' => :'updatedAt',
@@ -65,6 +91,7 @@ module MailSlurpClient
         :'dkim_tokens' => :'Array<String>',
         :'domain' => :'String',
         :'domain_name_records' => :'Array<DomainNameRecord>',
+        :'domain_type' => :'String',
         :'id' => :'String',
         :'is_verified' => :'Boolean',
         :'updated_at' => :'DateTime',
@@ -118,6 +145,10 @@ module MailSlurpClient
         end
       end
 
+      if attributes.key?(:'domain_type')
+        self.domain_type = attributes[:'domain_type']
+      end
+
       if attributes.key?(:'id')
         self.id = attributes[:'id']
       end
@@ -166,12 +197,24 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
+      domain_type_validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      return false unless domain_type_validator.valid?(@domain_type)
       return false if @id.nil?
       return false if @updated_at.nil?
       return false if @user_id.nil?
       true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] domain_type Object to be assigned
+    def domain_type=(domain_type)
+      validator = EnumAttributeValidator.new('String', ["HTTP_INBOX", "SMTP_DOMAIN"])
+      unless validator.valid?(domain_type)
+        fail ArgumentError, "invalid value for \"domain_type\", must be one of #{validator.allowable_values}."
+      end
+      @domain_type = domain_type
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -182,6 +225,7 @@ module MailSlurpClient
           dkim_tokens == o.dkim_tokens &&
           domain == o.domain &&
           domain_name_records == o.domain_name_records &&
+          domain_type == o.domain_type &&
           id == o.id &&
           is_verified == o.is_verified &&
           updated_at == o.updated_at &&
@@ -198,7 +242,7 @@ module MailSlurpClient
     # Calculates hash code according to all attributes.
     # @return [Integer] Hash code
     def hash
-      [catch_all_inbox_id, created_at, dkim_tokens, domain, domain_name_records, id, is_verified, updated_at, user_id, verification_token].hash
+      [catch_all_inbox_id, created_at, dkim_tokens, domain, domain_name_records, domain_type, id, is_verified, updated_at, user_id, verification_token].hash
     end
 
     # Builds the object from hash