Class: ThePlaidApi::LinkEventName

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

Overview

A string representing the event that has just occurred in the Link flow.

Constant Summary collapse 

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = BANK_INCOME_INSIGHTS_COMPLETED) ⇒ Object 



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
 
# File 'lib/the_plaid_api/models/link_event_name.rb', line 95

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

  str = value.to_s.strip

  case str.downcase
  when 'bank_income_insights_completed' then BANK_INCOME_INSIGHTS_COMPLETED
  when 'close_oauth' then CLOSE_OAUTH
  when 'error' then ERROR
  when 'exit' then EXIT
  when 'fail_oauth' then FAIL_OAUTH
  when 'handoff' then HANDOFF
  when 'issue_followed' then ISSUE_FOLLOWED
  when 'open' then OPEN
  when 'open_my_plaid' then OPEN_MY_PLAID
  when 'open_oauth' then OPEN_OAUTH
  when 'search_institution' then SEARCH_INSTITUTION
  when 'select_auth_type' then SELECT_AUTH_TYPE
  when 'select_brand' then SELECT_BRAND
  when 'select_degraded_institution' then SELECT_DEGRADED_INSTITUTION
  when 'select_down_institution' then SELECT_DOWN_INSTITUTION
  when 'select_filtered_institution' then SELECT_FILTERED_INSTITUTION
  when 'select_institution' then SELECT_INSTITUTION
  when 'submit_account_number' then SUBMIT_ACCOUNT_NUMBER
  when 'submit_credentials' then SUBMIT_CREDENTIALS
  when 'submit_documents' then SUBMIT_DOCUMENTS
  when 'submit_documents_error' then SUBMIT_DOCUMENTS_ERROR
  when 'submit_documents_success' then SUBMIT_DOCUMENTS_SUCCESS
  when 'submit_mfa' then SUBMIT_MFA
  when 'submit_routing_number' then SUBMIT_ROUTING_NUMBER
  when 'transition_view' then TRANSITION_VIEW
  when 'view_data_types' then VIEW_DATA_TYPES
  else
    default_value
  end
end

.validate(value) ⇒ Object 



89
90
91
92
93
 
# File 'lib/the_plaid_api/models/link_event_name.rb', line 89

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

  LINK_EVENT_NAME.include?(value)
end