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



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 158

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::ExperimentVariation` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::ExperimentVariation`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'add_to_cart_count')
    self.add_to_cart_count = attributes[:'add_to_cart_count']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'sms_opt_ins')
    self.sms_opt_ins = attributes[:'sms_opt_ins']
  end

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

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

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

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

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

Instance Attribute Details

#add_to_cart_count ⇒ Object

Total add to cart count for this variation



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

def add_to_cart_count
  @add_to_cart_count
end

#average_duration_seconds ⇒ Object

Average duration seconds per session for this variation



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

def average_duration_seconds
  @average_duration_seconds
end

#average_objective_per_session ⇒ Object

Average objective value per session for this variation



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

def average_objective_per_session
  @average_objective_per_session
end

#average_order_value ⇒ Object

Average order value for this variation



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

def average_order_value
  @average_order_value
end

#bounce_count ⇒ Object

Total bounce count for this variation



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

def bounce_count
  @bounce_count
end

#conversion_rate ⇒ Object

Conversion rate for this variation



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

def conversion_rate
  @conversion_rate
end

#daily_statistics ⇒ Object

Array of daily statistics for this variation



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

def daily_statistics
  @daily_statistics
end

#duration_seconds_sum ⇒ Object

Total number of seconds spent on the site for this variation



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

def duration_seconds_sum
  @duration_seconds_sum
end

#event_count ⇒ Object

Total event ocunt for this variation



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

def event_count
  @event_count
end

#initiate_checkout_count ⇒ Object

Total initiate checkout count for this variation



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

def initiate_checkout_count
  @initiate_checkout_count
end

#order_count ⇒ Object

Total order count for this variation



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

def order_count
  @order_count
end

#order_item_count ⇒ Object

Total order item count for this variation



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

def order_item_count
  @order_item_count
end

#original_traffic_percentage ⇒ Object

Percentage of the traffic the variation originally started out with



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

def original_traffic_percentage
  @original_traffic_percentage
end

#page_view_count ⇒ Object

Total page view count for this variation



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

def page_view_count
  @page_view_count
end

#paused ⇒ Object

True if traffic should be paused to this variation



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

def paused
  @paused
end

#revenue ⇒ Object

Total revenue for this variation



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

def revenue
  @revenue
end

#session_count ⇒ Object

Total sessions for this variation



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

def session_count
  @session_count
end

#sms_opt_ins ⇒ Object

SMS Opt Ins for this variation



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

def sms_opt_ins
  @sms_opt_ins
end

#traffic_percentage ⇒ Object

Percentage of the traffic this variation is currently receiving



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

def traffic_percentage
  @traffic_percentage
end

#url ⇒ Object

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



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

def url
  @url
end

#variation_name ⇒ Object

Name of the variation



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

def variation_name
  @variation_name
end

#variation_number ⇒ Object

Variation number



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

def variation_number
  @variation_number
end

#winner ⇒ Object

True if this variation has been declared the winner



85
86
87
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 85

def winner
  @winner
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



117
118
119
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 117

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 88

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',
    :'sms_opt_ins' => :'sms_opt_ins',
    :'traffic_percentage' => :'traffic_percentage',
    :'url' => :'url',
    :'variation_name' => :'variation_name',
    :'variation_number' => :'variation_number',
    :'winner' => :'winner'
  }
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



324
325
326
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 324

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



151
152
153
154
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 151

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 122

def self.openapi_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',
    :'sms_opt_ins' => :'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



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 281

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 &&
      sms_opt_ins == o.sms_opt_ins &&
      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



355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 355

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = UltracartClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 426

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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 331

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


311
312
313
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 311

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



317
318
319
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 317

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, sms_opt_ins, 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



268
269
270
271
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 268

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



402
403
404
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 402

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



408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 408

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



396
397
398
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 396

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



275
276
277
 
# File 'lib/ultracart_api/models/experiment_variation.rb', line 275

def valid?
  true
end