mailslurp_client 13.0.1 → 14.0.2

data/lib/mailslurp_client/models/webhook_email_read_payload.rb

@@ -0,0 +1,312 @@
+=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
+  # EMAIL_READ webhook payload. Sent to your webhook url endpoint via HTTP POST when an email is read. This happens when an email is requested in full from the API or a user views the email in the dashboard.
+  class WebhookEmailReadPayload
+    # Date time of event creation
+    attr_accessor :created_at
+
+    # ID of the email that was received. Use this ID for fetching the email with the `EmailController`.
+    attr_accessor :email_id
+
+    # Is the email read
+    attr_accessor :email_is_read
+
+    # Name of the event type webhook is being triggered for.
+    attr_accessor :event_name
+
+    # Id of the inbox that received an email
+    attr_accessor :inbox_id
+
+    # Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
+    attr_accessor :message_id
+
+    # ID of webhook entity being triggered
+    attr_accessor :webhook_id
+
+    # Name of the webhook being triggered
+    attr_accessor :webhook_name
+
+    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
+      {
+        :'created_at' => :'createdAt',
+        :'email_id' => :'emailId',
+        :'email_is_read' => :'emailIsRead',
+        :'event_name' => :'eventName',
+        :'inbox_id' => :'inboxId',
+        :'message_id' => :'messageId',
+        :'webhook_id' => :'webhookId',
+        :'webhook_name' => :'webhookName'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'created_at' => :'DateTime',
+        :'email_id' => :'String',
+        :'email_is_read' => :'Boolean',
+        :'event_name' => :'String',
+        :'inbox_id' => :'String',
+        :'message_id' => :'String',
+        :'webhook_id' => :'String',
+        :'webhook_name' => :'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::WebhookEmailReadPayload` 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::WebhookEmailReadPayload`. 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?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.key?(:'email_id')
+        self.email_id = attributes[:'email_id']
+      end
+
+      if attributes.key?(:'email_is_read')
+        self.email_is_read = attributes[:'email_is_read']
+      end
+
+      if attributes.key?(:'event_name')
+        self.event_name = attributes[:'event_name']
+      end
+
+      if attributes.key?(:'inbox_id')
+        self.inbox_id = attributes[:'inbox_id']
+      end
+
+      if attributes.key?(:'message_id')
+        self.message_id = attributes[:'message_id']
+      end
+
+      if attributes.key?(:'webhook_id')
+        self.webhook_id = attributes[:'webhook_id']
+      end
+
+      if attributes.key?(:'webhook_name')
+        self.webhook_name = attributes[:'webhook_name']
+      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?
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
+      return false unless event_name_validator.valid?(@event_name)
+      true
+    end
+
+    # 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", "EMAIL_OPENED", "EMAIL_READ"])
+      unless validator.valid?(event_name)
+        fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
+      end
+      @event_name = event_name
+    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 &&
+          created_at == o.created_at &&
+          email_id == o.email_id &&
+          email_is_read == o.email_is_read &&
+          event_name == o.event_name &&
+          inbox_id == o.inbox_id &&
+          message_id == o.message_id &&
+          webhook_id == o.webhook_id &&
+          webhook_name == o.webhook_name
+    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
+      [created_at, email_id, email_is_read, event_name, inbox_id, message_id, webhook_id, webhook_name].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/webhook_new_attachment_payload.rb

@@ -1,7 +1,7 @@
 =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 
+#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
 
@@ -153,7 +153,7 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       return false unless event_name_validator.valid?(@event_name)
       true
     end
@@ -161,7 +161,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", "EMAIL_OPENED"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       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/webhook_new_contact_payload.rb

@@ -1,7 +1,7 @@
 =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 
+#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
 
@@ -228,7 +228,7 @@ module MailSlurpClient
       return false if @contact_id.nil?
       return false if @created_at.nil?
       return false if @email_addresses.nil?
-      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       return false unless event_name_validator.valid?(@event_name)
       return false if @tags.nil?
       true
@@ -237,7 +237,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", "EMAIL_OPENED"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       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/webhook_new_email_payload.rb

@@ -1,7 +1,7 @@
 =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 
+#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
 
@@ -18,10 +18,10 @@ module MailSlurpClient
     # List of attachment meta data objects if attachments present
     attr_accessor :attachment_meta_datas
 
-    # List of `BCC` recipients email was addressed to
+    # List of `BCC` recipients email addresses that the email was addressed to. See recipients object for names.
     attr_accessor :bcc
 
-    # List of `CC` recipients email was addressed to
+    # List of `CC` recipients email addresses that the email was addressed to. See recipients object for names.
     attr_accessor :cc
 
     # Date time of event creation
@@ -33,7 +33,7 @@ module MailSlurpClient
     # Name of the event type webhook is being triggered for.
     attr_accessor :event_name
 
-    # Who the email was sent from
+    # Who the email was sent from. An email address - see fromName for the sender name.
     attr_accessor :from
 
     # Id of the inbox that received an email
@@ -42,10 +42,10 @@ module MailSlurpClient
     # Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
     attr_accessor :message_id
 
-    # The subject line of the email message
+    # The subject line of the email message as specified by SMTP subject header
     attr_accessor :subject
 
-    # List of `To` recipients that email was addressed to
+    # List of `To` recipient email addresses that the email was addressed to. See recipients object for names.
     attr_accessor :to
 
     # ID of webhook entity being triggered
@@ -206,7 +206,7 @@ module MailSlurpClient
     # Check to see if the all the properties in the model are valid
     # @return true if the model is valid
     def valid?
-      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       return false unless event_name_validator.valid?(@event_name)
       true
     end
@@ -214,7 +214,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", "EMAIL_OPENED"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       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/webhook_projection.rb

@@ -1,7 +1,7 @@
 =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 
+#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
 
@@ -158,7 +158,7 @@ module MailSlurpClient
     # @return true if the model is valid
     def valid?
       return false if @created_at.nil?
-      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED"])
+      event_name_validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       return false unless event_name_validator.valid?(@event_name)
       return false if @id.nil?
       return false if @inbox_id.nil?
@@ -170,7 +170,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", "EMAIL_OPENED"])
+      validator = EnumAttributeValidator.new('String', ["EMAIL_RECEIVED", "NEW_EMAIL", "NEW_CONTACT", "NEW_ATTACHMENT", "EMAIL_OPENED", "EMAIL_READ"])
       unless validator.valid?(event_name)
         fail ArgumentError, "invalid value for \"event_name\", must be one of #{validator.allowable_values}."
       end