Class: BrevoRuby::Body8

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body8

Initializes the object

Parameters:

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

    Model attributes in the form of hash



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/brevo-ruby/models/body_8.rb', line 61

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

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

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

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

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

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

Instance Attribute Details

#agent_email ⇒ Object

agent email. When sending messages from a standalone system, it’s hard to maintain a 1-to-1 relationship between the users of both systems. In this case, an agent can be specified by their email address.



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

def agent_email
  @agent_email
end

#agent_id ⇒ Object

agent ID. It can be found on agent’s page or received <a href="developers.brevo.com/docs/conversations-webhooks">from a webhook</a>. Alternatively, you can use ‘agentEmail` + `agentName` + `receivedFrom` instead (all 3 fields required).



24
25
26
 
# File 'lib/brevo-ruby/models/body_8.rb', line 24

def agent_id
  @agent_id
end

#agent_name ⇒ Object

agent name



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

def agent_name
  @agent_name
end

#received_from ⇒ Object

mark your messages to distinguish messages created by you from the others.



27
28
29
 
# File 'lib/brevo-ruby/models/body_8.rb', line 27

def received_from
  @received_from
end

#text ⇒ Object

message text



21
22
23
 
# File 'lib/brevo-ruby/models/body_8.rb', line 21

def text
  @text
end

#visitor_id ⇒ Object

visitor’s ID received <a href="developers.brevo.com/docs/conversations-webhooks">from a webhook</a> or generated by you to <a href="developers.brevo.com/docs/customize-the-widget#identifying-existing-users">bind existing user account to Conversations</a>



18
19
20
 
# File 'lib/brevo-ruby/models/body_8.rb', line 18

def visitor_id
  @visitor_id
end

Class Method Details

.attribute_map ⇒ Object

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



36
37
38
39
40
41
42
43
44
45
 
# File 'lib/brevo-ruby/models/body_8.rb', line 36

def self.attribute_map
  {
    :'visitor_id' => :'visitorId',
    :'text' => :'text',
    :'agent_id' => :'agentId',
    :'received_from' => :'receivedFrom',
    :'agent_email' => :'agentEmail',
    :'agent_name' => :'agentName'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'visitor_id' => :'String',
    :'text' => :'String',
    :'agent_id' => :'String',
    :'received_from' => :'String',
    :'agent_email' => :'String',
    :'agent_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



117
118
119
120
121
122
123
124
125
126
 
# File 'lib/brevo-ruby/models/body_8.rb', line 117

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



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

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



230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/brevo-ruby/models/body_8.rb', line 230

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



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
 
# File 'lib/brevo-ruby/models/body_8.rb', line 143

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


130
131
132
 
# File 'lib/brevo-ruby/models/body_8.rb', line 130

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



136
137
138
 
# File 'lib/brevo-ruby/models/body_8.rb', line 136

def hash
  [visitor_id, text, agent_id, received_from, agent_email, agent_name].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



94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/brevo-ruby/models/body_8.rb', line 94

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

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



210
211
212
 
# File 'lib/brevo-ruby/models/body_8.rb', line 210

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



216
217
218
219
220
221
222
223
224
 
# File 'lib/brevo-ruby/models/body_8.rb', line 216

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



204
205
206
 
# File 'lib/brevo-ruby/models/body_8.rb', line 204

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



109
110
111
112
113
 
# File 'lib/brevo-ruby/models/body_8.rb', line 109

def valid?
  return false if @visitor_id.nil?
  return false if @text.nil?
  true
end