class SibApiV3Sdk::GetReportsReports

Attributes

blocked[RW]

Number of blocked emails for the date

clicks[RW]

Number of clicks for the date

date[RW]

Date of the statistics

delivered[RW]

Number of delivered emails for the date

hard_bounces[RW]

Number of hardbounces for the date

invalid[RW]

Number of invalid emails for the date

opens[RW]

Number of openings for the date

requests[RW]

Number of requests for the date

soft_bounces[RW]

Number of softbounces for the date

spam_reports[RW]

Number of complaints (spam reports) for the date

unique_clicks[RW]

Number of unique clicks for the date

unique_opens[RW]

Number of unique openings for the date

unsubscribed[RW]

Number of unsubscribed emails for the date

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_reports_reports.rb, line 57
def self.attribute_map
  {
    :'date' => :'date',
    :'requests' => :'requests',
    :'delivered' => :'delivered',
    :'hard_bounces' => :'hardBounces',
    :'soft_bounces' => :'softBounces',
    :'clicks' => :'clicks',
    :'unique_clicks' => :'uniqueClicks',
    :'opens' => :'opens',
    :'unique_opens' => :'uniqueOpens',
    :'spam_reports' => :'spamReports',
    :'blocked' => :'blocked',
    :'invalid' => :'invalid',
    :'unsubscribed' => :'unsubscribed'
  }
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_reports_reports.rb, line 96
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?(:'date')
    self.date = attributes[:'date']
  end

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'unsubscribed')
    self.unsubscribed = attributes[:'unsubscribed']
  end
end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_reports_reports.rb, line 76
def self.swagger_types
  {
    :'date' => :'Date',
    :'requests' => :'Integer',
    :'delivered' => :'Integer',
    :'hard_bounces' => :'Integer',
    :'soft_bounces' => :'Integer',
    :'clicks' => :'Integer',
    :'unique_clicks' => :'Integer',
    :'opens' => :'Integer',
    :'unique_opens' => :'Integer',
    :'spam_reports' => :'Integer',
    :'blocked' => :'Integer',
    :'invalid' => :'Integer',
    :'unsubscribed' => :'Integer'
  }
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_reports_reports.rb, line 235
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      date == o.date &&
      requests == o.requests &&
      delivered == o.delivered &&
      hard_bounces == o.hard_bounces &&
      soft_bounces == o.soft_bounces &&
      clicks == o.clicks &&
      unique_clicks == o.unique_clicks &&
      opens == o.opens &&
      unique_opens == o.unique_opens &&
      spam_reports == o.spam_reports &&
      blocked == o.blocked &&
      invalid == o.invalid &&
      unsubscribed == o.unsubscribed
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_reports_reports.rb, line 289
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_reports_reports.rb, line 355
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_reports_reports.rb, line 268
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_reports_reports.rb, line 255
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_reports_reports.rb, line 261
def hash
  [date, requests, delivered, hard_bounces, soft_bounces, clicks, unique_clicks, opens, unique_opens, spam_reports, blocked, invalid, unsubscribed].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_reports_reports.rb, line 157
def list_invalid_properties
  invalid_properties = Array.new
  if @date.nil?
    invalid_properties.push('invalid value for "date", date cannot be nil.')
  end

  if @requests.nil?
    invalid_properties.push('invalid value for "requests", requests cannot be nil.')
  end

  if @delivered.nil?
    invalid_properties.push('invalid value for "delivered", delivered cannot be nil.')
  end

  if @hard_bounces.nil?
    invalid_properties.push('invalid value for "hard_bounces", hard_bounces cannot be nil.')
  end

  if @soft_bounces.nil?
    invalid_properties.push('invalid value for "soft_bounces", soft_bounces cannot be nil.')
  end

  if @clicks.nil?
    invalid_properties.push('invalid value for "clicks", clicks cannot be nil.')
  end

  if @unique_clicks.nil?
    invalid_properties.push('invalid value for "unique_clicks", unique_clicks cannot be nil.')
  end

  if @opens.nil?
    invalid_properties.push('invalid value for "opens", opens cannot be nil.')
  end

  if @unique_opens.nil?
    invalid_properties.push('invalid value for "unique_opens", unique_opens cannot be nil.')
  end

  if @spam_reports.nil?
    invalid_properties.push('invalid value for "spam_reports", spam_reports cannot be nil.')
  end

  if @blocked.nil?
    invalid_properties.push('invalid value for "blocked", blocked cannot be nil.')
  end

  if @invalid.nil?
    invalid_properties.push('invalid value for "invalid", invalid cannot be nil.')
  end

  if @unsubscribed.nil?
    invalid_properties.push('invalid value for "unsubscribed", unsubscribed cannot be nil.')
  end

  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_reports_reports.rb, line 335
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_reports_reports.rb, line 341
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_reports_reports.rb, line 329
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_reports_reports.rb, line 216
def valid?
  return false if @date.nil?
  return false if @requests.nil?
  return false if @delivered.nil?
  return false if @hard_bounces.nil?
  return false if @soft_bounces.nil?
  return false if @clicks.nil?
  return false if @unique_clicks.nil?
  return false if @opens.nil?
  return false if @unique_opens.nil?
  return false if @spam_reports.nil?
  return false if @blocked.nil?
  return false if @invalid.nil?
  return false if @unsubscribed.nil?
  true
end