Class: Verizon::SMSNumber

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/sms_number.rb

Overview

Notification SMS details.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(carrier = SKIP, number = SKIP) ⇒ SMSNumber

Returns a new instance of SMSNumber.



41
42
43
44
 
# File 'lib/verizon/models/sms_number.rb', line 41

def initialize(carrier = SKIP, number = SKIP)
  @carrier = carrier unless carrier == SKIP
  @number = number unless number == SKIP
end

Instance Attribute Details

#carrier ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/sms_number.rb', line 14

def carrier
  @carrier
end

#number ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


18
19
20
 
# File 'lib/verizon/models/sms_number.rb', line 18

def number
  @number
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/verizon/models/sms_number.rb', line 47

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  carrier = hash.key?('carrier') ? hash['carrier'] : SKIP
  number = hash.key?('number') ? hash['number'] : SKIP

  # Create object from extracted values.
  SMSNumber.new(carrier,
                number)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/verizon/models/sms_number.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['carrier'] = 'carrier'
  @_hash['number'] = 'number'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/verizon/models/sms_number.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/verizon/models/sms_number.rb', line 29

def self.optionals
  %w[
    carrier
    number
  ]
end