Class: SmoochApi::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/smooch-api/models/message.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



158
159
160
161
162
163
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
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
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
270
 
# File 'lib/smooch-api/models/message.rb', line 158

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

end

Instance Attribute Details

#actions ⇒ Object

The actions in the message.



64
65
66
 
# File 'lib/smooch-api/models/message.rb', line 64

def actions
  @actions
end

#altText ⇒ Object

An optional description of the image or the file for accessibility purposes. The field will be saved by default with the file name as the value.



55
56
57
 
# File 'lib/smooch-api/models/message.rb', line 55

def altText
  @altText
end

#authorId ⇒ Object

The ID of the message’s author.



22
23
24
 
# File 'lib/smooch-api/models/message.rb', line 22

def authorId
  @authorId
end

#avatarUrl ⇒ Object

The URL of the desired message avatar image.



43
44
45
 
# File 'lib/smooch-api/models/message.rb', line 43

def avatarUrl
  @avatarUrl
end

#blockChatInput ⇒ Object

Indicates if the Web SDK chat input should be blocked. Defaults to false. Only for form messages.



73
74
75
 
# File 'lib/smooch-api/models/message.rb', line 73

def blockChatInput
  @blockChatInput
end

#coordinates ⇒ Object

Data representing the location being sent in the message.



88
89
90
 
# File 'lib/smooch-api/models/message.rb', line 88

def coordinates
  @coordinates
end

#displaySettings ⇒ Object

