class SmoochApi::Message

Attributes

actions[RW]

The actions in the message.

altText[RW]

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.

authorId[RW]

The ID of the message's author.

avatarUrl[RW]

The URL of the desired message avatar image.

blockChatInput[RW]

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

coordinates[RW]

Data representing the location being sent in the message.

displaySettings[RW]

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

email[RW]

The email address of the message author.

fields[RW]

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

id[RW]

The message ID, generated automatically.

items[RW]

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

location[RW]

Additional information about the location being sent in the message.

mediaType[RW]

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

mediaUrl[RW]

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

metadata[RW]

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

name[RW]

The display name of the message author.

payload[RW]

The payload of a reply action, if applicable.

quotedMessage[RW]

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

received[RW]

The unix timestamp of the moment the message was received.

role[RW]

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

source[RW]

The source of the message.

submitted[RW]

Indicates if the form was submitted. Generated automatically.

text[RW]

The message text. Required for text messages.

textFallback[RW]

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

type[RW]

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

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.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
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.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
swagger_types() click to toggle source

Attribute type mapping.

# 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

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.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) 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.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) 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.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) 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.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) click to toggle source

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

# File lib/smooch-api/models/message.rb, line 359
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.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() 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.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() 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.rb, line 439
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.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() click to toggle source

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

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