class SibApiV3Sdk::GetExtendedContactDetailsStatistics

Campaign statistics of the contact

Attributes

clicked[RW]

Listing of the clicks generated by the contact

complaints[RW]

Listing of the complaints generated by the contact

hard_bounces[RW]

Listing of the hardbounes generated by the contact

messages_sent[RW]

Listing of the sent campaign for the contact

opened[RW]

Listing of the openings generated by the contact

soft_bounces[RW]

Listing of the softbounes generated by the contact

transac_attributes[RW]

Listing of the transactional attributes for the contact

unsubscriptions[RW]

Public Class Methods

attribute_map() click to toggle source

Attribute mapping from ruby-style variable name to JSON key.

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 42
def self.attribute_map
  {
    :'messages_sent' => :'messagesSent',
    :'hard_bounces' => :'hardBounces',
    :'soft_bounces' => :'softBounces',
    :'complaints' => :'complaints',
    :'unsubscriptions' => :'unsubscriptions',
    :'opened' => :'opened',
    :'clicked' => :'clicked',
    :'transac_attributes' => :'transacAttributes'
  }
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 71
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?(:'messagesSent')
    if (value = attributes[:'messagesSent']).is_a?(Array)
      self.messages_sent = value
    end
  end

  if attributes.has_key?(:'hardBounces')
    if (value = attributes[:'hardBounces']).is_a?(Array)
      self.hard_bounces = value
    end
  end

  if attributes.has_key?(:'softBounces')
    if (value = attributes[:'softBounces']).is_a?(Array)
      self.soft_bounces = value
    end
  end

  if attributes.has_key?(:'complaints')
    if (value = attributes[:'complaints']).is_a?(Array)
      self.complaints = value
    end
  end

  if attributes.has_key?(:'unsubscriptions')
    self.unsubscriptions = attributes[:'unsubscriptions']
  end

  if attributes.has_key?(:'opened')
    if (value = attributes[:'opened']).is_a?(Array)
      self.opened = value
    end
  end

  if attributes.has_key?(:'clicked')
    if (value = attributes[:'clicked']).is_a?(Array)
      self.clicked = value
    end
  end

  if attributes.has_key?(:'transacAttributes')
    if (value = attributes[:'transacAttributes']).is_a?(Array)
      self.transac_attributes = value
    end
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 56
def self.swagger_types
  {
    :'messages_sent' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'hard_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'soft_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'complaints' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'unsubscriptions' => :'GetExtendedContactDetailsStatisticsUnsubscriptions',
    :'opened' => :'Array<GetExtendedContactDetailsStatisticsOpened>',
    :'clicked' => :'Array<GetExtendedContactDetailsStatisticsClicked>',
    :'transac_attributes' => :'Array<Object>'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 139
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages_sent == o.messages_sent &&
      hard_bounces == o.hard_bounces &&
      soft_bounces == o.soft_bounces &&
      complaints == o.complaints &&
      unsubscriptions == o.unsubscriptions &&
      opened == o.opened &&
      clicked == o.clicked &&
      transac_attributes == o.transac_attributes
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 188
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 = SibApiV3Sdk.const_get(type).new
    temp_model.build_from_hash(value)
  end
end
_to_hash(value) click to toggle source

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/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 254
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
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 167
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
eql?(o) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 154
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Fixnum] Hash code

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 160
def hash
  [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 126
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 234
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 240
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
to_s() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 228
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sib-api-v3-sdk/models/get_extended_contact_details_statistics.rb, line 133
def valid?
  true
end