Class: SibApiV3Sdk::GetCampaignStats

Inherits:
Object
  • Object
show all
Defined in:
lib/sib-api-v3-sdk/models/get_campaign_stats.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetCampaignStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 111

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#clickers ⇒ Object

Number of total clicks for the campaign



24
25
26
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 24

def clickers
  @clickers
end

#complaints ⇒ Object

Number of complaints (Spam reports) for the campaign



27
28
29
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 27

def complaints
  @complaints
end

#deferred ⇒ Object

Number of deferred emails for the campaign



60
61
62
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 60

def deferred
  @deferred
end

#delivered ⇒ Object

Number of delivered emails for the campaign



30
31
32
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 30

def delivered
  @delivered
end

#estimated_views ⇒ Object

Rate of recipients without any privacy protection option enabled in their email client, applied to all delivered emails



51
52
53
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 51

def estimated_views
  @estimated_views
end

#hard_bounces ⇒ Object

Number of harbounce for the campaign



39
40
41
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 39

def hard_bounces
  @hard_bounces
end

#list_id ⇒ Object

List Id of email campaign (only in case of get email campaign(s)(not for global stats))



18
19
20
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 18

def list_id
  @list_id
end

#return_bounce ⇒ Object

Total number of non-delivered campaigns for a particular campaign id.



63
64
65
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 63

def return_bounce
  @return_bounce
end

#sent ⇒ Object

Number of sent emails for the campaign



33
34
35
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 33

def sent
  @sent
end

#soft_bounces ⇒ Object

Number of softbounce for the campaign



36
37
38
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 36

def soft_bounces
  @soft_bounces
end

#trackable_views ⇒ Object

Recipients without any privacy protection option enabled in their email client



45
46
47
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 45

def trackable_views
  @trackable_views
end

#trackable_views_rate ⇒ Object

Rate of recipients without any privacy protection option enabled in their email client



48
49
50
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 48

def trackable_views_rate
  @trackable_views_rate
end

#unique_clicks ⇒ Object

Number of unique clicks for the campaign



21
22
23
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 21

def unique_clicks
  @unique_clicks
end

#unique_views ⇒ Object

Number of unique openings for the campaign



42
43
44
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 42

def unique_views
  @unique_views
end

#unsubscriptions ⇒ Object

Number of unsubscription for the campaign



54
55
56
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 54

def unsubscriptions
  @unsubscriptions
end

#viewed ⇒ Object

Number of openings for the campaign



57
58
59
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 57

def viewed
  @viewed
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 66

def self.attribute_map
  {
    :'list_id' => :'listId',
    :'unique_clicks' => :'uniqueClicks',
    :'clickers' => :'clickers',
    :'complaints' => :'complaints',
    :'delivered' => :'delivered',
    :'sent' => :'sent',
    :'soft_bounces' => :'softBounces',
    :'hard_bounces' => :'hardBounces',
    :'unique_views' => :'uniqueViews',
    :'trackable_views' => :'trackableViews',
    :'trackable_views_rate' => :'trackableViewsRate',
    :'estimated_views' => :'estimatedViews',
    :'unsubscriptions' => :'unsubscriptions',
    :'viewed' => :'viewed',
    :'deferred' => :'deferred',
    :'return_bounce' => :'returnBounce'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 88

def self.swagger_types
  {
    :'list_id' => :'Integer',
    :'unique_clicks' => :'Integer',
    :'clickers' => :'Integer',
    :'complaints' => :'Integer',
    :'delivered' => :'Integer',
    :'sent' => :'Integer',
    :'soft_bounces' => :'Integer',
    :'hard_bounces' => :'Integer',
    :'unique_views' => :'Integer',
    :'trackable_views' => :'Integer',
    :'trackable_views_rate' => :'Float',
    :'estimated_views' => :'Integer',
    :'unsubscriptions' => :'Integer',
    :'viewed' => :'Integer',
    :'deferred' => :'Integer',
    :'return_bounce' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 252

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      list_id == o.list_id &&
      unique_clicks == o.unique_clicks &&
      clickers == o.clickers &&
      complaints == o.complaints &&
      delivered == o.delivered &&
      sent == o.sent &&
      soft_bounces == o.soft_bounces &&
      hard_bounces == o.hard_bounces &&
      unique_views == o.unique_views &&
      trackable_views == o.trackable_views &&
      trackable_views_rate == o.trackable_views_rate &&
      estimated_views == o.estimated_views &&
      unsubscriptions == o.unsubscriptions &&
      viewed == o.viewed &&
      deferred == o.deferred &&
      return_bounce == o.return_bounce
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



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
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 309

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 = SibApiV3Sdk.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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 375

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



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 288

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


275
276
277
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 275

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



281
282
283
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 281

def hash
  [list_id, unique_clicks, clickers, complaints, delivered, sent, soft_bounces, hard_bounces, unique_views, trackable_views, trackable_views_rate, estimated_views, unsubscriptions, viewed, deferred, return_bounce].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



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
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 184

def list_invalid_properties
  invalid_properties = Array.new
  if @unique_clicks.nil?
    invalid_properties.push('invalid value for "unique_clicks", unique_clicks cannot be nil.')
  end

  if @clickers.nil?
    invalid_properties.push('invalid value for "clickers", clickers cannot be nil.')
  end

  if @complaints.nil?
    invalid_properties.push('invalid value for "complaints", complaints cannot be nil.')
  end

  if @delivered.nil?
    invalid_properties.push('invalid value for "delivered", delivered cannot be nil.')
  end

  if @sent.nil?
    invalid_properties.push('invalid value for "sent", sent cannot be nil.')
  end

  if @soft_bounces.nil?
    invalid_properties.push('invalid value for "soft_bounces", soft_bounces cannot be nil.')
  end

  if @hard_bounces.nil?
    invalid_properties.push('invalid value for "hard_bounces", hard_bounces cannot be nil.')
  end

  if @unique_views.nil?
    invalid_properties.push('invalid value for "unique_views", unique_views cannot be nil.')
  end

  if @trackable_views.nil?
    invalid_properties.push('invalid value for "trackable_views", trackable_views cannot be nil.')
  end

  if @unsubscriptions.nil?
    invalid_properties.push('invalid value for "unsubscriptions", unsubscriptions cannot be nil.')
  end

  if @viewed.nil?
    invalid_properties.push('invalid value for "viewed", viewed cannot be nil.')
  end

  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



355
356
357
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 355

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



361
362
363
364
365
366
367
368
369
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 361

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



349
350
351
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 349

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



235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 235

def valid?
  return false if @unique_clicks.nil?
  return false if @clickers.nil?
  return false if @complaints.nil?
  return false if @delivered.nil?
  return false if @sent.nil?
  return false if @soft_bounces.nil?
  return false if @hard_bounces.nil?
  return false if @unique_views.nil?
  return false if @trackable_views.nil?
  return false if @unsubscriptions.nil?
  return false if @viewed.nil?
  true
end