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



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
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
142
143
144
145
146
147
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 93

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?(:'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

end

Instance Attribute Details

#clickers ⇒ Object

Number of clicks for the campaign



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

def clickers
  @clickers
end

#complaints ⇒ Object

Number of complaints (Spam reports) for the campaign



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

def complaints
  @complaints
end

#deferred ⇒ Object

Number of deferred emails for the campaign



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

def deferred
  @deferred
end

#delivered ⇒ Object

Number of delivered emails for the campaign



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

def delivered
  @delivered
end

#hard_bounces ⇒ Object

Number of harbounce for the campaign



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

def hard_bounces
  @hard_bounces
end

#list_id ⇒ Object

List Id of email campaign (only in case of get email campaign(s))



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

def list_id
  @list_id
end

#sent ⇒ Object

Number of sent emails for the campaign



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

def sent
  @sent
end

#soft_bounces ⇒ Object

Number of softbounce for the campaign



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

def soft_bounces
  @soft_bounces
end

#unique_clicks ⇒ Object

Number of unique clicks for the campaign



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

def unique_clicks
  @unique_clicks
end

#unique_views ⇒ Object

Number of unique openings for the campaign



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

def unique_views
  @unique_views
end

#unsubscriptions ⇒ Object

Number of unsubscription for the campaign



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

def unsubscriptions
  @unsubscriptions
end

#viewed ⇒ Object

Number of openings for the campaign



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

def viewed
  @viewed
end

Class Method Details

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 56

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',
    :'unsubscriptions' => :'unsubscriptions',
    :'viewed' => :'viewed',
    :'deferred' => :'deferred'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 74

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',
    :'unsubscriptions' => :'Integer',
    :'viewed' => :'Integer',
    :'deferred' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 219

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 &&
      unsubscriptions == o.unsubscriptions &&
      viewed == o.viewed &&
      deferred == o.deferred
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



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

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



338
339
340
341
342
343
344
345
346
347
348
349
350
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 338

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



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

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


238
239
240
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 238

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



244
245
246
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 244

def hash
  [list_id, unique_clicks, clickers, complaints, delivered, sent, soft_bounces, hard_bounces, unique_views, unsubscriptions, viewed, deferred].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properies with the reasons



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

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 @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

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

  return 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



318
319
320
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 318

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



324
325
326
327
328
329
330
331
332
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 324

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



312
313
314
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 312

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



202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/sib-api-v3-sdk/models/get_campaign_stats.rb', line 202

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 @unsubscriptions.nil?
  return false if @viewed.nil?
  return false if @deferred.nil?
  return true
end