Class: FactPulse::APIError

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

Overview

Erreur API standardisée (alignée sur AFNOR Error schema). Format unifié pour toutes les réponses d’erreur HTTP.

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 = {}) ⇒ APIError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/factpulse/models/api_error.rb', line 64

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::APIError` 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::APIError`. 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?(:'error_code')
    self.error_code = attributes[:'error_code']
  else
    self.error_code = nil
  end

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

  if attributes.key?(:'details')
    if (value = attributes[:'details']).is_a?(Array)
      self.details = value
    end
  end
end

Instance Attribute Details

#details ⇒ Object

Returns the value of attribute details.



25
26
27
 
# File 'lib/factpulse/models/api_error.rb', line 25

def details
  @details
end

#error_code ⇒ Object

Code alphanumérique identifiant précisément l’erreur



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

def error_code
  @error_code
end

#error_message ⇒ Object

Message décrivant l’erreur (non destiné à l’utilisateur final)



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

def error_message
  @error_message
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



37
38
39
 
# File 'lib/factpulse/models/api_error.rb', line 37

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/factpulse/models/api_error.rb', line 42

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/factpulse/models/api_error.rb', line 28

def self.attribute_map
  {
    :'error_code' => :'errorCode',
    :'error_message' => :'errorMessage',
    :'details' => :'details'
  }
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



167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/factpulse/models/api_error.rb', line 167

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



56
57
58
59
60
 
# File 'lib/factpulse/models/api_error.rb', line 56

def self.openapi_nullable
  Set.new([
    :'details'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
 
# File 'lib/factpulse/models/api_error.rb', line 47

def self.openapi_types
  {
    :'error_code' => :'String',
    :'error_message' => :'String',
    :'details' => :'Array<ValidationErrorDetail>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



144
145
146
147
148
149
150
 
# File 'lib/factpulse/models/api_error.rb', line 144

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_code == o.error_code &&
      error_message == o.error_message &&
      details == o.details
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


154
155
156
 
# File 'lib/factpulse/models/api_error.rb', line 154

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



160
161
162
 
# File 'lib/factpulse/models/api_error.rb', line 160

def hash
  [error_code, error_message, details].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



99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/factpulse/models/api_error.rb', line 99

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

  if @error_message.nil?
    invalid_properties.push('invalid value for "error_message", error_message 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



189
190
191
192
193
194
195
196
197
198
199
200
201
 
# File 'lib/factpulse/models/api_error.rb', line 189

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



115
116
117
118
119
120
 
# File 'lib/factpulse/models/api_error.rb', line 115

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