Class: UltracartClient::EmailPerformance

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EmailPerformance

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
265
266
 
# File 'lib/ultracart_api/models/email_performance.rb', line 167

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active_customers ⇒ Object

Active customers. The value will be -1 if calculation is pending.



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

def active_customers
  @active_customers
end

#actual_customers ⇒ Object

Actual customers that they have regardless of active state. The value will be -1 if calculation is pending.



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

def actual_customers
  @actual_customers
end

#bounce_count ⇒ Object

Bounce count



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

def bounce_count
  @bounce_count
end

#bounce_percentage ⇒ Object

bounce percentage rate based upon our look back window. This should be under five percent or the account will be paused for sending.



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

def bounce_percentage
  @bounce_percentage
end

#bounce_percentage_formatted ⇒ Object

bounce percentage rate (formatted) based upon our look back window. This should be under five percent or the account will be paused for sending.



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

def bounce_percentage_formatted
  @bounce_percentage_formatted
end

#customer_histogram ⇒ Object

Returns the value of attribute customer_histogram.



32
33
34
 
# File 'lib/ultracart_api/models/email_performance.rb', line 32

def customer_histogram
  @customer_histogram
end

#daily_stats ⇒ Object

Daily statistics used for charting



35
36
37
 
# File 'lib/ultracart_api/models/email_performance.rb', line 35

def daily_stats
  @daily_stats
end

#delivered_count ⇒ Object

Delivered count



38
39
40
 
# File 'lib/ultracart_api/models/email_performance.rb', line 38

def delivered_count
  @delivered_count
end

#loyalty_program_type ⇒ Object

Loyalty Program Type



41
42
43
 
# File 'lib/ultracart_api/models/email_performance.rb', line 41

def loyalty_program_type
  @loyalty_program_type
end

#max_active_customers ⇒ Object

Maximum active customers allowed under their billing plan



44
45
46
 
# File 'lib/ultracart_api/models/email_performance.rb', line 44

def max_active_customers
  @max_active_customers
end

#max_emails_per_day ⇒ Object

Max emails per day



47
48
49
 
# File 'lib/ultracart_api/models/email_performance.rb', line 47

def max_emails_per_day
  @max_emails_per_day
end

#max_emails_per_hour ⇒ Object

Max emails per hour



50
51
52
 
# File 'lib/ultracart_api/models/email_performance.rb', line 50

def max_emails_per_hour
  @max_emails_per_hour
end

#max_emails_per_month ⇒ Object

Max emails per month



53
54
55
 
# File 'lib/ultracart_api/models/email_performance.rb', line 53

def max_emails_per_month
  @max_emails_per_month
end

#paused_for_spam ⇒ Object

True if campaign/flow emails are paused due to spam complaints.



56
57
58
 
# File 'lib/ultracart_api/models/email_performance.rb', line 56

def paused_for_spam
  @paused_for_spam
end

#revenue ⇒ Object

Revenue



59
60
61
 
# File 'lib/ultracart_api/models/email_performance.rb', line 59

def revenue
  @revenue
end

#sent_emails_per_day ⇒ Object

Sent emails last 24 hours



62
63
64
 
# File 'lib/ultracart_api/models/email_performance.rb', line 62

def sent_emails_per_day
  @sent_emails_per_day
end

#sent_emails_per_hour ⇒ Object

Sent emails last hour



65
66
67
 
# File 'lib/ultracart_api/models/email_performance.rb', line 65

def sent_emails_per_hour
  @sent_emails_per_hour
end

#sent_emails_per_month ⇒ Object

Sent emails last 31 days



68
69
70
 
# File 'lib/ultracart_api/models/email_performance.rb', line 68

def sent_emails_per_month
  @sent_emails_per_month
end

#sequence_send_count ⇒ Object

Total sequence (campaign/flow) emails sent



71
72
73
 
# File 'lib/ultracart_api/models/email_performance.rb', line 71

def sequence_send_count
  @sequence_send_count
end

#spam_count ⇒ Object

Spam complaints



74
75
76
 
# File 'lib/ultracart_api/models/email_performance.rb', line 74

def spam_count
  @spam_count
end

#spam_percentage ⇒ Object

Spam percentage rate based upon our look back window. This should be under one half a percent or the account will be paused for sending.



77
78
79
 
# File 'lib/ultracart_api/models/email_performance.rb', line 77

def spam_percentage
  @spam_percentage
end

#spam_percentage_formatted ⇒ Object

Spam percentage rate (formatted) based upon our look back window. This should be under one half a percent or the account will be paused for sending.



80
81
82
 
# File 'lib/ultracart_api/models/email_performance.rb', line 80

def spam_percentage_formatted
  @spam_percentage_formatted
end

#transactional_send_count ⇒ Object

Total transactions emails sent



83
84
85
 
# File 'lib/ultracart_api/models/email_performance.rb', line 83

def transactional_send_count
  @transactional_send_count
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
 
# File 'lib/ultracart_api/models/email_performance.rb', line 108

