class MailSlurpClient::WebhookEmailReadPayload
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.
Attributes
Date time of event creation
ID of the email that was received. Use this ID for fetching the email with the `EmailController`.
Is the email read
Name of the event type webhook is being triggered for.
Id of the inbox that received an email
Idempotent message ID. Store this ID locally or in a database to prevent message duplication.
ID of webhook entity being triggered
Name of the webhook being triggered
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 65 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 201 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 100 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
List of attributes with nullable: true
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 93 def self.openapi_nullable Set.new([ ]) end
Attribute type mapping.
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 79 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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 173 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 229 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
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
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 298 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 208 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
@see the `==` method @param [Object] Object to be compared
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 188 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] event_name
Object to be assigned
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 163 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
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 194 def hash [created_at, email_id, email_is_read, event_name, inbox_id, message_id, webhook_id, webhook_name].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 148 def list_invalid_properties invalid_properties = Array.new invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 280 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 268 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/mailslurp_client/models/webhook_email_read_payload.rb, line 155 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