Class: UltracartClient::EmailSmsStat

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailSmsStat

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 192

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::EmailSmsStat` 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::EmailSmsStat`. 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?(:'click_count')
    self.click_count = attributes[:'click_count']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#click_count ⇒ Object

Count of clicked emails



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

def click_count
  @click_count
end

#click_count_formatted ⇒ Object

Count of clicked emails, formatted



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

def click_count_formatted
  @click_count_formatted
end

#conversion_count ⇒ Object

Count of conversions



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

def conversion_count
  @conversion_count
end

#conversion_count_formatted ⇒ Object

Count of conversions, formatted



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

def conversion_count_formatted
  @conversion_count_formatted
end

#deleted ⇒ Object

True if campaign/flow has been archived



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

def deleted
  @deleted
end

#delivered_count ⇒ Object

Count of delivered emails



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

def delivered_count
  @delivered_count
end

#delivered_count_formatted ⇒ Object

Count of delivered emails, formatted



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

def delivered_count_formatted
  @delivered_count_formatted
end

#merchant_id ⇒ Object

Merchant ID



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

def merchant_id
  @merchant_id
end

#name ⇒ Object

List or segment name



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

def name
  @name
end

#order_count ⇒ Object

Count of orders



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

def order_count
  @order_count
end

#order_count_formatted ⇒ Object

Count of orders, formatted



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

def order_count_formatted
  @order_count_formatted
end

#profit ⇒ Object

Profit



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

def profit
  @profit
end

#profit_formatted ⇒ Object

Profit, formatted



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

def profit_formatted
  @profit_formatted
end

#revenue ⇒ Object

Revenue



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

def revenue
  @revenue
end

#revenue_formatted ⇒ Object

Revenue, formatted



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

def revenue_formatted
  @revenue_formatted
end

#send_count ⇒ Object

Count of emails sent



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

def send_count
  @send_count
end

#send_count_formatted ⇒ Object

Count of emails sent, formatted



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

def send_count_formatted
  @send_count_formatted
end

#skipped_count ⇒ Object

Count of skipped emails



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

def skipped_count
  @skipped_count
end

#skipped_count_formatted ⇒ Object

Count of skipped emails, formatted



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

def skipped_count_formatted
  @skipped_count_formatted
end

#stat_type ⇒ Object

Campaign, Flow or None (for anything else)



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

def stat_type
  @stat_type
end

#status ⇒ Object

Status of campaign or flow



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

def status
  @status
end

#status_dts ⇒ Object

Status dts of campaign or flow



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

def status_dts
  @status_dts
end

#step_uuid ⇒ Object

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



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

def step_uuid
  @step_uuid
end

#steps ⇒ Object

Returns the value of attribute steps.



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

def steps
  @steps
end

#storefront_oid ⇒ Object

Storefront oid



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

def storefront_oid
  @storefront_oid
end

#unsubscribe_count ⇒ Object

Count of emails classified as unsubscribe



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

def unsubscribe_count
  @unsubscribe_count
end

#unsubscribe_count_formatted ⇒ Object

Count of emails classified as unsubscribe, formatted



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

def unsubscribe_count_formatted
  @unsubscribe_count_formatted
end

#uuid ⇒ Object

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



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

def uuid
  @uuid
end

#view_count ⇒ Object

Count of views



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

def view_count
  @view_count
end

#view_count_formatted ⇒ Object

Count of views, formatted



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

def view_count_formatted
  @view_count_formatted
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



144
145
146
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 144

def self.acceptable_attributes
  attribute_map.values
end

.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_sms_stat.rb', line 108

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',
    :'merchant_id' => :'merchant_id',
    :'name' => :'name',
    :'order_count' => :'order_count',
    :'order_count_formatted' => :'order_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',
    :'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

.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



393
394
395
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 393

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



185
186
187
188
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 185

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'click_count' => :'Integer',
    :'click_count_formatted' => :'String',
    :'conversion_count' => :'Integer',
    :'conversion_count_formatted' => :'String',
    :'deleted' => :'Boolean',
    :'delivered_count' => :'Integer',
    :'delivered_count_formatted' => :'String',
    :'merchant_id' => :'String',
    :'name' => :'String',
    :'order_count' => :'Integer',
    :'order_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',
    :'stat_type' => :'String',
    :'status' => :'String',
    :'status_dts' => :'String',
    :'step_uuid' => :'String',
    :'steps' => :'Array<EmailSmsStat>',
    :'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



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

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 &&
      merchant_id == o.merchant_id &&
      name == o.name &&
      order_count == o.order_count &&
      order_count_formatted == o.order_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 &&
      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



424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 424

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



495
496
497
498
499
500
501
502
503
504
505
506
507
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 495

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



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 400

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


380
381
382
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 380

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



386
387
388
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 386

def hash
  [click_count, click_count_formatted, conversion_count, conversion_count_formatted, deleted, delivered_count, delivered_count_formatted, merchant_id, name, order_count, order_count_formatted, profit, profit_formatted, revenue, revenue_formatted, send_count, send_count_formatted, skipped_count, skipped_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_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



330
331
332
333
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 330

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



471
472
473
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 471

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



477
478
479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 477

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



465
466
467
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 465

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



337
338
339
 
# File 'lib/ultracart_api/models/email_sms_stat.rb', line 337

def valid?
  true
end