def self.attribute_map
  {
    :'active_customers' => :'active_customers',
    :'actual_customers' => :'actual_customers',
    :'bounce_count' => :'bounce_count',
    :'bounce_percentage' => :'bounce_percentage',
    :'bounce_percentage_formatted' => :'bounce_percentage_formatted',
    :'customer_histogram' => :'customer_histogram',
    :'daily_stats' => :'daily_stats',
    :'delivered_count' => :'delivered_count',
    :'loyalty_program_type' => :'loyalty_program_type',
    :'max_active_customers' => :'max_active_customers',
    :'max_emails_per_day' => :'max_emails_per_day',
    :'max_emails_per_hour' => :'max_emails_per_hour',
    :'max_emails_per_month' => :'max_emails_per_month',
    :'paused_for_spam' => :'paused_for_spam',
    :'revenue' => :'revenue',
    :'sent_emails_per_day' => :'sent_emails_per_day',
    :'sent_emails_per_hour' => :'sent_emails_per_hour',
    :'sent_emails_per_month' => :'sent_emails_per_month',
    :'sequence_send_count' => :'sequence_send_count',
    :'spam_count' => :'spam_count',
    :'spam_percentage' => :'spam_percentage',
    :'spam_percentage_formatted' => :'spam_percentage_formatted',
    :'transactional_send_count' => :'transactional_send_count'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'active_customers' => :'Integer',
    :'actual_customers' => :'Integer',
    :'bounce_count' => :'Integer',
    :'bounce_percentage' => :'Float',
    :'bounce_percentage_formatted' => :'String',
    :'customer_histogram' => :'EmailPerformanceCustomerHistogram',
    :'daily_stats' => :'Array<EmailPerformanceDaily>',
    :'delivered_count' => :'Integer',
    :'loyalty_program_type' => :'String',
    :'max_active_customers' => :'Integer',
    :'max_emails_per_day' => :'Integer',
    :'max_emails_per_hour' => :'Integer',
    :'max_emails_per_month' => :'Integer',
    :'paused_for_spam' => :'BOOLEAN',
    :'revenue' => :'Float',
    :'sent_emails_per_day' => :'Integer',
    :'sent_emails_per_hour' => :'Integer',
    :'sent_emails_per_month' => :'Integer',
    :'sequence_send_count' => :'Integer',
    :'spam_count' => :'Integer',
    :'spam_percentage' => :'Float',
    :'spam_percentage_formatted' => :'String',
    :'transactional_send_count' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      active_customers == o.active_customers &&
      actual_customers == o.actual_customers &&
      bounce_count == o.bounce_count &&
      bounce_percentage == o.bounce_percentage &&
      bounce_percentage_formatted == o.bounce_percentage_formatted &&
      customer_histogram == o.customer_histogram &&
      daily_stats == o.daily_stats &&
      delivered_count == o.delivered_count &&
      loyalty_program_type == o.loyalty_program_type &&
      max_active_customers == o.max_active_customers &&
      max_emails_per_day == o.max_emails_per_day &&
      max_emails_per_hour == o.max_emails_per_hour &&
      max_emails_per_month == o.max_emails_per_month &&
      paused_for_spam == o.paused_for_spam &&
      revenue == o.revenue &&
      sent_emails_per_day == o.sent_emails_per_day &&
      sent_emails_per_hour == o.sent_emails_per_hour &&
      sent_emails_per_month == o.sent_emails_per_month &&
      sequence_send_count == o.sequence_send_count &&
      spam_count == o.spam_count &&
      spam_percentage == o.spam_percentage &&
      spam_percentage_formatted == o.spam_percentage_formatted &&
      transactional_send_count == o.transactional_send_count
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



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
393
394
395
 
# File 'lib/ultracart_api/models/email_performance.rb', line 359

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



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

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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/ultracart_api/models/email_performance.rb', line 338

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


325
326
327
 
# File 'lib/ultracart_api/models/email_performance.rb', line 325

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [active_customers, actual_customers, bounce_count, bounce_percentage, bounce_percentage_formatted, customer_histogram, daily_stats, delivered_count, loyalty_program_type, max_active_customers, max_emails_per_day, max_emails_per_hour, max_emails_per_month, paused_for_spam, revenue, sent_emails_per_day, sent_emails_per_hour, sent_emails_per_month, sequence_send_count, spam_count, spam_percentage, spam_percentage_formatted, transactional_send_count].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



270
271
272
273
 
# File 'lib/ultracart_api/models/email_performance.rb', line 270

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



405
406
407
 
# File 'lib/ultracart_api/models/email_performance.rb', line 405

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



411
412
413
414
415
416
417
418
419
 
# File 'lib/ultracart_api/models/email_performance.rb', line 411

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



399
400
401
 
# File 'lib/ultracart_api/models/email_performance.rb', line 399

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



277
278
279
280
281
 
# File 'lib/ultracart_api/models/email_performance.rb', line 277

def valid?
  loyalty_program_type_validator = EnumAttributeValidator.new('String', ['disabled', 'points', 'cashback'])
  return false unless loyalty_program_type_validator.valid?(@loyalty_program_type)
  true
end