Class: FactPulse::ValidationErrorDetail

Inherits:
ApiModelBase show all
Defined in:
lib/factpulse/models/validation_error_detail.rb

Overview

Validation error detail (aligned with AFNOR AcknowledgementDetail). Unified format for all Factur-X validation errors, compatible with AFNOR XP Z12-013 standard.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ ValidationErrorDetail

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 96

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::ValidationErrorDetail` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::ValidationErrorDetail`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'level')
    self.level = attributes[:'level']
  end

  if attributes.key?(:'item')
    self.item = attributes[:'item']
  else
    self.item = nil
  end

  if attributes.key?(:'reason')
    self.reason = attributes[:'reason']
  else
    self.reason = nil
  end

  if attributes.key?(:'source')
    self.source = attributes[:'source']
  end

  if attributes.key?(:'code')
    self.code = attributes[:'code']
  end
end

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



30
31
32
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 30

def code
  @code
end

#item ⇒ Object

Identifier of the concerned element (XPath, field, BR-FR rule, etc.)



23
24
25
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 23

def item
  @item
end

#level ⇒ Object

Severity level: ‘Error’ or ‘Warning’



20
21
22
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 20

def level
  @level
end

#reason ⇒ Object

Error description



26
27
28
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 26

def reason
  @reason
end

#source ⇒ Object

Returns the value of attribute source.



28
29
30
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 28

def source
  @source
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



66
67
68
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 66

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



71
72
73
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 71

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



55
56
57
58
59
60
61
62
63
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 55

def self.attribute_map
  {
    :'level' => :'level',
    :'item' => :'item',
    :'reason' => :'reason',
    :'source' => :'source',
    :'code' => :'code'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 207

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
91
92
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 87

def self.openapi_nullable
  Set.new([
    :'source',
    :'code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 76

def self.openapi_types
  {
    :'level' => :'ErrorLevel',
    :'item' => :'String',
    :'reason' => :'String',
    :'source' => :'ErrorSource',
    :'code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



182
183
184
185
186
187
188
189
190
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 182

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      level == o.level &&
      item == o.item &&
      reason == o.reason &&
      source == o.source &&
      code == o.code
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 200

def hash
  [level, item, reason, source, code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 137

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @item.nil?
    invalid_properties.push('invalid value for "item", item cannot be nil.')
  end

  if @reason.nil?
    invalid_properties.push('invalid value for "reason", reason cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 229

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



153
154
155
156
157
158
 
# File 'lib/factpulse/models/validation_error_detail.rb', line 153

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @item.nil?
  return false if @reason.nil?
  true
end