mailslurp_client 8.2.11 → 8.2.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40608cc8ee70cfd122f80fababa6cad2e55bab5bcca6f96212bd63a13502961
-  data.tar.gz: 94ee3ff4be8b1d07e049ec5dccfcd47609c5b1767e22f14b3ce11f959b0909b3
+  metadata.gz: 881dae0965a313cf4e679fc47e998a276e07d3061765332c5ce6e383b5b837c9
+  data.tar.gz: 37bc815bc87386f28781283cc8188d67eaff8e064017f5dcf9c13b61a6e79206
 SHA512:
-  metadata.gz: 84c3e53059f5a0d9fab85eff31f7eb70b87f241c47be0cdb681f3b378f7975e277b5d973071d4a375733113aab280f50ffe851cc03c7b533a801f6c41a3f4086
-  data.tar.gz: b0279d78a93d3cf3692b99e04387e89239e18804fe8b2cbcb59ed216f72421705904571ecb8c7cab15e7a9781ce4c8feacfc8326251e3cc529fa0f20dda1b7b7
+  metadata.gz: 8f96ca7c6b8e8576577ab457784427bd827f6c2168ca80baf22d979107aac4ab9491643e6f06172fb002e0583ac34c58efa2796f35d800bd6717ea9216902fb5
+  data.tar.gz: 1210557bf09554f787242009ef9d604c4ce4565ec3bc0a3b72f605c484869a5707cc5e4e93f8d9fb8f5267e7e45294102f9609464ebc3197a0004cd44ea62ec0

data/lib/mailslurp_client.rb

@@ -30,6 +30,9 @@ require 'mailslurp_client/models/create_group_options'
 require 'mailslurp_client/models/create_owned_alias_options'
 require 'mailslurp_client/models/create_template_options'
 require 'mailslurp_client/models/create_webhook_options'
+require 'mailslurp_client/models/dns_lookup_options'
+require 'mailslurp_client/models/dns_lookup_result'
+require 'mailslurp_client/models/dns_lookup_results'
 require 'mailslurp_client/models/describe_domain_options'
 require 'mailslurp_client/models/describe_mail_server_domain_result'
 require 'mailslurp_client/models/domain_dto'
@@ -46,6 +49,7 @@ require 'mailslurp_client/models/group_contacts_dto'
 require 'mailslurp_client/models/group_dto'
 require 'mailslurp_client/models/group_projection'
 require 'mailslurp_client/models/html_validation_result'
+require 'mailslurp_client/models/ip_address_result'
 require 'mailslurp_client/models/inbox'
 require 'mailslurp_client/models/inbox_projection'
 require 'mailslurp_client/models/match_option'
@@ -64,7 +68,6 @@ require 'mailslurp_client/models/page_webhook_projection'
 require 'mailslurp_client/models/pageable'
 require 'mailslurp_client/models/raw_email_json'
 require 'mailslurp_client/models/send_email_options'
-require 'mailslurp_client/models/sent_email'
 require 'mailslurp_client/models/sent_email_dto'
 require 'mailslurp_client/models/sent_email_projection'
 require 'mailslurp_client/models/set_inbox_favourited_options'

data/lib/mailslurp_client/api/attachment_controller_api.rb

@@ -20,7 +20,7 @@ module MailSlurpClient
       @api_client = api_client
     end
     # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param upload_options [UploadAttachmentOptions] uploadOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<String>]
@@ -30,7 +30,7 @@ module MailSlurpClient
     end
 
     # Upload an attachment for sending using base64 file encoding. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param upload_options [UploadAttachmentOptions] uploadOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
@@ -84,7 +84,7 @@ module MailSlurpClient
     end
 
     # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
     # @option opts [String] :filename Optional filename to save upload with
@@ -96,7 +96,7 @@ module MailSlurpClient
     end
 
     # Upload an attachment for sending using file byte stream input octet stream. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :string Optional contentType for file. For instance &#x60;application/pdf&#x60;
     # @option opts [String] :filename Optional filename to save upload with
@@ -150,7 +150,7 @@ module MailSlurpClient
     end
 
     # Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with `SendEmailOptions` when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param file [File] file
     # @param [Hash] opts the optional parameters
     # @option opts [String] :content_type Optional content type of attachment
@@ -163,7 +163,7 @@ module MailSlurpClient
     end
 
     # Upload an attachment for sending using a Multipart Form request. Returns an array whose first element is the ID of the uploaded attachment.
