Class: ThePlaidApi::ConsentedDataScope

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

Overview

A data scope for the products that a user can consent to in [Data Transparency Messaging](plaid.com/docs/link/data-transparency-messaging-migration -guide)

Constant Summary collapse

CONSENTED_DATA_SCOPE = 
[
  # TODO: Write general description for ACCOUNT_BALANCE_INFO
  ACCOUNT_BALANCE_INFO = 'account_balance_info'.freeze,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = ACCOUNT_BALANCE_INFO) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/the_plaid_api/models/consented_data_scope.rb', line 65

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

  str = value.to_s.strip

  case str.downcase
  when 'account_balance_info' then ACCOUNT_BALANCE_INFO
  when 'contact_info' then CONTACT_INFO
  when 'account_routing_number' then ACCOUNT_ROUTING_NUMBER
  when 'transactions' then TRANSACTIONS
  when 'credit_loan_info' then CREDIT_LOAN_INFO
  when 'investments' then INVESTMENTS
  when 'payroll_info' then PAYROLL_INFO
  when 'income_verification_paystubs_info' then INCOME_VERIFICATION_PAYSTUBS_INFO
  when 'income_verification_w2s_info' then INCOME_VERIFICATION_W2S_INFO
  when 'income_verification_bank_statements' then INCOME_VERIFICATION_BANK_STATEMENTS
  when 'income_verification_employment_info' then INCOME_VERIFICATION_EMPLOYMENT_INFO
  when 'bank_statements' then BANK_STATEMENTS
  when 'risk_info' then RISK_INFO
  when 'network_insights_lite' then NETWORK_INSIGHTS_LITE
  when 'fraud_info' then FRAUD_INFO
  else
    default_value
  end
end

.validate(value) ⇒ Object 



59
60
61
62
63
 
# File 'lib/the_plaid_api/models/consented_data_scope.rb', line 59

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

  CONSENTED_DATA_SCOPE.include?(value)
end