class SibApiV3Sdk::AbTestCampaignResult

Attributes

click_rate[RW]

Click rate for current winning version

open_rate[RW]

Open rate for current winning version

statistics[RW]
winning_criteria[RW]

Criteria choosen for winning version (Open/Click)

winning_subject_line[RW]

Subject Line of current winning version

winning_version[RW]

Winning Campaign Info. pending = Campaign has been picked for sending and winning version is yet to be decided, tie = A tie happened between both the versions, notAvailable = Campaign has not yet been picked for sending.

winning_version_rate[RW]

Open/Click rate for the winner version

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/ab_test_campaign_result.rb, line 62
def self.attribute_map
  {
    :'winning_version' => :'winningVersion',
    :'winning_criteria' => :'winningCriteria',
    :'winning_subject_line' => :'winningSubjectLine',
    :'open_rate' => :'openRate',
    :'click_rate' => :'clickRate',
    :'winning_version_rate' => :'winningVersionRate',
    :'statistics' => :'statistics',
    :'clicked_links' => :'clickedLinks'
  }
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/ab_test_campaign_result.rb, line 91
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?(:'winningVersion')
    self.winning_version = attributes[:'winningVersion']
  end

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

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

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

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

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

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

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

Attribute type mapping.

# File lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb, line 76
def self.swagger_types
  {
    :'winning_version' => :'String',
    :'winning_criteria' => :'String',
    :'winning_subject_line' => :'String',
    :'open_rate' => :'String',
    :'click_rate' => :'String',
    :'winning_version_rate' => :'String',
    :'statistics' => :'AbTestCampaignResultStatistics',
    :'clicked_links' => :'AbTestCampaignResultClickedLinks'
  }
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/ab_test_campaign_result.rb, line 169
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      winning_version == o.winning_version &&
      winning_criteria == o.winning_criteria &&
      winning_subject_line == o.winning_subject_line &&
      open_rate == o.open_rate &&
      click_rate == o.click_rate &&
      winning_version_rate == o.winning_version_rate &&
      statistics == o.statistics &&
      clicked_links == o.clicked_links
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/ab_test_campaign_result.rb, line 218
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/ab_test_campaign_result.rb, line 284
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/ab_test_campaign_result.rb, line 197
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/ab_test_campaign_result.rb, line 184
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/ab_test_campaign_result.rb, line 190
def hash
  [winning_version, winning_criteria, winning_subject_line, open_rate, click_rate, winning_version_rate, statistics, clicked_links].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/ab_test_campaign_result.rb, line 132
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/ab_test_campaign_result.rb, line 264
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/ab_test_campaign_result.rb, line 270
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/ab_test_campaign_result.rb, line 258
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/ab_test_campaign_result.rb, line 139
def valid?
  winning_version_validator = EnumAttributeValidator.new('String', ['notAvailable', 'pending', 'tie', 'A', 'B'])
  return false unless winning_version_validator.valid?(@winning_version)
  winning_criteria_validator = EnumAttributeValidator.new('String', ['Open', 'Click'])
  return false unless winning_criteria_validator.valid?(@winning_criteria)
  true
end
winning_criteria=(winning_criteria) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] winning_criteria Object to be assigned

# File lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb, line 159
def winning_criteria=(winning_criteria)
  validator = EnumAttributeValidator.new('String', ['Open', 'Click'])
  unless validator.valid?(winning_criteria)
    fail ArgumentError, 'invalid value for "winning_criteria", must be one of #{validator.allowable_values}.'
  end
  @winning_criteria = winning_criteria
end
winning_version=(winning_version) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] winning_version Object to be assigned

# File lib/sib-api-v3-sdk/models/ab_test_campaign_result.rb, line 149
def winning_version=(winning_version)
  validator = EnumAttributeValidator.new('String', ['notAvailable', 'pending', 'tie', 'A', 'B'])
  unless validator.valid?(winning_version)
    fail ArgumentError, 'invalid value for "winning_version", must be one of #{validator.allowable_values}.'
  end
  @winning_version = winning_version
end