Class: Verizon::DtoFields

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

Overview

Fields to return needed by search

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(additional_prop1: SKIP, additional_prop2: SKIP, additional_prop3: SKIP) ⇒ DtoFields

Returns a new instance of DtoFields.



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

def initialize(additional_prop1: SKIP, additional_prop2: SKIP,
               additional_prop3: SKIP)
  @additional_prop1 = additional_prop1 unless additional_prop1 == SKIP
  @additional_prop2 = additional_prop2 unless additional_prop2 == SKIP
  @additional_prop3 = additional_prop3 unless additional_prop3 == SKIP
end

Instance Attribute Details

#additional_prop1String

TODO: Write general description for this method

Returns:

  • (String)


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

def additional_prop1
  @additional_prop1
end

#additional_prop2String

TODO: Write general description for this method

Returns:

  • (String)


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

def additional_prop2
  @additional_prop2
end

#additional_prop3String

TODO: Write general description for this method

Returns:

  • (String)


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

def additional_prop3
  @additional_prop3
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
68
69
70
# File 'lib/verizon/models/dto_fields.rb', line 55

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  additional_prop1 =
    hash.key?('additionalProp1') ? hash['additionalProp1'] : SKIP
  additional_prop2 =
    hash.key?('additionalProp2') ? hash['additionalProp2'] : SKIP
  additional_prop3 =
    hash.key?('additionalProp3') ? hash['additionalProp3'] : SKIP

  # Create object from extracted values.
  DtoFields.new(additional_prop1: additional_prop1,
                additional_prop2: additional_prop2,
                additional_prop3: additional_prop3)
end

.namesObject

A mapping from model property names to API property names.



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

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['additional_prop1'] = 'additionalProp1'
  @_hash['additional_prop2'] = 'additionalProp2'
  @_hash['additional_prop3'] = 'additionalProp3'
  @_hash
end

.nullablesObject

An array for nullable fields



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

def self.nullables
  []
end

.optionalsObject

An array for optional fields



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

def self.optionals
  %w[
    additional_prop1
    additional_prop2
    additional_prop3
  ]
end

Instance Method Details

#inspectObject

Provides a debugging-friendly string with detailed object information.



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

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

#to_sObject

Provides a human-readable string representation of the object.



73
74
75
76
77
# File 'lib/verizon/models/dto_fields.rb', line 73

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