Class: Verizon::DiagnosticsCategory

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

Overview

Various types of information about the device, grouped into categories. Each category object contains the category name and a list of Extended Attribute objects as key-value pairs.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#to_hash, #to_json

Constructor Details

#initialize(category_name = SKIP, extended_attributes = SKIP) ⇒ DiagnosticsCategory

Returns a new instance of DiagnosticsCategory.



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

def initialize(category_name = SKIP, extended_attributes = SKIP)
  @category_name = category_name unless category_name == SKIP
  @extended_attributes = extended_attributes unless extended_attributes == SKIP
end

Instance Attribute Details

#category_name ⇒ String

The name of the category.

Returns:

  • (String) 


16
17
18
 
# File 'lib/verizon/models/diagnostics_category.rb', line 16

def category_name
  @category_name
end

#extended_attributes ⇒ Array[CustomFields]

A list of Extended Attribute objects as key-value pairs.

Returns:



20
21
22
 
# File 'lib/verizon/models/diagnostics_category.rb', line 20

def extended_attributes
  @extended_attributes
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/verizon/models/diagnostics_category.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  category_name = hash.key?('categoryName') ? hash['categoryName'] : SKIP
  # Parameter is an array, so we need to iterate through it
  extended_attributes = nil
  unless hash['extendedAttributes'].nil?
    extended_attributes = []
    hash['extendedAttributes'].each do |structure|
      extended_attributes << (CustomFields.from_hash(structure) if structure)
    end
  end

  extended_attributes = SKIP unless hash.key?('extendedAttributes')

  # Create object from extracted values.
  DiagnosticsCategory.new(category_name,
                          extended_attributes)
end

.names ⇒ Object

A mapping from model property names to API property names.



23
24
25
26
27
28
 
# File 'lib/verizon/models/diagnostics_category.rb', line 23

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['category_name'] = 'categoryName'
  @_hash['extended_attributes'] = 'extendedAttributes'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



39
40
41
 
# File 'lib/verizon/models/diagnostics_category.rb', line 39

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



31
32
33
34
35
36
 
# File 'lib/verizon/models/diagnostics_category.rb', line 31

def self.optionals
  %w[
    category_name
    extended_attributes
  ]
end