Class: Plaid::PlaidError

Inherits:
Object
  • Object
show all
Defined in:
lib/plaid/models/plaid_error.rb

Overview

We use standard HTTP response codes for success and failure notifications, and our errors are further classified by ‘error_type`. In general, 200 HTTP codes correspond to success, 40X codes are for developer- or user-related failures, and 50X codes are for Plaid-related issues. An Item with a non-`null` error object will only be part of an API response when calling `/item/get` to view Item status. Otherwise, error fields will be `null` if no error has occurred; if an error has occurred, an error code will be returned instead.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PlaidError

Initializes the object

Parameters:

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

    Model attributes in the form of hash



91
92
93
94
95
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
134
135
136
137
138
139
140
141
 
# File 'lib/plaid/models/plaid_error.rb', line 91

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#causes ⇒ Object

In the Assets product, a request can pertain to more than one Item. If an error is returned for such a request, ‘causes` will return an array of errors containing a breakdown of these errors on the individual Item level, if any can be identified. `causes` will only be provided for the `error_type` `ASSET_REPORT_ERROR`. `causes` will also not be populated inside an error nested within a `warning` object.



34
35
36
 
# File 'lib/plaid/models/plaid_error.rb', line 34

def causes
  @causes
end

#display_message ⇒ Object

A user-friendly representation of the error code. ‘null` if the error is not related to user action. This may change over time and is not safe for programmatic use.



28
29
30
 
# File 'lib/plaid/models/plaid_error.rb', line 28

def display_message
  @display_message
end

#documentation_url ⇒ Object

The URL of a Plaid documentation page with more information about the error



40
41
42
 
# File 'lib/plaid/models/plaid_error.rb', line 40

def documentation_url
  @documentation_url
end

#error_code ⇒ Object

The particular error code. Safe for programmatic use.



22
23
24
 
# File 'lib/plaid/models/plaid_error.rb', line 22

def error_code
  @error_code
end

#error_message ⇒ Object

A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use.



25
26
27
 
# File 'lib/plaid/models/plaid_error.rb', line 25

def error_message
  @error_message
end

#error_type ⇒ Object

Returns the value of attribute error_type.



19
20
21
 
# File 'lib/plaid/models/plaid_error.rb', line 19

def error_type
  @error_type
end

#request_id ⇒ Object

A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks.



31
32
33
 
# File 'lib/plaid/models/plaid_error.rb', line 31

def request_id
  @request_id
end

#status ⇒ Object

The HTTP status code associated with the error. This will only be returned in the response body when the error information is provided via a webhook.



37
38
39
 
# File 'lib/plaid/models/plaid_error.rb', line 37

def status
  @status
end

#suggested_action ⇒ Object

Suggested steps for resolving the error



43
44
45
 
# File 'lib/plaid/models/plaid_error.rb', line 43

def suggested_action
  @suggested_action
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



61
62
63
 
# File 'lib/plaid/models/plaid_error.rb', line 61

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/plaid/models/plaid_error.rb', line 46

def self.attribute_map
  {
    :'error_type' => :'error_type',
    :'error_code' => :'error_code',
    :'error_message' => :'error_message',
    :'display_message' => :'display_message',
    :'request_id' => :'request_id',
    :'causes' => :'causes',
    :'status' => :'status',
    :'documentation_url' => :'documentation_url',
    :'suggested_action' => :'suggested_action'
  }
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



202
203
204
 
# File 'lib/plaid/models/plaid_error.rb', line 202

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
85
86
87
 
# File 'lib/plaid/models/plaid_error.rb', line 81

def self.openapi_nullable
  Set.new([
    :'display_message',
    :'status',
    :'suggested_action'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/plaid/models/plaid_error.rb', line 66

def self.openapi_types
  {
    :'error_type' => :'PlaidErrorType',
    :'error_code' => :'String',
    :'error_message' => :'String',
    :'display_message' => :'String',
    :'request_id' => :'String',
    :'causes' => :'Array<AnyType>',
    :'status' => :'Float',
    :'documentation_url' => :'String',
    :'suggested_action' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/plaid/models/plaid_error.rb', line 173

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_type == o.error_type &&
      error_code == o.error_code &&
      error_message == o.error_message &&
      display_message == o.display_message &&
      request_id == o.request_id &&
      causes == o.causes &&
      status == o.status &&
      documentation_url == o.documentation_url &&
      suggested_action == o.suggested_action
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/plaid/models/plaid_error.rb', line 232

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Plaid.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/plaid/models/plaid_error.rb', line 303

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/plaid/models/plaid_error.rb', line 209

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


189
190
191
 
# File 'lib/plaid/models/plaid_error.rb', line 189

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



195
196
197
 
# File 'lib/plaid/models/plaid_error.rb', line 195

def hash
  [error_type, error_code, error_message, display_message, request_id, causes, status, documentation_url, suggested_action].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



145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/plaid/models/plaid_error.rb', line 145

def list_invalid_properties
  invalid_properties = Array.new
  if @error_type.nil?
    invalid_properties.push('invalid value for "error_type", error_type cannot be nil.')
  end

  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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



279
280
281
 
# File 'lib/plaid/models/plaid_error.rb', line 279

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/plaid/models/plaid_error.rb', line 285

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



273
274
275
 
# File 'lib/plaid/models/plaid_error.rb', line 273

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



164
165
166
167
168
169
 
# File 'lib/plaid/models/plaid_error.rb', line 164

def valid?
  return false if @error_type.nil?
  return false if @error_code.nil?
  return false if @error_message.nil?
  true
end