Class: UltracartClient::EmailStat

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailStat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
307
308
309
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
347
348
349
350
351
352
353
354
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
# File 'lib/ultracart_api/models/email_stat.rb', line 220

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#click_countObject

Count of clicked emails



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

def click_count
  @click_count
end

#click_count_formattedObject

Count of clicked emails, formatted



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

def click_count_formatted
  @click_count_formatted
end

#conversion_countObject

Count of conversions



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

def conversion_count
  @conversion_count
end

#conversion_count_formattedObject

Count of conversions, formatted



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

def conversion_count_formatted
  @conversion_count_formatted
end

#deletedObject

True if campaign/flow has been archived



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

def deleted
  @deleted
end

#delivered_countObject

Count of delivered emails



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

def delivered_count
  @delivered_count
end

#delivered_count_formattedObject

Count of delivered emails, formatted



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

def delivered_count_formatted
  @delivered_count_formatted
end

#kickbox_countObject

Count of emails kicked



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

def kickbox_count
  @kickbox_count
end

#kickbox_count_formattedObject

Count of emails kicked, formatted



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

def kickbox_count_formatted
  @kickbox_count_formatted
end

#merchant_idObject

Merchant ID



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

def merchant_id
  @merchant_id
end

#nameObject

List or segment name



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

def name
  @name
end

#open_countObject

Count of opened emails



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

def open_count
  @open_count
end

#open_count_formattedObject

Count of opened emails, formatted



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

def open_count_formatted
  @open_count_formatted
end

#order_countObject

Count of orders



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

def order_count
  @order_count
end

#order_count_formattedObject

Count of orders, formatted



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

def order_count_formatted
  @order_count_formatted
end

#permanent_bounce_countObject

Count of emails permanently bounced



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

def permanent_bounce_count
  @permanent_bounce_count
end

#permanent_bounce_count_formattedObject

Count of emails permanently bounced, formatted



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

def permanent_bounce_count_formatted
  @permanent_bounce_count_formatted
end

#profitObject

Profit



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

def profit
  @profit
end

#profit_formattedObject

Profit, formatted



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

def profit_formatted
  @profit_formatted
end

#revenueObject

Revenue



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

def revenue
  @revenue
end

#revenue_formattedObject

Revenue, formatted



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

def revenue_formatted
  @revenue_formatted
end

#send_countObject

Count of emails sent



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

def send_count
  @send_count
end

#send_count_formattedObject

Count of emails sent, formatted



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

def send_count_formatted
  @send_count_formatted
end

#skipped_countObject

Count of skipped emails



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

def skipped_count
  @skipped_count
end

#skipped_count_formattedObject

Count of skipped emails, formatted



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

def skipped_count_formatted
  @skipped_count_formatted
end

#spam_countObject

Count of emails classified as spam



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

def spam_count
  @spam_count
end

#spam_count_formattedObject

Count of emails classified as spam, formatted



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

def spam_count_formatted
  @spam_count_formatted
end

#stat_typeObject

Campaign, Flow or None (for anything else)



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

def stat_type
  @stat_type
end

#statusObject

Status of campaign or flow



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

def status
  @status
end

#status_dtsObject

Status dts of campaign or flow



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

def status_dts
  @status_dts
end

#step_uuidObject

Step UUID if the statistics are at the step/email level



108
109
110
# File 'lib/ultracart_api/models/email_stat.rb', line 108

def step_uuid
  @step_uuid
end

#stepsObject

Returns the value of attribute steps.



110
111
112
# File 'lib/ultracart_api/models/email_stat.rb', line 110

def steps
  @steps
end

#storefront_oidObject

Storefront oid



113
114
115
# File 'lib/ultracart_api/models/email_stat.rb', line 113

def storefront_oid
  @storefront_oid
end

#unsubscribe_countObject

Count of emails classified as unsubscribe



116
117
118
# File 'lib/ultracart_api/models/email_stat.rb', line 116

