=begin #The Plaid API #The Plaid REST API. Please see https://plaid.com/docs/api for more details. The version of the OpenAPI document: 2020-09-14_1.385.1 Generated by: https://openapi-generator.tech OpenAPI Generator version: 5.1.1 =end require 'date' require 'time' module Plaid # 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. class PlaidError attr_accessor :error_type # The particular error code. Safe for programmatic use. attr_accessor :error_code # A developer-friendly representation of the error code. This may change over time and is not safe for programmatic use. attr_accessor :error_message # 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. attr_accessor :display_message # A unique ID identifying the request, to be used for troubleshooting purposes. This field will be omitted in errors provided by webhooks. attr_accessor :request_id # 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. attr_accessor :causes # 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. attr_accessor :status # The URL of a Plaid documentation page with more information about the error attr_accessor :documentation_url # Suggested steps for resolving the error attr_accessor :suggested_action # Attribute mapping from ruby-style variable name to JSON key. 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 # Returns all the JSON keys this model knows about def self.acceptable_attributes attribute_map.values end # Attribute type mapping. def self.openapi_types { :'error_type' => :'PlaidErrorType', :'error_code' => :'String', :'error_message' => :'String', :'display_message' => :'String', :'request_id' => :'String', :'causes' => :'Array', :'status' => :'Integer', :'documentation_url' => :'String', :'suggested_action' => :'String' } end # List of attributes with nullable: true def self.openapi_nullable Set.new([ :'display_message', :'status', :'suggested_action' ]) end # Initializes the object # @param [Hash] attributes Model attributes in the form of hash 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 # Show invalid properties with the reasons. Usually used together with valid? # @return Array for valid properties with the reasons 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 # Check to see if the all the properties in the model are valid # @return true if the model is valid def valid? return false if @error_type.nil? return false if @error_code.nil? return false if @error_message.nil? true end # Checks equality by comparing each attribute. # @param [Object] Object to be compared 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 # @see the `==` method # @param [Object] Object to be compared def eql?(o) self == o end # Calculates hash code according to all attributes. # @return [Integer] Hash code def hash [error_type, error_code, error_message, display_message, request_id, causes, status, documentation_url, suggested_action].hash end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself def self.build_from_hash(attributes) new.build_from_hash(attributes) end # Builds the object from hash # @param [Hash] attributes Model attributes in the form of hash # @return [Object] Returns the model itself 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 # Deserializes the data based on type # @param string type Data type # @param string value Value to be deserialized # @return [Object] Deserialized data 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<(?.+)>\z/ inner_type = Regexp.last_match[:inner_type] value.map { |v| _deserialize(inner_type, v) } when /\AHash<(?.+?), (?.+)>\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 # Returns the string representation of the object # @return [String] String presentation of the object def to_s to_hash.to_s end # to_body is an alias to to_hash (backward compatibility) # @return [Hash] Returns the object in the form of hash def to_body to_hash end # Returns the object in the form of hash # @return [Hash] Returns the object in the form of hash 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 # 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 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 end end