class SmoochApi::MessagePost
Attributes
The actions in the message.
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.
The URL of the desired message avatar image.
Indicates if the Web SDK chat input should be blocked. Defaults to false. Only for form messages.
Data representing the location being sent in the message.
Specifies which channel to deliver a message to. See [list integrations](docs.smooch.io/rest/#list-integrations) to get integration ID and type.
Settings to adjust the carousel layout. See [Display Settings](docs.smooch.io/rest/#display-settings).
The email address of the message author.
The fields in the form. Required for form messages.
The items in the message list. Required for carousel and list messages.
Additional information about the location being sent in the message.
The mediaType for the message. Required for image/file messages.
The mediaUrl for the message. Required for image/file messages.
Flat JSON object containing any custom properties associated with the message.
The display name of the message author.
Specifies channel-specific overrides to use in order to bypass Smooch's message translation logic.
The payload of a reply action, if applicable.
The role of the individual posting the message. See [RoleEnum](Enums.md#RoleEnum) for available values.
The message text. Required for text messages.
The message type. See [MessageTypeEnum](Enums.md#MessageTypeEnum) for available values.
Public Class Methods
Attribute mapping from ruby-style variable name to JSON key.
# File lib/smooch-api/models/message_post.rb, line 80 def self.attribute_map { :'role' => :'role', :'type' => :'type', :'name' => :'name', :'email' => :'email', :'avatarUrl' => :'avatarUrl', :'metadata' => :'metadata', :'payload' => :'payload', :'text' => :'text', :'mediaUrl' => :'mediaUrl', :'mediaType' => :'mediaType', :'altText' => :'altText', :'items' => :'items', :'actions' => :'actions', :'blockChatInput' => :'blockChatInput', :'displaySettings' => :'displaySettings', :'fields' => :'fields', :'destination' => :'destination', :'override' => :'override', :'coordinates' => :'coordinates', :'location' => :'location' } end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/smooch-api/models/message_post.rb, line 133 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?(:'role') self.role = attributes[:'role'] end if attributes.has_key?(:'type') self.type = attributes[:'type'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] 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?(:'metadata') self.metadata = attributes[:'metadata'] end if attributes.has_key?(:'payload') self.payload = attributes[:'payload'] end if attributes.has_key?(:'text') self.text = attributes[:'text'] 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?(:'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?(:'blockChatInput') self.blockChatInput = attributes[:'blockChatInput'] end if attributes.has_key?(:'displaySettings') self.displaySettings = attributes[:'displaySettings'] end if attributes.has_key?(:'fields') if (value = attributes[:'fields']).is_a?(Array) self.fields = value end end if attributes.has_key?(:'destination') self.destination = attributes[:'destination'] end if attributes.has_key?(:'override') self.override = attributes[:'override'] end if attributes.has_key?(:'coordinates') self.coordinates = attributes[:'coordinates'] end if attributes.has_key?(:'location') self.location = attributes[:'location'] end end
Attribute type mapping.
# File lib/smooch-api/models/message_post.rb, line 106 def self.swagger_types { :'role' => :'String', :'type' => :'String', :'name' => :'String', :'email' => :'String', :'avatarUrl' => :'String', :'metadata' => :'Object', :'payload' => :'String', :'text' => :'String', :'mediaUrl' => :'String', :'mediaType' => :'String', :'altText' => :'String', :'items' => :'Array<MessageItem>', :'actions' => :'Array<Action>', :'blockChatInput' => :'BOOLEAN', :'displaySettings' => :'DisplaySettings', :'fields' => :'Array<FieldPost>', :'destination' => :'Destination', :'override' => :'MessageOverride', :'coordinates' => :'Coordinates', :'location' => :'Location' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/smooch-api/models/message_post.rb, line 252 def ==(o) return true if self.equal?(o) self.class == o.class && role == o.role && type == o.type && name == o.name && email == o.email && avatarUrl == o.avatarUrl && metadata == o.metadata && payload == o.payload && text == o.text && mediaUrl == o.mediaUrl && mediaType == o.mediaType && altText == o.altText && items == o.items && actions == o.actions && blockChatInput == o.blockChatInput && displaySettings == o.displaySettings && fields == o.fields && destination == o.destination && override == o.override && coordinates == o.coordinates && location == o.location end
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_post.rb, line 313 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
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_post.rb, line 379 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
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_post.rb, line 292 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
@see the `==` method @param [Object] Object to be compared
# File lib/smooch-api/models/message_post.rb, line 279 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Fixnum] Hash code
# File lib/smooch-api/models/message_post.rb, line 285 def hash [role, type, name, email, avatarUrl, metadata, payload, text, mediaUrl, mediaType, altText, items, actions, blockChatInput, displaySettings, fields, destination, override, coordinates, location].hash end
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_post.rb, line 229 def list_invalid_properties invalid_properties = Array.new 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 return invalid_properties end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/smooch-api/models/message_post.rb, line 365 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/smooch-api/models/message_post.rb, line 353 def to_s to_hash.to_s end
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_post.rb, line 244 def valid? return false if @role.nil? return false if @type.nil? return true end