plaid 15.4.0 → 15.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (821) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +110 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/README.md +36 -1
  6. data/lib/plaid/api/plaid_api.rb +3457 -1704
  7. data/lib/plaid/api_client.rb +4 -4
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +1 -1
  10. data/lib/plaid/models/account_access.rb +1 -1
  11. data/lib/plaid/models/account_assets.rb +1 -1
  12. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  13. data/lib/plaid/models/account_balance.rb +1 -1
  14. data/lib/plaid/models/account_base.rb +1 -1
  15. data/lib/plaid/models/account_filter.rb +1 -1
  16. data/lib/plaid/models/account_filters_response.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +1 -1
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_product_access.rb +1 -1
  20. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  21. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  22. data/lib/plaid/models/account_subtype.rb +1 -1
  23. data/lib/plaid/models/account_type.rb +1 -1
  24. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  26. data/lib/plaid/models/accounts_get_request.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  28. data/lib/plaid/models/accounts_get_response.rb +1 -1
  29. data/lib/plaid/models/ach_class.rb +1 -12
  30. data/lib/plaid/models/address.rb +1 -1
  31. data/lib/plaid/models/address_data.rb +1 -1
  32. data/lib/plaid/models/address_data_nullable.rb +1 -1
  33. data/lib/plaid/models/address_nullable.rb +1 -1
  34. data/lib/plaid/models/address_purpose_label.rb +40 -0
  35. data/lib/plaid/models/application.rb +10 -9
  36. data/lib/plaid/models/application_get_request.rb +1 -1
  37. data/lib/plaid/models/application_get_response.rb +1 -1
  38. data/lib/plaid/models/apr.rb +1 -1
  39. data/lib/plaid/models/asset_report.rb +1 -1
  40. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  41. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  42. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  43. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  44. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  45. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  46. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  47. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  48. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  51. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  52. data/lib/plaid/models/asset_report_item.rb +1 -1
  53. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  56. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  57. data/lib/plaid/models/asset_report_relay_create_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_relay_create_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_relay_get_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_relay_refresh_request.rb +1 -1
  61. data/lib/plaid/models/asset_report_relay_refresh_response.rb +1 -1
  62. data/lib/plaid/models/asset_report_relay_remove_request.rb +1 -1
  63. data/lib/plaid/models/asset_report_relay_remove_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  67. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  68. data/lib/plaid/models/asset_report_user.rb +1 -1
  69. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  70. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  71. data/lib/plaid/models/assets_relay_webhook.rb +1 -1
  72. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  73. data/lib/plaid/models/auth_get_request.rb +1 -1
  74. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  75. data/lib/plaid/models/auth_get_response.rb +1 -1
  76. data/lib/plaid/models/auth_metadata.rb +1 -1
  77. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  78. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  79. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  80. data/lib/plaid/models/bank_transfer.rb +1 -1
  81. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  82. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  83. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  84. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  85. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  86. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  87. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  88. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  89. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  90. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  91. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  92. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  93. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  113. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  114. data/lib/plaid/models/categories_get_response.rb +1 -1
  115. data/lib/plaid/models/category.rb +1 -1
  116. data/lib/plaid/models/cause.rb +2 -1
  117. data/lib/plaid/models/cause_all_of.rb +1 -1
  118. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  119. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  120. data/lib/plaid/models/connected_application.rb +13 -2
  121. data/lib/plaid/models/country_code.rb +1 -1
  122. data/lib/plaid/models/{transactions_recurring_deactivate_request.rb → create_entity_screening_request.rb} +28 -29
  123. data/lib/plaid/models/create_entity_watchlist_screening_review_request.rb +307 -0
  124. data/lib/plaid/models/create_individual_watchlist_screening_review_request.rb +307 -0
  125. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  126. data/lib/plaid/models/credit_bank_income.rb +1 -1
  127. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  128. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  129. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  130. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  131. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  132. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  133. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  134. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  135. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  136. data/lib/plaid/models/credit_bank_income_item.rb +8 -8
  137. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  138. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  139. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  140. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  141. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  142. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  143. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  144. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  145. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  146. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  147. data/lib/plaid/models/credit_card_liability.rb +1 -1
  148. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  149. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  150. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  151. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  152. data/lib/plaid/models/credit_employment_item.rb +1 -1
  153. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  154. data/lib/plaid/models/credit_filter.rb +1 -1
  155. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  156. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  157. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  158. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  159. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  160. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  161. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  162. data/lib/plaid/models/credit_pay_stub_verification.rb +1 -1
  163. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  164. data/lib/plaid/models/credit_payroll_income_get_response.rb +20 -5
  165. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  166. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  167. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  168. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  169. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +240 -0
  170. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +251 -0
  171. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  172. data/lib/plaid/models/credit_w2.rb +1 -1
  173. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  174. data/lib/plaid/models/dashboard_user.rb +269 -0
  175. data/lib/plaid/models/dashboard_user_list.rb +242 -0
  176. data/lib/plaid/models/dashboard_user_status.rb +40 -0
  177. data/lib/plaid/models/date_range.rb +240 -0
  178. data/lib/plaid/models/deductions.rb +1 -1
  179. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  180. data/lib/plaid/models/deductions_total.rb +1 -1
  181. data/lib/plaid/models/default_update_webhook.rb +1 -1
  182. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  183. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  184. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  185. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  186. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  187. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  188. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  189. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  190. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  191. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  192. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  193. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  194. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  195. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  196. data/lib/plaid/models/depository_filter.rb +1 -1
  197. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  198. data/lib/plaid/models/doc_type.rb +1 -1
  199. data/lib/plaid/models/document_analysis.rb +248 -0
  200. data/lib/plaid/models/document_authenticity_match_code.rb +41 -0
  201. data/lib/plaid/models/document_date_of_birth_match_code.rb +40 -0
  202. data/lib/plaid/models/document_metadata.rb +1 -1
  203. data/lib/plaid/models/document_name_match_code.rb +40 -0
  204. data/lib/plaid/models/document_risk_signal.rb +274 -0
  205. data/lib/plaid/models/{transactions_recurring_deactivate_response.rb → document_risk_signal_institution_metadata.rb} +16 -16
  206. data/lib/plaid/models/document_risk_signals_object.rb +255 -0
  207. data/lib/plaid/models/document_status.rb +40 -0
  208. data/lib/plaid/models/{payment_initiation_refund.rb → documentary_verification.rb} +20 -46
  209. data/lib/plaid/models/documentary_verification_document.rb +277 -0
  210. data/lib/plaid/models/earnings.rb +1 -1
  211. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  212. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  213. data/lib/plaid/models/earnings_total.rb +1 -1
  214. data/lib/plaid/models/email.rb +1 -1
  215. data/lib/plaid/models/employee.rb +1 -1
  216. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  217. data/lib/plaid/models/employer.rb +1 -1
  218. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  219. data/lib/plaid/models/employer_verification.rb +1 -1
  220. data/lib/plaid/models/employers_search_request.rb +1 -1
  221. data/lib/plaid/models/employers_search_response.rb +1 -1
  222. data/lib/plaid/models/employment_details.rb +1 -1
  223. data/lib/plaid/models/employment_verification.rb +1 -1
  224. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  225. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  226. data/lib/plaid/models/employment_verification_status.rb +1 -1
  227. data/lib/plaid/models/enhancements.rb +1 -1
  228. data/lib/plaid/models/entity_document.rb +271 -0
  229. data/lib/plaid/models/entity_document_type.rb +43 -0
  230. data/lib/plaid/models/entity_screening_hit_analysis.rb +279 -0
  231. data/lib/plaid/models/entity_screening_hit_data.rb +282 -0
  232. data/lib/plaid/models/entity_screening_hit_documents_items.rb +228 -0
  233. data/lib/plaid/models/entity_screening_hit_emails.rb +225 -0
  234. data/lib/plaid/models/entity_screening_hit_emails_items.rb +228 -0
  235. data/lib/plaid/models/entity_screening_hit_names.rb +254 -0
  236. data/lib/plaid/models/entity_screening_hit_names_items.rb +228 -0
  237. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +262 -0
  238. data/lib/plaid/models/entity_screening_hit_urls.rb +225 -0
  239. data/lib/plaid/models/entity_screening_hit_urls_items.rb +228 -0
  240. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +228 -0
  241. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +251 -0
  242. data/lib/plaid/models/entity_watchlist_code.rb +50 -0
  243. data/lib/plaid/models/entity_watchlist_program.rb +374 -0
  244. data/lib/plaid/models/entity_watchlist_screening.rb +287 -0
  245. data/lib/plaid/models/entity_watchlist_screening_hit.rb +349 -0
  246. data/lib/plaid/models/entity_watchlist_screening_hit_list.rb +242 -0
  247. data/lib/plaid/models/entity_watchlist_screening_list.rb +242 -0
  248. data/lib/plaid/models/entity_watchlist_screening_program_list.rb +242 -0
  249. data/lib/plaid/models/entity_watchlist_screening_review.rb +301 -0
  250. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +337 -0
  251. data/lib/plaid/models/entity_watchlist_search_terms.rb +322 -0
  252. data/lib/plaid/models/error.rb +2 -1
  253. data/lib/plaid/models/expiration_date.rb +40 -0
  254. data/lib/plaid/models/external_payment_initiation_consent_options.rb +53 -6
  255. data/lib/plaid/models/external_payment_options.rb +1 -1
  256. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  257. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  258. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  259. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  260. data/lib/plaid/models/generic_screening_hit_location_items.rb +228 -0
  261. data/lib/plaid/models/get_dashboard_user_request.rb +245 -0
  262. data/lib/plaid/models/get_entity_watchlist_screening_request.rb +245 -0
  263. data/lib/plaid/models/get_identity_verification_request.rb +245 -0
  264. data/lib/plaid/models/get_individual_watchlist_screening_request.rb +245 -0
  265. data/lib/plaid/models/get_watchlist_screening_entity_program_request.rb +245 -0
  266. data/lib/plaid/models/get_watchlist_screening_individual_program_request.rb +245 -0
  267. data/lib/plaid/models/health_incident.rb +1 -1
  268. data/lib/plaid/models/historical_balance.rb +1 -1
  269. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  270. data/lib/plaid/models/holding.rb +1 -1
  271. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  272. data/lib/plaid/models/holdings_override.rb +1 -1
  273. data/lib/plaid/models/id_number_type.rb +72 -0
  274. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  275. data/lib/plaid/models/identity_get_request.rb +1 -1
  276. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  277. data/lib/plaid/models/identity_get_response.rb +1 -1
  278. data/lib/plaid/models/identity_update_types.rb +1 -1
  279. data/lib/plaid/models/identity_verification.rb +420 -0
  280. data/lib/plaid/models/identity_verification_create_request.rb +302 -0
  281. data/lib/plaid/models/identity_verification_list.rb +242 -0
  282. data/lib/plaid/models/identity_verification_request_user.rb +338 -0
  283. data/lib/plaid/models/identity_verification_retried_webhook.rb +251 -0
  284. data/lib/plaid/models/identity_verification_retry_request.rb +316 -0
  285. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +270 -0
  286. data/lib/plaid/models/identity_verification_status.rb +43 -0
  287. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +251 -0
  288. data/lib/plaid/models/identity_verification_step_status.rb +48 -0
  289. data/lib/plaid/models/identity_verification_step_summary.rb +308 -0
  290. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +251 -0
  291. data/lib/plaid/models/identity_verification_template_reference.rb +240 -0
  292. data/lib/plaid/models/identity_verification_user_address.rb +308 -0
  293. data/lib/plaid/models/identity_verification_user_data.rb +302 -0
  294. data/lib/plaid/models/image_quality.rb +40 -0
  295. data/lib/plaid/models/incident_update.rb +1 -1
  296. data/lib/plaid/models/income_breakdown.rb +1 -1
  297. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  298. data/lib/plaid/models/income_override.rb +1 -1
  299. data/lib/plaid/models/income_summary.rb +1 -1
  300. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  301. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  302. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  303. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  304. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  305. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  306. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  307. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  308. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  309. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  310. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  311. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  312. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  313. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  314. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  315. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  316. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  317. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  318. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  319. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  320. data/lib/plaid/models/income_verification_status_webhook.rb +12 -2
  321. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  322. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  323. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  324. data/lib/plaid/models/individual_screening_hit_names.rb +254 -0
  325. data/lib/plaid/models/individual_watchlist_code.rb +59 -0
  326. data/lib/plaid/models/individual_watchlist_program.rb +374 -0
  327. data/lib/plaid/models/individual_watchlist_program_list.rb +227 -0
  328. data/lib/plaid/models/inflow_model.rb +1 -1
  329. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  330. data/lib/plaid/models/institution.rb +1 -1
  331. data/lib/plaid/models/institution_status.rb +1 -1
  332. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  333. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  334. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  335. data/lib/plaid/models/institutions_get_request.rb +1 -1
  336. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  337. data/lib/plaid/models/institutions_get_response.rb +1 -1
  338. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  339. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  340. data/lib/plaid/models/institutions_search_request.rb +1 -1
  341. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  342. data/lib/plaid/models/institutions_search_response.rb +1 -1
  343. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  344. data/lib/plaid/models/investment_filter.rb +1 -1
  345. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  346. data/lib/plaid/models/investment_transaction.rb +1 -1
  347. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  348. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  349. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  350. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  351. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  352. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  353. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  354. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  355. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  356. data/lib/plaid/models/issuing_country.rb +39 -0
  357. data/lib/plaid/models/item.rb +1 -1
  358. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  359. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  360. data/lib/plaid/models/item_application_list_request.rb +1 -1
  361. data/lib/plaid/models/item_application_list_response.rb +1 -1
  362. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  363. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  364. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  365. data/lib/plaid/models/item_error_webhook.rb +1 -1
  366. data/lib/plaid/models/item_get_request.rb +1 -1
  367. data/lib/plaid/models/item_get_response.rb +1 -1
  368. data/lib/plaid/models/item_import_request.rb +1 -1
  369. data/lib/plaid/models/item_import_request_options.rb +1 -1
  370. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  371. data/lib/plaid/models/item_import_response.rb +1 -1
  372. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  373. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  374. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  375. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  376. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  377. data/lib/plaid/models/item_remove_request.rb +1 -1
  378. data/lib/plaid/models/item_remove_response.rb +1 -1
  379. data/lib/plaid/models/item_status.rb +1 -1
  380. data/lib/plaid/models/item_status_investments.rb +1 -1
  381. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  382. data/lib/plaid/models/item_status_nullable.rb +1 -1
  383. data/lib/plaid/models/item_status_transactions.rb +1 -1
  384. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  385. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  386. data/lib/plaid/models/jwk_public_key.rb +1 -1
  387. data/lib/plaid/models/jwt_header.rb +1 -1
  388. data/lib/plaid/models/kyc_check_address_summary.rb +252 -0
  389. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +224 -0
  390. data/lib/plaid/models/kyc_check_details.rb +295 -0
  391. data/lib/plaid/models/kyc_check_id_number_summary.rb +224 -0
  392. data/lib/plaid/models/kyc_check_name_summary.rb +224 -0
  393. data/lib/plaid/models/kyc_check_phone_summary.rb +224 -0
  394. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  395. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  396. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  397. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  398. data/lib/plaid/models/liabilities_object.rb +1 -1
  399. data/lib/plaid/models/liability_override.rb +1 -1
  400. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  401. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  402. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  403. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  404. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  405. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  406. data/lib/plaid/models/link_token_create_request.rb +14 -2
  407. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  408. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  409. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  410. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  411. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +18 -5
  412. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +16 -6
  413. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  414. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  415. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  416. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  417. data/lib/plaid/models/link_token_create_response.rb +1 -1
  418. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  419. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  420. data/lib/plaid/models/link_token_get_request.rb +1 -1
  421. data/lib/plaid/models/link_token_get_response.rb +1 -1
  422. data/lib/plaid/models/list_dashboard_user_request.rb +241 -0
  423. data/lib/plaid/models/list_entity_watchlist_screening_request.rb +286 -0
  424. data/lib/plaid/models/list_identity_verification_request.rb +303 -0
  425. data/lib/plaid/models/list_individual_watchlist_screening_request.rb +286 -0
  426. data/lib/plaid/models/list_pagination.rb +221 -0
  427. data/lib/plaid/models/list_watchlist_screening_entity_history_request.rb +256 -0
  428. data/lib/plaid/models/list_watchlist_screening_entity_hit_request.rb +256 -0
  429. data/lib/plaid/models/list_watchlist_screening_entity_programs_request.rb +241 -0
  430. data/lib/plaid/models/list_watchlist_screening_entity_reviews_request.rb +256 -0
  431. data/lib/plaid/models/list_watchlist_screening_individual_history_request.rb +256 -0
  432. data/lib/plaid/models/list_watchlist_screening_individual_hit_request.rb +256 -0
  433. data/lib/plaid/models/list_watchlist_screening_individual_programs_request.rb +241 -0
  434. data/lib/plaid/models/list_watchlist_screening_individual_reviews_request.rb +256 -0
  435. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  436. data/lib/plaid/models/loan_filter.rb +1 -1
  437. data/lib/plaid/models/location.rb +1 -1
  438. data/lib/plaid/models/match_summary.rb +224 -0
  439. data/lib/plaid/models/match_summary_code.rb +42 -0
  440. data/lib/plaid/models/meta.rb +1 -1
  441. data/lib/plaid/models/mfa.rb +1 -1
  442. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  443. data/lib/plaid/models/mortgage_liability.rb +1 -1
  444. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  445. data/lib/plaid/models/multi_document_risk_signal.rb +244 -0
  446. data/lib/plaid/models/net_pay.rb +1 -1
  447. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  448. data/lib/plaid/models/numbers.rb +1 -1
  449. data/lib/plaid/models/numbers_ach.rb +1 -1
  450. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  451. data/lib/plaid/models/numbers_bacs.rb +1 -1
  452. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  453. data/lib/plaid/models/numbers_eft.rb +1 -1
  454. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  455. data/lib/plaid/models/numbers_international.rb +1 -1
  456. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  457. data/lib/plaid/models/override_account_type.rb +1 -1
  458. data/lib/plaid/models/override_accounts.rb +1 -1
  459. data/lib/plaid/models/owner.rb +1 -1
  460. data/lib/plaid/models/owner_override.rb +1 -1
  461. data/lib/plaid/models/paginated_dashboard_user_list.rb +261 -0
  462. data/lib/plaid/models/paginated_entity_watchlist_program_list.rb +261 -0
  463. data/lib/plaid/models/paginated_entity_watchlist_screening_hit_list.rb +261 -0
  464. data/lib/plaid/models/paginated_entity_watchlist_screening_list.rb +261 -0
  465. data/lib/plaid/models/paginated_entity_watchlist_screening_review_list.rb +261 -0
  466. data/lib/plaid/models/paginated_identity_verification_paginated_list.rb +261 -0
  467. data/lib/plaid/models/paginated_individual_watchlist_program_list.rb +246 -0
  468. data/lib/plaid/models/paginated_individual_watchlist_screening_hit_list.rb +261 -0
  469. data/lib/plaid/models/paginated_individual_watchlist_screening_list.rb +261 -0
  470. data/lib/plaid/models/paginated_individual_watchlist_screening_review_list.rb +261 -0
  471. data/lib/plaid/models/pay.rb +1 -1
  472. data/lib/plaid/models/pay_frequency.rb +1 -1
  473. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  474. data/lib/plaid/models/pay_period_details.rb +1 -1
  475. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  476. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  477. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  478. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  479. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  480. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  481. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  482. data/lib/plaid/models/pay_stub_verification_attribute.rb +1 -1
  483. data/lib/plaid/models/payment_amount.rb +1 -1
  484. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  485. data/lib/plaid/models/payment_channel.rb +1 -1
  486. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  487. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  488. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  489. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  490. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  491. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  492. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  493. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  494. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  495. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  496. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  497. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  498. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  499. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  500. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  501. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  502. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  503. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  504. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  505. data/lib/plaid/models/payment_initiation_metadata.rb +17 -2
  506. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  507. data/lib/plaid/models/payment_initiation_payment.rb +11 -10
  508. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  509. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  510. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  511. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  512. data/lib/plaid/models/payment_initiation_payment_get_response.rb +11 -10
  513. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  514. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  515. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +95 -5
  516. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  517. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  518. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  519. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  520. data/lib/plaid/models/payment_initiation_recipient.rb +6 -17
  521. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  522. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  523. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  524. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -13
  525. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  526. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  527. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  528. data/lib/plaid/models/payment_initiation_refund_status.rb +1 -1
  529. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  530. data/lib/plaid/models/payment_meta.rb +1 -1
  531. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  532. data/lib/plaid/models/payment_scheme.rb +1 -1
  533. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  534. data/lib/plaid/models/payroll_income_object.rb +1 -1
  535. data/lib/plaid/models/payroll_item.rb +1 -1
  536. data/lib/plaid/models/payroll_item_status.rb +1 -1
  537. data/lib/plaid/models/payroll_risk_signals_item.rb +242 -0
  538. data/lib/plaid/models/paystub.rb +1 -1
  539. data/lib/plaid/models/paystub_address.rb +1 -1
  540. data/lib/plaid/models/paystub_deduction.rb +1 -1
  541. data/lib/plaid/models/paystub_details.rb +1 -1
  542. data/lib/plaid/models/paystub_employer.rb +1 -1
  543. data/lib/plaid/models/paystub_override.rb +1 -1
  544. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  545. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  546. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  547. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  548. data/lib/plaid/models/paystub_verification.rb +1 -1
  549. data/lib/plaid/models/paystub_verification_status.rb +1 -1
  550. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  551. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  552. data/lib/plaid/models/personal_finance_category.rb +1 -1
  553. data/lib/plaid/models/phone_number.rb +1 -1
  554. data/lib/plaid/models/phone_type.rb +39 -0
  555. data/lib/plaid/models/physical_document_category.rb +42 -0
  556. data/lib/plaid/models/physical_document_extracted_data.rb +311 -0
  557. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +266 -0
  558. data/lib/plaid/models/physical_document_images.rb +269 -0
  559. data/lib/plaid/models/plaid_error.rb +2 -1
  560. data/lib/plaid/models/platform_ids.rb +1 -1
  561. data/lib/plaid/models/po_box_status.rb +40 -0
  562. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  563. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  564. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  565. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  566. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  567. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  568. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  569. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  570. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  571. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  572. data/lib/plaid/models/processor_number.rb +1 -1
  573. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  574. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  575. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  576. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  577. data/lib/plaid/models/product_access.rb +1 -1
  578. data/lib/plaid/models/product_status.rb +1 -1
  579. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  580. data/lib/plaid/models/products.rb +1 -1
  581. data/lib/plaid/models/program_name_sensitivity.rb +41 -0
  582. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  583. data/lib/plaid/models/pslf_status.rb +1 -1
  584. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  585. data/lib/plaid/models/recipient_bacs.rb +1 -1
  586. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  587. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  588. data/lib/plaid/models/relay_event.rb +1 -1
  589. data/lib/plaid/models/removed_transaction.rb +1 -1
  590. data/lib/plaid/models/risk_signal_document_reference.rb +231 -0
  591. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  592. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  593. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  594. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  595. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +12 -2
  596. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  597. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
  598. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  599. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  600. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  601. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  602. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  603. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  604. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  605. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  606. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  607. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  608. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  609. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  610. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  611. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  612. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  613. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  614. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  615. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  616. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  617. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  618. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  619. data/lib/plaid/models/scopes.rb +1 -1
  620. data/lib/plaid/models/scopes_context.rb +1 -1
  621. data/lib/plaid/models/scopes_nullable.rb +1 -1
  622. data/lib/plaid/models/screening_hit_analysis.rb +261 -0
  623. data/lib/plaid/models/screening_hit_data.rb +258 -0
  624. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +228 -0
  625. data/lib/plaid/models/screening_hit_documents_items.rb +228 -0
  626. data/lib/plaid/models/screening_hit_names_items.rb +228 -0
  627. data/lib/plaid/models/screening_status_updated_webhook.rb +251 -0
  628. data/lib/plaid/models/security.rb +1 -1
  629. data/lib/plaid/models/security_override.rb +1 -1
  630. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  631. data/lib/plaid/models/servicer_address_data.rb +1 -1
  632. data/lib/plaid/models/signal_address_data.rb +1 -1
  633. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  634. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  635. data/lib/plaid/models/signal_device.rb +1 -1
  636. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  637. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  638. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  639. data/lib/plaid/models/signal_person_name.rb +1 -1
  640. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  641. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  642. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  643. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  644. data/lib/plaid/models/signal_scores.rb +1 -1
  645. data/lib/plaid/models/signal_user.rb +1 -1
  646. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  647. data/lib/plaid/models/single_document_risk_signal.rb +241 -0
  648. data/lib/plaid/models/source.rb +41 -0
  649. data/lib/plaid/models/standalone_account_type.rb +1 -1
  650. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  651. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  652. data/lib/plaid/models/strategy.rb +41 -0
  653. data/lib/plaid/models/student_loan.rb +1 -1
  654. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  655. data/lib/plaid/models/student_loan_status.rb +1 -1
  656. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  657. data/lib/plaid/models/sync_updates_available_webhook.rb +285 -0
  658. data/lib/plaid/models/taxform.rb +1 -1
  659. data/lib/plaid/models/taxpayer_id.rb +1 -1
  660. data/lib/plaid/models/total.rb +1 -1
  661. data/lib/plaid/models/total_canonical_description.rb +1 -1
  662. data/lib/plaid/models/transaction.rb +1 -1
  663. data/lib/plaid/models/transaction_all_of.rb +1 -1
  664. data/lib/plaid/models/transaction_base.rb +1 -1
  665. data/lib/plaid/models/transaction_code.rb +1 -1
  666. data/lib/plaid/models/transaction_data.rb +1 -1
  667. data/lib/plaid/models/transaction_override.rb +1 -1
  668. data/lib/plaid/models/transaction_stream.rb +2 -6
  669. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  670. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  671. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  672. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  673. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  674. data/lib/plaid/models/transactions_get_request.rb +1 -1
  675. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  676. data/lib/plaid/models/transactions_get_response.rb +1 -1
  677. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  678. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  679. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  680. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  681. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  682. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  683. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  684. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  685. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  686. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  687. data/lib/plaid/models/transactions_rules_create_response.rb +2 -2
  688. data/lib/plaid/models/transactions_rules_list_request.rb +2 -2
  689. data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
  690. data/lib/plaid/models/transactions_rules_remove_request.rb +2 -2
  691. data/lib/plaid/models/transactions_rules_remove_response.rb +2 -2
  692. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  693. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  694. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  695. data/lib/plaid/models/transfer.rb +1 -1
  696. data/lib/plaid/models/transfer_authorization.rb +1 -1
  697. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  698. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  699. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  700. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  701. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  702. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  703. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  704. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  705. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  706. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  707. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  708. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  709. data/lib/plaid/models/transfer_create_request.rb +2 -2
  710. data/lib/plaid/models/transfer_create_response.rb +1 -1
  711. data/lib/plaid/models/transfer_event.rb +1 -1
  712. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  713. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  714. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  715. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  716. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  717. data/lib/plaid/models/transfer_event_type.rb +1 -1
  718. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  719. data/lib/plaid/models/transfer_failure.rb +1 -1
  720. data/lib/plaid/models/transfer_get_request.rb +1 -1
  721. data/lib/plaid/models/transfer_get_response.rb +1 -1
  722. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  723. data/lib/plaid/models/transfer_intent_create.rb +16 -5
  724. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  725. data/lib/plaid/models/transfer_intent_create_request.rb +18 -5
  726. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  727. data/lib/plaid/models/transfer_intent_get.rb +36 -5
  728. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  729. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  730. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  731. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  732. data/lib/plaid/models/transfer_list_request.rb +1 -1
  733. data/lib/plaid/models/transfer_list_response.rb +1 -1
  734. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  735. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  736. data/lib/plaid/models/transfer_network.rb +1 -1
  737. data/lib/plaid/models/transfer_repayment.rb +1 -1
  738. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  739. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  740. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  741. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  742. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  743. data/lib/plaid/models/transfer_status.rb +1 -1
  744. data/lib/plaid/models/transfer_sweep.rb +1 -1
  745. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  746. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  747. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  748. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  749. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  750. data/lib/plaid/models/transfer_type.rb +1 -1
  751. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  752. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  753. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  754. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  755. data/lib/plaid/models/update_entity_screening_request.rb +285 -0
  756. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +315 -0
  757. data/lib/plaid/models/update_individual_screening_request.rb +285 -0
  758. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +260 -0
  759. data/lib/plaid/models/user_address.rb +328 -0
  760. data/lib/plaid/models/user_create_request.rb +1 -1
  761. data/lib/plaid/models/user_create_response.rb +2 -1
  762. data/lib/plaid/models/user_custom_password.rb +1 -1
  763. data/lib/plaid/models/user_id_number.rb +239 -0
  764. data/lib/plaid/models/user_name.rb +240 -0
  765. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  766. data/lib/plaid/models/verification_attribute.rb +1 -1
  767. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  768. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  769. data/lib/plaid/models/verification_status.rb +1 -1
  770. data/lib/plaid/models/w2.rb +1 -1
  771. data/lib/plaid/models/w2_box12.rb +1 -1
  772. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  773. data/lib/plaid/models/wallet.rb +253 -0
  774. data/lib/plaid/models/wallet_balance.rb +1 -1
  775. data/lib/plaid/models/wallet_create_request.rb +244 -0
  776. data/lib/plaid/models/wallet_create_response.rb +276 -0
  777. data/lib/plaid/models/wallet_get_request.rb +1 -1
  778. data/lib/plaid/models/wallet_get_response.rb +32 -15
  779. data/lib/plaid/models/wallet_iso_currency_code.rb +38 -0
  780. data/lib/plaid/models/wallet_numbers.rb +1 -1
  781. data/lib/plaid/models/wallet_transaction.rb +4 -4
  782. data/lib/plaid/models/wallet_transaction_amount.rb +2 -48
  783. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  784. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  785. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  786. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  787. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  788. data/lib/plaid/models/wallet_transaction_get_request.rb +266 -0
  789. data/lib/plaid/models/wallet_transaction_get_response.rb +369 -0
  790. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  791. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  792. data/lib/plaid/models/wallet_transactions_list_response.rb +1 -1
  793. data/lib/plaid/models/warning.rb +1 -1
  794. data/lib/plaid/models/watchlist_screening_audit_trail.rb +249 -0
  795. data/lib/plaid/models/watchlist_screening_create_request.rb +254 -0
  796. data/lib/plaid/models/watchlist_screening_document.rb +271 -0
  797. data/lib/plaid/models/watchlist_screening_document_type.rb +50 -0
  798. data/lib/plaid/models/watchlist_screening_entity_review_list.rb +242 -0
  799. data/lib/plaid/models/watchlist_screening_hit.rb +349 -0
  800. data/lib/plaid/models/watchlist_screening_hit_list.rb +242 -0
  801. data/lib/plaid/models/watchlist_screening_hit_locations.rb +272 -0
  802. data/lib/plaid/models/watchlist_screening_hit_status.rb +40 -0
  803. data/lib/plaid/models/watchlist_screening_individual.rb +287 -0
  804. data/lib/plaid/models/watchlist_screening_list.rb +242 -0
  805. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +302 -0
  806. data/lib/plaid/models/watchlist_screening_review.rb +301 -0
  807. data/lib/plaid/models/watchlist_screening_review_list.rb +242 -0
  808. data/lib/plaid/models/watchlist_screening_search_terms.rb +317 -0
  809. data/lib/plaid/models/watchlist_screening_status.rb +40 -0
  810. data/lib/plaid/models/weak_alias_determination.rb +40 -0
  811. data/lib/plaid/models/webhook_type.rb +1 -1
  812. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  813. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  814. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  815. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  816. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  817. data/lib/plaid/version.rb +2 -2
  818. data/lib/plaid.rb +156 -4
  819. data/plaid.gemspec +1 -1
  820. data/templates/ruby/api_client.mustache +2 -2
  821. metadata +158 -6
