Class: Brevo::ConversationsMessage

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

Overview

a Conversations message

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ConversationsMessage

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
148
 
# File 'lib/brevo/models/conversations_message.rb', line 103

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#agent_id ⇒ Object

ID of the agent on whose behalf the message was sent (only in messages sent by an agent).



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

def agent_id
  @agent_id
end

#agent_name ⇒ Object

Agent’s name as displayed to the visitor. Only in the messages sent by an agent.



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

def agent_name
  @agent_name
end

#created_at ⇒ Object

Timestamp in milliseconds.



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

def created_at
  @created_at
end

#file ⇒ Object

Returns the value of attribute file.



45
46
47
 
# File 'lib/brevo/models/conversations_message.rb', line 45

def file
  @file
end

#id ⇒ Object

Message ID. It can be used for further manipulations with the message.



19
20
21
 
# File 'lib/brevo/models/conversations_message.rb', line 19

def id
  @id
end

#is_pushed ⇒ Object

‘true` for pushed messages



40
41
42
 
# File 'lib/brevo/models/conversations_message.rb', line 40

def is_pushed
  @is_pushed
end

#received_from ⇒ Object

In two-way integrations, messages sent via REST API can be marked with receivedFrom property and then filtered out when received in a webhook to avoid infinite loop.



43
44
45
 
# File 'lib/brevo/models/conversations_message.rb', line 43

def received_from
  @received_from
end

#text ⇒ Object

Message text or name of the attached file



25
26
27
 
# File 'lib/brevo/models/conversations_message.rb', line 25

def text
  @text
end

#type ⇒ Object

‘"agent"` for agents’ messages, `"visitor"` for visitors’ messages.



22
23
24
 
# File 'lib/brevo/models/conversations_message.rb', line 22

def type
  @type
end

#visitor_id ⇒ Object

visitor’s ID



28
29
30
 
# File 'lib/brevo/models/conversations_message.rb', line 28

def visitor_id
  @visitor_id
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/brevo/models/conversations_message.rb', line 70

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'text' => :'text',
    :'visitor_id' => :'visitorId',
    :'agent_id' => :'agentId',
    :'agent_name' => :'agentName',
    :'created_at' => :'createdAt',
    :'is_pushed' => :'isPushed',
    :'received_from' => :'receivedFrom',
    :'file' => :'file'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/brevo/models/conversations_message.rb', line 86

def self.swagger_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'text' => :'String',
    :'visitor_id' => :'String',
    :'agent_id' => :'String',
    :'agent_name' => :'String',
    :'created_at' => :'Integer',
    :'is_pushed' => :'BOOLEAN',
    :'received_from' => :'String',
    :'file' => :'ConversationsMessageFile'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      text == o.text &&
      visitor_id == o.visitor_id &&
      agent_id == o.agent_id &&
      agent_name == o.agent_name &&
      created_at == o.created_at &&
      is_pushed == o.is_pushed &&
      received_from == o.received_from &&
      file == o.file
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



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
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/brevo/models/conversations_message.rb', line 243

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/brevo/models/conversations_message.rb', line 309

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



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/brevo/models/conversations_message.rb', line 222

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


209
210
211
 
# File 'lib/brevo/models/conversations_message.rb', line 209

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



215
216
217
 
# File 'lib/brevo/models/conversations_message.rb', line 215

def hash
  [id, type, text, visitor_id, agent_id, agent_name, created_at, is_pushed, received_from, file].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



152
153
154
155
156
157
158
159
 
# File 'lib/brevo/models/conversations_message.rb', line 152

def list_invalid_properties
  invalid_properties = Array.new
  if !@created_at.nil? && @created_at < 0
    invalid_properties.push('invalid value for "created_at", must be greater than or equal to 0.')
  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



289
290
291
 
# File 'lib/brevo/models/conversations_message.rb', line 289

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



295
296
297
298
299
300
301
302
303
 
# File 'lib/brevo/models/conversations_message.rb', line 295

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



283
284
285
 
# File 'lib/brevo/models/conversations_message.rb', line 283

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



163
164
165
166
167
168
 
# File 'lib/brevo/models/conversations_message.rb', line 163

def valid?
  type_validator = EnumAttributeValidator.new('String', ['agent', 'visitor'])
  return false unless type_validator.valid?(@type)
  return false if !@created_at.nil? && @created_at < 0
  true
end