Class: MessenteApi::Viber
- Inherits:
-
Object
- Object
- MessenteApi::Viber
- Defined in:
- lib/messente_api/models/viber.rb
Overview
Viber message content
Defined Under Namespace
Classes: EnumAttributeValidator
Instance Attribute Summary collapse
-
#button_text ⇒ Object
Must be specified along with ”text”, ”button_url”, ”button_text”, ”image_url” (optional).
-
#button_url ⇒ Object
URL of the button, must be specified along with ”text”, ”button_text” and ”image_url” (optional).
-
#channel ⇒ Object
The channel used to deliver the message.
-
#image_url ⇒ Object
URL for the embedded image Valid combinations: 1) image_url, 2) text, image_url, button_url, button_text.
-
#sender ⇒ Object
Phone number or alphanumeric sender name.
-
#text ⇒ Object
Plaintext content for Viber.
-
#validity ⇒ Object
After how many minutes this channel is considered as failed and the next channel is attempted.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_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 ⇒ Integer
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ Viber
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 = {}) ⇒ Viber
Initializes the object
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
# File 'lib/messente_api/models/viber.rb', line 89 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `MessenteApi::Viber` 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 `MessenteApi::Viber`. 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?(:'sender') self.sender = attributes[:'sender'] end if attributes.key?(:'validity') self.validity = attributes[:'validity'] end if attributes.key?(:'text') self.text = attributes[:'text'] end if attributes.key?(:'image_url') self.image_url = attributes[:'image_url'] end if attributes.key?(:'button_url') self. = attributes[:'button_url'] end if attributes.key?(:'button_text') self. = attributes[:'button_text'] end if attributes.key?(:'channel') self.channel = attributes[:'channel'] else self.channel = 'viber' end end |
Instance Attribute Details
#button_text ⇒ Object
Must be specified along with ”text”, ”button_url”, ”button_text”, ”image_url” (optional)
34 35 36 |
# File 'lib/messente_api/models/viber.rb', line 34 def @button_text end |
#button_url ⇒ Object
URL of the button, must be specified along with ”text”, ”button_text” and ”image_url” (optional)
31 32 33 |
# File 'lib/messente_api/models/viber.rb', line 31 def @button_url end |
#channel ⇒ Object
The channel used to deliver the message
37 38 39 |
# File 'lib/messente_api/models/viber.rb', line 37 def channel @channel end |
#image_url ⇒ Object
URL for the embedded image Valid combinations: 1) image_url, 2) text, image_url, button_url, button_text
28 29 30 |
# File 'lib/messente_api/models/viber.rb', line 28 def image_url @image_url end |
#sender ⇒ Object
Phone number or alphanumeric sender name
19 20 21 |
# File 'lib/messente_api/models/viber.rb', line 19 def sender @sender end |
#text ⇒ Object
Plaintext content for Viber
25 26 27 |
# File 'lib/messente_api/models/viber.rb', line 25 def text @text end |
#validity ⇒ Object
After how many minutes this channel is considered as failed and the next channel is attempted
22 23 24 |
# File 'lib/messente_api/models/viber.rb', line 22 def validity @validity end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
62 63 64 65 66 67 68 69 70 71 72 |
# File 'lib/messente_api/models/viber.rb', line 62 def self.attribute_map { :'sender' => :'sender', :'validity' => :'validity', :'text' => :'text', :'image_url' => :'image_url', :'button_url' => :'button_url', :'button_text' => :'button_text', :'channel' => :'channel' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
187 188 189 |
# File 'lib/messente_api/models/viber.rb', line 187 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
75 76 77 78 79 80 81 82 83 84 85 |
# File 'lib/messente_api/models/viber.rb', line 75 def self.openapi_types { :'sender' => :'String', :'validity' => :'Integer', :'text' => :'String', :'image_url' => :'String', :'button_url' => :'String', :'button_text' => :'String', :'channel' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
160 161 162 163 164 165 166 167 168 169 170 |
# File 'lib/messente_api/models/viber.rb', line 160 def ==(o) return true if self.equal?(o) self.class == o.class && sender == o.sender && validity == o.validity && text == o.text && image_url == o.image_url && == o. && == o. && channel == o.channel end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 |
# File 'lib/messente_api/models/viber.rb', line 215 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 MessenteApi.const_get(type).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
280 281 282 283 284 285 286 287 288 289 290 291 292 |
# File 'lib/messente_api/models/viber.rb', line 280 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
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 |
# File 'lib/messente_api/models/viber.rb', line 194 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) ⇒ Boolean
174 175 176 |
# File 'lib/messente_api/models/viber.rb', line 174 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
180 181 182 |
# File 'lib/messente_api/models/viber.rb', line 180 def hash [sender, validity, text, image_url, , , channel].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
135 136 137 138 |
# File 'lib/messente_api/models/viber.rb', line 135 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
260 261 262 |
# File 'lib/messente_api/models/viber.rb', line 260 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
266 267 268 269 270 271 272 273 274 |
# File 'lib/messente_api/models/viber.rb', line 266 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
254 255 256 |
# File 'lib/messente_api/models/viber.rb', line 254 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
142 143 144 145 146 |
# File 'lib/messente_api/models/viber.rb', line 142 def valid? channel_validator = EnumAttributeValidator.new('String', ["viber"]) return false unless channel_validator.valid?(@channel) true end |