Class: UltracartClient::EmailStepStat

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailStepStat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
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
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 181

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#left_click_count ⇒ Object

click count (left side)



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

def left_click_count
  @left_click_count
end

#left_click_count_formatted ⇒ Object

click count formatted (left side)



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

def left_click_count_formatted
  @left_click_count_formatted
end

#left_conversion_count ⇒ Object

conversion count (left/default side)



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

def left_conversion_count
  @left_conversion_count
end

#left_conversion_count_formatted ⇒ Object

conversion count formatted (left/default side)



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

def left_conversion_count_formatted
  @left_conversion_count_formatted
end

#left_customer_count ⇒ Object

customer count (left/default side)



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

def left_customer_count
  @left_customer_count
end

#left_customer_count_formatted ⇒ Object

customer count formatted (left/default side)



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

def left_customer_count_formatted
  @left_customer_count_formatted
end

#left_delivered_count ⇒ Object

delivered count (left side)



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

def left_delivered_count
  @left_delivered_count
end

#left_delivered_count_formatted ⇒ Object

delivered count formatted (left side)



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

def left_delivered_count_formatted
  @left_delivered_count_formatted
end

#left_order_count ⇒ Object

order count (left/default side)



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

def left_order_count
  @left_order_count
end

#left_order_count_formatted ⇒ Object

order count formatted (left/default side)



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

def left_order_count_formatted
  @left_order_count_formatted
end

#left_profit ⇒ Object

profit (left/default side)



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

def left_profit
  @left_profit
end

#left_profit_formatted ⇒ Object

profit formatted (left/default side)



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

def left_profit_formatted
  @left_profit_formatted
end

#left_revenue ⇒ Object

revenue (left/default side)



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

def left_revenue
  @left_revenue
end

#left_revenue_formatted ⇒ Object

revenue formatted (left/default side)



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

def left_revenue_formatted
  @left_revenue_formatted
end

#left_send_count ⇒ Object

send count (left side)



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

def left_send_count
  @left_send_count
end

#left_send_count_formatted ⇒ Object

send count formatted (left side)



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

def left_send_count_formatted
  @left_send_count_formatted
end

#left_skipped_count ⇒ Object

conversion count (left side)



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

def left_skipped_count
  @left_skipped_count
end

#left_skipped_count_formatted ⇒ Object

skipped count formatted (left side)



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

def left_skipped_count_formatted
  @left_skipped_count_formatted
end

#left_unsubscribe_count ⇒ Object

unsubscribe count (left side)



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

def left_unsubscribe_count
  @left_unsubscribe_count
end

#left_unsubscribe_count_formatted ⇒ Object

unsubscribe count formatted (left side)



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

def left_unsubscribe_count_formatted
  @left_unsubscribe_count_formatted
end

#right_conversion_count ⇒ Object

conversion count (right side)



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

def right_conversion_count
  @right_conversion_count
end

#right_conversion_count_formatted ⇒ Object

conversion count formatted (right side)



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

def right_conversion_count_formatted
  @right_conversion_count_formatted
end

#right_customer_count ⇒ Object

customer count (right side)



84
85
86
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 84

def right_customer_count
  @right_customer_count
end

#right_customer_count_formatted ⇒ Object

customer count formatted (right side)



87
88
89
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 87

def right_customer_count_formatted
  @right_customer_count_formatted
end

#right_order_count ⇒ Object

order count (right side)



90
91
92
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 90

def right_order_count
  @right_order_count
end

#right_order_count_formatted ⇒ Object

order count formatted (right side)



93
94
95
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 93

def right_order_count_formatted
  @right_order_count_formatted
end

#right_profit ⇒ Object

profit (right side)



96
97
98
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 96

def right_profit
  @right_profit
end

#right_profit_formatted ⇒ Object

profit formatted (right side)



99
100
101
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 99

def right_profit_formatted
  @right_profit_formatted
end

#right_revenue ⇒ Object

revenue (right side)



102
103
104
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 102

def right_revenue
  @right_revenue
end

#right_revenue_formatted ⇒ Object

revenue formatted (right side)



105
106
107
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 105

def right_revenue_formatted
  @right_revenue_formatted
end

Class Method Details

.attribute_map ⇒ Object

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



108
109
110
111
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
138
139
140
141
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 108