-    # When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment IDs. For legacy reasons the ID is returned in an array. Only a single ID is ever returned at one time. To send the attachments pass a list of attachment IDs with SendEmailOptions when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
+    # Email attachments are essentially files with meta data. Files are byte arrays and the meta data is a content type and a filename. These properties allow email clients to display the filename and icon etc. When sending emails with attachments first upload each attachment with an upload endpoint. Record the returned attachment ID and use it with subsequent email sending. For legacy reasons the ID is returned as the first element in an array. Only a single ID is ever returned. To send the attachments pass a list of attachment IDs with &#x60;SendEmailOptions&#x60; when sending an email. Using the upload endpoints prior to sending mean attachments can easily be reused.
     # @param file [File] file
     # @param [Hash] opts the optional parameters
     # @option opts [String] :content_type Optional content type of attachment

data/lib/mailslurp_client/api/email_controller_api.rb

@@ -536,7 +536,7 @@ module MailSlurpClient
     end
 
     # Get email content regex pattern match results. Runs regex against email body and returns match groups.
-    # Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
+    # Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. 
     # @param email_id [String] ID of email to match against
     # @param content_match_options [ContentMatchOptions] contentMatchOptions
     # @param [Hash] opts the optional parameters
@@ -547,7 +547,7 @@ module MailSlurpClient
     end
 
     # Get email content regex pattern match results. Runs regex against email body and returns match groups.
-    # Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns.
+    # Return the matches for a given Java style regex pattern. Do not include the typical `/` at start or end of regex in some languages. Given an example `your code is: 12345` the pattern to extract match looks like `code is: (\\d{6})`. This will return an array of matches with the first matching the entire pattern and the subsequent matching the groups: `['code is: 123456', '123456']` See https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html for more information of available patterns. 
     # @param email_id [String] ID of email to match against
     # @param content_match_options [ContentMatchOptions] contentMatchOptions
     # @param [Hash] opts the optional parameters
@@ -598,7 +598,7 @@ module MailSlurpClient
         :return_type => return_type
       )
 
-      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
       if @api_client.config.debugging
         @api_client.config.logger.debug "API called: EmailControllerApi#get_email_content_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
       end
@@ -675,7 +675,7 @@ module MailSlurpClient
     # @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.
     # @option opts [Integer] :page Optional page index in email list pagination (default to 0)
-    # @option opts [Integer] :size Optional page size in email list pagination (default to 20)
+    # @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly (default to false)
     # @return [PageEmailProjection]
@@ -689,7 +689,7 @@ module MailSlurpClient
     # @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.
     # @option opts [Integer] :page Optional page index in email list pagination
-    # @option opts [Integer] :size Optional page size in email list pagination
+    # @option opts [Integer] :size Optional page size in email list pagination. Maximum size is 100. Use page index and sort to page through larger results
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @option opts [Boolean] :unread_only Optional filter for unread emails only. All emails are considered unread until they are viewed in the dashboard or requested directly
     # @return [Array<(PageEmailProjection, Integer, Hash)>] PageEmailProjection data, response status code and response headers

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -207,8 +207,8 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # List Inboxes Paginated
-    # List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
+    # List All Inboxes Paginated
+    # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return(, and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only (default to false)
     # @option opts [Integer] :page Optional page index in inbox list pagination (default to 0)
@@ -222,8 +222,8 @@ module MailSlurpClient
       data
     end
 
-    # List Inboxes Paginated
-    # List inboxes in paginated form. Allows for page index, page size, and sort direction. Can also filter by favourited or email address like pattern.
+    # List All Inboxes Paginated
+    # List inboxes in paginated form. The results are available on the `content` property of the returned object. This method allows for page index (zero based), page size (how many results to return(, and a sort direction (based on createdAt time). You Can also filter by whether an inbox is favorited or use email address pattern. This method is the recommended way to query inboxes. The alternative `getInboxes` method returns a full list of inboxes but is limited to 100 results.
     # @param [Hash] opts the optional parameters
     # @option opts [Boolean] :favourite Optionally filter results for favourites only
     # @option opts [Integer] :page Optional page index in inbox list pagination
@@ -285,14 +285,15 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
-    # Get emails in an Inbox
+    # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
     # List emails that an inbox has received. Only emails that are sent to the inbox's email address will appear in the inbox. It may take several seconds for any email you send to an inbox's email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the `minCount` parameter. The server will retry the inbox database until the `minCount` is satisfied or the `retryTimeout` is reached
     # @param inbox_id [String] Id of inbox that emails belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
+    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
     # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
     # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
     # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
+    # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
     # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
     # @return [Array<EmailPreview>]
     def get_emails(inbox_id, opts = {})
@@ -300,14 +301,15 @@ module MailSlurpClient
       data
     end
 
