Class: BrevoRuby::AbTestCampaignResult

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/ab_test_campaign_result.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AbTestCampaignResult

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/brevo-ruby/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

Instance Attribute Details

#click_rate ⇒ Object

Click rate for current winning version



30
31
32
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 30

def click_rate
  @click_rate
end

#clicked_links ⇒ Object

Returns the value of attribute clicked_links.



37
38
39
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 37

def clicked_links
  @clicked_links
end

#open_rate ⇒ Object

Open rate for current winning version



27
28
29
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 27

def open_rate
  @open_rate
end

#statistics ⇒ Object

Returns the value of attribute statistics.



35
36
37
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 35

def statistics
  @statistics
end

#winning_criteria ⇒ Object

Criteria choosen for winning version (Open/Click)



21
22
23
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 21

def winning_criteria
  @winning_criteria
end

#winning_subject_line ⇒ Object

Subject Line of current winning version



24
25
26
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 24

def winning_subject_line
  @winning_subject_line
end

#winning_version ⇒ Object

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.



18
19
20
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 18

def winning_version
  @winning_version
end

#winning_version_rate ⇒ Object

Open/Click rate for the winner version



33
34
35
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 33

def winning_version_rate
  @winning_version_rate
end

Class Method Details

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/brevo-ruby/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

.swagger_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/brevo-ruby/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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/brevo-ruby/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) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/brevo-ruby/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 = BrevoRuby.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/brevo-ruby/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) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/brevo-ruby/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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


184
185
186
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 184

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



190
191
192
 
# File 'lib/brevo-ruby/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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



132
133
134
135
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 132

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



264
265
266
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 264

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
 
# File 'lib/brevo-ruby/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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



258
259
260
 
# File 'lib/brevo-ruby/models/ab_test_campaign_result.rb', line 258

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



139
140
141
142
143
144
145
 
# File 'lib/brevo-ruby/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