Class: Verizon::Id

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

Overview

Id Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = SKIP, kind = SKIP) ⇒ Id

Returns a new instance of Id.



43
44
45
46
 
# File 'lib/verizon/models/id.rb', line 43

def initialize(id = SKIP, kind = SKIP)
  @id = id unless id == SKIP
  @kind = kind unless kind == SKIP
end

Instance Attribute Details

#id ⇒ String

The value of the device identifier.

Returns:

  • (String) 


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

def id
  @id
end

#kind ⇒ String

The type of the device identifier. Valid types of identifiers are:ESN (decimal),EID,ICCID (up to 20 digits),IMEI (up to 16 digits),MDN,MEID (hexadecimal),MSISDN.

Returns:

  • (String) 


20
21
22
 
# File 'lib/verizon/models/id.rb', line 20

def kind
  @kind
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/verizon/models/id.rb', line 49

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  Id.new(id,
         kind)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/verizon/models/id.rb', line 23

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

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/verizon/models/id.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
36
 
# File 'lib/verizon/models/id.rb', line 31

def self.optionals
  %w[
    id
    kind
  ]
end