class SunshineConversationsClient::Content

Attributes

actions[RW]

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

alt_text[RW]

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

block_chat_input[RW]

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

coordinates[RW]
display_settings[RW]
fields[RW]

Array of field objects that contain the submitted fields.

items[RW]

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

location[RW]
media_size[RW]

The size of the media.

media_type[RW]

The media type of the file.

media_url[RW]

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

template[RW]

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

text[RW]

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

text_fallback[RW]

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

type[RW]

The type of message.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/sunshine-conversations-client/models/content.rb, line 57
def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'actions' => :'actions',
    :'items' => :'items',
    :'display_settings' => :'displaySettings',
    :'media_url' => :'mediaUrl',
    :'media_size' => :'mediaSize',
    :'media_type' => :'mediaType',
    :'alt_text' => :'altText',
    :'block_chat_input' => :'blockChatInput',
    :'fields' => :'fields',
    :'text_fallback' => :'textFallback',
    :'coordinates' => :'coordinates',
    :'location' => :'location',
    :'template' => :'template'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/content.rb, line 310
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/sunshine-conversations-client/models/content.rb, line 126
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?(:'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?(:'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
openapi_discriminator_name() click to toggle source

discriminator's property name in OpenAPI v3

# File lib/sunshine-conversations-client/models/content.rb, line 120
def self.openapi_discriminator_name
  :'type'
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/sunshine-conversations-client/models/content.rb, line 99
def self.openapi_nullable
  Set.new([
  ])
end
openapi_one_of() click to toggle source

List of class defined in oneOf (OpenAPI v3)

# File lib/sunshine-conversations-client/models/content.rb, line 105
def self.openapi_one_of
  [
  :'CarouselMessage',
  :'FileMessage',
  :'FormMessage',
  :'FormResponseMessage',
  :'ImageMessage',
  :'ListMessage',
  :'LocationMessage',
  :'TemplateMessage',
  :'TextMessage'
  ]
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/sunshine-conversations-client/models/content.rb, line 78
def self.openapi_types
  {
    :'type' => :'String',
    :'text' => :'String',
    :'actions' => :'Array<ActionSubset>',
    :'items' => :'Array<Item>',
    :'display_settings' => :'CarouselMessageDisplaySettings',
    :'media_url' => :'String',
    :'media_size' => :'Float',
    :'media_type' => :'String',
    :'alt_text' => :'String',
    :'block_chat_input' => :'Boolean',
    :'fields' => :'Array<Field>',
    :'text_fallback' => :'String',
    :'coordinates' => :'LocationMessageCoordinates',
    :'location' => :'LocationMessageLocation',
    :'template' => :'Object'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/content.rb, line 275
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      actions == o.actions &&
      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 &&
      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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/sunshine-conversations-client/models/content.rb, line 338
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/sunshine-conversations-client/models/content.rb, line 407
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
alt_text=(alt_text) click to toggle source

Custom attribute writer method with validation @param [Object] alt_text Value to be assigned

# File lib/sunshine-conversations-client/models/content.rb, line 265
def alt_text=(alt_text)
  if !alt_text.nil? && alt_text.to_s.length > 128
    fail ArgumentError, 'invalid value for "alt_text", the character length must be smaller than or equal to 128.'
  end

  @alt_text = alt_text
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/sunshine-conversations-client/models/content.rb, line 317
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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/sunshine-conversations-client/models/content.rb, line 297
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/sunshine-conversations-client/models/content.rb, line 303
def hash
  [type, text, actions, items, display_settings, media_url, media_size, media_type, alt_text, block_chat_input, fields, text_fallback, coordinates, location, template].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/sunshine-conversations-client/models/content.rb, line 201
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 !@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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/content.rb, line 383
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/sunshine-conversations-client/models/content.rb, line 389
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/sunshine-conversations-client/models/content.rb, line 377
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/sunshine-conversations-client/models/content.rb, line 236
def valid?
  return false if @type.nil?
  return false if @items.nil?
  return false if @media_url.nil?
  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