Class: MessenteApi::SMS

Inherits:
Object
  • Object
show all
Defined in:
lib/messente_api/models/sms.rb

Overview

SMS message content

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SMS

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



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
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/messente_api/models/sms.rb', line 101

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `MessenteApi::SMS` 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::SMS`. 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?(:'text')
    self.text = attributes[:'text']
  else
    self.text = nil
  end

  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?(:'autoconvert')
    self.autoconvert = attributes[:'autoconvert']
  end

  if attributes.key?(:'udh')
    self.udh = attributes[:'udh']
  end

  if attributes.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



32
33
34
 
# File 'lib/messente_api/models/sms.rb', line 32

def autoconvert
  @autoconvert
end

#channel ⇒ Object

The channel used to deliver the message



38
39
40
 
# File 'lib/messente_api/models/sms.rb', line 38

def channel
  @channel
end

#sender ⇒ Object

Phone number or alphanumeric sender name



23
24
25
 
# File 'lib/messente_api/models/sms.rb', line 23

def sender
  @sender
end

#text ⇒ Object

Text content of the SMS



20
21
22
 
# File 'lib/messente_api/models/sms.rb', line 20

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.



29
30
31
 
# File 'lib/messente_api/models/sms.rb', line 29

def ttl
  @ttl
end

#udh ⇒ Object

hex-encoded string containing SMS UDH



35
36
37
 
# File 'lib/messente_api/models/sms.rb', line 35

def udh
  @udh
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.



26
27
28
 
# File 'lib/messente_api/models/sms.rb', line 26

def validity
  @validity
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
273
274
275
276
277
278
279
280
281
 
# File 'lib/messente_api/models/sms.rb', line 244

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



76
77
78
 
# File 'lib/messente_api/models/sms.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/messente_api/models/sms.rb', line 63

def self.attribute_map
  {
    :'text' => :'text',
    :'sender' => :'sender',
    :'validity' => :'validity',
    :'ttl' => :'ttl',
    :'autoconvert' => :'autoconvert',
    :'udh' => :'udh',
    :'channel' => :'channel'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/messente_api/models/sms.rb', line 220

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



94
95
96
97
 
# File 'lib/messente_api/models/sms.rb', line 94

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/messente_api/models/sms.rb', line 81

def self.openapi_types
  {
    :'text' => :'String',
    :'sender' => :'String',
    :'validity' => :'Integer',
    :'ttl' => :'Integer',
    :'autoconvert' => :'String',
    :'udh' => :'String',
    :'channel' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/messente_api/models/sms.rb', line 193

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      text == o.text &&
      sender == o.sender &&
      validity == o.validity &&
      ttl == o.ttl &&
      autoconvert == o.autoconvert &&
      udh == o.udh &&
      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

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/messente_api/models/sms.rb', line 315

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

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


207
208
209
 
# File 'lib/messente_api/models/sms.rb', line 207

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



213
214
215
 
# File 'lib/messente_api/models/sms.rb', line 213

def hash
  [text, sender, validity, ttl, autoconvert, udh, channel].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



149
150
151
152
153
154
155
156
157
 
# File 'lib/messente_api/models/sms.rb', line 149

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  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)

Returns:

  • (Hash) —

    Returns the object in the form of hash



291
292
293
 
# File 'lib/messente_api/models/sms.rb', line 291

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



297
298
299
300
301
302
303
304
305
306
307
308
309
 
# File 'lib/messente_api/models/sms.rb', line 297

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

Returns:

  • (String) —

    String presentation of the object



285
286
287
 
# File 'lib/messente_api/models/sms.rb', line 285

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



161
162
163
164
165
166
167
168
169
 
# File 'lib/messente_api/models/sms.rb', line 161

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @text.nil?
  autoconvert_validator = EnumAttributeValidator.new('String', ["full", "on", "off"])
  return false unless autoconvert_validator.valid?(@autoconvert)
  channel_validator = EnumAttributeValidator.new('String', ["sms"])
  return false unless channel_validator.valid?(@channel)
  true
end