Class: Shipeasy::Admin::Generated::Error

Inherits:
ApiModelBase show all
Defined in:
lib/shipeasy_admin/models/error.rb

Overview

Uniform error envelope returned by every admin endpoint on a non-2xx status. error is the human-readable message; code is the stable machine code (present whenever the failure maps to a catalogued ErrorCode); detail carries extra context (validation paths, conflicting field); fields maps each failing input field to its own message; instructions is optional actionable guidance for resolving the error; schema echoes back the expected JSON Schema when a value failed schema validation.

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/shipeasy_admin/models/error.rb', line 100

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Returns the value of attribute code.



22
23
24
 
# File 'lib/shipeasy_admin/models/error.rb', line 22

def code
  @code
end

#detail ⇒ Object

Extra context (validation details, conflicting field, referenced row).



25
26
27
 
# File 'lib/shipeasy_admin/models/error.rb', line 25

def detail
  @detail
end

#error ⇒ Object

Human-readable error message.



20
21
22
 
# File 'lib/shipeasy_admin/models/error.rb', line 20

def error
  @error
end

#fields ⇒ Object

Per-field validation messages, keyed by the submitted field's path (dot-notation for nested fields, e.g. groups.0.weight). Present when structural validation failed on one or more specific input fields, so a client form can attach each message to its own input instead of collapsing everything into one banner.



28
29
30
 
# File 'lib/shipeasy_admin/models/error.rb', line 28

def fields
  @fields
end

#instructions ⇒ Object

Actionable guidance for resolving this error — what to check or change next.



31
32
33
 
# File 'lib/shipeasy_admin/models/error.rb', line 31

def instructions
  @instructions
end

#schema ⇒ Object

The expected JSON Schema (draft 2020-12) the submitted value must satisfy. Returned only when a value failed schema validation (e.g. a config value that does not match its config's saved schema), so the caller can correct the value and retry without re-fetching.



34
35
36
 
# File 'lib/shipeasy_admin/models/error.rb', line 34

def schema
  @schema
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



71
72
73
 
# File 'lib/shipeasy_admin/models/error.rb', line 71

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



76
77
78
 
# File 'lib/shipeasy_admin/models/error.rb', line 76

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



59
60
61
62
63
64
65
66
67
68
 
# File 'lib/shipeasy_admin/models/error.rb', line 59

def self.attribute_map
  {
    :'error' => :'error',
    :'code' => :'code',
    :'detail' => :'detail',
    :'fields' => :'fields',
    :'instructions' => :'instructions',
    :'schema' => :'schema'
  }
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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/shipeasy_admin/models/error.rb', line 203

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



93
94
95
96
 
# File 'lib/shipeasy_admin/models/error.rb', line 93

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/shipeasy_admin/models/error.rb', line 81

def self.openapi_types
  {
    :'error' => :'String',
    :'code' => :'ErrorCode',
    :'detail' => :'String',
    :'fields' => :'Hash<String, String>',
    :'instructions' => :'String',
    :'schema' => :'Hash<String, Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



177
178
179
180
181
182
183
184
185
186
 
# File 'lib/shipeasy_admin/models/error.rb', line 177

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error == o.error &&
      code == o.code &&
      detail == o.detail &&
      fields == o.fields &&
      instructions == o.instructions &&
      schema == o.schema
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


190
191
192
 
# File 'lib/shipeasy_admin/models/error.rb', line 190

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



196
197
198
 
# File 'lib/shipeasy_admin/models/error.rb', line 196

def hash
  [error, code, detail, fields, instructions, schema].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



147
148
149
150
151
152
153
154
155
 
# File 'lib/shipeasy_admin/models/error.rb', line 147

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @error.nil?
    invalid_properties.push('invalid value for "error", error 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



225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/shipeasy_admin/models/error.rb', line 225

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



159
160
161
162
163
 
# File 'lib/shipeasy_admin/models/error.rb', line 159

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