class MailchimpTransactional::InlineResponse20054
a user-defined tag
Attributes
the total number of times tracked URLs in messages with this tag have been clicked
the total number of spam complaints received for messages with this tag
the total number of hard bounces by messages with this tag
the total number of times messages with this tag have been opened
the total number of rejected messages with this tag
the tag's current reputation on a scale from 0 to 100.
the total number of messages sent with this tag
the total number of soft bounces by messages with this tag
the actual tag as a string
the number of unique clicks for emails sent with this tag
the number of unique opens for emails sent with this tag
the total number of unsubscribe requests received for messages with this tag
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 55 def self.attribute_map { :'tag' => :'tag', :'reputation' => :'reputation', :'sent' => :'sent', :'hard_bounces' => :'hard_bounces', :'soft_bounces' => :'soft_bounces', :'rejects' => :'rejects', :'complaints' => :'complaints', :'unsubs' => :'unsubs', :'opens' => :'opens', :'clicks' => :'clicks', :'unique_opens' => :'unique_opens', :'unique_clicks' => :'unique_clicks' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 92 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?(:'tag') self.tag = attributes[:'tag'] end if attributes.has_key?(:'reputation') self.reputation = attributes[:'reputation'] end if attributes.has_key?(:'sent') self.sent = attributes[:'sent'] end if attributes.has_key?(:'hard_bounces') self.hard_bounces = attributes[:'hard_bounces'] end if attributes.has_key?(:'soft_bounces') self.soft_bounces = attributes[:'soft_bounces'] end if attributes.has_key?(:'rejects') self.rejects = attributes[:'rejects'] end if attributes.has_key?(:'complaints') self.complaints = attributes[:'complaints'] end if attributes.has_key?(:'unsubs') self.unsubs = attributes[:'unsubs'] end if attributes.has_key?(:'opens') self.opens = attributes[:'opens'] end if attributes.has_key?(:'clicks') self.clicks = attributes[:'clicks'] end if attributes.has_key?(:'unique_opens') self.unique_opens = attributes[:'unique_opens'] end if attributes.has_key?(:'unique_clicks') self.unique_clicks = attributes[:'unique_clicks'] end end
Attribute type mapping.
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 73 def self.swagger_types { :'tag' => :'String', :'reputation' => :'Integer', :'sent' => :'Integer', :'hard_bounces' => :'Integer', :'soft_bounces' => :'Integer', :'rejects' => :'Integer', :'complaints' => :'Integer', :'unsubs' => :'Integer', :'opens' => :'Integer', :'clicks' => :'Integer', :'unique_opens' => :'Integer', :'unique_clicks' => :'Integer' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 186 def ==(o) return true if self.equal?(o) self.class == o.class && tag == o.tag && reputation == o.reputation && sent == o.sent && hard_bounces == o.hard_bounces && soft_bounces == o.soft_bounces && rejects == o.rejects && complaints == o.complaints && unsubs == o.unsubs && opens == o.opens && clicks == o.clicks && unique_opens == o.unique_opens && unique_clicks == o.unique_clicks 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/mailchimp_transactional/models/inline_response_200_54.rb, line 239 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 temp_model = MailchimpTransactional.const_get(type).new temp_model.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/mailchimp_transactional/models/inline_response_200_54.rb, line 305 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/mailchimp_transactional/models/inline_response_200_54.rb, line 218 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 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/mailchimp_transactional/models/inline_response_200_54.rb, line 205 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 211 def hash [tag, reputation, sent, hard_bounces, soft_bounces, rejects, complaints, unsubs, opens, clicks, unique_opens, unique_clicks].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 149 def list_invalid_properties invalid_properties = Array.new if !@reputation.nil? && @reputation > 100 invalid_properties.push('invalid value for "reputation", must be smaller than or equal to 100.') end if !@reputation.nil? && @reputation < 0 invalid_properties.push('invalid value for "reputation", must be greater than or equal to 0.') end invalid_properties end
Custom attribute writer method with validation @param [Object] reputation Value to be assigned
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 172 def reputation=(reputation) if !reputation.nil? && reputation > 100 fail ArgumentError, 'invalid value for "reputation", must be smaller than or equal to 100.' end if !reputation.nil? && reputation < 0 fail ArgumentError, 'invalid value for "reputation", must be greater than or equal to 0.' end @reputation = reputation end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 291 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/mailchimp_transactional/models/inline_response_200_54.rb, line 279 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/mailchimp_transactional/models/inline_response_200_54.rb, line 164 def valid? return false if !@reputation.nil? && @reputation > 100 return false if !@reputation.nil? && @reputation < 0 true end