Class: Brevo::GetWhatsappEventReportEvents

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetWhatsappEventReportEvents

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
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.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?(:'contactNumber')
    self.contact_number = attributes[:'contactNumber']
  end

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

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

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

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

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

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

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

Instance Attribute Details

#body ⇒ Object

Text of the reply (will be there only in case of ‘reply` event with text)



33
34
35
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 33

def body
  @body
end

#contact_number ⇒ Object

WhatsApp Number with country code. Example, 85264318721



18
19
20
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 18

def contact_number
  @contact_number
end

#date ⇒ Object

UTC date-time on which the event has been generated



21
22
23
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 21

def date
  @date
end

#event ⇒ Object

Event which occurred



27
28
29
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 27

def event
  @event
end

#media_url ⇒ Object

Url of the media reply (will be there only in case of ‘reply` event with media)



36
37
38
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 36

def media_url
  @media_url
end

#message_id ⇒ Object

Message ID which generated the event



24
25
26
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 24

def message_id
  @message_id
end

#reason ⇒ Object

Reason for the event (will be there in case of ‘error` and `soft-bounce` events)



30
31
32
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 30

def reason
  @reason
end

#sender_number ⇒ Object

WhatsApp Number with country code. Example, 85264318721



39
40
41
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 39

def sender_number
  @sender_number
end

Class Method Details

.attribute_map ⇒ Object

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



64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 64

def self.attribute_map
  {
    :'contact_number' => :'contactNumber',
    :'date' => :'date',
    :'message_id' => :'messageId',
    :'event' => :'event',
    :'reason' => :'reason',
    :'body' => :'body',
    :'media_url' => :'mediaUrl',
    :'sender_number' => :'senderNumber'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 78

def self.swagger_types
  {
    :'contact_number' => :'String',
    :'date' => :'String',
    :'message_id' => :'String',
    :'event' => :'String',
    :'reason' => :'String',
    :'body' => :'String',
    :'media_url' => :'String',
    :'sender_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 184

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      contact_number == o.contact_number &&
      date == o.date &&
      message_id == o.message_id &&
      event == o.event &&
      reason == o.reason &&
      body == o.body &&
      media_url == o.media_url &&
      sender_number == o.sender_number
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



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 233

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



299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 299

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



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 212

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


199
200
201
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



205
206
207
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 205

def hash
  [contact_number, date, message_id, event, reason, body, media_url, sender_number].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



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 134

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

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

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

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

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



279
280
281
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 279

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



285
286
287
288
289
290
291
292
293
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 285

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



273
274
275
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 273

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



161
162
163
164
165
166
167
168
169
170
 
# File 'lib/brevo/models/get_whatsapp_event_report_events.rb', line 161

def valid?
  return false if @contact_number.nil?
  return false if @date.nil?
  return false if @message_id.nil?
  return false if @event.nil?
  event_validator = EnumAttributeValidator.new('String', ['sent', 'delivered', 'read', 'error', 'unsubscribe', 'reply', 'soft-bounce'])
  return false unless event_validator.valid?(@event)
  return false if @sender_number.nil?
  true
end