Settings to adjust the carousel layout. See [Display Settings](docs.smooch.io/rest/#display-settings).



70
71
72
 
# File 'lib/smooch-api/models/message.rb', line 70

def displaySettings
  @displaySettings
end

#email ⇒ Object

The email address of the message author.



40
41
42
 
# File 'lib/smooch-api/models/message.rb', line 40

def email
  @email
end

#fields ⇒ Object

The fields in the form. Required for form and formResponse messages.



76
77
78
 
# File 'lib/smooch-api/models/message.rb', line 76

def fields
  @fields
end

#id ⇒ Object

The message ID, generated automatically.



19
20
21
 
# File 'lib/smooch-api/models/message.rb', line 19

def id
  @id
end

#items ⇒ Object

The items in the message list. Required for carousel and list messages.



61
62
63
 
# File 'lib/smooch-api/models/message.rb', line 61

def items
  @items
end

#location ⇒ Object

Additional information about the location being sent in the message.



91
92
93
 
# File 'lib/smooch-api/models/message.rb', line 91

def location
  @location
end

#mediaType ⇒ Object

The mediaType for the message. Required for image/file messages.



52
53
54
 
# File 'lib/smooch-api/models/message.rb', line 52

def mediaType
  @mediaType
end

#mediaUrl ⇒ Object

The mediaUrl for the message. Required for image/file messages.



49
50
51
 
# File 'lib/smooch-api/models/message.rb', line 49

def mediaUrl
  @mediaUrl
end

#metadata ⇒ Object

Flat JSON object containing any custom properties associated with the message.



58
59
60
 
# File 'lib/smooch-api/models/message.rb', line 58

def metadata
  @metadata
end

#name ⇒ Object

The display name of the message author.



34
35
36
 
# File 'lib/smooch-api/models/message.rb', line 34

def name
  @name
end

#payload ⇒ Object

The payload of a reply action, if applicable.



67
68
69
 
# File 'lib/smooch-api/models/message.rb', line 67

def payload
  @payload
end

#quotedMessage ⇒ Object

The form message a formResponse message responds to. Required for formResponse messages.



82
83
84
 
# File 'lib/smooch-api/models/message.rb', line 82

def quotedMessage
  @quotedMessage
end

#received ⇒ Object

The unix timestamp of the moment the message was received.



46
47
48
 
# File 'lib/smooch-api/models/message.rb', line 46

def received
  @received
end

#role ⇒ Object

The role of the individual posting the message. See [RoleEnum](Enums.md#RoleEnum) for available values.



25
26
27
 
# File 'lib/smooch-api/models/message.rb', line 25

def role
  @role
end

#source ⇒ Object

The source of the message.



31
32
33
 
# File 'lib/smooch-api/models/message.rb', line 31

def source
  @source
end

#submitted ⇒ Object

Indicates if the form was submitted. Generated automatically.



79
80
81
 
# File 'lib/smooch-api/models/message.rb', line 79

def submitted
  @submitted
end

#text ⇒ Object

The message text. Required for text messages.



37
38
39
 
# File 'lib/smooch-api/models/message.rb', line 37

def text
  @text
end

#textFallback ⇒ Object

The text fallback displayed in channels that do not support form messages. Only for formResponse messages. Generated automatically.



85
86
87
 
# File 'lib/smooch-api/models/message.rb', line 85

def textFallback
  @textFallback
end

#type ⇒ Object

The message type. See [MessageTypeEnum](Enums.md#MessageTypeEnum) for available values.



28
29
30
 
# File 'lib/smooch-api/models/message.rb', line 28

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/smooch-api/models/message.rb', line 95

def self.attribute_map
  {
    :'id' => :'_id',
    :'authorId' => :'authorId',
    :'role' => :'role',
    :'type' => :'type',
    :'source' => :'source',
    :'name' => :'name',
    :'text' => :'text',
    :'email' => :'email',
    :'avatarUrl' => :'avatarUrl',
    :'received' => :'received',
    :'mediaUrl' => :'mediaUrl',
    :'mediaType' => :'mediaType',
    :'altText' => :'altText',
    :'metadata' => :'metadata',
    :'items' => :'items',
    :'actions' => :'actions',
    :'payload' => :'payload',
    :'displaySettings' => :'displaySettings',
    :'blockChatInput' => :'blockChatInput',
    :'fields' => :'fields',
    :'submitted' => :'submitted',
    :'quotedMessage' => :'quotedMessage',
    :'textFallback' => :'textFallback',
    :'coordinates' => :'coordinates',
    :'location' => :'location'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/smooch-api/models/message.rb', line 126

def self.swagger_types
  {
    :'id' => :'String',
    :'authorId' => :'String',
    :'role' => :'String',
    :'type' => :'String',
    :'source' => :'Source',
    :'name' => :'String',
    :'text' => :'String',
    :'email' => :'String',
    :'avatarUrl' => :'String',
    :'received' => :'Float',
    :'mediaUrl' => :'String',
    :'mediaType' => :'String',
    :'altText' => :'String',
    :'metadata' => :'Object',
    :'items' => :'Array<MessageItem>',
    :'actions' => :'Array<Action>',
    :'payload' => :'String',
    :'displaySettings' => :'DisplaySettings',
    :'blockChatInput' => :'BOOLEAN',
    :'fields' => :'Array<Field>',
    :'submitted' => :'BOOLEAN',
    :'quotedMessage' => :'QuotedMessage',
    :'textFallback' => :'String',
    :'coordinates' => :'Coordinates',
    :'location' => :'Location'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/smooch-api/models/message.rb', line 327

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      authorId == o.authorId &&
      role == o.role &&
      type == o.type &&
      source == o.source &&
      name == o.name &&
      text == o.text &&
      email == o.email &&
      avatarUrl == o.avatarUrl &&
      received == o.received &&
      mediaUrl == o.mediaUrl &&
      mediaType == o.mediaType &&
      altText == o.altText &&
      metadata == o.metadata &&
      items == o.items &&
      actions == o.actions &&
      payload == o.payload &&
      displaySettings == o.displaySettings &&
      blockChatInput == o.blockChatInput &&
      fields == o.fields &&
      submitted == o.submitted &&
      quotedMessage == o.quotedMessage &&
      textFallback == o.textFallback &&
      coordinates == o.coordinates &&
      location == o.location
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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/smooch-api/models/message.rb', line 393

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



459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/smooch-api/models/message.rb', line 459

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



372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/smooch-api/models/message.rb', line 372

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 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


359
360
361
 
# File 'lib/smooch-api/models/message.rb', line 359

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



365
366
367
 
# File 'lib/smooch-api/models/message.rb', line 365

def hash
  [id, authorId, role, type, source, name, text, email, avatarUrl, received, mediaUrl, mediaType, altText, metadata, items, actions, payload, displaySettings, blockChatInput, fields, submitted, quotedMessage, textFallback, coordinates, location].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properies with the reasons



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/smooch-api/models/message.rb', line 274

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

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

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

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

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

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

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

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

  return 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



439
440
441
 
# File 'lib/smooch-api/models/message.rb', line 439

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



445
446
447
448
449
450
451
452
453
 
# File 'lib/smooch-api/models/message.rb', line 445

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



433
434
435
 
# File 'lib/smooch-api/models/message.rb', line 433

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



313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/smooch-api/models/message.rb', line 313

def valid?
  return false if @id.nil?
  return false if @authorId.nil?
  return false if @role.nil?
  return false if @type.nil?
  return false if @name.nil?
  return false if @text.nil?
  return false if @avatarUrl.nil?
  return false if @received.nil?
  return true
end