Class: ApimaticApi::ApiValidationSummary

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/apimatic_api/models/api_validation_summary.rb

Overview

ApiValidationSummary 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:, errors:, warnings:, messages:, additional_properties: nil) ⇒ ApiValidationSummary

Returns a new instance of ApiValidationSummary.



48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 48

def initialize(success:, errors:, warnings:, messages:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @success = success
  @errors = errors
  @warnings = warnings
  @messages = messages
  @additional_properties = additional_properties
end

Instance Attribute Details

#errors ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


18
19
20
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 18

def errors
  @errors
end

#messages ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


26
27
28
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 26

def messages
  @messages
end

#success ⇒ TrueClass | FalseClass

TODO: Write general description for this method

Returns:

  • (TrueClass | FalseClass) 


14
15
16
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 14

def success
  @success
end

#warnings ⇒ Array[String]

TODO: Write general description for this method

Returns:

  • (Array[String]) 


22
23
24
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 22

def warnings
  @warnings
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 61

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  success = hash.key?('success') ? hash['success'] : nil
  errors = hash.key?('errors') ? hash['errors'] : nil
  warnings = hash.key?('warnings') ? hash['warnings'] : nil
  messages = hash.key?('messages') ? hash['messages'] : nil

  # 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.
  ApiValidationSummary.new(success: success,
                           errors: errors,
                           warnings: warnings,
                           messages: messages,
                           additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



29
30
31
32
33
34
35
36
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 29

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

.nullables ⇒ Object

An array for nullable fields



44
45
46
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 44

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



39
40
41
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 39

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



93
94
95
96
97
98
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 93

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



86
87
88
89
90
 
# File 'lib/apimatic_api/models/api_validation_summary.rb', line 86

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