mailslurp_client 8.2.8 → 8.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c939cc4a13acdfa00befd57219f03fb5043cfcd59388d515edb4fb998a5b6d79
-  data.tar.gz: 0e2a9812fe11d95e8cf0fff0a529ab013a502ed09fb801088efb5cebeddea021
+  metadata.gz: 885a47966c945561dd2f0d6ded52689c21a44d055877e7ce1c6298cbfc7b6e43
+  data.tar.gz: a30ae7021cefd27456e10ff7503e6674ee45e822bf9c826c69289faec89133ba
 SHA512:
-  metadata.gz: 9ec7920d5f89318fb2dc9dd36ee6c1f862e56d78fb7ec3b5d1db19f528f04fa7b494b0d20e1eee66953ccc115e569b4844ac020df7f2634e479bde828753b0ee
-  data.tar.gz: 6a10885e285042aaf67a7ce890b512bea25205b358a2e0e3b84a2361e38e021ff81c3e04649ed246a7fc43e55eb9c18684c0682caf57e1038b9ea5f3167be6f0
+  metadata.gz: f91f21f8d50b6c154ae5a2240554734dce8c922c5e213f3a9a402959c286008a53b9c47f16da51e8e95c2d06ab3fb83f946324ccbba47281c0eb1237f15cba15
+  data.tar.gz: 69b0b31c1248e8660446d0eb35328bd659a80080c1b62cfd0bb79f08366ff422a9064e33b48d7a2770dd5ac4f1ce3da27731487c43adf117700e029ea572d014

data/lib/mailslurp_client.rb

@@ -22,6 +22,7 @@ require 'mailslurp_client/models/basic_auth_options'
 require 'mailslurp_client/models/bulk_send_email_options'
 require 'mailslurp_client/models/contact_dto'
 require 'mailslurp_client/models/contact_projection'
+require 'mailslurp_client/models/content_match_options'
 require 'mailslurp_client/models/create_anonymous_alias_options'
 require 'mailslurp_client/models/create_contact_options'
 require 'mailslurp_client/models/create_domain_options'
@@ -36,6 +37,7 @@ require 'mailslurp_client/models/domain_preview'
 require 'mailslurp_client/models/download_attachment_dto'
 require 'mailslurp_client/models/email'
 require 'mailslurp_client/models/email_analysis'
+require 'mailslurp_client/models/email_content_match_result'
 require 'mailslurp_client/models/email_preview'
 require 'mailslurp_client/models/email_projection'
 require 'mailslurp_client/models/email_verification_result'

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

@@ -535,6 +535,76 @@ module MailSlurpClient
       return data, status_code, headers
     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. 
