Class: SunshineConversationsClient::Content

Inherits:
Object
  • Object
show all
Defined in:
lib/sunshine-conversations-client/models/content.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Content

Initializes the object

Parameters:

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

    Model attributes in the form of hash



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
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
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 141

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SunshineConversationsClient::Content` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SunshineConversationsClient::Content`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'type')
    self.type = attributes[:'type']
  else
    self.type = 'template'
  end

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

  if attributes.key?(:'actions')
  end

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

  if attributes.key?(:'items')
  end

  if attributes.key?(:'display_settings')
    self.display_settings = attributes[:'display_settings']
  end

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

  if attributes.key?(:'media_size')
    self.media_size = attributes[:'media_size']
  end

  if attributes.key?(:'media_type')
    self.media_type = attributes[:'media_type']
  end

  if attributes.key?(:'alt_text')
    self.alt_text = attributes[:'alt_text']
  end

  if attributes.key?(:'attachment_id')
    self.attachment_id = attributes[:'attachment_id']
  end

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

  if attributes.key?(:'block_chat_input')
    self.block_chat_input = attributes[:'block_chat_input']
  end

  if attributes.key?(:'fields')
  end

  if attributes.key?(:'text_fallback')
    self.text_fallback = attributes[:'text_fallback']
  end

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

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

  if attributes.key?(:'template')
    self.template = attributes[:'template']
  end
end

Instance Attribute Details

#actions ⇒ Object

An array of objects representing the actions associated with the message. The array length is limited by the third party channel.



21
22
23
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 21

def actions
  @actions
end

#alt_text ⇒ Object

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



41
42
43
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 41

def alt_text
  @alt_text
end

#attachment_id ⇒ Object

An identifier used by Sunshine Conversations for internal purposes.



44
45
46
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 44

def attachment_id
  @attachment_id
end

#block_chat_input ⇒ Object

true if the message should block the chat input on Web Messenger.



50
51
52
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 50

def block_chat_input
  @block_chat_input
end

#coordinates ⇒ Object

Returns the value of attribute coordinates.



58
59
60
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 58

def coordinates
  @coordinates
end

#display_settings ⇒ Object

Returns the value of attribute display_settings.



29
30
31
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 29

def display_settings
  @display_settings
end

#fields ⇒ Object

Array of field objects that contain the submitted fields.



53
54
55
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 53

def fields
  @fields
end

#items ⇒ Object

An array of objects representing the items associated with the message. Only present in carousel and list type messages.



27
28
29
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 27

def items
  @items
end

#location ⇒ Object

Returns the value of attribute location.



60
61
62
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 60

def location
  @location
end

#media_size ⇒ Object

The size of the media in bytes.



35
36
37
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 35

def media_size
  @media_size
end

#media_type ⇒ Object

The type of media.



38
39
40
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 38

def media_type
  @media_type
end

#media_url ⇒ Object

The URL for media, such as an image, attached to the message.



32
33
34
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 32

def media_url
  @media_url
end

#payload ⇒ Object

