class SmoochApi::MessageItem

Attributes

actions[RW]

Array of [action buttons](docs.smooch.io/rest/#action-buttons). At least 1 is required, a maximum of 3 are allowed.

altText[RW]

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

description[RW]

The text description, or subtitle.

mediaType[RW]

If a mediaUrl was specified, the media type is defined here, for example image/jpeg.

mediaUrl[RW]

The image URL to be shown in the carousel/list item.

size[RW]

The size of the image to be shown in the carousel/list item. Only top item of Facebook Messenger carousel supported. See [MessageItemSizeEnum](Enums.md#MessageItemSizeEnum) for available values.

title[RW]

The title of the message item.

Public Class Methods

attribute_map() click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 41
def self.attribute_map
  {
    :'title' => :'title',
    :'description' => :'description',
    :'mediaUrl' => :'mediaUrl',
    :'altText' => :'altText',
    :'size' => :'size',
    :'mediaType' => :'mediaType',
    :'actions' => :'actions'
  }
end
new(attributes = {}) click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 68
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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

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

end
swagger_types() click to toggle source

Attribute type mapping.

# File lib/smooch-api/models/message_item.rb, line 54
def self.swagger_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'mediaUrl' => :'String',
    :'altText' => :'String',
    :'size' => :'String',
    :'mediaType' => :'String',
    :'actions' => :'Array<Action>'
  }
end

Public Instance Methods

==(o) click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 131
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      description == o.description &&
      mediaUrl == o.mediaUrl &&
      altText == o.altText &&
      size == o.size &&
      mediaType == o.mediaType &&
      actions == o.actions
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/smooch-api/models/message_item.rb, line 179
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) 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/smooch-api/models/message_item.rb, line 245
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) 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/smooch-api/models/message_item.rb, line 158
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) click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 145
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 151
def hash
  [title, description, mediaUrl, altText, size, mediaType, actions].hash
end
list_invalid_properties() click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 108
def list_invalid_properties
  invalid_properties = Array.new
  if @title.nil?
    invalid_properties.push("invalid value for 'title', title cannot be nil.")
  end

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

  return 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/smooch-api/models/message_item.rb, line 225
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/smooch-api/models/message_item.rb, line 231
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() click to toggle source

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

# File lib/smooch-api/models/message_item.rb, line 219
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/smooch-api/models/message_item.rb, line 123
def valid?
  return false if @title.nil?
  return false if @actions.nil?
  return true
end