Class: Brevo::GetExtendedCampaignStats

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo/models/get_extended_campaign_stats.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetExtendedCampaignStats

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 69

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

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

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

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

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

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

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

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

Instance Attribute Details

#campaign_stats ⇒ Object

List-wise statistics of the campaign.



20
21
22
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 20

def campaign_stats
  @campaign_stats
end

#global_stats ⇒ Object

Returns the value of attribute global_stats.



17
18
19
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 17

def global_stats
  @global_stats
end

#links_stats ⇒ Object

Statistics about the number of clicks for the links



29
30
31
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 29

def links_stats
  @links_stats
end

#mirror_click ⇒ Object

Number of clicks on mirror link



23
24
25
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 23

def mirror_click
  @mirror_click
end

#remaining ⇒ Object

Number of remaning emails to send



26
27
28
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 26

def remaining
  @remaining
end

#stats_by_browser ⇒ Object

Statistics about the campaign on the basis of various browsers



37
38
39
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 37

def stats_by_browser
  @stats_by_browser
end

#stats_by_device ⇒ Object

Statistics about the campaign on the basis of various devices



34
35
36
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 34

def stats_by_device
  @stats_by_device
end

#stats_by_domain ⇒ Object

Returns the value of attribute stats_by_domain.



31
32
33
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 31

def stats_by_domain
  @stats_by_domain
end

Class Method Details

.attribute_map ⇒ Object

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



40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 40

def self.attribute_map
  {
    :'global_stats' => :'globalStats',
    :'campaign_stats' => :'campaignStats',
    :'mirror_click' => :'mirrorClick',
    :'remaining' => :'remaining',
    :'links_stats' => :'linksStats',
    :'stats_by_domain' => :'statsByDomain',
    :'stats_by_device' => :'statsByDevice',
    :'stats_by_browser' => :'statsByBrowser'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 54

def self.swagger_types
  {
    :'global_stats' => :'GetExtendedCampaignStatsGlobalStats',
    :'campaign_stats' => :'Array<Object>',
    :'mirror_click' => :'Integer',
    :'remaining' => :'Integer',
    :'links_stats' => :'Object',
    :'stats_by_domain' => :'GetStatsByDomain',
    :'stats_by_device' => :'GetStatsByDevice',
    :'stats_by_browser' => :'GetStatsByBrowser'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 165

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      global_stats == o.global_stats &&
      campaign_stats == o.campaign_stats &&
      mirror_click == o.mirror_click &&
      remaining == o.remaining &&
      links_stats == o.links_stats &&
      stats_by_domain == o.stats_by_domain &&
      stats_by_device == o.stats_by_device &&
      stats_by_browser == o.stats_by_browser
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



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
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 214

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



280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 280

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



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 193

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


180
181
182
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 180

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



186
187
188
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 186

def hash
  [global_stats, campaign_stats, mirror_click, remaining, links_stats, stats_by_domain, stats_by_device, stats_by_browser].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



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/brevo/models/get_extended_campaign_stats.rb', line 112

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

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

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

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

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

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

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

  if @stats_by_browser.nil?
    invalid_properties.push('invalid value for "stats_by_browser", stats_by_browser 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



260
261
262
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 260

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



266
267
268
269
270
271
272
273
274
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 266

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



254
255
256
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 254

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



151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/brevo/models/get_extended_campaign_stats.rb', line 151

def valid?
  return false if @global_stats.nil?
  return false if @campaign_stats.nil?
  return false if @mirror_click.nil?
  return false if @remaining.nil?
  return false if @links_stats.nil?
  return false if @stats_by_domain.nil?
  return false if @stats_by_device.nil?
  return false if @stats_by_browser.nil?
  true
end