mailslurp_client 12.6.0 → 12.7.1

data/lib/mailslurp_client/api/missed_email_controller_api.rb

@@ -154,41 +154,35 @@ module MailSlurpClient
 
     # Wait for Nth missed email
     # Wait for 0 based index missed email
-    # @param inbox_id [String] Optional inbox ID filter
-    # @param timeout [Integer] Optional timeout milliseconds
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox ID filter
     # @option opts [Integer] :index Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1
+    # @option opts [Integer] :timeout Optional timeout milliseconds
     # @return [MissedEmail]
-    def wait_for_nth_missed_email(inbox_id, timeout, opts = {})
-      data, _status_code, _headers = wait_for_nth_missed_email_with_http_info(inbox_id, timeout, opts)
+    def wait_for_nth_missed_email(opts = {})
+      data, _status_code, _headers = wait_for_nth_missed_email_with_http_info(opts)
       data
     end
 
     # Wait for Nth missed email
     # Wait for 0 based index missed email
-    # @param inbox_id [String] Optional inbox ID filter
-    # @param timeout [Integer] Optional timeout milliseconds
     # @param [Hash] opts the optional parameters
+    # @option opts [String] :inbox_id Optional inbox ID filter
     # @option opts [Integer] :index Zero based index of the email to wait for. If 1 missed email already and you want to wait for the 2nd email pass index=1
+    # @option opts [Integer] :timeout Optional timeout milliseconds
     # @return [Array<(MissedEmail, Integer, Hash)>] MissedEmail data, response status code and response headers
-    def wait_for_nth_missed_email_with_http_info(inbox_id, timeout, opts = {})
+    def wait_for_nth_missed_email_with_http_info(opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MissedEmailControllerApi.wait_for_nth_missed_email ...'
       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 MissedEmailControllerApi.wait_for_nth_missed_email"
-      end
-      # verify the required parameter 'timeout' is set
-      if @api_client.config.client_side_validation && timeout.nil?
-        fail ArgumentError, "Missing the required parameter 'timeout' when calling MissedEmailControllerApi.wait_for_nth_missed_email"
-      end
       # resource path
-      local_var_path = '/missed-emails/waitForNthMissedEmail'.sub('{' + 'inboxId' + '}', CGI.escape(inbox_id.to_s)).sub('{' + 'timeout' + '}', CGI.escape(timeout.to_s))
+      local_var_path = '/missed-emails/waitForNthMissedEmail'
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'inboxId'] = opts[:'inbox_id'] if !opts[:'inbox_id'].nil?
       query_params[:'index'] = opts[:'index'] if !opts[:'index'].nil?
+      query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}

data/lib/mailslurp_client/api/sent_emails_controller_api.rb

@@ -19,6 +19,76 @@ module MailSlurpClient
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
+    # Get all sent email tracking pixels in paginated form
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageTrackingPixelProjection]
+    def get_all_sent_tracking_pixels(opts = {})
+      data, _status_code, _headers = get_all_sent_tracking_pixels_with_http_info(opts)
+      data
+    end
+
+    # Get all sent email tracking pixels in paginated form
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
+    def get_all_sent_tracking_pixels_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.get_all_sent_tracking_pixels ...'
+      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 = '/sent/tracking-pixels'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
+      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] || {}
+      # 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] || 'PageTrackingPixelProjection' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SentEmailsControllerApi#get_all_sent_tracking_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get sent email receipt
     # @param id [String] id
     # @param [Hash] opts the optional parameters
@@ -79,6 +149,82 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get all tracking pixels for a sent email in paginated form
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination (default to 20)
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
+    # @return [PageTrackingPixelProjection]
+    def get_sent_email_tracking_pixels(id, opts = {})
+      data, _status_code, _headers = get_sent_email_tracking_pixels_with_http_info(id, opts)
+      data
+    end
+
+    # Get all tracking pixels for a sent email in paginated form
+    # @param id [String] id
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page Optional page index in sent email tracking pixel list pagination
+    # @option opts [String] :search_filter Optional search filter
+    # @option opts [Integer] :size Optional page size in sent email tracking pixel list pagination
+    # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
+    # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
+    def get_sent_email_tracking_pixels_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SentEmailsControllerApi.get_sent_email_tracking_pixels ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling SentEmailsControllerApi.get_sent_email_tracking_pixels"
+      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 = '/sent/{id}/tracking-pixels'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
+      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] || {}
+      # 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] || 'PageTrackingPixelProjection' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SentEmailsControllerApi#get_sent_email_tracking_pixels\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get all sent emails in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
@@ -155,9 +301,9 @@ module MailSlurpClient
     # Get all sent organization emails in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
