Class: Verizon::SuccessResponse

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

Overview

SuccessResponse 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(success: SKIP) ⇒ SuccessResponse

Returns a new instance of SuccessResponse.



35
36
37
 
# File 'lib/verizon/models/success_response.rb', line 35

def initialize(success: SKIP)
  @success = success unless success == SKIP
end

Instance Attribute Details

#success ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


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

def success
  @success
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



40
41
42
43
44
45
46
47
48
 
# File 'lib/verizon/models/success_response.rb', line 40

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  success = hash.key?('success') ? hash['success'] : SKIP

  # Create object from extracted values.
  SuccessResponse.new(success: success)
end

.names ⇒ Object

A mapping from model property names to API property names.



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

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

.nullables ⇒ Object

An array for nullable fields



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

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  %w[
    success
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



57
58
59
60
 
# File 'lib/verizon/models/success_response.rb', line 57

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



51
52
53
54
 
# File 'lib/verizon/models/success_response.rb', line 51

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