Class: Omnichannel::SMS
- Inherits:
-
Object
- Object
- Omnichannel::SMS
- Defined in:
- lib/omnichannel/models/sms.rb
Overview
SMS message content
Instance Attribute Summary collapse
-
#autoconvert ⇒ Object
Defines how non-GSM characters will be treated: - "on" Use replacement settings from the account’s [API Auto Replace settings page](dashboard.messente.com/api-settings/auto-replace)(default) - "full" All non GSM 03.38 characters will be replaced with suitable alternatives - "off" Message content is not modified in any way.
-
#channel ⇒ Object
Returns the value of attribute channel.
-
#sender ⇒ Object
Phone number or alphanumeric sender name.
-
#text ⇒ Object
Text content of the SMS.
-
#udh ⇒ Object
hex-encoded string containing SMS UDH.
-
#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 ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ SMS
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 = {}) ⇒ SMS
Initializes the object
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 |
# File 'lib/omnichannel/models/sms.rb', line 61 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?(:'sender') self.sender = attributes[:'sender'] end if attributes.has_key?(:'validity') self.validity = attributes[:'validity'] end if attributes.has_key?(:'text') self.text = attributes[:'text'] end if attributes.has_key?(:'autoconvert') self.autoconvert = attributes[:'autoconvert'] end if attributes.has_key?(:'udh') self.udh = attributes[:'udh'] end if attributes.has_key?(:'channel') self.channel = attributes[:'channel'] else self.channel = 'sms' end end |
Instance Attribute Details
#autoconvert ⇒ Object
Defines how non-GSM characters will be treated: - "on" Use replacement settings from the account’s [API Auto Replace settings page](dashboard.messente.com/api-settings/auto-replace)(default) - "full" All non GSM 03.38 characters will be replaced with suitable alternatives - "off" Message content is not modified in any way
28 29 30 |
# File 'lib/omnichannel/models/sms.rb', line 28 def autoconvert @autoconvert end |
#channel ⇒ Object
Returns the value of attribute channel.
33 34 35 |
# File 'lib/omnichannel/models/sms.rb', line 33 def channel @channel end |
#sender ⇒ Object
Phone number or alphanumeric sender name
19 20 21 |
# File 'lib/omnichannel/models/sms.rb', line 19 def sender @sender end |
#text ⇒ Object
Text content of the SMS
25 26 27 |
# File 'lib/omnichannel/models/sms.rb', line 25 def text @text end |
#udh ⇒ Object
hex-encoded string containing SMS UDH
31 32 33 |
# File 'lib/omnichannel/models/sms.rb', line 31 def udh @udh end |
#validity ⇒ Object
After how many minutes this channel is considered as failed and the next channel is attempted
22 23 24 |
# File 'lib/omnichannel/models/sms.rb', line 22 def validity @validity end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
36 37 38 39 40 41 42 43 44 45 |
# File 'lib/omnichannel/models/sms.rb', line 36 def self.attribute_map { :'sender' => :'sender', :'validity' => :'validity', :'text' => :'text', :'autoconvert' => :'autoconvert', :'udh' => :'udh', :'channel' => :'channel' } end |
.build_from_hash(attributes) ⇒ Object
Builds the object from hash
140 141 142 |
# File 'lib/omnichannel/models/sms.rb', line 140 def self.build_from_hash(attributes) new.build_from_hash(attributes) end |
.openapi_types ⇒ Object
Attribute type mapping.
48 49 50 51 52 53 54 55 56 57 |
# File 'lib/omnichannel/models/sms.rb', line 48 def self.openapi_types { :'sender' => :'String', :'validity' => :'Integer', :'text' => :'String', :'autoconvert' => :'Float', :'udh' => :'String', :'channel' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
114 115 116 117 118 119 120 121 122 123 |
# File 'lib/omnichannel/models/sms.rb', line 114 def ==(o) return true if self.equal?(o) self.class == o.class && sender == o.sender && validity == o.validity && text == o.text && autoconvert == o.autoconvert && udh == o.udh && channel == o.channel end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
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 197 198 199 200 201 202 203 |
# File 'lib/omnichannel/models/sms.rb', line 168 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 Omnichannel.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
233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/omnichannel/models/sms.rb', line 233 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
147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 |
# File 'lib/omnichannel/models/sms.rb', line 147 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
127 128 129 |
# File 'lib/omnichannel/models/sms.rb', line 127 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
133 134 135 |
# File 'lib/omnichannel/models/sms.rb', line 133 def hash [sender, validity, text, autoconvert, udh, channel].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
96 97 98 99 100 101 102 103 |
# File 'lib/omnichannel/models/sms.rb', line 96 def list_invalid_properties invalid_properties = Array.new if @text.nil? invalid_properties.push('invalid value for "text", text cannot be nil.') end invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
213 214 215 |
# File 'lib/omnichannel/models/sms.rb', line 213 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
219 220 221 222 223 224 225 226 227 |
# File 'lib/omnichannel/models/sms.rb', line 219 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
207 208 209 |
# File 'lib/omnichannel/models/sms.rb', line 207 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
107 108 109 110 |
# File 'lib/omnichannel/models/sms.rb', line 107 def valid? return false if @text.nil? true end |