=begin #SendinBlue API #SendinBlue provide a RESTFul API that can be used with any languages. With this API, you will be able to : - Manage your campaigns and get the statistics - Manage your contacts - Send transactional Emails and SMS - and much more... You can download our wrappers at https://github.com/orgs/sendinblue **Possible responses** | Code | Message | | :-------------: | ------------- | | 200 | OK. Successful Request | | 201 | OK. Successful Creation | | 202 | OK. Request accepted | | 204 | OK. Successful Update/Deletion | | 400 | Error. Bad Request | | 401 | Error. Authentication Needed | | 402 | Error. Not enough credit, plan upgrade needed | | 403 | Error. Permission denied | | 404 | Error. Object does not exist | | 405 | Error. Method not allowed | OpenAPI spec version: 3.0.0 Contact: contact@sendinblue.com Generated by: https://github.com/swagger-api/swagger-codegen.git Swagger Codegen version: 2.2.3 =end require 'date' module SibApiV3Sdk class GetEmailEventReportEvents # Email address which generates the event attr_accessor :email # Date on which the event has been generated attr_accessor :date # Message ID which generated the event attr_accessor :message_id # Event which occured attr_accessor :event # Reason of bounce (only availble if the event is hardbounce or softbounce) attr_accessor :reason # Tag of the email which generated the event attr_accessor :tag # IP from which the user has opened the email or clicked on the link (only availble if the event is opened or clicks) attr_accessor :ip 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 { :'email' => :'email', :'date' => :'date', :'message_id' => :'messageId', :'event' => :'event', :'reason' => :'reason', :'tag' => :'tag', :'ip' => :'ip' } end # Attribute type mapping. def self.swagger_types { :'email' => :'String', :'date' => :'Date', :'message_id' => :'String', :'event' => :'String', :'reason' => :'String', :'tag' => :'String', :'ip' => :'String' } end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash def initialize(attributes = {}) return unless attributes.is_a?(Hash) # convert string to symbol for hash key attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v} if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'date') self.date = attributes[:'date'] end if attributes.has_key?(:'messageId') self.message_id = attributes[:'messageId'] end if attributes.has_key?(:'event') self.event = attributes[:'event'] end if attributes.has_key?(:'reason') self.reason = attributes[:'reason'] end if attributes.has_key?(:'tag') self.tag = attributes[:'tag'] end if attributes.has_key?(:'ip') self.ip = attributes[:'ip'] end end # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properies with the reasons def list_invalid_properties invalid_properties = Array.new if @email.nil? invalid_properties.push("invalid value for 'email', email cannot be nil.") end if @date.nil? invalid_properties.push("invalid value for 'date', date cannot be nil.") end if @message_id.nil? invalid_properties.push("invalid value for 'message_id', message_id cannot be nil.") end if @event.nil? invalid_properties.push("invalid value for 'event', event cannot be nil.") end if @reason.nil? invalid_properties.push("invalid value for 'reason', reason cannot be nil.") end if @tag.nil? invalid_properties.push("invalid value for 'tag', tag cannot be nil.") end return 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 @email.nil? return false if @date.nil? return false if @message_id.nil? return false if @event.nil? event_validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"]) return false unless event_validator.valid?(@event) return false if @reason.nil? return false if @tag.nil? return true end # Custom attribute writer method checking allowed values (enum). # @param [Object] event Object to be assigned def event=(event) validator = EnumAttributeValidator.new('String', ["bounces", "hardBounces", "softBounces", "delivered", "spam", "requests", "opened", "clicks", "invalid", "deferred", "blocked"]) unless validator.valid?(event) fail ArgumentError, "invalid value for 'event', must be one of #{validator.allowable_values}." end @event = event 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 && email == o.email && date == o.date && message_id == o.message_id && event == o.event && reason == o.reason && tag == o.tag && ip == o.ip end # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Fixnum] Hash code def hash [email, date, message_id, event, reason, tag, ip].hash 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.swagger_types.each_pair do |key, type| if type =~ /\AArray<(.*)>/i # check to ensure the input is an array given that the 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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 temp_model = SibApiV3Sdk.const_get(type).new temp_model.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) next if value.nil? 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