-    # Get emails in an Inbox
+    # Get emails in an Inbox. This method is not idempotent as it allows retries and waits if you want certain conditions to be met before returning. For simple listing and sorting of known emails use the email controller instead.
     # List emails that an inbox has received. Only emails that are sent to the inbox&#39;s email address will appear in the inbox. It may take several seconds for any email you send to an inbox&#39;s email address to appear in the inbox. To make this endpoint wait for a minimum number of emails use the &#x60;minCount&#x60; parameter. The server will retry the inbox database until the &#x60;minCount&#x60; is satisfied or the &#x60;retryTimeout&#x60; is reached
     # @param inbox_id [String] Id of inbox that emails belongs to
     # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction
+    # @option opts [Integer] :limit Limit the result set, ordered by received date time sort direction. Maximum 100. For more listing options see the email controller
     # @option opts [Integer] :min_count Minimum acceptable email count. Will cause request to hang (and retry) until minCount is satisfied or retryTimeout is reached.
     # @option opts [Integer] :retry_timeout Maximum milliseconds to spend retrying inbox database until minCount emails are returned
     # @option opts [DateTime] :since Exclude emails received before this ISO 8601 date time
+    # @option opts [Integer] :size Alias for limit. Assessed first before assessing any passed limit.
     # @option opts [String] :sort Sort the results by received date and direction ASC or DESC
     # @return [Array<(Array<EmailPreview>, Integer, Hash)>] Array<EmailPreview> data, response status code and response headers
     def get_emails_with_http_info(inbox_id, opts = {})
@@ -331,6 +333,7 @@ module MailSlurpClient
       query_params[:'minCount'] = opts[:'min_count'] if !opts[:'min_count'].nil?
       query_params[:'retryTimeout'] = opts[:'retry_timeout'] if !opts[:'retry_timeout'].nil?
       query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
@@ -635,8 +638,10 @@ module MailSlurpClient
     end
 
     # List Inboxes / Email Addresses
-    # List the inboxes you have created
+    # List the inboxes you have created. Note use of the more advanced `getAllEmails` is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries. (default to 100)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [Array<Inbox>]
     def get_inboxes(opts = {})
       data, _status_code, _headers = get_inboxes_with_http_info(opts)
@@ -644,18 +649,26 @@ module MailSlurpClient
     end
 
     # List Inboxes / Email Addresses
-    # List the inboxes you have created
+    # List the inboxes you have created. Note use of the more advanced &#x60;getAllEmails&#x60; is recommended. You can provide a limit and sort parameter.
     # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :size Optional result size limit. Note an automatic limit of 100 results is applied. See the paginated &#x60;getAllEmails&#x60; for larger queries.
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(Array<Inbox>, Integer, Hash)>] Array<Inbox> data, response status code and response headers
     def get_inboxes_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InboxControllerApi.get_inboxes ...'
       end
+      allowable_values = ["ASC", "DESC"]
+      if @api_client.config.client_side_validation && opts[:'sort'] && !allowable_values.include?(opts[:'sort'])
+        fail ArgumentError, "invalid value for \"sort\", must be one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/inboxes'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
+      query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -759,7 +772,7 @@ module MailSlurpClient
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
-    # @return [SentEmail]
+    # @return [SentEmailDto]
     def send_email_and_confirm(inbox_id, opts = {})
       data, _status_code, _headers = send_email_and_confirm_with_http_info(inbox_id, opts)
       data
@@ -770,7 +783,7 @@ module MailSlurpClient
     # @param inbox_id [String] ID of the inbox you want to send the email from
     # @param [Hash] opts the optional parameters
     # @option opts [SendEmailOptions] :send_email_options Options for the email