-    # @option opts [Integer] :page Optional page index in inbox sent email list pagination (default to 0)
+    # @option opts [Integer] :page Optional page index in sent email list pagination (default to 0)
     # @option opts [String] :search_filter Optional search filter
-    # @option opts [Integer] :size Optional page size in inbox sent email list pagination (default to 20)
+    # @option opts [Integer] :size Optional page size in sent email list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageSentEmailProjection]
     def get_sent_organization_emails(opts = {})
@@ -168,9 +314,9 @@ module MailSlurpClient
     # Get all sent organization emails in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [String] :inbox_id Optional inboxId to filter sender of sent emails by
-    # @option opts [Integer] :page Optional page index in inbox sent email list pagination
+    # @option opts [Integer] :page Optional page index in sent email list pagination
     # @option opts [String] :search_filter Optional search filter
-    # @option opts [Integer] :size Optional page size in inbox sent email list pagination
+    # @option opts [Integer] :size Optional page size in sent email list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageSentEmailProjection, Integer, Hash)>] PageSentEmailProjection data, response status code and response headers
     def get_sent_organization_emails_with_http_info(opts = {})

data/lib/mailslurp_client/api/tracking_controller_api.rb

@@ -20,7 +20,7 @@ module MailSlurpClient
       @api_client = api_client
     end
     # Create tracking pixel
-    # Create a tracking pixel
+    # Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel.
     # @param create_tracking_pixel_options [CreateTrackingPixelOptions] createTrackingPixelOptions
     # @param [Hash] opts the optional parameters
     # @return [TrackingPixelDto]
@@ -30,7 +30,7 @@ module MailSlurpClient
     end
 
     # Create tracking pixel
-    # Create a tracking pixel
+    # Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel.
     # @param create_tracking_pixel_options [CreateTrackingPixelOptions] createTrackingPixelOptions
     # @param [Hash] opts the optional parameters
     # @return [Array<(TrackingPixelDto, Integer, Hash)>] TrackingPixelDto data, response status code and response headers
@@ -87,6 +87,7 @@ module MailSlurpClient
     # List tracking pixels in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination (default to 0)
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination (default to 20)
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC (default to 'ASC')
     # @return [PageTrackingPixelProjection]
@@ -99,6 +100,7 @@ module MailSlurpClient
     # List tracking pixels in paginated form
     # @param [Hash] opts the optional parameters
     # @option opts [Integer] :page Optional page index in list pagination
+    # @option opts [String] :search_filter Optional search filter
     # @option opts [Integer] :size Optional page size in list pagination
     # @option opts [String] :sort Optional createdAt sort direction ASC or DESC
     # @return [Array<(PageTrackingPixelProjection, Integer, Hash)>] PageTrackingPixelProjection data, response status code and response headers
@@ -116,6 +118,7 @@ module MailSlurpClient
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'searchFilter'] = opts[:'search_filter'] if !opts[:'search_filter'].nil?
       query_params[:'size'] = opts[:'size'] if !opts[:'size'].nil?
       query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
 

data/lib/mailslurp_client/api/webhook_controller_api.rb

@@ -388,7 +388,7 @@ module MailSlurpClient
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload ...'
       end
-      allowable_values = ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT"]
+      allowable_values = ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"]
       if @api_client.config.client_side_validation && opts[:'event_name'] && !allowable_values.include?(opts[:'event_name'])
         fail ArgumentError, "invalid value for \"event_name\", must be one of #{allowable_values}"
       end
@@ -432,6 +432,60 @@ module MailSlurpClient
       return data, status_code, headers
     end
 
