class SibApiV3Sdk::GetCampaignStats

Attributes

clickers[RW]

Number of total clicks for the campaign

complaints[RW]

Number of complaints (Spam reports) for the campaign

deferred[RW]

Number of deferred emails for the campaign

delivered[RW]

Number of delivered emails for the campaign

hard_bounces[RW]

Number of harbounce for the campaign

list_id[RW]

List Id of email campaign (only in case of get email campaign(s)(not for global stats))

return_bounce[RW]

Total number of non-delivered campaigns for a particular campaign id.

sent[RW]

Number of sent emails for the campaign

soft_bounces[RW]

Number of softbounce for the campaign

unique_clicks[RW]

Number of unique clicks for the campaign

unique_views[RW]

Number of unique openings for the campaign

unsubscriptions[RW]

Number of unsubscription for the campaign

viewed[RW]

Number of openings for the campaign

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_campaign_stats.rb, line 57
def self.attribute_map
  {
    :'list_id' => :'listId',
    :'unique_clicks' => :'uniqueClicks',
    :'clickers' => :'clickers',
    :'complaints' => :'complaints',
    :'delivered' => :'delivered',
    :'sent' => :'sent',
    :'soft_bounces' => :'softBounces',
    :'hard_bounces' => :'hardBounces',
    :'unique_views' => :'uniqueViews',
    :'unsubscriptions' => :'unsubscriptions',
    :'viewed' => :'viewed',
    :'deferred' => :'deferred',
    :'return_bounce' => :'returnBounce'
  }
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_campaign_stats.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?(:'listId')
    self.list_id = attributes[:'listId']
  end

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/get_campaign_stats.rb, line 76
def self.swagger_types
  {
    :'list_id' => :'Integer',
    :'unique_clicks' => :'Integer',
    :'clickers' => :'Integer',
    :'complaints' => :'Integer',
    :'delivered' => :'Integer',
    :'sent' => :'Integer',
    :'soft_bounces' => :'Integer',
    :'hard_bounces' => :'Integer',
    :'unique_views' => :'Integer',
    :'unsubscriptions' => :'Integer',
    :'viewed' => :'Integer',
    :'deferred' => :'Integer',
    :'return_bounce' => :'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_campaign_stats.rb, line 220
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      list_id == o.list_id &&
      unique_clicks == o.unique_clicks &&
      clickers == o.clickers &&
      complaints == o.complaints &&
      delivered == o.delivered &&
      sent == o.sent &&
      soft_bounces == o.soft_bounces &&
      hard_bounces == o.hard_bounces &&
      unique_views == o.unique_views &&
      unsubscriptions == o.unsubscriptions &&
      viewed == o.viewed &&
      deferred == o.deferred &&
      return_bounce == o.return_bounce
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_campaign_stats.rb, line 274
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_campaign_stats.rb, line 340
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_campaign_stats.rb, line 253
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_campaign_stats.rb, line 240
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_campaign_stats.rb, line 246
def hash
  [list_id, unique_clicks, clickers, complaints, delivered, sent, soft_bounces, hard_bounces, unique_views, unsubscriptions, viewed, deferred, return_bounce].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_campaign_stats.rb, line 157
def list_invalid_properties
  invalid_properties = Array.new
  if @unique_clicks.nil?
    invalid_properties.push('invalid value for "unique_clicks", unique_clicks cannot be nil.')
  end

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

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

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

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

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

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

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

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

  if @viewed.nil?
    invalid_properties.push('invalid value for "viewed", viewed 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_campaign_stats.rb, line 320
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_campaign_stats.rb, line 326
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_campaign_stats.rb, line 314
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_campaign_stats.rb, line 204
def valid?
  return false if @unique_clicks.nil?
  return false if @clickers.nil?
  return false if @complaints.nil?
  return false if @delivered.nil?
  return false if @sent.nil?
  return false if @soft_bounces.nil?
  return false if @hard_bounces.nil?
  return false if @unique_views.nil?
  return false if @unsubscriptions.nil?
  return false if @viewed.nil?
  true
end