Class: ConstantContactClient::GetEmailStatsReport200ResponseResultsInnerStats

Inherits:
Object
  • Object
show all
Defined in:
lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb

Overview

Key-value pairs of campaign related statistics.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetEmailStatsReport200ResponseResultsInnerStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 139

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#em_bounces ⇒ Object

Number of unique email bounces.



20
21
22
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 20

def em_bounces
  @em_bounces
end

#em_clicks ⇒ Object

Number of unique recipients who clicked any link in the email.



23
24
25
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 23

def em_clicks
  @em_clicks
end

#em_clicks_all ⇒ Object

Total number of non-unique email clicks.



26
27
28
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 26

def em_clicks_all
  @em_clicks_all
end

#em_clicks_all_computer ⇒ Object

Number of non-unique email clicks on a standard desktop or laptop computer.



29
30
31
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 29

def em_clicks_all_computer
  @em_clicks_all_computer
end

#em_clicks_all_mobile ⇒ Object

Number of non-unique email clicks on a mobile phone or similar small mobile device (e.g. iPhone).



32
33
34
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 32

def em_clicks_all_mobile
  @em_clicks_all_mobile
end

#em_clicks_all_none ⇒ Object

Number of non-unique email clicks for which the device type was not captured. This will account for any clicks prior to when device type was collected and stored.



41
42
43
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 41

def em_clicks_all_none
  @em_clicks_all_none
end

#em_clicks_all_other ⇒ Object

Number of non-unique email clicks on an unknown device (e.g. Game Console or Wearable).



38
39
40
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 38

def em_clicks_all_other
  @em_clicks_all_other
end

#em_clicks_all_tablet ⇒ Object

Number of non-unique email clicks on a small tablet type computer (e.g. iPad).



35
36
37
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 35

def em_clicks_all_tablet
  @em_clicks_all_tablet
end

#em_forwards ⇒ Object

Number of unique recipients who forwarded the email using the forward to a friend feature (not available for all types of emails).



44
45
46
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 44

def em_forwards
  @em_forwards
end

#em_not_opened ⇒ Object

Number of unique recipients who did not open the email. This is calculated as follows: em_not_opened is equal to em_sends - em_opens - em_bounces. This value is reported as zero if the calculation results in a negative value.



47
48
49
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 47

def em_not_opened
  @em_not_opened
end

#em_opens ⇒ Object

Number of unique recipients who opened the email.



50
51
52
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 50

def em_opens
  @em_opens
end

#em_opens_all ⇒ Object

Total number of non-unique email opens.



53
54
55
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 53

def em_opens_all
  @em_opens_all
end

#em_opens_all_computer ⇒ Object

Number of non-unique email opens on a standard desktop or laptop computer.



56
57
58
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 56

def em_opens_all_computer
  @em_opens_all_computer
end

#em_opens_all_mobile ⇒ Object

Number of non-unique email opens on a mobile phone or similar small mobile device (e.g. iPhone).



59
60
61
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 59

def em_opens_all_mobile
  @em_opens_all_mobile
end

#em_opens_all_none ⇒ Object

Number of non-unique email opens for which the device type was not captured. This will account for any opens prior to when device type was collected and stored.



68
69
70
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 68

def em_opens_all_none
  @em_opens_all_none
end

#em_opens_all_other ⇒ Object

Number of non-unique email opens on an unknown device (e.g. Game Console or Wearable).



65
66
67
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 65

def em_opens_all_other
  @em_opens_all_other
end

#em_opens_all_tablet ⇒ Object

Number of non-unique email opens on a small tablet type computer (e.g. iPad).



62
63
64
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 62

def em_opens_all_tablet
  @em_opens_all_tablet
end

#em_optouts ⇒ Object

Number of unique recipients who unsubscribed due to this email.



71
72
73
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 71

def em_optouts
  @em_optouts
end

#em_sends ⇒ Object

Number of unique email sends.



74
75
76
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 74

def em_sends
  @em_sends
end

Class Method Details

._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



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
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 309

def self._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 = ConstantContactClient.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



102
103
104
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 102

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 77

