Class: Verizon::AggregateUsageError

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

Overview

Error reported by a 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, error_message = SKIP, error_response = SKIP) ⇒ AggregateUsageError

Returns a new instance of AggregateUsageError.



48
49
50
51
52
 
# File 'lib/verizon/models/aggregate_usage_error.rb', line 48

def initialize(imei = SKIP, error_message = SKIP, error_response = SKIP)
  @imei = imei unless imei == SKIP
  @error_message = error_message unless error_message == SKIP
  @error_response = error_response unless error_response == SKIP
end

Instance Attribute Details

#error_message ⇒ String

A general error message.

Returns:

  • (String) 


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

def error_message
  @error_message
end

#error_response ⇒ IErrorMessage

Error message.

Returns:



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

def error_response
  @error_response
end

#imei ⇒ String

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

Returns:

  • (String) 


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

def imei
  @imei
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/verizon/models/aggregate_usage_error.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  imei = hash.key?('imei') ? hash['imei'] : SKIP
  error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
  error_response = IErrorMessage.from_hash(hash['errorResponse']) if hash['errorResponse']

  # Create object from extracted values.
  AggregateUsageError.new(imei,
                          error_message,
                          error_response)
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_error.rb', line 26

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['imei'] = 'imei'
  @_hash['error_message'] = 'errorMessage'
  @_hash['error_response'] = 'errorResponse'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/verizon/models/aggregate_usage_error.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_error.rb', line 35

def self.optionals
  %w[
    imei
    error_message
    error_response
  ]
end