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.
-
#ttl ⇒ Object
After how many seconds this channel is considered as failed and the next channel is attempted.
-
#validity ⇒ Object
After how many minutes this channel is considered as failed and the next channel is attempted.
Class Method Summary collapse
-
._deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about.
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.build_from_hash(attributes) ⇒ Object
Builds the object from hash.
-
.openapi_nullable ⇒ Object
List of attributes with nullable: true.
-
.openapi_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_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
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 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 |
# File 'lib/messente_api/models/viber.rb', line 106 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?(:'ttl') self.ttl = attributes[:'ttl'] 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)
38 39 40 |
# File 'lib/messente_api/models/viber.rb', line 38 def @button_text end |
#button_url ⇒ Object
URL of the button, must be specified along with ”text”, ”button_text” and ”image_url” (optional)
35 36 37 |
# File 'lib/messente_api/models/viber.rb', line 35 def @button_url end |
#channel ⇒ Object
The channel used to deliver the message
41 42 43 |
# File 'lib/messente_api/models/viber.rb', line 41 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
32 33 34 |
# File 'lib/messente_api/models/viber.rb', line 32 def image_url @image_url end |
#sender ⇒ Object
Phone number or alphanumeric sender name
20 21 22 |
# File 'lib/messente_api/models/viber.rb', line 20 def sender @sender end |
#text ⇒ Object
Plaintext content for Viber
29 30 31 |
# File 'lib/messente_api/models/viber.rb', line 29 def text @text end |
#ttl ⇒ Object
After how many seconds this channel is considered as failed and the next channel is attempted. Only one of "ttl" and "validity" can be used.
26 27 28 |
# File 'lib/messente_api/models/viber.rb', line 26 def ttl @ttl end |
#validity ⇒ Object
After how many minutes this channel is considered as failed and the next channel is attempted. Only one of "ttl" and "validity" can be used.
23 24 25 |
# File 'lib/messente_api/models/viber.rb', line 23 def validity @validity end |
Class Method Details
._deserialize(type, value) ⇒ Object
Deserializes the data based on type
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 |
# File 'lib/messente_api/models/viber.rb', line 235 def self._deserialize(type, value) case type.to_sym when :Time Time.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 # models (e.g. Pet) or oneOf klass = MessenteApi.const_get(type) klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value) end end |
.acceptable_attributes ⇒ Object
Returns all the JSON keys this model knows about
80 81 82 |
# File 'lib/messente_api/models/viber.rb', line 80 def self.acceptable_attributes attribute_map.values end |
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
66 67 68 69 70 71 72 73 74 75 76 77 |
# File 'lib/messente_api/models/viber.rb', line 66 def self.attribute_map { :'sender' => :'sender', :'validity' => :'validity', :'ttl' => :'ttl', :'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
211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 |
# File 'lib/messente_api/models/viber.rb', line 211 def self.build_from_hash(attributes) return nil unless attributes.is_a?(Hash) attributes = attributes.transform_keys(&:to_sym) transformed_hash = {} openapi_types.each_pair do |key, type| if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = nil elsif 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[attribute_map[key]].is_a?(Array) transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) } end elsif !attributes[attribute_map[key]].nil? transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]]) end end new(transformed_hash) end |
.openapi_nullable ⇒ Object
List of attributes with nullable: true
99 100 101 102 |
# File 'lib/messente_api/models/viber.rb', line 99 def self.openapi_nullable Set.new([ ]) end |
.openapi_types ⇒ Object
Attribute type mapping.
85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/messente_api/models/viber.rb', line 85 def self.openapi_types { :'sender' => :'String', :'validity' => :'Integer', :'ttl' => :'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.
183 184 185 186 187 188 189 190 191 192 193 194 |
# File 'lib/messente_api/models/viber.rb', line 183 def ==(o) return true if self.equal?(o) self.class == o.class && sender == o.sender && validity == o.validity && ttl == o.ttl && text == o.text && image_url == o.image_url && == o. && == o. && channel == o.channel end |
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value
306 307 308 309 310 311 312 313 314 315 316 317 318 |
# File 'lib/messente_api/models/viber.rb', line 306 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 |
#eql?(o) ⇒ Boolean
198 199 200 |
# File 'lib/messente_api/models/viber.rb', line 198 def eql?(o) self == o end |
#hash ⇒ Integer
Calculates hash code according to all attributes.
204 205 206 |
# File 'lib/messente_api/models/viber.rb', line 204 def hash [sender, validity, ttl, text, image_url, , , channel].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
156 157 158 159 160 |
# File 'lib/messente_api/models/viber.rb', line 156 def list_invalid_properties warn '[DEPRECATED] the `list_invalid_properties` method is obsolete' invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
282 283 284 |
# File 'lib/messente_api/models/viber.rb', line 282 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
288 289 290 291 292 293 294 295 296 297 298 299 300 |
# File 'lib/messente_api/models/viber.rb', line 288 def to_hash hash = {} self.class.attribute_map.each_pair do |attr, param| value = self.send(attr) if value.nil? is_nullable = self.class.openapi_nullable.include?(attr) next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}")) end hash[param] = _to_hash(value) end hash end |
#to_s ⇒ String
Returns the string representation of the object
276 277 278 |
# File 'lib/messente_api/models/viber.rb', line 276 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
164 165 166 167 168 169 |
# File 'lib/messente_api/models/viber.rb', line 164 def valid? warn '[DEPRECATED] the `valid?` method is obsolete' channel_validator = EnumAttributeValidator.new('String', ["viber"]) return false unless channel_validator.valid?(@channel) true end |