+    # Get webhook test payload for email opened event
+    # @param [Hash] opts the optional parameters
+    # @return [WebhookEmailOpenedPayload]
+    def get_test_webhook_payload_email_opened(opts = {})
+      data, _status_code, _headers = get_test_webhook_payload_email_opened_with_http_info(opts)
+      data
+    end
+
+    # Get webhook test payload for email opened event
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(WebhookEmailOpenedPayload, Integer, Hash)>] WebhookEmailOpenedPayload data, response status code and response headers
+    def get_test_webhook_payload_email_opened_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: WebhookControllerApi.get_test_webhook_payload_email_opened ...'
+      end
+      # resource path
+      local_var_path = '/webhooks/test/email-opened-payload'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'WebhookEmailOpenedPayload' 
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: WebhookControllerApi#get_test_webhook_payload_email_opened\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get webhook test payload for new attachment event
     # @param [Hash] opts the optional parameters
     # @return [WebhookNewAttachmentPayload]

data/lib/mailslurp_client/models/abstract_webhook_payload.rb

@@ -13,7 +13,7 @@ OpenAPI Generator version: 4.3.1
 require 'date'
 
 module MailSlurpClient
-  # Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT` and `NEW_ATTACHMENT` payloads for the properties available for those events.
+  # Abstract webhook payload. Use the correct payload type for your webhook event type in order to access all the specific properties for that event. See the `NEW_EMAIL`,`NEW_CONTACT`, `NEW_ATTACHMENT` and `EMAIL_OPENED` payloads for the properties available for those events.
   class AbstractWebhookPayload
     attr_accessor :event_name
 
@@ -126,7 +126,7 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @event_name.nil?
-      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT"])
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
       return false unless event_name_validator.valid?(@event_name)
       return false if @message_id.nil?
       return false if @webhook_id.nil?
@@ -136,7 +136,7 @@ module MailSlurpClient
     # Custom attribute writer method checking allowed values (enum).
     # @param [Object] event_name Object to be assigned
     def event_name=(event_name)
-      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
       unless validator.valid?(event_name)
         fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
       end

data/lib/mailslurp_client/models/create_inbox_forwarder_options.rb

@@ -0,0 +1,275 @@
+=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
+  class CreateInboxForwarderOptions
+    attr_accessor :field
+
+    attr_accessor :match
+
+    attr_accessor :forward_to_recipients
+
+    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
+      {
+        :'field' => :'field',
+        :'match' => :'match',
+        :'forward_to_recipients' => :'forwardToRecipients'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'field' => :'String',
+        :'match' => :'String',
+        :'forward_to_recipients' => :'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::CreateInboxForwarderOptions` 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::CreateInboxForwarderOptions`. 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?(:'field')
+        self.field = attributes[:'field']
+      end
+
+      if attributes.key?(:'match')
+        self.match = attributes[:'match']
+      end
+
+      if attributes.key?(:'forward_to_recipients')
+        if (value = attributes[:'forward_to_recipients']).is_a?(Array)
+          self.forward_to_recipients = 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
+      if @field.nil?
+        invalid_properties.push('invalid value for "field", field cannot be nil.')
+      end
+
+      if @match.nil?
+        invalid_properties.push('invalid value for "match", match cannot be nil.')
+      end
+
+      if @forward_to_recipients.nil?
+        invalid_properties.push('invalid value for "forward_to_recipients", forward_to_recipients 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 @field.nil?
+      field_validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
+      return false unless field_validator.valid?(@field)
+      return false if @match.nil?
+      return false if @forward_to_recipients.nil?
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] field Object to be assigned
+    def field=(field)
+      validator = EnumAttributeValidator.new('String', ["RECIPIENTS", "SENDER", "SUBJECT", "ATTACHMENTS"])
+      unless validator.valid?(field)
+        fail ArgumentError, "invalid value for \"field\", must be one of #{validator.allowable_values}."
+      end
+      @field = field
+    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 &&
+          field == o.field &&
+          match == o.match &&
+          forward_to_recipients == o.forward_to_recipients
+    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
+      [field, match, forward_to_recipients].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