Class: ThePlaidApi::PlaidErrorType

Inherits:
Object
  • Object
show all
Defined in:
lib/the_plaid_api/models/plaid_error_type.rb

Overview

A broad categorization of the error. Safe for programmatic use.

Constant Summary collapse

PLAID_ERROR_TYPE = 
[
  # TODO: Write general description for INVALID_REQUEST
  INVALID_REQUEST = 'INVALID_REQUEST'.freeze,

  # TODO: Write general description for INVALID_RESULT
  INVALID_RESULT = 'INVALID_RESULT'.freeze,

  # TODO: Write general description for INVALID_INPUT
  INVALID_INPUT = 'INVALID_INPUT'.freeze,

  # TODO: Write general description for INSTITUTION_ERROR
  INSTITUTION_ERROR = 'INSTITUTION_ERROR'.freeze,

  # TODO: Write general description for RATE_LIMIT_EXCEEDED
  RATE_LIMIT_EXCEEDED = 'RATE_LIMIT_EXCEEDED'.freeze,

  # TODO: Write general description for API_ERROR
  API_ERROR = 'API_ERROR'.freeze,

  # TODO: Write general description for ITEM_ERROR
  ITEM_ERROR = 'ITEM_ERROR'.freeze,

  # TODO: Write general description for ASSET_REPORT_ERROR
  ASSET_REPORT_ERROR = 'ASSET_REPORT_ERROR'.freeze,

  # TODO: Write general description for RECAPTCHA_ERROR
  RECAPTCHA_ERROR = 'RECAPTCHA_ERROR'.freeze,

  # TODO: Write general description for OAUTH_ERROR
  OAUTH_ERROR = 'OAUTH_ERROR'.freeze,

  # TODO: Write general description for PAYMENT_ERROR
  PAYMENT_ERROR = 'PAYMENT_ERROR'.freeze,

  # TODO: Write general description for BANK_TRANSFER_ERROR
  BANK_TRANSFER_ERROR = 'BANK_TRANSFER_ERROR'.freeze,

  # TODO: Write general description for INCOME_VERIFICATION_ERROR
  INCOME_VERIFICATION_ERROR = 'INCOME_VERIFICATION_ERROR'.freeze,

  # TODO: Write general description for MICRODEPOSITS_ERROR
  MICRODEPOSITS_ERROR = 'MICRODEPOSITS_ERROR'.freeze,

  # TODO: Write general description for SANDBOX_ERROR
  SANDBOX_ERROR = 'SANDBOX_ERROR'.freeze,

  # TODO: Write general description for PARTNER_ERROR
  PARTNER_ERROR = 'PARTNER_ERROR'.freeze,

  # TODO: Write general description for SIGNAL_ERROR
  SIGNAL_ERROR = 'SIGNAL_ERROR'.freeze,

  # TODO: Write general description for TRANSACTIONS_ERROR
  TRANSACTIONS_ERROR = 'TRANSACTIONS_ERROR'.freeze,

  # TODO: Write general description for TRANSACTION_ERROR
  TRANSACTION_ERROR = 'TRANSACTION_ERROR'.freeze,

  # TODO: Write general description for TRANSFER_ERROR
  TRANSFER_ERROR = 'TRANSFER_ERROR'.freeze,

  # TODO: Write general description for CHECK_REPORT_ERROR
  CHECK_REPORT_ERROR = 'CHECK_REPORT_ERROR'.freeze,

  # TODO: Write general description for CONSUMER_REPORT_ERROR
  CONSUMER_REPORT_ERROR = 'CONSUMER_REPORT_ERROR'.freeze,

  # TODO: Write general description for USER_ERROR
  USER_ERROR = 'USER_ERROR'.freeze
].freeze

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = INVALID_REQUEST) ⇒ Object 



86
87
88
89
90
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
 
# File 'lib/the_plaid_api/models/plaid_error_type.rb', line 86

def self.from_value(value, default_value = INVALID_REQUEST)
  return default_value if value.nil?

  str = value.to_s.strip

  case str.downcase
  when 'invalid_request' then INVALID_REQUEST
  when 'invalid_result' then INVALID_RESULT
  when 'invalid_input' then INVALID_INPUT
  when 'institution_error' then INSTITUTION_ERROR
  when 'rate_limit_exceeded' then RATE_LIMIT_EXCEEDED
  when 'api_error' then API_ERROR
  when 'item_error' then ITEM_ERROR
  when 'asset_report_error' then ASSET_REPORT_ERROR
  when 'recaptcha_error' then RECAPTCHA_ERROR
  when 'oauth_error' then OAUTH_ERROR
  when 'payment_error' then PAYMENT_ERROR
  when 'bank_transfer_error' then BANK_TRANSFER_ERROR
  when 'income_verification_error' then INCOME_VERIFICATION_ERROR
  when 'microdeposits_error' then MICRODEPOSITS_ERROR
  when 'sandbox_error' then SANDBOX_ERROR
  when 'partner_error' then PARTNER_ERROR
  when 'signal_error' then SIGNAL_ERROR
  when 'transactions_error' then TRANSACTIONS_ERROR
  when 'transaction_error' then TRANSACTION_ERROR
  when 'transfer_error' then TRANSFER_ERROR
  when 'check_report_error' then CHECK_REPORT_ERROR
  when 'consumer_report_error' then CONSUMER_REPORT_ERROR
  when 'user_error' then USER_ERROR
  else
    default_value
  end
end

.validate(value) ⇒ Object 



80
81
82
83
84
 
# File 'lib/the_plaid_api/models/plaid_error_type.rb', line 80

def self.validate(value)
  return false if value.nil?

  PLAID_ERROR_TYPE.include?(value)
end