class Plaid::Cause

An error object and associated ‘item_id` used to identify a specific Item and error when a batch operation operating on multiple Items has encountered an error in one of the Items.

Attributes

causes[RW]

In this 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.

display_message[RW]

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.

documentation_url[RW]

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

error_code[RW]

The particular error code. Safe for programmatic use.

error_code_reason[RW]

The specific reason for the error code. Currently, reasons are only supported OAuth-based item errors; ‘null` will be returned otherwise. Safe for programmatic use. Possible values: `OAUTH_INVALID_TOKEN`: The user’s OAuth connection to this institution has been invalidated. `OAUTH_CONSENT_EXPIRED`: The user’s access consent for this OAuth connection to this institution has expired. ‘OAUTH_REVOKED_TOKEN`: The user’s OAuth connection to this institution is invalid because the user revoked their connection.

error_message[RW]

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

error_type[RW]
item_id[RW]

The ‘item_id` of the Item associated with this webhook, warning, or error

request_id[RW]

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

status[RW]

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.

suggested_action[RW]

Suggested steps for resolving the error

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/plaid/models/cause.rb, line 91
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# File lib/plaid/models/cause.rb, line 74
def self.attribute_map
  {
    :'error_type' => :'error_type',
    :'error_code' => :'error_code',
    :'error_code_reason' => :'error_code_reason',
    :'error_message' => :'error_message',
    :'display_message' => :'display_message',
    :'request_id' => :'request_id',
    :'causes' => :'causes',
    :'status' => :'status',
    :'documentation_url' => :'documentation_url',
    :'suggested_action' => :'suggested_action',
    :'item_id' => :'item_id'
  }
end
build_from_hash(attributes) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/cause.rb, line 258
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# File lib/plaid/models/cause.rb, line 132
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::Cause` 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::Cause`. 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_code_reason')
    self.error_code_reason = attributes[:'error_code_reason']
  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

  if attributes.key?(:'item_id')
    self.item_id = attributes[:'item_id']
  end
end
openapi_all_of() click to toggle source

List of class defined in allOf (OpenAPI v3)

# File lib/plaid/models/cause.rb, line 123
def self.openapi_all_of
  [
  :'CauseAllOf',
  :'PlaidError'
  ]
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/plaid/models/cause.rb, line 113
def self.openapi_nullable
  Set.new([
    :'error_code_reason',
    :'display_message',
    :'status',
    :'suggested_action',
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/plaid/models/cause.rb, line 96
def self.openapi_types
  {
    :'error_type' => :'PlaidErrorType',
    :'error_code' => :'String',
    :'error_code_reason' => :'String',
    :'error_message' => :'String',
    :'display_message' => :'String',
    :'request_id' => :'String',
    :'causes' => :'Array<Object>',
    :'status' => :'Integer',
    :'documentation_url' => :'String',
    :'suggested_action' => :'String',
    :'item_id' => :'String'
  }
end

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# File lib/plaid/models/cause.rb, line 227
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      error_type == o.error_type &&
      error_code == o.error_code &&
      error_code_reason == o.error_code_reason &&
      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 &&
      item_id == o.item_id
end
_deserialize(type, value) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# File lib/plaid/models/cause.rb, line 289
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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# File lib/plaid/models/cause.rb, line 360
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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/plaid/models/cause.rb, line 265
def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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) click to toggle source

@see the ‘==` method @param [Object] Object to be compared

# File lib/plaid/models/cause.rb, line 245
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# File lib/plaid/models/cause.rb, line 251
def hash
  [error_type, error_code, error_code_reason, error_message, display_message, request_id, causes, status, documentation_url, suggested_action, item_id].hash
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# File lib/plaid/models/cause.rb, line 194
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

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

  invalid_properties
end
to_body() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/cause.rb, line 336
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# File lib/plaid/models/cause.rb, line 342
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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/plaid/models/cause.rb, line 330
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# File lib/plaid/models/cause.rb, line 217
def valid?
  return false if @error_type.nil?
  return false if @error_code.nil?
  return false if @error_message.nil?
  return false if @item_id.nil?
  true
end