Class: Verizon::History

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

Overview

History data for a selected device and its attributes at a specific time.

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 = nil, attributes = SKIP) ⇒ History

Returns a new instance of History.



46
47
48
49
50
 
# File 'lib/verizon/models/history.rb', line 46

def initialize( = nil, device = nil, attributes = SKIP)
  @account_name = 
  @device = device
  @attributes = attributes unless attributes == SKIP
end

Instance Attribute Details

#account_name ⇒ String

The name of the billing account for which you want retrieve history data. An account name is usually numeric, and must include any leading zeros.

Returns:

  • (String) 


15
16
17
 
# File 'lib/verizon/models/history.rb', line 15

def 
  @account_name
end

#attributes ⇒ HistoryAttributeValue

Streaming RF parameter for which you want to retrieve history data.

Returns:



23
24
25
 
# File 'lib/verizon/models/history.rb', line 23

def attributes
  @attributes
end

#device ⇒ Device

Identifies a particular IoT device.

Returns:



19
20
21
 
# File 'lib/verizon/models/history.rb', line 19

def device
  @device
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/verizon/models/history.rb', line 53

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
   = hash.key?('accountName') ? hash['accountName'] : nil
  device = Device.from_hash(hash['device']) if hash['device']
  attributes = HistoryAttributeValue.from_hash(hash['attributes']) if hash['attributes']

  # Create object from extracted values.
  History.new(,
              device,
              attributes)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['account_name'] = 'accountName'
  @_hash['device'] = 'device'
  @_hash['attributes'] = 'attributes'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



35
36
37
38
39
 
# File 'lib/verizon/models/history.rb', line 35

def self.optionals
  %w[
    attributes
  ]
end