def unsubscribe_count
  @unsubscribe_count
end

#unsubscribe_count_formattedObject

Count of emails classified as unsubscribe, formatted



119
120
121
# File 'lib/ultracart_api/models/email_stat.rb', line 119

def unsubscribe_count_formatted
  @unsubscribe_count_formatted
end

#uuidObject

List/Segment uuid, or Flow/Campaign uuid depending on level of stat aggregation.



122
123
124
# File 'lib/ultracart_api/models/email_stat.rb', line 122

def uuid
  @uuid
end

#view_countObject

Count of views



125
126
127
# File 'lib/ultracart_api/models/email_stat.rb', line 125

def view_count
  @view_count
end

#view_count_formattedObject

Count of views, formatted



128
129
130
# File 'lib/ultracart_api/models/email_stat.rb', line 128

def view_count_formatted
  @view_count_formatted
end

Class Method Details

.attribute_mapObject

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



131
132
133
134
135
136
137
138
139
140
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
# File 'lib/ultracart_api/models/email_stat.rb', line 131

def self.attribute_map
  {
    :'click_count' => :'click_count',
    :'click_count_formatted' => :'click_count_formatted',
    :'conversion_count' => :'conversion_count',
    :'conversion_count_formatted' => :'conversion_count_formatted',
    :'deleted' => :'deleted',
    :'delivered_count' => :'delivered_count',
    :'delivered_count_formatted' => :'delivered_count_formatted',
    :'kickbox_count' => :'kickbox_count',
    :'kickbox_count_formatted' => :'kickbox_count_formatted',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'open_count' => :'open_count',
    :'open_count_formatted' => :'open_count_formatted',
    :'order_count' => :'order_count',
    :'order_count_formatted' => :'order_count_formatted',
    :'permanent_bounce_count' => :'permanent_bounce_count',
    :'permanent_bounce_count_formatted' => :'permanent_bounce_count_formatted',
    :'profit' => :'profit',
    :'profit_formatted' => :'profit_formatted',
    :'revenue' => :'revenue',
    :'revenue_formatted' => :'revenue_formatted',
    :'send_count' => :'send_count',
    :'send_count_formatted' => :'send_count_formatted',
    :'skipped_count' => :'skipped_count',
    :'skipped_count_formatted' => :'skipped_count_formatted',
    :'spam_count' => :'spam_count',
    :'spam_count_formatted' => :'spam_count_formatted',
    :'stat_type' => :'stat_type',
    :'status' => :'status',
    :'status_dts' => :'status_dts',
    :'step_uuid' => :'step_uuid',
    :'steps' => :'steps',
    :'storefront_oid' => :'storefront_oid',
    :'unsubscribe_count' => :'unsubscribe_count',
    :'unsubscribe_count_formatted' => :'unsubscribe_count_formatted',
    :'uuid' => :'uuid',
    :'view_count' => :'view_count',
    :'view_count_formatted' => :'view_count_formatted'
  }
end

.swagger_typesObject

Attribute type mapping.



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

