Class: Verizon::DeviceId

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

Overview

An identifier for a single device.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(id = nil, kind = nil) ⇒ DeviceId

Returns a new instance of DeviceId.



40
41
42
43
 
# File 'lib/verizon/models/device_id.rb', line 40

def initialize(id = nil, kind = nil)
  @id = id
  @kind = kind
end

Instance Attribute Details

#id ⇒ String

The value of the device identifier.

Returns:

  • (String) 


14
15
16
 
# File 'lib/verizon/models/device_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/device_id.rb', line 20

def kind
  @kind
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

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

  # Create object from extracted values.
  DeviceId.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/device_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



36
37
38
 
# File 'lib/verizon/models/device_id.rb', line 36

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
 
# File 'lib/verizon/models/device_id.rb', line 31

def self.optionals
  []
end