Class: Verizon::V2DeviceStatus

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

Overview

Device with id in IMEI.

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(device_id:, status:, result_reason: SKIP, additional_properties: nil) ⇒ V2DeviceStatus

Returns a new instance of V2DeviceStatus.



45
46
47
48
49
50
51
52
53
54
 
# File 'lib/verizon/models/v2_device_status.rb', line 45

def initialize(device_id:, status:, result_reason: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @device_id = device_id
  @status = status
  @result_reason = result_reason unless result_reason == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#device_id ⇒ String

Device IMEI.

Returns:

  • (String) 


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

def device_id
  @device_id
end

#result_reason ⇒ String

Result reason.

Returns:

  • (String) 


22
23
24
 
# File 'lib/verizon/models/v2_device_status.rb', line 22

def result_reason
  @result_reason
end

#status ⇒ String

Success or failure.

Returns:

  • (String) 


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

def status
  @status
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
72
73
74
75
76
77
 
# File 'lib/verizon/models/v2_device_status.rb', line 57

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  device_id = hash.key?('deviceId') ? hash['deviceId'] : nil
  status = hash.key?('status') ? hash['status'] : nil
  result_reason = hash.key?('resultReason') ? hash['resultReason'] : 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.
  V2DeviceStatus.new(device_id: device_id,
                     status: status,
                     result_reason: result_reason,
                     additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['device_id'] = 'deviceId'
  @_hash['status'] = 'status'
  @_hash['result_reason'] = 'resultReason'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
 
# File 'lib/verizon/models/v2_device_status.rb', line 41

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/verizon/models/v2_device_status.rb', line 34

def self.optionals
  %w[
    result_reason
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



87
88
89
90
91
92
 
# File 'lib/verizon/models/v2_device_status.rb', line 87

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



80
81
82
83
84
 
# File 'lib/verizon/models/v2_device_status.rb', line 80

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