+    # @param email_id [String] ID of email to match against
+    # @param content_match_options [ContentMatchOptions] contentMatchOptions
+    # @param [Hash] opts the optional parameters
+    # @return [EmailContentMatchResult]
+    def get_email_content_match(email_id, content_match_options, opts = {})
+      data, _status_code, _headers = get_email_content_match_with_http_info(email_id, content_match_options, opts)
+      data
+    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. 
+    # @param email_id [String] ID of email to match against
+    # @param content_match_options [ContentMatchOptions] contentMatchOptions
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EmailContentMatchResult, Integer, Hash)>] EmailContentMatchResult data, response status code and response headers
+    def get_email_content_match_with_http_info(email_id, content_match_options, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EmailControllerApi.get_email_content_match ...'
+      end
+      # verify the required parameter 'email_id' is set
+      if @api_client.config.client_side_validation && email_id.nil?
+        fail ArgumentError, "Missing the required parameter 'email_id' when calling EmailControllerApi.get_email_content_match"
+      end
+      # verify the required parameter 'content_match_options' is set
+      if @api_client.config.client_side_validation && content_match_options.nil?
+        fail ArgumentError, "Missing the required parameter 'content_match_options' when calling EmailControllerApi.get_email_content_match"
+      end
+      # resource path
+      local_var_path = '/emails/{emailId}/contentMatch'.sub('{' + 'emailId' + '}', CGI.escape(email_id.to_s))
+
+      # 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(content_match_options) 
+
+      # return_type
+      return_type = opts[:return_type] || 'EmailContentMatchResult' 
+
+      # 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: EmailControllerApi#get_email_content_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get email content as HTML
     # Retrieve email content as HTML response for viewing in browsers. Decodes quoted-printable entities and converts charset to UTF-8. Pass your API KEY as a request parameter when viewing in a browser: `?apiKey=xxx`
     # @param email_id [String] emailId

data/lib/mailslurp_client/api/inbox_controller_api.rb

@@ -691,7 +691,7 @@ module MailSlurpClient
     end
 
     # Send Email
-    # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails.
+    # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
     # @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
@@ -702,7 +702,7 @@ module MailSlurpClient
     end
 
     # Send Email
-    # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails.
+    # Send an email from an inbox's email address.  The request body should contain the `SendEmailOptions` that include recipients, attachments, body etc. See `SendEmailOptions` for all available properties. Note the `inboxId` refers to the inbox's id not the inbox's email address. See https://www.mailslurp.com/guides/ for more information on how to send emails. This method does not return a sent email entity due to legacy reasons. To send and get a sent email as returned response use the sister method `sendEmailAndConfirm`.
     # @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
@@ -754,6 +754,72 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Send email and return sent confirmation
+    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
+    # @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 [SentEmailDto]
+    def send_email_and_confirm(inbox_id, opts = {})
+      data, _status_code, _headers = send_email_and_confirm_with_http_info(inbox_id, opts)
+      data
+    end
+
+    # Send email and return sent confirmation
+    # Sister method for standard `sendEmail` method with the benefit of returning a `SentEmail` entity confirming the successful sending of the email with link the the sent object created for it.
+    # @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<(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 ...'
+      end
+      # verify the required parameter 'inbox_id' is set
+      if @api_client.config.client_side_validation && inbox_id.nil?
+        fail ArgumentError, "Missing the required parameter 'inbox_id' when calling InboxControllerApi.send_email_and_confirm"
+      end
+      # resource path
+      local_var_path = '/inboxes/{inboxId}/confirm'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s))
+
+      # 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(opts[:'send_email_options']) 
+
+      # return_type
+      return_type = opts[:return_type] || 'SentEmailDto' 
+
+      # 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: InboxControllerApi#send_email_and_confirm\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Set inbox favourited state
     # Set and return new favourite state for an inbox
     # @param inbox_id [String] inboxId

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/content_match_options.rb

@@ -0,0 +1,208 @@
+=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 matching content using regex patterns based on Java Pattern syntax
+  class ContentMatchOptions
+    # 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.
+    attr_accessor :pattern
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'pattern' => :'pattern'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'pattern' => :'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::ContentMatchOptions` 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::ContentMatchOptions`. 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?(:'pattern')
+        self.pattern = attributes[:'pattern']
+      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 &&
+          pattern == o.pattern
+    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
+      [pattern].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

data/lib/mailslurp_client/models/email_content_match_result.rb

@@ -0,0 +1,228 @@
+=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
+  # Matches for the given pattern
+  class EmailContentMatchResult
+    attr_accessor :matches
+
+    attr_accessor :pattern
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'matches' => :'matches',
+        :'pattern' => :'pattern'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'matches' => :'Array<String>',
+        :'pattern' => :'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::EmailContentMatchResult` 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::EmailContentMatchResult`. 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?(:'matches')
+        if (value = attributes[:'matches']).is_a?(Array)
+          self.matches = value
+        end
+      end
+
+      if attributes.key?(:'pattern')
+        self.pattern = attributes[:'pattern']
+      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
+      if @matches.nil?
+        invalid_properties.push('invalid value for "matches", matches cannot be nil.')
+      end
+
+      if @pattern.nil?
+        invalid_properties.push('invalid value for "pattern", pattern cannot be nil.')
+      end
+
+      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?
+      return false if @matches.nil?
+      return false if @pattern.nil?
+      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 &&
+          matches == o.matches &&
+          pattern == o.pattern
+    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
+      [matches, pattern].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

data/lib/mailslurp_client/models/match_options.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value.
+  # Optional filter for matching emails based on fields. For instance filter results to only include emails whose `SUBJECT` value does `CONTAIN` given match value. An example payload would be `{ matches: [{ field: 'SUBJECT', should: 'CONTAIN', value: 'Welcome' }] }`. If you wish to extract regex matches inside the email content see the `getEmailContentMatch` method in the EmailController.
   class MatchOptions
     # 1 or more match options. Options are additive so if one does not match the email is excluded from results
     attr_accessor :matches