def self.attribute_map
  {
    :'left_click_count' => :'left_click_count',
    :'left_click_count_formatted' => :'left_click_count_formatted',
    :'left_conversion_count' => :'left_conversion_count',
    :'left_conversion_count_formatted' => :'left_conversion_count_formatted',
    :'left_customer_count' => :'left_customer_count',
    :'left_customer_count_formatted' => :'left_customer_count_formatted',
    :'left_delivered_count' => :'left_delivered_count',
    :'left_delivered_count_formatted' => :'left_delivered_count_formatted',
    :'left_order_count' => :'left_order_count',
    :'left_order_count_formatted' => :'left_order_count_formatted',
    :'left_profit' => :'left_profit',
    :'left_profit_formatted' => :'left_profit_formatted',
    :'left_revenue' => :'left_revenue',
    :'left_revenue_formatted' => :'left_revenue_formatted',
    :'left_send_count' => :'left_send_count',
    :'left_send_count_formatted' => :'left_send_count_formatted',
    :'left_skipped_count' => :'left_skipped_count',
    :'left_skipped_count_formatted' => :'left_skipped_count_formatted',
    :'left_unsubscribe_count' => :'left_unsubscribe_count',
    :'left_unsubscribe_count_formatted' => :'left_unsubscribe_count_formatted',
    :'right_conversion_count' => :'right_conversion_count',
    :'right_conversion_count_formatted' => :'right_conversion_count_formatted',
    :'right_customer_count' => :'right_customer_count',
    :'right_customer_count_formatted' => :'right_customer_count_formatted',
    :'right_order_count' => :'right_order_count',
    :'right_order_count_formatted' => :'right_order_count_formatted',
    :'right_profit' => :'right_profit',
    :'right_profit_formatted' => :'right_profit_formatted',
    :'right_revenue' => :'right_revenue',
    :'right_revenue_formatted' => :'right_revenue_formatted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'left_click_count' => :'Integer',
    :'left_click_count_formatted' => :'String',
    :'left_conversion_count' => :'Integer',
    :'left_conversion_count_formatted' => :'String',
    :'left_customer_count' => :'Integer',
    :'left_customer_count_formatted' => :'String',
    :'left_delivered_count' => :'Integer',
    :'left_delivered_count_formatted' => :'String',
    :'left_order_count' => :'Integer',
    :'left_order_count_formatted' => :'String',
    :'left_profit' => :'Float',
    :'left_profit_formatted' => :'String',
    :'left_revenue' => :'Float',
    :'left_revenue_formatted' => :'String',
    :'left_send_count' => :'Integer',
    :'left_send_count_formatted' => :'String',
    :'left_skipped_count' => :'Integer',
    :'left_skipped_count_formatted' => :'String',
    :'left_unsubscribe_count' => :'Integer',
    :'left_unsubscribe_count_formatted' => :'String',
    :'right_conversion_count' => :'Integer',
    :'right_conversion_count_formatted' => :'String',
    :'right_customer_count' => :'Integer',
    :'right_customer_count_formatted' => :'String',
    :'right_order_count' => :'Integer',
    :'right_order_count_formatted' => :'String',
    :'right_profit' => :'Float',
    :'right_profit_formatted' => :'String',
    :'right_revenue' => :'Float',
    :'right_revenue_formatted' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
353
354
355
356
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 323

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      left_click_count == o.left_click_count &&
      left_click_count_formatted == o.left_click_count_formatted &&
      left_conversion_count == o.left_conversion_count &&
      left_conversion_count_formatted == o.left_conversion_count_formatted &&
      left_customer_count == o.left_customer_count &&
      left_customer_count_formatted == o.left_customer_count_formatted &&
      left_delivered_count == o.left_delivered_count &&
      left_delivered_count_formatted == o.left_delivered_count_formatted &&
      left_order_count == o.left_order_count &&
      left_order_count_formatted == o.left_order_count_formatted &&
      left_profit == o.left_profit &&
      left_profit_formatted == o.left_profit_formatted &&
      left_revenue == o.left_revenue &&
      left_revenue_formatted == o.left_revenue_formatted &&
      left_send_count == o.left_send_count &&
      left_send_count_formatted == o.left_send_count_formatted &&
      left_skipped_count == o.left_skipped_count &&
      left_skipped_count_formatted == o.left_skipped_count_formatted &&
      left_unsubscribe_count == o.left_unsubscribe_count &&
      left_unsubscribe_count_formatted == o.left_unsubscribe_count_formatted &&
      right_conversion_count == o.right_conversion_count &&
      right_conversion_count_formatted == o.right_conversion_count_formatted &&
      right_customer_count == o.right_customer_count &&
      right_customer_count_formatted == o.right_customer_count_formatted &&
      right_order_count == o.right_order_count &&
      right_order_count_formatted == o.right_order_count_formatted &&
      right_profit == o.right_profit &&
      right_profit_formatted == o.right_profit_formatted &&
      right_revenue == o.right_revenue &&
      right_revenue_formatted == o.right_revenue_formatted
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



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 394

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



460
461
462
463
464
465
466
467
468
469
470
471
472
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 460

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



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

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


360
361
362
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 360

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



366
367
368
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 366

def hash
  [left_click_count, left_click_count_formatted, left_conversion_count, left_conversion_count_formatted, left_customer_count, left_customer_count_formatted, left_delivered_count, left_delivered_count_formatted, left_order_count, left_order_count_formatted, left_profit, left_profit_formatted, left_revenue, left_revenue_formatted, left_send_count, left_send_count_formatted, left_skipped_count, left_skipped_count_formatted, left_unsubscribe_count, left_unsubscribe_count_formatted, right_conversion_count, right_conversion_count_formatted, right_customer_count, right_customer_count_formatted, right_order_count, right_order_count_formatted, right_profit, right_profit_formatted, right_revenue, right_revenue_formatted].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



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

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



440
441
442
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 440

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



446
447
448
449
450
451
452
453
454
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 446

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



434
435
436
 
# File 'lib/ultracart_api/models/email_step_stat.rb', line 434

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



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

def valid?
  true
end