Class: UltracartClient::ExperimentVariation

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/models/experiment_variation.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExperimentVariation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 141

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?(:'add_to_cart_count')
    self.add_to_cart_count = attributes[:'add_to_cart_count']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#add_to_cart_count ⇒ Object

Total add to cart count for this variation



18
19
20
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 18

def add_to_cart_count
  @add_to_cart_count
end

#average_duration_seconds ⇒ Object

Average duration seconds per session for this variation



21
22
23
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 21

def average_duration_seconds
  @average_duration_seconds
end

#average_objective_per_session ⇒ Object

Average objective value per session for this variation



24
25
26
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 24

def average_objective_per_session
  @average_objective_per_session
end

#average_order_value ⇒ Object

Average order value for this variation



27
28
29
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 27

def average_order_value
  @average_order_value
end

#bounce_count ⇒ Object

Total bounce count for this variation



30
31
32
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 30

def bounce_count
  @bounce_count
end

#conversion_rate ⇒ Object

Conversion rate for this variation



33
34
35
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 33

def conversion_rate
  @conversion_rate
end

#daily_statistics ⇒ Object

Array of daily statistics for this variation



36
37
38
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 36

def daily_statistics
  @daily_statistics
end

#duration_seconds_sum ⇒ Object

Total number of seconds spent on the site for this variation



39
40
41
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 39

def duration_seconds_sum
  @duration_seconds_sum
end

#event_count ⇒ Object

Total event ocunt for this variation



42
43
44
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 42

def event_count
  @event_count
end

#initiate_checkout_count ⇒ Object

Total initiate checkout count for this variation



45
46
47
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 45

def initiate_checkout_count
  @initiate_checkout_count
end

#order_count ⇒ Object

Total order count for this variation



48
49
50
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 48

def order_count
  @order_count
end

#order_item_count ⇒ Object

Total order item count for this variation



51
52
53
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 51

def order_item_count
  @order_item_count
end

#original_traffic_percentage ⇒ Object

Percentage of the traffic the variation originally started out with



54
55
56
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 54

def original_traffic_percentage
  @original_traffic_percentage
end

#page_view_count ⇒ Object

Total page view count for this variation



57
58
59
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 57

def page_view_count
  @page_view_count
end

#paused ⇒ Object

True if traffic should be paused to this variation



60
61
62
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 60

def paused
  @paused
end

#revenue ⇒ Object

Total revenue for this variation



63
64
65
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 63

def revenue
  @revenue
end

#session_count ⇒ Object

Total sessions for this variation



66
67
68
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 66

def session_count
  @session_count
end

#traffic_percentage ⇒ Object

Percentage of the traffic this variation is currently receiving



69
70
71
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 69

def traffic_percentage
  @traffic_percentage
end

#url ⇒ Object

Url of the variation if this experiment is a url experiment.



72
73
74
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 72

def url
  @url
end

#variation_name ⇒ Object

Name of the variation



75
76
77
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 75

def variation_name
  @variation_name
end

#variation_number ⇒ Object

Variation number



78
79
80
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 78

def variation_number
  @variation_number
end

#winner ⇒ Object

True if this variation has been declared the winner



81
82
83
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 81

def winner
  @winner
end

Class Method Details

.attribute_map ⇒ Object

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



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 84

def self.attribute_map
  {
    :'add_to_cart_count' => :'add_to_cart_count',
    :'average_duration_seconds' => :'average_duration_seconds',
    :'average_objective_per_session' => :'average_objective_per_session',
    :'average_order_value' => :'average_order_value',
    :'bounce_count' => :'bounce_count',
    :'conversion_rate' => :'conversion_rate',
    :'daily_statistics' => :'daily_statistics',
    :'duration_seconds_sum' => :'duration_seconds_sum',
    :'event_count' => :'event_count',
    :'initiate_checkout_count' => :'initiate_checkout_count',
    :'order_count' => :'order_count',
    :'order_item_count' => :'order_item_count',
    :'original_traffic_percentage' => :'original_traffic_percentage',
    :'page_view_count' => :'page_view_count',
    :'paused' => :'paused',
    :'revenue' => :'revenue',
    :'session_count' => :'session_count',
    :'traffic_percentage' => :'traffic_percentage',
    :'url' => :'url',
    :'variation_name' => :'variation_name',
    :'variation_number' => :'variation_number',
    :'winner' => :'winner'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 112

def self.swagger_types
  {
    :'add_to_cart_count' => :'Integer',
    :'average_duration_seconds' => :'Integer',
    :'average_objective_per_session' => :'Float',
    :'average_order_value' => :'Float',
    :'bounce_count' => :'Integer',
    :'conversion_rate' => :'Float',
    :'daily_statistics' => :'Array<ExperimentVariationStat>',
    :'duration_seconds_sum' => :'Integer',
    :'event_count' => :'Integer',
    :'initiate_checkout_count' => :'Integer',
    :'order_count' => :'Integer',
    :'order_item_count' => :'Integer',
    :'original_traffic_percentage' => :'Float',
    :'page_view_count' => :'Integer',
    :'paused' => :'BOOLEAN',
    :'revenue' => :'Float',
    :'session_count' => :'Integer',
    :'traffic_percentage' => :'Float',
    :'url' => :'String',
    :'variation_name' => :'String',
    :'variation_number' => :'Integer',
    :'winner' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      add_to_cart_count == o.add_to_cart_count &&
      average_duration_seconds == o.average_duration_seconds &&
      average_objective_per_session == o.average_objective_per_session &&
      average_order_value == o.average_order_value &&
      bounce_count == o.bounce_count &&
      conversion_rate == o.conversion_rate &&
      daily_statistics == o.daily_statistics &&
      duration_seconds_sum == o.duration_seconds_sum &&
      event_count == o.event_count &&
      initiate_checkout_count == o.initiate_checkout_count &&
      order_count == o.order_count &&
      order_item_count == o.order_item_count &&
      original_traffic_percentage == o.original_traffic_percentage &&
      page_view_count == o.page_view_count &&
      paused == o.paused &&
      revenue == o.revenue &&
      session_count == o.session_count &&
      traffic_percentage == o.traffic_percentage &&
      url == o.url &&
      variation_name == o.variation_name &&
      variation_number == o.variation_number &&
      winner == o.winner
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



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 316

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) ⇒ 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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 382

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 295

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


282
283
284
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 288

def hash
  [add_to_cart_count, average_duration_seconds, average_objective_per_session, average_order_value, bounce_count, conversion_rate, daily_statistics, duration_seconds_sum, event_count, initiate_checkout_count, order_count, order_item_count, original_traffic_percentage, page_view_count, paused, revenue, session_count, traffic_percentage, url, variation_name, variation_number, winner].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



240
241
242
243
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 240

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



362
363
364
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 362

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



368
369
370
371
372
373
374
375
376
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 368

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



356
357
358
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 356

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



247
248
249
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 247

def valid?
  true
end