Class: Verizon::AggregateUsageItem

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

Overview

Contains usage information per device.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(imei = SKIP, number_of_sessions = SKIP, bytes_transferred = SKIP) ⇒ AggregateUsageItem

Returns a new instance of AggregateUsageItem.



49
50
51
52
53
54
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 49

def initialize(imei = SKIP, number_of_sessions = SKIP,
               bytes_transferred = SKIP)
  @imei = imei unless imei == SKIP
  @number_of_sessions = number_of_sessions unless number_of_sessions == SKIP
  @bytes_transferred = bytes_transferred unless bytes_transferred == SKIP
end

Instance Attribute Details

#bytes_transferred ⇒ Integer

The amount of data transferred by the device reporting usage, measured in Bytes.

Returns:

  • (Integer) 


24
25
26
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 24

def bytes_transferred
  @bytes_transferred
end

#imei ⇒ String

International Mobile Equipment Identifier. This is the ID of the device reporting usage.

Returns:

  • (String) 


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

def imei
  @imei
end

#number_of_sessions ⇒ Integer

Number of sessions established by the device reporting usage.

Returns:

  • (Integer) 


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

def number_of_sessions
  @number_of_sessions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  imei = hash.key?('imei') ? hash['imei'] : SKIP
  number_of_sessions =
    hash.key?('numberOfSessions') ? hash['numberOfSessions'] : SKIP
  bytes_transferred =
    hash.key?('bytesTransferred') ? hash['bytesTransferred'] : SKIP

  # Create object from extracted values.
  AggregateUsageItem.new(imei,
                         number_of_sessions,
                         bytes_transferred)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['imei'] = 'imei'
  @_hash['number_of_sessions'] = 'numberOfSessions'
  @_hash['bytes_transferred'] = 'bytesTransferred'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



45
46
47
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 45

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



36
37
38
39
40
41
42
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 36

def self.optionals
  %w[
    imei
    number_of_sessions
    bytes_transferred
  ]
end