Class: Verizon::KpiInfoList

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

Overview

KpiInfoList Model.

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(kpi_info_list: SKIP, additional_properties: nil) ⇒ KpiInfoList

Returns a new instance of KpiInfoList.



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

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

  @kpi_info_list = kpi_info_list unless kpi_info_list == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#kpi_info_list ⇒ Array[KpiInfo]

TODO: Write general description for this method

Returns:



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

def kpi_info_list
  @kpi_info_list
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/verizon/models/kpi_info_list.rb', line 44

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  # Parameter is an array, so we need to iterate through it
  kpi_info_list = nil
  unless hash['KpiInfoList'].nil?
    kpi_info_list = []
    hash['KpiInfoList'].each do |structure|
      kpi_info_list << (KpiInfo.from_hash(structure) if structure)
    end
  end

  kpi_info_list = SKIP unless hash.key?('KpiInfoList')

  # 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.
  KpiInfoList.new(kpi_info_list: kpi_info_list,
                  additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



17
18
19
20
21
 
# File 'lib/verizon/models/kpi_info_list.rb', line 17

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['kpi_info_list'] = 'KpiInfoList'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    kpi_info_list
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



79
80
81
82
83
 
# File 'lib/verizon/models/kpi_info_list.rb', line 79

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



72
73
74
75
76
 
# File 'lib/verizon/models/kpi_info_list.rb', line 72

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