def self.attribute_map
  {
    :'em_bounces' => :'em_bounces',
    :'em_clicks' => :'em_clicks',
    :'em_clicks_all' => :'em_clicks_all',
    :'em_clicks_all_computer' => :'em_clicks_all_computer',
    :'em_clicks_all_mobile' => :'em_clicks_all_mobile',
    :'em_clicks_all_tablet' => :'em_clicks_all_tablet',
    :'em_clicks_all_other' => :'em_clicks_all_other',
    :'em_clicks_all_none' => :'em_clicks_all_none',
    :'em_forwards' => :'em_forwards',
    :'em_not_opened' => :'em_not_opened',
    :'em_opens' => :'em_opens',
    :'em_opens_all' => :'em_opens_all',
    :'em_opens_all_computer' => :'em_opens_all_computer',
    :'em_opens_all_mobile' => :'em_opens_all_mobile',
    :'em_opens_all_tablet' => :'em_opens_all_tablet',
    :'em_opens_all_other' => :'em_opens_all_other',
    :'em_opens_all_none' => :'em_opens_all_none',
    :'em_optouts' => :'em_optouts',
    :'em_sends' => :'em_sends'
  }
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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 285

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



132
133
134
135
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 132

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

.openapi_types ⇒ Object

Attribute type mapping.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 107

def self.openapi_types
  {
    :'em_bounces' => :'Integer',
    :'em_clicks' => :'Integer',
    :'em_clicks_all' => :'Integer',
    :'em_clicks_all_computer' => :'Integer',
    :'em_clicks_all_mobile' => :'Integer',
    :'em_clicks_all_tablet' => :'Integer',
    :'em_clicks_all_other' => :'Integer',
    :'em_clicks_all_none' => :'Integer',
    :'em_forwards' => :'Integer',
    :'em_not_opened' => :'Integer',
    :'em_opens' => :'Integer',
    :'em_opens_all' => :'Integer',
    :'em_opens_all_computer' => :'Integer',
    :'em_opens_all_mobile' => :'Integer',
    :'em_opens_all_tablet' => :'Integer',
    :'em_opens_all_other' => :'Integer',
    :'em_opens_all_none' => :'Integer',
    :'em_optouts' => :'Integer',
    :'em_sends' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 246

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      em_bounces == o.em_bounces &&
      em_clicks == o.em_clicks &&
      em_clicks_all == o.em_clicks_all &&
      em_clicks_all_computer == o.em_clicks_all_computer &&
      em_clicks_all_mobile == o.em_clicks_all_mobile &&
      em_clicks_all_tablet == o.em_clicks_all_tablet &&
      em_clicks_all_other == o.em_clicks_all_other &&
      em_clicks_all_none == o.em_clicks_all_none &&
      em_forwards == o.em_forwards &&
      em_not_opened == o.em_not_opened &&
      em_opens == o.em_opens &&
      em_opens_all == o.em_opens_all &&
      em_opens_all_computer == o.em_opens_all_computer &&
      em_opens_all_mobile == o.em_opens_all_mobile &&
      em_opens_all_tablet == o.em_opens_all_tablet &&
      em_opens_all_other == o.em_opens_all_other &&
      em_opens_all_none == o.em_opens_all_none &&
      em_optouts == o.em_optouts &&
      em_sends == o.em_sends
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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 380

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


272
273
274
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 272

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



278
279
280
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 278

def hash
  [em_bounces, em_clicks, em_clicks_all, em_clicks_all_computer, em_clicks_all_mobile, em_clicks_all_tablet, em_clicks_all_other, em_clicks_all_none, em_forwards, em_not_opened, em_opens, em_opens_all, em_opens_all_computer, em_opens_all_mobile, em_opens_all_tablet, em_opens_all_other, em_opens_all_none, em_optouts, em_sends].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



231
232
233
234
235
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 231

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.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
371
372
373
374
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 362

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



350
351
352
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.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



239
240
241
242
 
# File 'lib/constant_contact_client/models/get_email_stats_report200_response_results_inner_stats.rb', line 239

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end