The payload of a [reply button](docs.smooch.io/guide/structured-messages/#reply-buttons) response message.



24
25
26
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 24

def payload
  @payload
end

#submitted ⇒ Object

Flag which states whether the form is submitted.



47
48
49
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 47

def submitted
  @submitted
end

#template ⇒ Object

The whatsapp template message to send. For more information, consult the [guide](docs.smooch.io/guide/whatsapp#sending-message-templates). ‘schema` must be set to `whatsapp`.



63
64
65
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 63

def template
  @template
end

#text ⇒ Object

The fallback text message used when location messages are not supported by the channel.



18
19
20
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 18

def text
  @text
end

#text_fallback ⇒ Object

A string containing the ‘label: value` of all fields, each separated by a newline character.



56
57
58
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 56

def text_fallback
  @text_fallback
end

#type ⇒ Object

The type of message.



15
16
17
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 15

def type
  @type
end

Class Method Details

.attribute_map ⇒ Object

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



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 66

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'actions' => :'actions',
    :'payload' => :'payload',
    :'items' => :'items',
    :'display_settings' => :'displaySettings',
    :'media_url' => :'mediaUrl',
    :'media_size' => :'mediaSize',
    :'media_type' => :'mediaType',
    :'alt_text' => :'altText',
    :'attachment_id' => :'attachmentId',
    :'submitted' => :'submitted',
    :'block_chat_input' => :'blockChatInput',
    :'fields' => :'fields',
    :'text_fallback' => :'textFallback',
    :'coordinates' => :'coordinates',
    :'location' => :'location',
    :'template' => :'template'
  }
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



355
356
357
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 355

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



135
136
137
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 135

def self.openapi_discriminator_name
  :'type'
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



114
115
116
117
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 114

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_one_of ⇒ Object

List of class defined in oneOf (OpenAPI v3)



120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 120

def self.openapi_one_of
  [
  :'CarouselMessage',
  :'FileMessage',
  :'FormMessage',
  :'FormResponseMessage',
  :'ImageMessage',
  :'ListMessage',
  :'LocationMessage',
  :'TemplateMessage',
  :'TextMessage'
  ]
end

.openapi_types ⇒ Object

Attribute type mapping.



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 90

def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'actions' => :'Array<ActionSubset>',
    :'payload' => :'String',
    :'items' => :'Array<Item>',
    :'display_settings' => :'CarouselMessageDisplaySettings',
    :'media_url' => :'String',
    :'media_size' => :'Float',
    :'media_type' => :'String',
    :'alt_text' => :'String',
    :'attachment_id' => :'String',
    :'submitted' => :'Boolean',
    :'block_chat_input' => :'Boolean',
    :'fields' => :'Array<FormResponseMessageField>',
    :'text_fallback' => :'String',
    :'coordinates' => :'LocationMessageCoordinates',
    :'location' => :'LocationMessageLocation',
    :'template' => :'Object'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 317

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      actions == o.actions &&
      payload == o.payload &&
      items == o.items &&
      display_settings == o.display_settings &&
      media_url == o.media_url &&
      media_size == o.media_size &&
      media_type == o.media_type &&
      alt_text == o.alt_text &&
      attachment_id == o.attachment_id &&
      submitted == o.submitted &&
      block_chat_input == o.block_chat_input &&
      fields == o.fields &&
      text_fallback == o.text_fallback &&
      coordinates == o.coordinates &&
      location == o.location &&
      template == o.template
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



383
384
385
386
387
388
389
390
391
392
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
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 383

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
    SunshineConversationsClient.const_get(type).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



452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 452

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



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 362

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


342
343
344
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 342

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



348
349
350
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 348

def hash
  [type, text, actions, payload, items, display_settings, media_url, media_size, media_type, alt_text, attachment_id, submitted, block_chat_input, fields, text_fallback, coordinates, location, template].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



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
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 228

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

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

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

  if !@media_type.nil? && @media_type.to_s.length > 128
    invalid_properties.push('invalid value for "media_type", the character length must be smaller than or equal to 128.')
  end

  if !@alt_text.nil? && @alt_text.to_s.length > 128
    invalid_properties.push('invalid value for "alt_text", the character length must be smaller than or equal to 128.')
  end

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

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

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



428
429
430
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 428

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



434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 434

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end
    
    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



422
423
424
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 422

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



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/sunshine-conversations-client/models/content.rb', line 267

def valid?
  return false if @type.nil?
  return false if @items.nil?
  return false if @media_url.nil?
  return false if !@media_type.nil? && @media_type.to_s.length > 128
  return false if !@alt_text.nil? && @alt_text.to_s.length > 128
  return false if @fields.nil?
  return false if @coordinates.nil?
  return false if @template.nil?
  _one_of_found = false
  self.class.openapi_one_of.each do |_class|
    _one_of = SunshineConversationsClient.const_get(_class).build_from_hash(self.to_hash)
    if _one_of.valid?
      if _one_of_found
        return false
      else
        _one_of_found = true
      end
    end
  end

  if !_one_of_found
    return false
  end

  true
end