Class: ThePlaidApi::IdNumberType

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

Overview

A globally unique and human readable ID type, specific to the country and document category. For more context on this field, see [Input Validation Rules](cognitohq.com/docs/flow/flow-hybrid-input-validation#id-numbe rs).

Constant Summary collapse

ID_NUMBER_TYPE = 
[
  # TODO: Write general description for AR_DNI
  AR_DNI = 'ar_dni'.freeze,

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Class Method Summary collapse

Class Method Details

.from_value(value, default_value = AR_DNI) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/the_plaid_api/models/id_number_type.rb', line 125

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

  str = value.to_s.strip

  case str.downcase
  when 'ar_dni' then AR_DNI
  when 'au_drivers_license' then AU_DRIVERS_LICENSE
  when 'au_passport' then AU_PASSPORT
  when 'br_cpf' then BR_CPF
  when 'ca_sin' then CA_SIN
  when 'cl_run' then CL_RUN
  when 'cn_resident_card' then CN_RESIDENT_CARD
  when 'co_nit' then CO_NIT
  when 'dk_cpr' then DK_CPR
  when 'eg_national_id' then EG_NATIONAL_ID
  when 'es_dni' then ES_DNI
  when 'es_nie' then ES_NIE
  when 'hk_hkid' then HK_HKID
  when 'in_pan' then IN_PAN
  when 'it_cf' then IT_CF
  when 'jo_civil_id' then JO_CIVIL_ID
  when 'jp_my_number' then JP_MY_NUMBER
  when 'ke_huduma_namba' then KE_HUDUMA_NAMBA
  when 'kw_civil_id' then KW_CIVIL_ID
  when 'mx_curp' then MX_CURP
  when 'mx_rfc' then MX_RFC
  when 'my_nric' then MY_NRIC
  when 'ng_nin' then NG_NIN
  when 'nz_drivers_license' then NZ_DRIVERS_LICENSE
  when 'om_civil_id' then OM_CIVIL_ID
  when 'ph_psn' then PH_PSN
  when 'pl_pesel' then PL_PESEL
  when 'ro_cnp' then RO_CNP
  when 'sa_national_id' then SA_NATIONAL_ID
  when 'se_pin' then SE_PIN
  when 'sg_nric' then SG_NRIC
  when 'tr_tc_kimlik' then TR_TC_KIMLIK
  when 'us_ssn' then US_SSN
  when 'us_ssn_last_4' then US_SSN_LAST_4
  when 'za_smart_id' then ZA_SMART_ID
  else
    default_value
  end
end

.validate(value) ⇒ Object 



119
120
121
122
123
 
# File 'lib/the_plaid_api/models/id_number_type.rb', line 119

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

  ID_NUMBER_TYPE.include?(value)
end