class UltracartClient::EmailPostcardStat

Attributes

click_count[RW]

Count of clicked emails

click_count_formatted[RW]

Count of clicked emails, formatted

conversion_count[RW]

Count of conversions

conversion_count_formatted[RW]

Count of conversions, formatted

delivered_count[RW]

Count of delivered emails

delivered_count_formatted[RW]

Count of delivered emails, formatted

merchant_id[RW]

Merchant ID

name[RW]

List or segment name

order_count[RW]

Count of orders

order_count_formatted[RW]

Count of orders, formatted

profit[RW]

Profit

profit_formatted[RW]

Profit, formatted

return_to_sender_count[RW]

Count of return to sender

return_to_sender_count_formatted[RW]

Count of return to sender, formatted

revenue[RW]

Revenue

revenue_formatted[RW]

Revenue, formatted

send_count[RW]

Count of emails sent

send_count_formatted[RW]

Count of emails sent, formatted

skipped_count[RW]

Count of skipped emails

skipped_count_formatted[RW]

Count of skipped emails, formatted

spam_count[RW]

Count of emails classified as spam

spam_count_formatted[RW]

Count of emails classified as spam, formatted

stat_type[RW]

Campaign, Flow or None (for anything else)

status[RW]

Status of campaign or flow

status_dts[RW]

Status dts of campaign or flow

steps[RW]
storefront_oid[RW]

Storefront oid

unsubscribe_count[RW]

Count of emails classified as unsubscribe

unsubscribe_count_formatted[RW]

Count of emails classified as unsubscribe, formatted

uuid[RW]

List or segment uuid

view_count[RW]

Count of views

view_count_formatted[RW]

Count of views, formatted

Public Class Methods

attribute_map() click to toggle source

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

# File lib/ultracart_api/models/email_postcard_stat.rb, line 113
def self.attribute_map
  {
    :'click_count' => :'click_count',
    :'click_count_formatted' => :'click_count_formatted',
    :'conversion_count' => :'conversion_count',
    :'conversion_count_formatted' => :'conversion_count_formatted',
    :'delivered_count' => :'delivered_count',
    :'delivered_count_formatted' => :'delivered_count_formatted',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'order_count' => :'order_count',
    :'order_count_formatted' => :'order_count_formatted',
    :'profit' => :'profit',
    :'profit_formatted' => :'profit_formatted',
    :'return_to_sender_count' => :'return_to_sender_count',
    :'return_to_sender_count_formatted' => :'return_to_sender_count_formatted',
    :'revenue' => :'revenue',
    :'revenue_formatted' => :'revenue_formatted',
    :'send_count' => :'send_count',
    :'send_count_formatted' => :'send_count_formatted',
    :'skipped_count' => :'skipped_count',
    :'skipped_count_formatted' => :'skipped_count_formatted',
    :'spam_count' => :'spam_count',
    :'spam_count_formatted' => :'spam_count_formatted',
    :'stat_type' => :'stat_type',
    :'status' => :'status',
    :'status_dts' => :'status_dts',
    :'steps' => :'steps',
    :'storefront_oid' => :'storefront_oid',
    :'unsubscribe_count' => :'unsubscribe_count',
    :'unsubscribe_count_formatted' => :'unsubscribe_count_formatted',
    :'uuid' => :'uuid',
    :'view_count' => :'view_count',
    :'view_count_formatted' => :'view_count_formatted'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/ultracart_api/models/email_postcard_stat.rb, line 190
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?(:'click_count')
    self.click_count = attributes[:'click_count']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/ultracart_api/models/email_postcard_stat.rb, line 151
def self.swagger_types
  {
    :'click_count' => :'Integer',
    :'click_count_formatted' => :'String',
    :'conversion_count' => :'Integer',
    :'conversion_count_formatted' => :'String',
    :'delivered_count' => :'Integer',
    :'delivered_count_formatted' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'order_count' => :'Integer',
    :'order_count_formatted' => :'String',
    :'profit' => :'Float',
    :'profit_formatted' => :'String',
    :'return_to_sender_count' => :'Integer',
    :'return_to_sender_count_formatted' => :'String',
    :'revenue' => :'Float',
    :'revenue_formatted' => :'String',
    :'send_count' => :'Integer',
    :'send_count_formatted' => :'String',
    :'skipped_count' => :'Integer',
    :'skipped_count_formatted' => :'String',
    :'spam_count' => :'Integer',
    :'spam_count_formatted' => :'String',
    :'stat_type' => :'String',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'steps' => :'Array<EmailPostcardStat>',
    :'storefront_oid' => :'Integer',
    :'unsubscribe_count' => :'Integer',
    :'unsubscribe_count_formatted' => :'String',
    :'uuid' => :'String',
    :'view_count' => :'Integer',
    :'view_count_formatted' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/ultracart_api/models/email_postcard_stat.rb, line 342
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      click_count == o.click_count &&
      click_count_formatted == o.click_count_formatted &&
      conversion_count == o.conversion_count &&
      conversion_count_formatted == o.conversion_count_formatted &&
      delivered_count == o.delivered_count &&
      delivered_count_formatted == o.delivered_count_formatted &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      order_count == o.order_count &&
      order_count_formatted == o.order_count_formatted &&
      profit == o.profit &&
      profit_formatted == o.profit_formatted &&
      return_to_sender_count == o.return_to_sender_count &&
      return_to_sender_count_formatted == o.return_to_sender_count_formatted &&
      revenue == o.revenue &&
      revenue_formatted == o.revenue_formatted &&
      send_count == o.send_count &&
      send_count_formatted == o.send_count_formatted &&
      skipped_count == o.skipped_count &&
      skipped_count_formatted == o.skipped_count_formatted &&
      spam_count == o.spam_count &&
      spam_count_formatted == o.spam_count_formatted &&
      stat_type == o.stat_type &&
      status == o.status &&
      status_dts == o.status_dts &&
      steps == o.steps &&
      storefront_oid == o.storefront_oid &&
      unsubscribe_count == o.unsubscribe_count &&
      unsubscribe_count_formatted == o.unsubscribe_count_formatted &&
      uuid == o.uuid &&
      view_count == o.view_count &&
      view_count_formatted == o.view_count_formatted
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/ultracart_api/models/email_postcard_stat.rb, line 415
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 = UltracartClient.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/ultracart_api/models/email_postcard_stat.rb, line 481
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/ultracart_api/models/email_postcard_stat.rb, line 394
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/ultracart_api/models/email_postcard_stat.rb, line 381
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/ultracart_api/models/email_postcard_stat.rb, line 387
def hash
  [click_count, click_count_formatted, conversion_count, conversion_count_formatted, delivered_count, delivered_count_formatted, merchant_id, name, order_count, order_count_formatted, profit, profit_formatted, return_to_sender_count, return_to_sender_count_formatted, revenue, revenue_formatted, send_count, send_count_formatted, skipped_count, skipped_count_formatted, spam_count, spam_count_formatted, stat_type, status, status_dts, steps, storefront_oid, unsubscribe_count, unsubscribe_count_formatted, uuid, view_count, view_count_formatted].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/ultracart_api/models/email_postcard_stat.rb, line 329
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/ultracart_api/models/email_postcard_stat.rb, line 461
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/ultracart_api/models/email_postcard_stat.rb, line 467
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/ultracart_api/models/email_postcard_stat.rb, line 455
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/ultracart_api/models/email_postcard_stat.rb, line 336
def valid?
  true
end