@@ -0,0 +1,338 @@
1
+ =begin
2
+ #The Plaid API
3
+
4
+ #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
+
6
+ The version of the OpenAPI document: 2020-09-14_1.115.2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ # User information collected outside of Link, most likely via your own onboarding process. Each of the following identity fields are optional: `email_address` `phone_number` `date_of_birth` `name` `address` `id_number` Specifically, these fields are optional in that they can either be fully provided (satisfying every required field in their subschema) or omitted from the request entirely by not providing the key or value. Providing these fields via the API will result in Link skipping the data collection process for the associated user. All verification steps enabled in the associated Identity Verification Template will still be run. Verification steps will either be run immediately, or once the user completes the `accept_tos` step, depending on the value provided to the `consent` field.
18
+ class IdentityVerificationRequestUser
19
+ # An identifier to help you connect this object to your internal systems. For example, your database ID corresponding to this object.
20
+ attr_accessor :client_user_id
21
+
22
+ attr_accessor :email_address
23
+
24
+ # A phone number in E.164 format.
25
+ attr_accessor :phone_number
26
+
27
+ # A date in the format YYYY-MM-DD (RFC 3339 Section 5.6).
28
+ attr_accessor :date_of_birth
29
+
30
+ attr_accessor :name
31
+
32
+ attr_accessor :address
33
+
34
+ attr_accessor :id_number
35
+
36
+ # Attribute mapping from ruby-style variable name to JSON key.
37
+ def self.attribute_map
38
+ {
39
+ :'client_user_id' => :'client_user_id',
40
+ :'email_address' => :'email_address',
41
+ :'phone_number' => :'phone_number',
42
+ :'date_of_birth' => :'date_of_birth',
43
+ :'name' => :'name',
44
+ :'address' => :'address',
45
+ :'id_number' => :'id_number'
46
+ }
47
+ end
48
+
49
+ # Returns all the JSON keys this model knows about
50
+ def self.acceptable_attributes
51
+ attribute_map.values
52
+ end
53
+
54
+ # Attribute type mapping.
55
+ def self.openapi_types
56
+ {
57
+ :'client_user_id' => :'String',
58
+ :'email_address' => :'String',
59
+ :'phone_number' => :'String',
60
+ :'date_of_birth' => :'Date',
61
+ :'name' => :'UserName',
62
+ :'address' => :'UserAddress',
63
+ :'id_number' => :'UserIDNumber'
64
+ }
65
+ end
66
+
67
+ # List of attributes with nullable: true
68
+ def self.openapi_nullable
69
+ Set.new([
70
+ :'email_address',
71
+ :'phone_number',
72
+ :'date_of_birth',
73
+ :'name',
74
+ :'address',
75
+ :'id_number'
76
+ ])
77
+ end
78
+
79
+ # Initializes the object
80
+ # @param [Hash] attributes Model attributes in the form of hash
81
+ def initialize(attributes = {})
82
+ if (!attributes.is_a?(Hash))
83
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IdentityVerificationRequestUser` initialize method"
84
+ end
85
+
86
+ # check to see if the attribute exists and convert string to symbol for hash key
87
+ attributes = attributes.each_with_object({}) { |(k, v), h|
88
+ if (!self.class.attribute_map.key?(k.to_sym))
89
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IdentityVerificationRequestUser`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
90
+ end
91
+ h[k.to_sym] = v
92
+ }
93
+
94
+ if attributes.key?(:'client_user_id')
95
+ self.client_user_id = attributes[:'client_user_id']
96
+ end
97
+
98
+ if attributes.key?(:'email_address')
99
+ self.email_address = attributes[:'email_address']
100
+ end
101
+
102
+ if attributes.key?(:'phone_number')
103
+ self.phone_number = attributes[:'phone_number']
104
+ end
105
+
106
+ if attributes.key?(:'date_of_birth')
107
+ self.date_of_birth = attributes[:'date_of_birth']
108
+ end
109
+
110
+ if attributes.key?(:'name')
111
+ self.name = attributes[:'name']
112
+ end
113
+
114
+ if attributes.key?(:'address')
115
+ self.address = attributes[:'address']
116
+ end
117
+
118
+ if attributes.key?(:'id_number')
119
+ self.id_number = attributes[:'id_number']
120
+ end
121
+ end
122
+
123
+ # Show invalid properties with the reasons. Usually used together with valid?
124
+ # @return Array for valid properties with the reasons
125
+ def list_invalid_properties
126
+ invalid_properties = Array.new
127
+ if @client_user_id.nil?
128
+ invalid_properties.push('invalid value for "client_user_id", client_user_id cannot be nil.')
129
+ end
130
+
131
+ if @client_user_id.to_s.length < 1
132
+ invalid_properties.push('invalid value for "client_user_id", the character length must be great than or equal to 1.')
133
+ end
134
+
135
+ pattern = Regexp.new(/^\S+(\s+\S+)*$/)
136
+ if @client_user_id !~ pattern
137
+ invalid_properties.push("invalid value for \"client_user_id\", must conform to the pattern #{pattern}.")
138
+ end
139
+
140
+
141
+ pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
142
+ if !@phone_number.nil? && @phone_number !~ pattern
143
+ invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
144
+ end
145
+
146
+
147
+ invalid_properties
148
+ end
149
+
150
+ # Check to see if the all the properties in the model are valid
151
+ # @return true if the model is valid
152
+ def valid?
153
+ return false if @client_user_id.nil?
154
+ return false if @client_user_id.to_s.length < 1
155
+ return false if @client_user_id !~ Regexp.new(/^\S+(\s+\S+)*$/)
156
+ return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+[1-9]\d{6,14}$/)
157
+ true
158
+ end
159
+
160
+ # Custom attribute writer method with validation
161
+ # @param [Object] client_user_id Value to be assigned
162
+ def client_user_id=(client_user_id)
163
+ if client_user_id.nil?
164
+ fail ArgumentError, 'client_user_id cannot be nil'
165
+ end
166
+
167
+ if client_user_id.to_s.length < 1
168
+ fail ArgumentError, 'invalid value for "client_user_id", the character length must be great than or equal to 1.'
169
+ end
170
+
171
+ pattern = Regexp.new(/^\S+(\s+\S+)*$/)
172
+ if client_user_id !~ pattern
173
+ fail ArgumentError, "invalid value for \"client_user_id\", must conform to the pattern #{pattern}."
174
+ end
175
+
176
+
177
+ @client_user_id = client_user_id
178
+ end
179
+
180
+ # Custom attribute writer method with validation
181
+ # @param [Object] phone_number Value to be assigned
182
+ def phone_number=(phone_number)
183
+ pattern = Regexp.new(/^\+[1-9]\d{6,14}$/)
184
+ if !phone_number.nil? && phone_number !~ pattern
185
+ fail ArgumentError, "invalid value for \"phone_number\", must conform to the pattern #{pattern}."
186
+ end
187
+
188
+
189
+ @phone_number = phone_number
190
+ end
191
+
192
+ # Checks equality by comparing each attribute.
193
+ # @param [Object] Object to be compared
194
+ def ==(o)
195
+ return true if self.equal?(o)
196
+ self.class == o.class &&
197
+ client_user_id == o.client_user_id &&
198
+ email_address == o.email_address &&
199
+ phone_number == o.phone_number &&
200
+ date_of_birth == o.date_of_birth &&
201
+ name == o.name &&
202
+ address == o.address &&
203
+ id_number == o.id_number
204
+ end
205
+
206
+ # @see the `==` method
207
+ # @param [Object] Object to be compared
208
+ def eql?(o)
209
+ self == o
210
+ end
211
+
212
+ # Calculates hash code according to all attributes.
213
+ # @return [Integer] Hash code
214
+ def hash
215
+ [client_user_id, email_address, phone_number, date_of_birth, name, address, id_number].hash
216
+ end
217
+
218
+ # Builds the object from hash
219
+ # @param [Hash] attributes Model attributes in the form of hash
220
+ # @return [Object] Returns the model itself
221
+ def self.build_from_hash(attributes)
222
+ new.build_from_hash(attributes)
223
+ end
224
+
225
+ # Builds the object from hash
226
+ # @param [Hash] attributes Model attributes in the form of hash
227
+ # @return [Object] Returns the model itself
228
+ def build_from_hash(attributes)
229
+ return nil unless attributes.is_a?(Hash)
230
+ self.class.openapi_types.each_pair do |key, type|
231
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
232
+ self.send("#{key}=", nil)
233
+ elsif type =~ /\AArray<(.*)>/i
234
+ # check to ensure the input is an array given that the attribute
235
+ # is documented as an array but the input is not
236
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
237
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
238
+ end
239
+ elsif !attributes[self.class.attribute_map[key]].nil?
240
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
241
+ end
242
+ end
243
+
244
+ self
245
+ end
246
+
247
+ # Deserializes the data based on type
248
+ # @param string type Data type
249
+ # @param string value Value to be deserialized
250
+ # @return [Object] Deserialized data
251
+ def _deserialize(type, value)
252
+ case type.to_sym
253
+ when :Time
254
+ Time.parse(value)
255
+ when :Date
256
+ Date.parse(value)
257
+ when :String
258
+ value.to_s
259
+ when :Integer
260
+ value.to_i
261
+ when :Float
262
+ value.to_f
263
+ when :Boolean
264
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
265
+ true
266
+ else
267
+ false
268
+ end
269
+ when :Object
270
+ # generic object (usually a Hash), return directly
271
+ value
272
+ when /\AArray<(?<inner_type>.+)>\z/
273
+ inner_type = Regexp.last_match[:inner_type]
274
+ value.map { |v| _deserialize(inner_type, v) }
275
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
276
+ k_type = Regexp.last_match[:k_type]
277
+ v_type = Regexp.last_match[:v_type]
278
+ {}.tap do |hash|
279
+ value.each do |k, v|
280
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
281
+ end
282
+ end
283
+ else # model
284
+ # models (e.g. Pet) or oneOf
285
+ klass = Plaid.const_get(type)
286
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
287
+ end
288
+ end
289
+
290
+ # Returns the string representation of the object
291
+ # @return [String] String presentation of the object
292
+ def to_s
293
+ to_hash.to_s
294
+ end
295
+
296
+ # to_body is an alias to to_hash (backward compatibility)
297
+ # @return [Hash] Returns the object in the form of hash
298
+ def to_body
299
+ to_hash
300
+ end
301
+
302
+ # Returns the object in the form of hash
303
+ # @return [Hash] Returns the object in the form of hash
304
+ def to_hash
305
+ hash = {}
306
+ self.class.attribute_map.each_pair do |attr, param|
307
+ value = self.send(attr)
308
+ if value.nil?
309
+ is_nullable = self.class.openapi_nullable.include?(attr)
310
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
311
+ end
312
+
313
+ hash[param] = _to_hash(value)
314
+ end
315
+ hash
316
+ end
317
+
318
+ # Outputs non-array value in the form of hash
319
+ # For object, use to_hash. Otherwise, just return the value
320
+ # @param [Object] value Any valid value
321
+ # @return [Hash] Returns the value in the form of hash
322
+ def _to_hash(value)
323
+ if value.is_a?(Array)
324
+ value.compact.map { |v| _to_hash(v) }
325
+ elsif value.is_a?(Hash)
326
+ {}.tap do |hash|
327
+ value.each { |k, v| hash[k] = _to_hash(v) }
328
+ end
329
+ elsif value.respond_to? :to_hash
330
+ value.to_hash
331
+ else
332
+ value
333
+ end
334
+ end
335
+
336
+ end
337
+
338
+ end
@@ -0,0 +1,251 @@
1
+ =begin
2
+ #The Plaid API
3
+
4
+ #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
+
6
+ The version of the OpenAPI document: 2020-09-14_1.115.2
7
+
8
+ Generated by: https://openapi-generator.tech
9
+ OpenAPI Generator version: 5.1.1
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Plaid
17
+ # Fired when identity verification has been retried, which can be triggered via the dashboard or the API.
18
+ class IdentityVerificationRetriedWebhook
19
+ # `IDENTITY_VERIFICATION`
20
+ attr_accessor :webhook_type
21
+
22
+ # `RETRIED`
23
+ attr_accessor :webhook_code
24
+
25
+ # The ID of the associated Identity Verification attempt.
26
+ attr_accessor :identity_verification_id
27
+
28
+ # Attribute mapping from ruby-style variable name to JSON key.
29
+ def self.attribute_map
30
+ {
31
+ :'webhook_type' => :'webhook_type',
32
+ :'webhook_code' => :'webhook_code',
33
+ :'identity_verification_id' => :'identity_verification_id'
34
+ }
35
+ end
36
+
37
+ # Returns all the JSON keys this model knows about
38
+ def self.acceptable_attributes
39
+ attribute_map.values
40
+ end
41
+
42
+ # Attribute type mapping.
43
+ def self.openapi_types
44
+ {
45
+ :'webhook_type' => :'String',
46
+ :'webhook_code' => :'String',
47
+ :'identity_verification_id' => :'AnyType'
48
+ }
49
+ end
50
+
51
+ # List of attributes with nullable: true
52
+ def self.openapi_nullable
53
+ Set.new([
54
+ :'identity_verification_id'
55
+ ])
56
+ end
57
+
58
+ # Initializes the object
59
+ # @param [Hash] attributes Model attributes in the form of hash
60
+ def initialize(attributes = {})
61
+ if (!attributes.is_a?(Hash))
62
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Plaid::IdentityVerificationRetriedWebhook` initialize method"
63
+ end
64
+
65
+ # check to see if the attribute exists and convert string to symbol for hash key
66
+ attributes = attributes.each_with_object({}) { |(k, v), h|
67
+ if (!self.class.attribute_map.key?(k.to_sym))
68
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Plaid::IdentityVerificationRetriedWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
69
+ end
70
+ h[k.to_sym] = v
71
+ }
72
+
73
+ if attributes.key?(:'webhook_type')
74
+ self.webhook_type = attributes[:'webhook_type']
75
+ end
76
+
77
+ if attributes.key?(:'webhook_code')
78
+ self.webhook_code = attributes[:'webhook_code']
79
+ end
80
+
81
+ if attributes.key?(:'identity_verification_id')
82
+ self.identity_verification_id = attributes[:'identity_verification_id']
83
+ end
84
+ end
85
+
86
+ # Show invalid properties with the reasons. Usually used together with valid?
87
+ # @return Array for valid properties with the reasons
88
+ def list_invalid_properties
89
+ invalid_properties = Array.new
90
+ if @webhook_type.nil?
91
+ invalid_properties.push('invalid value for "webhook_type", webhook_type cannot be nil.')
92
+ end
93
+
94
+ if @webhook_code.nil?
95
+ invalid_properties.push('invalid value for "webhook_code", webhook_code cannot be nil.')
96
+ end
97
+
98
+ invalid_properties
99
+ end
100
+
101
+ # Check to see if the all the properties in the model are valid
102
+ # @return true if the model is valid
103
+ def valid?
104
+ return false if @webhook_type.nil?
105
+ return false if @webhook_code.nil?
106
+ true
107
+ end
108
+
109
+ # Checks equality by comparing each attribute.
110
+ # @param [Object] Object to be compared
111
+ def ==(o)
112
+ return true if self.equal?(o)
113
+ self.class == o.class &&
114
+ webhook_type == o.webhook_type &&
115
+ webhook_code == o.webhook_code &&
116
+ identity_verification_id == o.identity_verification_id
117
+ end
118
+
119
+ # @see the `==` method
120
+ # @param [Object] Object to be compared
121
+ def eql?(o)
122
+ self == o
123
+ end
124
+
125
+ # Calculates hash code according to all attributes.
126
+ # @return [Integer] Hash code
127
+ def hash
128
+ [webhook_type, webhook_code, identity_verification_id].hash
129
+ end
130
+
131
+ # Builds the object from hash
132
+ # @param [Hash] attributes Model attributes in the form of hash
133
+ # @return [Object] Returns the model itself
134
+ def self.build_from_hash(attributes)
135
+ new.build_from_hash(attributes)
136
+ end
137
+
138
+ # Builds the object from hash
139
+ # @param [Hash] attributes Model attributes in the form of hash
140
+ # @return [Object] Returns the model itself
141
+ def build_from_hash(attributes)
142
+ return nil unless attributes.is_a?(Hash)
143
+ self.class.openapi_types.each_pair do |key, type|
144
+ if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
145
+ self.send("#{key}=", nil)
146
+ elsif type =~ /\AArray<(.*)>/i
147
+ # check to ensure the input is an array given that the attribute
148
+ # is documented as an array but the input is not
149
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
150
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
151
+ end
152
+ elsif !attributes[self.class.attribute_map[key]].nil?
153
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
154
+ end
155
+ end
156
+
157
+ self
158
+ end
159
+
160
+ # Deserializes the data based on type
161
+ # @param string type Data type
162
+ # @param string value Value to be deserialized
163
+ # @return [Object] Deserialized data
164
+ def _deserialize(type, value)
165
+ case type.to_sym
166
+ when :Time
167
+ Time.parse(value)
168
+ when :Date
169
+ Date.parse(value)
170
+ when :String
171
+ value.to_s
172
+ when :Integer
173
+ value.to_i
174
+ when :Float
175
+ value.to_f
176
+ when :Boolean
177
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
178
+ true
179
+ else
180
+ false
181
+ end
182
+ when :Object
183
+ # generic object (usually a Hash), return directly
184
+ value
185
+ when /\AArray<(?<inner_type>.+)>\z/
186
+ inner_type = Regexp.last_match[:inner_type]
187
+ value.map { |v| _deserialize(inner_type, v) }
188
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
189
+ k_type = Regexp.last_match[:k_type]
190
+ v_type = Regexp.last_match[:v_type]
191
+ {}.tap do |hash|
192
+ value.each do |k, v|
193
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
194
+ end
195
+ end
196
+ else # model
197
+ # models (e.g. Pet) or oneOf
198
+ klass = Plaid.const_get(type)
199
+ klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
200
+ end
201
+ end
202
+
203
+ # Returns the string representation of the object
204
+ # @return [String] String presentation of the object
205
+ def to_s
206
+ to_hash.to_s
207
+ end
208
+
209
+ # to_body is an alias to to_hash (backward compatibility)
210
+ # @return [Hash] Returns the object in the form of hash
211
+ def to_body
212
+ to_hash
213
+ end
214
+
215
+ # Returns the object in the form of hash
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_hash
218
+ hash = {}
219
+ self.class.attribute_map.each_pair do |attr, param|
220
+ value = self.send(attr)
221
+ if value.nil?
222
+ is_nullable = self.class.openapi_nullable.include?(attr)
223
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
224
+ end
225
+
226
+ hash[param] = _to_hash(value)
227
+ end
228
+ hash
229
+ end
230
+
231
+ # Outputs non-array value in the form of hash
232
+ # For object, use to_hash. Otherwise, just return the value
233
+ # @param [Object] value Any valid value
234
+ # @return [Hash] Returns the value in the form of hash
235
+ def _to_hash(value)
236
+ if value.is_a?(Array)
237
+ value.compact.map { |v| _to_hash(v) }
238
+ elsif value.is_a?(Hash)
239
+ {}.tap do |hash|
240
+ value.each { |k, v| hash[k] = _to_hash(v) }
241
+ end
242
+ elsif value.respond_to? :to_hash
243
+ value.to_hash
244
+ else
245
+ value
246
+ end
247
+ end
248
+
249
+ end
250
+
251
+ end