Class: ApiReference::ValidationError

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/api_reference/models/validation_error.rb

Overview

ValidationError 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(idempotency_key:, validation_errors:, additional_properties: nil) ⇒ ValidationError

Returns a new instance of ValidationError.



39
40
41
42
43
44
45
46
47
 
# File 'lib/api_reference/models/validation_error.rb', line 39

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

  @idempotency_key = idempotency_key
  @validation_errors = validation_errors
  @additional_properties = additional_properties
end

Instance Attribute Details

#idempotency_key ⇒ String

The passed idempotency_key corresponding to the validation_errors

Returns:

  • (String) 


14
15
16
 
# File 'lib/api_reference/models/validation_error.rb', line 14

def idempotency_key
  @idempotency_key
end

#validation_errors ⇒ Array[String]

An array of strings corresponding to validation failures for this idempotency_key.

Returns:

  • (Array[String]) 


19
20
21
 
# File 'lib/api_reference/models/validation_error.rb', line 19

def validation_errors
  @validation_errors
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



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

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  idempotency_key =
    hash.key?('idempotency_key') ? hash['idempotency_key'] : nil
  validation_errors =
    hash.key?('validation_errors') ? hash['validation_errors'] : 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.
  ValidationError.new(idempotency_key: idempotency_key,
                      validation_errors: validation_errors,
                      additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/api_reference/models/validation_error.rb', line 22

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

.nullables ⇒ Object

An array for nullable fields



35
36
37
 
# File 'lib/api_reference/models/validation_error.rb', line 35

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



30
31
32
 
# File 'lib/api_reference/models/validation_error.rb', line 30

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



80
81
82
83
84
 
# File 'lib/api_reference/models/validation_error.rb', line 80

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



73
74
75
76
77
 
# File 'lib/api_reference/models/validation_error.rb', line 73

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