Class: Verizon::AggregateUsage

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

Overview

AggregateUsage Model.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(device_id = SKIP, account_name = SKIP, earliest = SKIP, latest = SKIP) ⇒ AggregateUsage

Returns a new instance of AggregateUsage.



54
55
56
57
58
59
60
 
# File 'lib/verizon/models/aggregate_usage.rb', line 54

def initialize(device_id = SKIP,  = SKIP, earliest = SKIP,
               latest = SKIP)
  @device_id = device_id unless device_id == SKIP
  @account_name =  unless  == SKIP
  @earliest = earliest unless earliest == SKIP
  @latest = latest unless latest == SKIP
end

Instance Attribute Details

#account_name ⇒ String

The numeric name of the account, in the format “0000123456-00001”. Leading zeros must be included.

Returns:

  • (String) 


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

def 
  @account_name
end

#device_id ⇒ GIODeviceId

TODO: Write general description for this method

Returns:



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

def device_id
  @device_id
end

#earliest ⇒ String

The start date of the time period queried as “$datetime”

Returns:

  • (String) 


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

def earliest
  @earliest
end

#latest ⇒ String

The end date of the time period being queried as “$datetime”

Returns:

  • (String) 


27
28
29
 
# File 'lib/verizon/models/aggregate_usage.rb', line 27

def latest
  @latest
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/verizon/models/aggregate_usage.rb', line 63

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  device_id = GIODeviceId.from_hash(hash['deviceId']) if hash['deviceId']
   = hash.key?('accountName') ? hash['accountName'] : SKIP
  earliest = hash.key?('earliest') ? hash['earliest'] : SKIP
  latest = hash.key?('latest') ? hash['latest'] : SKIP

  # Create object from extracted values.
  AggregateUsage.new(device_id,
                     ,
                     earliest,
                     latest)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['device_id'] = 'deviceId'
  @_hash['account_name'] = 'accountName'
  @_hash['earliest'] = 'earliest'
  @_hash['latest'] = 'latest'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



50
51
52
 
# File 'lib/verizon/models/aggregate_usage.rb', line 50

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



40
41
42
43
44
45
46
47
 
# File 'lib/verizon/models/aggregate_usage.rb', line 40

def self.optionals
  %w[
    device_id
    account_name
    earliest
    latest
  ]
end