data/lib/mailslurp_client/models/raw_email_json.rb

@@ -13,6 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Content in raw format
   class RawEmailJson
     attr_accessor :content
 

data/lib/mailslurp_client/models/sent_email_dto.rb

@@ -13,13 +13,16 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
+  # Sent email details
   class SentEmailDto
+    # Array of IDs of attachments that were sent with this email
     attr_accessor :attachments
 
     attr_accessor :bcc
 
     attr_accessor :body
 
+    # MD5 Hash
     attr_accessor :body_md5_hash
 
     attr_accessor :cc
@@ -28,8 +31,10 @@ module MailSlurpClient
 
     attr_accessor :from
 
+    # ID of sent email
     attr_accessor :id
 
+    # Inbox ID email was sent from
     attr_accessor :inbox_id
 
     attr_accessor :is_html
@@ -38,8 +43,10 @@ module MailSlurpClient
 
     attr_accessor :subject
 
+    # Recipients email was sent to
     attr_accessor :to
 
+    # User ID
     attr_accessor :user_id
 
     # Attribute mapping from ruby-style variable name to JSON key.
@@ -172,32 +179,17 @@ module MailSlurpClient
     # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
-      if @id.nil?
-        invalid_properties.push('invalid value for "id", id cannot be nil.')
-      end
-
-      if @inbox_id.nil?
-        invalid_properties.push('invalid value for "inbox_id", inbox_id cannot be nil.')
-      end
-
       if @sent_at.nil?
         invalid_properties.push('invalid value for "sent_at", sent_at cannot be nil.')
       end
 
-      if @user_id.nil?
-        invalid_properties.push('invalid value for "user_id", user_id cannot be nil.')
-      end
-
       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?
-      return false if @id.nil?
-      return false if @inbox_id.nil?
       return false if @sent_at.nil?
-      return false if @user_id.nil?
       true
     end
 

data/lib/mailslurp_client/models/upload_attachment_options.rb

@@ -21,7 +21,7 @@ module MailSlurpClient
     # Optional contentType for file. For instance `application/pdf`
     attr_accessor :content_type
 
-    # Optional filename to save upload with
+    # Optional filename to save upload with. Will be the name that is shown in email clients
     attr_accessor :filename
 
     # Attribute mapping from ruby-style variable name to JSON key.

data/lib/mailslurp_client/version.rb

@@ -11,5 +11,5 @@ OpenAPI Generator version: 4.3.1
 =end
 
 module MailSlurpClient
-  VERSION = '8.2.8'
+  VERSION = '8.2.14'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mailslurp_client
 version: !ruby/object:Gem::Version
-  version: 8.2.8
+  version: 8.2.14
 platform: ruby
 authors:
 - mailslurp
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-20 00:00:00.000000000 Z
+date: 2020-11-22 00:00:00.000000000 Z
 dependencies: []
 description: Create emails addresses in Ruby then send and receive real emails and
   attachments. See https://www.mailslurp.com/docs/ruby/ for full Ruby documentation.
@@ -46,6 +46,7 @@ files:
 - lib/mailslurp_client/models/bulk_send_email_options.rb
 - lib/mailslurp_client/models/contact_dto.rb
 - lib/mailslurp_client/models/contact_projection.rb
+- lib/mailslurp_client/models/content_match_options.rb
 - lib/mailslurp_client/models/create_anonymous_alias_options.rb
 - lib/mailslurp_client/models/create_contact_options.rb
 - lib/mailslurp_client/models/create_domain_options.rb
@@ -60,6 +61,7 @@ files:
 - lib/mailslurp_client/models/download_attachment_dto.rb
 - lib/mailslurp_client/models/email.rb
 - lib/mailslurp_client/models/email_analysis.rb
+- lib/mailslurp_client/models/email_content_match_result.rb
 - lib/mailslurp_client/models/email_preview.rb
 - lib/mailslurp_client/models/email_projection.rb
 - lib/mailslurp_client/models/email_verification_result.rb