Class: Repull::ErrorError

Inherits:
ApiModelBase show all
Defined in:
lib/repull/models/error_error.rb

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/repull/models/error_error.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#code ⇒ Object

Stable machine-parseable error identifier. Match on this for retry logic. Codes are namespaced and never change meaning.



19
20
21
 
# File 'lib/repull/models/error_error.rb', line 19

def code
  @code
end

#did_you_mean ⇒ Object

Suggestion for typos and near-matches. Present when the server can guess the intent.



49
50
51
 
# File 'lib/repull/models/error_error.rb', line 49

def did_you_mean
  @did_you_mean
end

#docs_url ⇒ Object

Canonical write-up for this error code. URL pattern: ‘repull.dev/docs/errors/#code`.



28
29
30
 
# File 'lib/repull/models/error_error.rb', line 28

def docs_url
  @docs_url
end

#endpoint ⇒ Object

The endpoint path that produced the error. Present on ‘code: "unknown_params"` so consumers can match validation failures to the operation they invoked.



46
47
48
 
# File 'lib/repull/models/error_error.rb', line 46

def endpoint
  @endpoint
end

#field ⇒ Object

Body field, query param, or path segment the error is about. Present when the error is parameter-specific.



34
35
36
 
# File 'lib/repull/models/error_error.rb', line 34

def field
  @field
end

#fix ⇒ Object

Exact recovery steps. Surface this verbatim in your UI / agent reasoning trace — it is written to be actionable without further reading.



25
26
27
 
# File 'lib/repull/models/error_error.rb', line 25

def fix
  @fix
end

#message ⇒ Object

Human-readable cause. Echoes the offending value when relevant.



22
23
24
 
# File 'lib/repull/models/error_error.rb', line 22

def message
  @message
end

#request_id ⇒ Object

Opaque per-request id. Mirrors the ‘x-request-id` response header. Capture it before retrying so logs can be correlated.



31
32
33
 
# File 'lib/repull/models/error_error.rb', line 31

def request_id
  @request_id
end

#retry_after ⇒ Object

Seconds the client should wait before retrying. Mirrors the ‘Retry-After` HTTP header. Present on rate-limit responses and on transient upstream failures that are safe to retry.



52
53
54
 
# File 'lib/repull/models/error_error.rb', line 52

def retry_after
  @retry_after
end

#support ⇒ Object

Returns the value of attribute support.



54
55
56
 
# File 'lib/repull/models/error_error.rb', line 54

def support
  @support
end

#valid_params ⇒ Object

Sorted list of every query param this endpoint accepts. Present on ‘code: "unknown_params"` (HTTP 422) so SDK consumers can self-correct without reading docs.



43
44
45
 
# File 'lib/repull/models/error_error.rb', line 43

def valid_params
  @valid_params
end

#valid_values ⇒ Object

Allowed values when the error is enum-related (e.g. unknown ‘provider`, unknown `status`).



40
41
42
 
# File 'lib/repull/models/error_error.rb', line 40

def valid_values
  @valid_values
end

#value_received ⇒ Object

Echo of the offending value (truncated to 200 chars). Useful for debugging — helps callers see what the server actually parsed.



37
38
39
 
# File 'lib/repull/models/error_error.rb', line 37

def value_received
  @value_received
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



76
77
78
 
# File 'lib/repull/models/error_error.rb', line 76

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



81
82
83
 
# File 'lib/repull/models/error_error.rb', line 81

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/repull/models/error_error.rb', line 57

def self.attribute_map
  {
    :'code' => :'code',
    :'message' => :'message',
    :'fix' => :'fix',
    :'docs_url' => :'docs_url',
    :'request_id' => :'request_id',
    :'field' => :'field',
    :'value_received' => :'value_received',
    :'valid_values' => :'valid_values',
    :'valid_params' => :'validParams',
    :'endpoint' => :'endpoint',
    :'did_you_mean' => :'did_you_mean',
    :'retry_after' => :'retry_after',
    :'support' => :'support'
  }
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



319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/repull/models/error_error.rb', line 319

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



105
106
107
108
109
 
# File 'lib/repull/models/error_error.rb', line 105

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

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/repull/models/error_error.rb', line 86

def self.openapi_types
  {
    :'code' => :'String',
    :'message' => :'String',
    :'fix' => :'String',
    :'docs_url' => :'String',
    :'request_id' => :'String',
    :'field' => :'String',
    :'value_received' => :'Object',
    :'valid_values' => :'Array<String>',
    :'valid_params' => :'Array<String>',
    :'endpoint' => :'String',
    :'did_you_mean' => :'String',
    :'retry_after' => :'Integer',
    :'support' => :'ErrorErrorSupport'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/repull/models/error_error.rb', line 286

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      code == o.code &&
      message == o.message &&
      fix == o.fix &&
      docs_url == o.docs_url &&
      request_id == o.request_id &&
      field == o.field &&
      value_received == o.value_received &&
      valid_values == o.valid_values &&
      valid_params == o.valid_params &&
      endpoint == o.endpoint &&
      did_you_mean == o.did_you_mean &&
      retry_after == o.retry_after &&
      support == o.support
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


306
307
308
 
# File 'lib/repull/models/error_error.rb', line 306

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



312
313
314
 
# File 'lib/repull/models/error_error.rb', line 312

def hash
  [code, message, fix, docs_url, request_id, field, value_received, valid_values, valid_params, endpoint, did_you_mean, retry_after, support].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



196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/repull/models/error_error.rb', line 196

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

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

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

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

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



341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/repull/models/error_error.rb', line 341

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



224
225
226
227
228
229
230
231
232
 
# File 'lib/repull/models/error_error.rb', line 224

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @code.nil?
  return false if @message.nil?
  return false if @fix.nil?
  return false if @docs_url.nil?
  return false if @request_id.nil?
  true
end