Class: BrevoRuby::GetExtendedContactDetailsStatistics

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/get_extended_contact_details_statistics.rb

Overview

Campaign statistics of the contact

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetExtendedContactDetailsStatistics

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 76

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?(:'messagesSent')
    if (value = attributes[:'messagesSent']).is_a?(Array)
      self.messages_sent = value
    end
  end

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

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

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

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

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

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

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

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

Instance Attribute Details

#clicked ⇒ Object

Listing of the clicks generated by the contact



36
37
38
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 36

def clicked
  @clicked
end

#complaints ⇒ Object

Listing of the complaints generated by the contact



28
29
30
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 28

def complaints
  @complaints
end

#delivered ⇒ Object

Listing of the delivered campaign for the contact



42
43
44
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 42

def delivered
  @delivered
end

#hard_bounces ⇒ Object

Listing of the hardbounes generated by the contact



22
23
24
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 22

def hard_bounces
  @hard_bounces
end

#messages_sent ⇒ Object

Listing of the sent campaign for the contact



19
20
21
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 19

def messages_sent
  @messages_sent
end

#opened ⇒ Object

Listing of the openings generated by the contact



33
34
35
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 33

def opened
  @opened
end

#soft_bounces ⇒ Object

Listing of the softbounes generated by the contact



25
26
27
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 25

def soft_bounces
  @soft_bounces
end

#transac_attributes ⇒ Object

Listing of the transactional attributes for the contact



39
40
41
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 39

def transac_attributes
  @transac_attributes
end

#unsubscriptions ⇒ Object

Returns the value of attribute unsubscriptions.



30
31
32
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 30

def unsubscriptions
  @unsubscriptions
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 45

def self.attribute_map
  {
    :'messages_sent' => :'messagesSent',
    :'hard_bounces' => :'hardBounces',
    :'soft_bounces' => :'softBounces',
    :'complaints' => :'complaints',
    :'unsubscriptions' => :'unsubscriptions',
    :'opened' => :'opened',
    :'clicked' => :'clicked',
    :'transac_attributes' => :'transacAttributes',
    :'delivered' => :'delivered'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 60

def self.swagger_types
  {
    :'messages_sent' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'hard_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'soft_bounces' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'complaints' => :'Array<GetExtendedContactDetailsStatisticsMessagesSent>',
    :'unsubscriptions' => :'GetExtendedContactDetailsStatisticsUnsubscriptions',
    :'opened' => :'Array<GetExtendedContactDetailsStatisticsOpened>',
    :'clicked' => :'Array<GetExtendedContactDetailsStatisticsClicked>',
    :'transac_attributes' => :'Array<Object>',
    :'delivered' => :'Array<GetExtendedContactDetailsStatisticsDelivered>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
159
160
161
162
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      messages_sent == o.messages_sent &&
      hard_bounces == o.hard_bounces &&
      soft_bounces == o.soft_bounces &&
      complaints == o.complaints &&
      unsubscriptions == o.unsubscriptions &&
      opened == o.opened &&
      clicked == o.clicked &&
      transac_attributes == o.transac_attributes &&
      delivered == o.delivered
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



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
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 200

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 266

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 179

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


166
167
168
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 172

def hash
  [messages_sent, hard_bounces, soft_bounces, complaints, unsubscriptions, opened, clicked, transac_attributes, delivered].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



137
138
139
140
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 137

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



246
247
248
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 246

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 252

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



240
241
242
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 240

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



144
145
146
 
# File 'lib/brevo-ruby/models/get_extended_contact_details_statistics.rb', line 144

def valid?
  true
end