def self.swagger_types
  {
    :'click_count' => :'Integer',
    :'click_count_formatted' => :'String',
    :'conversion_count' => :'Integer',
    :'conversion_count_formatted' => :'String',
    :'deleted' => :'BOOLEAN',
    :'delivered_count' => :'Integer',
    :'delivered_count_formatted' => :'String',
    :'kickbox_count' => :'Integer',
    :'kickbox_count_formatted' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'open_count' => :'Integer',
    :'open_count_formatted' => :'String',
    :'order_count' => :'Integer',
    :'order_count_formatted' => :'String',
    :'permanent_bounce_count' => :'Integer',
    :'permanent_bounce_count_formatted' => :'String',
    :'profit' => :'Float',
    :'profit_formatted' => :'String',
    :'revenue' => :'Float',
    :'revenue_formatted' => :'String',
    :'send_count' => :'Integer',
    :'send_count_formatted' => :'String',
    :'skipped_count' => :'Integer',
    :'skipped_count_formatted' => :'String',
    :'spam_count' => :'Integer',
    :'spam_count_formatted' => :'String',
    :'stat_type' => :'String',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'step_uuid' => :'String',
    :'steps' => :'Array<EmailStat>',
    :'storefront_oid' => :'Integer',
    :'unsubscribe_count' => :'Integer',
    :'unsubscribe_count_formatted' => :'String',
    :'uuid' => :'String',
    :'view_count' => :'Integer',
    :'view_count_formatted' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



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
431
432
433
434
435
436
437
# File 'lib/ultracart_api/models/email_stat.rb', line 396

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      click_count == o.click_count &&
      click_count_formatted == o.click_count_formatted &&
      conversion_count == o.conversion_count &&
      conversion_count_formatted == o.conversion_count_formatted &&
      deleted == o.deleted &&
      delivered_count == o.delivered_count &&
      delivered_count_formatted == o.delivered_count_formatted &&
      kickbox_count == o.kickbox_count &&
      kickbox_count_formatted == o.kickbox_count_formatted &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      open_count == o.open_count &&
      open_count_formatted == o.open_count_formatted &&
      order_count == o.order_count &&
      order_count_formatted == o.order_count_formatted &&
      permanent_bounce_count == o.permanent_bounce_count &&
      permanent_bounce_count_formatted == o.permanent_bounce_count_formatted &&
      profit == o.profit &&
      profit_formatted == o.profit_formatted &&
      revenue == o.revenue &&
      revenue_formatted == o.revenue_formatted &&
      send_count == o.send_count &&
      send_count_formatted == o.send_count_formatted &&
      skipped_count == o.skipped_count &&
      skipped_count_formatted == o.skipped_count_formatted &&
      spam_count == o.spam_count &&
      spam_count_formatted == o.spam_count_formatted &&
      stat_type == o.stat_type &&
      status == o.status &&
      status_dts == o.status_dts &&
      step_uuid == o.step_uuid &&
      steps == o.steps &&
      storefront_oid == o.storefront_oid &&
      unsubscribe_count == o.unsubscribe_count &&
      unsubscribe_count_formatted == o.unsubscribe_count_formatted &&
      uuid == o.uuid &&
      view_count == o.view_count &&
      view_count_formatted == o.view_count_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



475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
# File 'lib/ultracart_api/models/email_stat.rb', line 475

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



541
542
543
544
545
546
547
548
549
550
551
552
553
# File 'lib/ultracart_api/models/email_stat.rb', line 541

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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
# File 'lib/ultracart_api/models/email_stat.rb', line 454

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


441
442
443
# File 'lib/ultracart_api/models/email_stat.rb', line 441

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



447
448
449
# File 'lib/ultracart_api/models/email_stat.rb', line 447

def hash
  [click_count, click_count_formatted, conversion_count, conversion_count_formatted, deleted, delivered_count, delivered_count_formatted, kickbox_count, kickbox_count_formatted, merchant_id, name, open_count, open_count_formatted, order_count, order_count_formatted, permanent_bounce_count, permanent_bounce_count_formatted, profit, profit_formatted, revenue, revenue_formatted, send_count, send_count_formatted, skipped_count, skipped_count_formatted, spam_count, spam_count_formatted, stat_type, status, status_dts, step_uuid, steps, storefront_oid, unsubscribe_count, unsubscribe_count_formatted, uuid, view_count, view_count_formatted].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



383
384
385
386
# File 'lib/ultracart_api/models/email_stat.rb', line 383

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



521
522
523
# File 'lib/ultracart_api/models/email_stat.rb', line 521

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



527
528
529
530
531
532
533
534
535
# File 'lib/ultracart_api/models/email_stat.rb', line 527

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



515
516
517
# File 'lib/ultracart_api/models/email_stat.rb', line 515

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



390
391
392
# File 'lib/ultracart_api/models/email_stat.rb', line 390

def valid?
  true
end