Class: Verizon::DeviceFirmwareVersion

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

Overview

Device and firmware information.

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:, firmware_version:, status: SKIP, reason: SKIP, firmware_version_update_time: SKIP, additional_properties: nil) ⇒ DeviceFirmwareVersion

Returns a new instance of DeviceFirmwareVersion.



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

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

  @status = status unless status == SKIP
  @reason = reason unless reason == SKIP
  @device_id = device_id
  @firmware_version = firmware_version
  unless firmware_version_update_time == SKIP
    @firmware_version_update_time =
      firmware_version_update_time
  end
  @additional_properties = additional_properties
end

Instance Attribute Details

#device_id ⇒ String

Device IMEI.

Returns:

  • (String) 


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

def device_id
  @device_id
end

#firmware_version ⇒ String

Device Firmware Version.

Returns:

  • (String) 


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

def firmware_version
  @firmware_version
end

#firmware_version_update_time ⇒ DateTime

Device Firmware Version.

Returns:

  • (DateTime) 


31
32
33
 
# File 'lib/verizon/models/device_firmware_version.rb', line 31

def firmware_version_update_time
  @firmware_version_update_time
end

#reason ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def reason
  @reason
end

#status ⇒ String

TODO: Write general description for this method

Returns:

  • (String) 


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

def status
  @status
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/verizon/models/device_firmware_version.rb', line 76

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  device_id = hash.key?('deviceId') ? hash['deviceId'] : nil
  firmware_version =
    hash.key?('firmwareVersion') ? hash['firmwareVersion'] : nil
  status = hash.key?('status') ? hash['status'] : SKIP
  reason = hash.key?('reason') ? hash['reason'] : SKIP
  firmware_version_update_time = if hash.key?('firmwareVersionUpdateTime')
                                   (DateTimeHelper.from_rfc3339(hash['firmwareVersionUpdateTime']) if hash['firmwareVersionUpdateTime'])
                                 else
                                   SKIP
                                 end

  # 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.
  DeviceFirmwareVersion.new(device_id: device_id,
                            firmware_version: firmware_version,
                            status: status,
                            reason: reason,
                            firmware_version_update_time: firmware_version_update_time,
                            additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['status'] = 'status'
  @_hash['reason'] = 'reason'
  @_hash['device_id'] = 'deviceId'
  @_hash['firmware_version'] = 'firmwareVersion'
  @_hash['firmware_version_update_time'] = 'firmwareVersionUpdateTime'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



54
55
56
 
# File 'lib/verizon/models/device_firmware_version.rb', line 54

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



45
46
47
48
49
50
51
 
# File 'lib/verizon/models/device_firmware_version.rb', line 45

def self.optionals
  %w[
    status
    reason
    firmware_version_update_time
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



120
121
122
123
124
125
126
 
# File 'lib/verizon/models/device_firmware_version.rb', line 120

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

#to_custom_firmware_version_update_time ⇒ Object 



107
108
109
 
# File 'lib/verizon/models/device_firmware_version.rb', line 107

def to_custom_firmware_version_update_time
  DateTimeHelper.to_rfc3339(firmware_version_update_time)
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



112
113
114
115
116
117
 
# File 'lib/verizon/models/device_firmware_version.rb', line 112

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