Class: UltracartClient::Experiment

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Experiment

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/ultracart_api/models/experiment.rb', line 143

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#container_id ⇒ Object

Contained ID where the experiment element was located



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

def container_id
  @container_id
end

#duration_days ⇒ Object

Duration in days



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

def duration_days
  @duration_days
end

#end_dts ⇒ Object

End date/time



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

def end_dts
  @end_dts
end

#equal_weighting ⇒ Object

Whether or not traffic is equally weighted or shifts over time during the experiment



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

def equal_weighting
  @equal_weighting
end

#experiment_type ⇒ Object

The type of experiment



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

def experiment_type
  @experiment_type
end

#id ⇒ Object

Experiment id



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

def id
  @id
end

#name ⇒ Object

Experiment name



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

def name
  @name
end

#notes ⇒ Object

Notes about the experiment



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

def notes
  @notes
end

#objective ⇒ Object

Objective that is being optimized



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

def objective
  @objective
end

#objective_parameter ⇒ Object

Objective parameter (such as event name) that is being optimized



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

def objective_parameter
  @objective_parameter
end

#optimization_type ⇒ Object

Type of optimization



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

def optimization_type
  @optimization_type
end

#session_count ⇒ Object

Total number of sessions in the experiment



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

def session_count
  @session_count
end

#start_dts ⇒ Object

Start date/time



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

def start_dts
  @start_dts
end

#status ⇒ Object

Status of the experiment



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

def status
  @status
end

#storefront_experiment_oid ⇒ Object

Storefront Experiment Oid



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

def storefront_experiment_oid
  @storefront_experiment_oid
end

#storefront_oid ⇒ Object

Storefront oid



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

def storefront_oid
  @storefront_oid
end

#uri ⇒ Object

URI the experiment was started on



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

def uri
  @uri
end

#variations ⇒ Object

Variations being tested in the experiment



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

def variations
  @variations
end

Class Method Details

.attribute_map ⇒ Object

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



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/ultracart_api/models/experiment.rb', line 94

def self.attribute_map
  {
    :'container_id' => :'container_id',
    :'duration_days' => :'duration_days',
    :'end_dts' => :'end_dts',
    :'equal_weighting' => :'equal_weighting',
    :'experiment_type' => :'experiment_type',
    :'id' => :'id',
    :'name' => :'name',
    :'notes' => :'notes',
    :'objective' => :'objective',
    :'objective_parameter' => :'objective_parameter',
    :'optimization_type' => :'optimization_type',
    :'session_count' => :'session_count',
    :'start_dts' => :'start_dts',
    :'status' => :'status',
    :'storefront_experiment_oid' => :'storefront_experiment_oid',
    :'storefront_oid' => :'storefront_oid',
    :'uri' => :'uri',
    :'variations' => :'variations'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/ultracart_api/models/experiment.rb', line 118

def self.swagger_types
  {
    :'container_id' => :'String',
    :'duration_days' => :'Integer',
    :'end_dts' => :'String',
    :'equal_weighting' => :'BOOLEAN',
    :'experiment_type' => :'String',
    :'id' => :'String',
    :'name' => :'String',
    :'notes' => :'String',
    :'objective' => :'String',
    :'objective_parameter' => :'String',
    :'optimization_type' => :'String',
    :'session_count' => :'Integer',
    :'start_dts' => :'String',
    :'status' => :'String',
    :'storefront_experiment_oid' => :'Integer',
    :'storefront_oid' => :'Integer',
    :'uri' => :'String',
    :'variations' => :'Array<ExperimentVariation>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/ultracart_api/models/experiment.rb', line 251

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      container_id == o.container_id &&
      duration_days == o.duration_days &&
      end_dts == o.end_dts &&
      equal_weighting == o.equal_weighting &&
      experiment_type == o.experiment_type &&
      id == o.id &&
      name == o.name &&
      notes == o.notes &&
      objective == o.objective &&
      objective_parameter == o.objective_parameter &&
      optimization_type == o.optimization_type &&
      session_count == o.session_count &&
      start_dts == o.start_dts &&
      status == o.status &&
      storefront_experiment_oid == o.storefront_experiment_oid &&
      storefront_oid == o.storefront_oid &&
      uri == o.uri &&
      variations == o.variations
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



310
311
312
313
314
315
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
 
# File 'lib/ultracart_api/models/experiment.rb', line 310

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



376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/ultracart_api/models/experiment.rb', line 376

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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/ultracart_api/models/experiment.rb', line 289

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


276
277
278
 
# File 'lib/ultracart_api/models/experiment.rb', line 276

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [container_id, duration_days, end_dts, equal_weighting, experiment_type, id, name, notes, objective, objective_parameter, optimization_type, session_count, start_dts, status, storefront_experiment_oid, storefront_oid, uri, variations].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



226
227
228
229
 
# File 'lib/ultracart_api/models/experiment.rb', line 226

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



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

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



362
363
364
365
366
367
368
369
370
 
# File 'lib/ultracart_api/models/experiment.rb', line 362

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



350
351
352
 
# File 'lib/ultracart_api/models/experiment.rb', line 350

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



233
234
235
236
237
 
# File 'lib/ultracart_api/models/experiment.rb', line 233

def valid?
  status_validator = EnumAttributeValidator.new('String', ['Running', 'Ended', 'Deleted'])
  return false unless status_validator.valid?(@status)
  true
end