-    # @return [Array<(SentEmail, Integer, Hash)>] SentEmail data, response status code and response headers
+    # @return [Array<(SentEmailDto, Integer, Hash)>] SentEmailDto data, response status code and response headers
     def send_email_and_confirm_with_http_info(inbox_id, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: InboxControllerApi.send_email_and_confirm ...'
@@ -799,7 +812,7 @@ module MailSlurpClient
       post_body = opts[:body] || @api_client.object_to_http_body(opts[:'send_email_options']) 
 
       # return_type
-      return_type = opts[:return_type] || 'SentEmail' 
+      return_type = opts[:return_type] || 'SentEmailDto' 
 
       # auth_names
       auth_names = opts[:auth_names] || ['API_KEY']

data/lib/mailslurp_client/api/mail_server_controller_api.rb

@@ -81,6 +81,129 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Lookup DNS records for a domain
+    # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
+    # @param [Hash] opts the optional parameters
+    # @return [DNSLookupResults]
+    def get_dns_lookup(dns_lookup_options, opts = {})
+      data, _status_code, _headers = get_dns_lookup_with_http_info(dns_lookup_options, opts)
+      data
+    end
+
+    # Lookup DNS records for a domain
+    # @param dns_lookup_options [DNSLookupOptions] dnsLookupOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DNSLookupResults, Integer, Hash)>] DNSLookupResults data, response status code and response headers
+    def get_dns_lookup_with_http_info(dns_lookup_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MailServerControllerApi.get_dns_lookup ...'
+      end
+      # verify the required parameter 'dns_lookup_options' is set
+      if @api_client.config.client_side_validation && dns_lookup_options.nil?
+        fail ArgumentError, "Missing the required parameter 'dns_lookup_options' when calling MailServerControllerApi.get_dns_lookup"
+      end
+      # resource path
+      local_var_path = '/mail-server/describe/dns-lookup'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(dns_lookup_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'DNSLookupResults' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MailServerControllerApi#get_dns_lookup\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get IP address for a domain
+    # @param name [String] name
+    # @param [Hash] opts the optional parameters
+    # @return [IPAddressResult]
+    def get_ip_address(name, opts = {})
+      data, _status_code, _headers = get_ip_address_with_http_info(name, opts)
+      data
+    end
+
+    # Get IP address for a domain
+    # @param name [String] name
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(IPAddressResult, Integer, Hash)>] IPAddressResult data, response status code and response headers
+    def get_ip_address_with_http_info(name, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: MailServerControllerApi.get_ip_address ...'
+      end
+      # verify the required parameter 'name' is set
+      if @api_client.config.client_side_validation && name.nil?
+        fail ArgumentError, "Missing the required parameter 'name' when calling MailServerControllerApi.get_ip_address"
+      end
+      # resource path
+      local_var_path = '/mail-server/describe/ip-address'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = name
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'IPAddressResult' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['API_KEY']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: MailServerControllerApi#get_ip_address\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Verify the existence of an email address at a given mail server.
     # @param verify_options [VerifyEmailAddressOptions] verifyOptions
     # @param [Hash] opts the optional parameters

data/lib/mailslurp_client/api/wait_for_controller_api.rb

@@ -213,7 +213,7 @@ module MailSlurpClient
     end
 
     # Wait or return list of emails that match simple matching patterns
-    # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options.
+    # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1
@@ -227,7 +227,7 @@ module MailSlurpClient
     end
 
     # Wait or return list of emails that match simple matching patterns
-    # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options.
+    # Perform a search of emails in an inbox with the given patterns. If results match expected count then return or else retry the search until results are found or timeout is reached. Match options allow simple CONTAINS or EQUALS filtering on SUBJECT, TO, BCC, CC, and FROM. See the `MatchOptions` object for options. An example payload is `{ matches: [{field: 'SUBJECT',should:'CONTAIN',value:'needle'}] }`. You can use an array of matches and they will be applied sequentially to filter out emails. If you want to perform matches and extractions of content using Regex patterns see the EmailController `getEmailContentMatch` method.
     # @param match_options [MatchOptions] matchOptions
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :count Number of emails to wait for. Must be greater that 1

data/lib/mailslurp_client/models/dns_lookup_options.rb

@@ -0,0 +1,252 @@
+=begin
+#MailSlurp API
+
+#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 
+
+The version of the OpenAPI document: 6.5.2
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.3.1
+
+=end
+
+require 'date'
+
+module MailSlurpClient
+  # Options for DNS query. 
+  class DNSLookupOptions
+    # List of record types you wish to query such as MX, DNS, TXT, NS, A etc.
+    attr_accessor :hostname
+
+    # Optionally control whether to omit the final dot in full DNS name values.
+    attr_accessor :omit_final_dns_dot
+
+    # List of record types you wish to query such as MX, DNS, TXT, NS, A etc.
+    attr_accessor :record_types
+
+    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
+      {
+        :'hostname' => :'hostname',
+        :'omit_final_dns_dot' => :'omitFinalDNSDot',
+        :'record_types' => :'recordTypes'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'hostname' => :'String',
+        :'omit_final_dns_dot' => :'Boolean',
+        :'record_types' => :'Array<String>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @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::DNSLookupOptions` 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::DNSLookupOptions`. 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
+      }
+
+      if attributes.key?(:'hostname')
+        self.hostname = attributes[:'hostname']
+      end
+
+      if attributes.key?(:'omit_final_dns_dot')
+        self.omit_final_dns_dot = attributes[:'omit_final_dns_dot']
+      end
+
+      if attributes.key?(:'record_types')
+        if (value = attributes[:'record_types']).is_a?(Array)
+          self.record_types = value
+        end
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          hostname == o.hostname &&
+          omit_final_dns_dot == o.omit_final_dns_dot &&
+          record_types == o.record_types
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [hostname, omit_final_dns_dot, record_types].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.openapi_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :Boolean
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        MailSlurpClient.const_get(type).build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+        
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+  end
+end