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

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(imei: SKIP, number_of_sessions: SKIP, bytes_transferred: SKIP, additional_properties: nil) ⇒ AggregateUsageItem

Returns a new instance of AggregateUsageItem.



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

def initialize(imei: SKIP, number_of_sessions: SKIP,
               bytes_transferred: SKIP, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @imei = imei unless imei == SKIP
  @number_of_sessions = number_of_sessions unless number_of_sessions == SKIP
  @bytes_transferred = bytes_transferred unless bytes_transferred == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#bytes_transferred ⇒ Integer

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

Returns:

  • (Integer) 


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

def bytes_transferred
  @bytes_transferred
end

#imei ⇒ HplImei

The International Mobile Equipment Identifier of the device.

Returns:



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

def imei
  @imei
end

#number_of_sessions ⇒ Integer

Number of sessions established by the device reporting usage.

Returns:

  • (Integer) 


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

def number_of_sessions
  @number_of_sessions
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 60

def self.from_hash(hash)
  return nil unless hash

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

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

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

.names ⇒ Object

A mapping from model property names to API property names.



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

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



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

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

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



93
94
95
96
97
98
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 93

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} imei: #{@imei.inspect}, number_of_sessions: #{@number_of_sessions.inspect},"\
  " bytes_transferred: #{@bytes_transferred.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



85
86
87
88
89
90
 
# File 'lib/verizon/models/aggregate_usage_item.rb', line 85

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} imei: #{@imei}, number_of_sessions: #{@number_of_sessions},"\
  " bytes_transferred: #{@bytes_transferred}, additional_properties:"\
  " #{@additional_properties}>"
end