Class: SmoochApi::Message
- Inherits:
-
Object
- Object
- SmoochApi::Message
- Defined in:
- lib/smooch-api/models/message.rb
Instance Attribute Summary collapse
-
#actions ⇒ Object
The actions in the message.
-
#authorId ⇒ Object
The ID of the message’s author.
-
#avatarUrl ⇒ Object
The URL of the desired message avatar image.
-
#displaySettings ⇒ Object
Settings to adjust the carousel layout.
-
#email ⇒ Object
The email address of the message author.
-
#id ⇒ Object
The message ID, generated automatically.
-
#items ⇒ Object
The items in the message list.
-
#mediaType ⇒ Object
The mediaType for the message.
-
#mediaUrl ⇒ Object
The mediaUrl for the message.
-
#metadata ⇒ Object
Flat JSON object containing any custom properties associated with the message.
-
#name ⇒ Object
The display name of the message author.
-
#payload ⇒ Object
The payload of a reply action, if applicable.
-
#received ⇒ Object
The unix timestamp of the moment the message was received.
-
#role ⇒ Object
The role of the individual posting the message.
-
#source ⇒ Object
The source of the message.
-
#text ⇒ Object
The message text.
-
#type ⇒ Object
The message type.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Message
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ Message
Initializes the object
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 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 |
# File 'lib/smooch-api/models/message.rb', line 118 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. = 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?(:'metadata') self. = 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 end |
Instance Attribute Details
#actions ⇒ Object
The actions in the message.
61 62 63 |
# File 'lib/smooch-api/models/message.rb', line 61 def actions @actions end |
#authorId ⇒ Object
The ID of the message’s author.
22 23 24 |
# File 'lib/smooch-api/models/message.rb', line 22 def @authorId end |
#avatarUrl ⇒ Object
The URL of the desired message avatar image.
43 44 45 |
# File 'lib/smooch-api/models/message.rb', line 43 def avatarUrl @avatarUrl end |
#displaySettings ⇒ Object
Settings to adjust the carousel layout. See [Display Settings](docs.smooch.io/rest/#display-settings).
67 68 69 |
# File 'lib/smooch-api/models/message.rb', line 67 def displaySettings @displaySettings end |
#email ⇒ Object
The email address of the message author.
40 41 42 |
# File 'lib/smooch-api/models/message.rb', line 40 def email @email end |
#id ⇒ Object
The message ID, generated automatically.
19 20 21 |
# File 'lib/smooch-api/models/message.rb', line 19 def id @id end |
#items ⇒ Object
The items in the message list. Required for carousel and list messages.
58 59 60 |
# File 'lib/smooch-api/models/message.rb', line 58 def items @items end |
#mediaType ⇒ Object
The mediaType for the message. Required for image/file messages.
52 53 54 |
# File 'lib/smooch-api/models/message.rb', line 52 def mediaType @mediaType end |
#mediaUrl ⇒ Object
The mediaUrl for the message. Required for image/file messages.
49 50 51 |
# File 'lib/smooch-api/models/message.rb', line 49 def mediaUrl @mediaUrl end |
#metadata ⇒ Object
Flat JSON object containing any custom properties associated with the message.
55 56 57 |
# File 'lib/smooch-api/models/message.rb', line 55 def @metadata end |
#name ⇒ Object
The display name of the message author.
34 35 36 |
# File 'lib/smooch-api/models/message.rb', line 34 def name @name end |
#payload ⇒ Object
The payload of a reply action, if applicable.
64 65 66 |
# File 'lib/smooch-api/models/message.rb', line 64 def payload @payload end |
#received ⇒ Object
The unix timestamp of the moment the message was received.
46 47 48 |
# File 'lib/smooch-api/models/message.rb', line 46 def received @received end |
#role ⇒ Object
The role of the individual posting the message. Can be either appUser or appMaker.
25 26 27 |
# File 'lib/smooch-api/models/message.rb', line 25 def role @role end |
#source ⇒ Object
The source of the message.
31 32 33 |
# File 'lib/smooch-api/models/message.rb', line 31 def source @source end |
#text ⇒ Object
The message text. Required for text messages.
37 38 39 |
# File 'lib/smooch-api/models/message.rb', line 37 def text @text end |
#type ⇒ Object
The message type.
28 29 30 |
# File 'lib/smooch-api/models/message.rb', line 28 def type @type end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
# File 'lib/smooch-api/models/message.rb', line 71 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', :'metadata' => :'metadata', :'items' => :'items', :'actions' => :'actions', :'payload' => :'payload', :'displaySettings' => :'displaySettings' } end |
.swagger_types ⇒ Object
Attribute type mapping.
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 |
# File 'lib/smooch-api/models/message.rb', line 94 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', :'metadata' => :'Object', :'items' => :'Array<MessageItem>', :'actions' => :'Array<Action>', :'payload' => :'String', :'displaySettings' => :'DisplaySettings' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 |
# File 'lib/smooch-api/models/message.rb', line 253 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && == o. && 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 && == o. && items == o.items && actions == o.actions && payload == o.payload && displaySettings == o.displaySettings end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/smooch-api/models/message.rb', line 311 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) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
377 378 379 380 381 382 383 384 385 386 387 388 389 |
# File 'lib/smooch-api/models/message.rb', line 377 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
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 |
# File 'lib/smooch-api/models/message.rb', line 290 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) ⇒ Boolean
277 278 279 |
# File 'lib/smooch-api/models/message.rb', line 277 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
283 284 285 |
# File 'lib/smooch-api/models/message.rb', line 283 def hash [id, , role, type, source, name, text, email, avatarUrl, received, mediaUrl, mediaType, , items, actions, payload, displaySettings].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
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 225 226 227 228 229 230 231 232 233 234 235 |
# File 'lib/smooch-api/models/message.rb', line 200 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 ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
357 358 359 |
# File 'lib/smooch-api/models/message.rb', line 357 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
363 364 365 366 367 368 369 370 371 |
# File 'lib/smooch-api/models/message.rb', line 363 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 ⇒ String
Returns the string representation of the object
351 352 353 |
# File 'lib/smooch-api/models/message.rb', line 351 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
239 240 241 242 243 244 245 246 247 248 249 |
# File 'lib/smooch-api/models/message.rb', line 239 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 |