Class: Verizon::DeviceListResult

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

Overview

Device list information.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(account_name = nil, device_count = nil, device_list = nil) ⇒ DeviceListResult

Returns a new instance of DeviceListResult.



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

def initialize( = nil, device_count = nil, device_list = nil)
  @account_name = 
  @device_count = device_count
  @device_list = device_list
end

Instance Attribute Details

#account_name ⇒ String

Account name.

Returns:

  • (String) 


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

def 
  @account_name
end

#device_count ⇒ Integer

Total device count.

Returns:

  • (Integer) 


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

def device_count
  @device_count
end

#device_list ⇒ Array[V3Device]

List of devices with id in IMEI.

Returns:



22
23
24
 
# File 'lib/verizon/models/device_list_result.rb', line 22

def device_list
  @device_list
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/verizon/models/device_list_result.rb', line 50

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('accountName') ? hash['accountName'] : nil
  device_count = hash.key?('deviceCount') ? hash['deviceCount'] : nil
  # Parameter is an array, so we need to iterate through it
  device_list = nil
  unless hash['deviceList'].nil?
    device_list = []
    hash['deviceList'].each do |structure|
      device_list << (V3Device.from_hash(structure) if structure)
    end
  end

  device_list = nil unless hash.key?('deviceList')

  # Create object from extracted values.
  DeviceListResult.new(,
                       device_count,
                       device_list)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/verizon/models/device_list_result.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['device_count'] = 'deviceCount'
  @_hash['device_list'] = 'deviceList'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
 
# File 'lib/verizon/models/device_list_result.rb', line 34

def self.optionals
  []
end