plaid 13.2.0 → 17.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1087) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1374 -1
  3. data/CONTRIBUTING.md +12 -60
  4. data/Dockerfile +14 -0
  5. data/Gemfile.lock +51 -44
  6. data/LICENSE.txt +1 -1
  7. data/Makefile +11 -0
  8. data/README.md +174 -101
  9. data/Rakefile +8 -79
  10. data/UPGRADING.md +4 -0
  11. data/lib/plaid/api/plaid_api.rb +12307 -0
  12. data/lib/plaid/api_client.rb +393 -0
  13. data/lib/plaid/api_error.rb +57 -0
  14. data/lib/plaid/configuration.rb +298 -0
  15. data/lib/plaid/models/account_access.rb +248 -0
  16. data/lib/plaid/models/account_assets.rb +428 -0
  17. data/lib/plaid/models/account_assets_all_of.rb +265 -0
  18. data/lib/plaid/models/account_balance.rb +276 -0
  19. data/lib/plaid/models/account_base.rb +344 -0
  20. data/lib/plaid/models/account_filter.rb +258 -0
  21. data/lib/plaid/models/account_filters_response.rb +246 -0
  22. data/lib/plaid/models/account_identity.rb +369 -0
  23. data/lib/plaid/models/account_identity_all_of.rb +226 -0
  24. data/lib/plaid/models/account_identity_match_score.rb +392 -0
  25. data/lib/plaid/models/account_identity_match_score_all_of.rb +249 -0
  26. data/lib/plaid/models/account_product_access.rb +249 -0
  27. data/lib/plaid/models/account_product_access_nullable.rb +256 -0
  28. data/lib/plaid/models/account_selection_cardinality.rb +40 -0
  29. data/lib/plaid/models/account_subtype.rb +111 -0
  30. data/lib/plaid/models/account_type.rb +43 -0
  31. data/lib/plaid/models/accounts_balance_get_request.rb +254 -0
  32. data/lib/plaid/models/accounts_balance_get_request_options.rb +232 -0
  33. data/lib/plaid/models/accounts_get_request.rb +254 -0
  34. data/lib/plaid/models/accounts_get_request_options.rb +222 -0
  35. data/lib/plaid/models/accounts_get_response.rb +256 -0
  36. data/lib/plaid/models/ach_class.rb +41 -0
  37. data/lib/plaid/models/address.rb +234 -0
  38. data/lib/plaid/models/address_data.rb +273 -0
  39. data/lib/plaid/models/address_data_nullable.rb +280 -0
  40. data/lib/plaid/models/address_match_score.rb +232 -0
  41. data/lib/plaid/models/address_nullable.rb +241 -0
  42. data/lib/plaid/models/address_purpose_label.rb +40 -0
  43. data/lib/plaid/models/application.rb +365 -0
  44. data/lib/plaid/models/application_get_request.rb +255 -0
  45. data/lib/plaid/models/application_get_response.rb +239 -0
  46. data/lib/plaid/models/apr.rb +296 -0
  47. data/lib/plaid/models/asset.rb +280 -0
  48. data/lib/plaid/models/asset_detail.rb +347 -0
  49. data/lib/plaid/models/asset_holder.rb +224 -0
  50. data/lib/plaid/models/asset_holder_name.rb +225 -0
  51. data/lib/plaid/models/asset_owner.rb +221 -0
  52. data/lib/plaid/models/asset_owners.rb +227 -0
  53. data/lib/plaid/models/asset_report.rb +297 -0
  54. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +255 -0
  55. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +240 -0
  56. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +245 -0
  57. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +245 -0
  58. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +240 -0
  59. data/lib/plaid/models/asset_report_create_request.rb +323 -0
  60. data/lib/plaid/models/asset_report_create_request_options.rb +264 -0
  61. data/lib/plaid/models/asset_report_create_response.rb +255 -0
  62. data/lib/plaid/models/asset_report_filter_request.rb +262 -0
  63. data/lib/plaid/models/asset_report_filter_response.rb +255 -0
  64. data/lib/plaid/models/asset_report_freddie.rb +252 -0
  65. data/lib/plaid/models/asset_report_freddie_get_request.rb +245 -0
  66. data/lib/plaid/models/asset_report_freddie_get_response.rb +254 -0
  67. data/lib/plaid/models/asset_report_get_request.rb +278 -0
  68. data/lib/plaid/models/asset_report_get_request_options.rb +247 -0
  69. data/lib/plaid/models/asset_report_get_response.rb +256 -0
  70. data/lib/plaid/models/asset_report_item.rb +287 -0
  71. data/lib/plaid/models/asset_report_pdf_get_request.rb +254 -0
  72. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +247 -0
  73. data/lib/plaid/models/asset_report_refresh_request.rb +291 -0
  74. data/lib/plaid/models/asset_report_refresh_request_options.rb +241 -0
  75. data/lib/plaid/models/asset_report_refresh_response.rb +255 -0
  76. data/lib/plaid/models/asset_report_remove_request.rb +245 -0
  77. data/lib/plaid/models/asset_report_remove_response.rb +240 -0
  78. data/lib/plaid/models/asset_report_transaction.rb +487 -0
  79. data/lib/plaid/models/asset_report_transaction_all_of.rb +230 -0
  80. data/lib/plaid/models/asset_report_user.rb +287 -0
  81. data/lib/plaid/models/asset_transaction.rb +241 -0
  82. data/lib/plaid/models/asset_transaction_category_type.rb +144 -0
  83. data/lib/plaid/models/asset_transaction_description.rb +225 -0
  84. data/lib/plaid/models/asset_transaction_detail.rb +327 -0
  85. data/lib/plaid/models/asset_transaction_type.rb +39 -0
  86. data/lib/plaid/models/asset_transactions.rb +226 -0
  87. data/lib/plaid/models/asset_type.rb +42 -0
  88. data/lib/plaid/models/assets.rb +227 -0
  89. data/lib/plaid/models/assets_error_webhook.rb +265 -0
  90. data/lib/plaid/models/assets_product_ready_webhook.rb +255 -0
  91. data/lib/plaid/models/auth_get_numbers.rb +278 -0
  92. data/lib/plaid/models/auth_get_request.rb +254 -0
  93. data/lib/plaid/models/auth_get_request_options.rb +222 -0
  94. data/lib/plaid/models/auth_get_response.rb +270 -0
  95. data/lib/plaid/models/auth_metadata.rb +220 -0
  96. data/lib/plaid/models/auth_supported_methods.rb +255 -0
  97. data/lib/plaid/models/automatically_verified_webhook.rb +284 -0
  98. data/lib/plaid/models/bank_initiated_return_risk.rb +300 -0
  99. data/lib/plaid/models/bank_transfer.rb +453 -0
  100. data/lib/plaid/models/bank_transfer_balance.rb +240 -0
  101. data/lib/plaid/models/bank_transfer_balance_get_request.rb +241 -0
  102. data/lib/plaid/models/bank_transfer_balance_get_response.rb +250 -0
  103. data/lib/plaid/models/bank_transfer_cancel_request.rb +245 -0
  104. data/lib/plaid/models/bank_transfer_cancel_response.rb +225 -0
  105. data/lib/plaid/models/bank_transfer_create_request.rb +474 -0
  106. data/lib/plaid/models/bank_transfer_create_response.rb +239 -0
  107. data/lib/plaid/models/bank_transfer_direction.rb +40 -0
  108. data/lib/plaid/models/bank_transfer_event.rb +380 -0
  109. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
  110. data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
  111. data/lib/plaid/models/bank_transfer_event_list_request.rb +386 -0
  112. data/lib/plaid/models/bank_transfer_event_list_response.rb +241 -0
  113. data/lib/plaid/models/bank_transfer_event_sync_request.rb +305 -0
  114. data/lib/plaid/models/bank_transfer_event_sync_response.rb +241 -0
  115. data/lib/plaid/models/bank_transfer_event_type.rb +42 -0
  116. data/lib/plaid/models/bank_transfer_failure.rb +231 -0
  117. data/lib/plaid/models/bank_transfer_get_request.rb +245 -0
  118. data/lib/plaid/models/bank_transfer_get_response.rb +239 -0
  119. data/lib/plaid/models/bank_transfer_list_request.rb +340 -0
  120. data/lib/plaid/models/bank_transfer_list_response.rb +241 -0
  121. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +285 -0
  122. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +255 -0
  123. data/lib/plaid/models/bank_transfer_network.rb +40 -0
  124. data/lib/plaid/models/bank_transfer_status.rb +42 -0
  125. data/lib/plaid/models/bank_transfer_sweep.rb +270 -0
  126. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +245 -0
  127. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +239 -0
  128. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +302 -0
  129. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +241 -0
  130. data/lib/plaid/models/bank_transfer_type.rb +39 -0
  131. data/lib/plaid/models/bank_transfer_user.rb +246 -0
  132. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +254 -0
  133. data/lib/plaid/models/categories_get_response.rb +242 -0
  134. data/lib/plaid/models/category.rb +257 -0
  135. data/lib/plaid/models/cause.rb +342 -0
  136. data/lib/plaid/models/cause_all_of.rb +219 -0
  137. data/lib/plaid/models/client_provided_enhanced_transaction.rb +284 -0
  138. data/lib/plaid/models/client_provided_enriched_transaction.rb +293 -0
  139. data/lib/plaid/models/client_provided_raw_transaction.rb +270 -0
  140. data/lib/plaid/models/client_provided_transaction.rb +279 -0
  141. data/lib/plaid/models/connected_application.rb +309 -0
  142. data/lib/plaid/models/counterparty.rb +239 -0
  143. data/lib/plaid/models/counterparty_type.rb +41 -0
  144. data/lib/plaid/models/country_code.rb +53 -0
  145. data/lib/plaid/models/credit1099.rb +772 -0
  146. data/lib/plaid/models/credit1099_filer.rb +252 -0
  147. data/lib/plaid/models/credit1099_payer.rb +252 -0
  148. data/lib/plaid/models/credit1099_recipient.rb +274 -0
  149. data/lib/plaid/models/credit_account_subtype.rb +40 -0
  150. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +247 -0
  151. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +240 -0
  152. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +245 -0
  153. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +240 -0
  154. data/lib/plaid/models/credit_bank_income.rb +273 -0
  155. data/lib/plaid/models/credit_bank_income_account.rb +281 -0
  156. data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
  157. data/lib/plaid/models/credit_bank_income_category.rb +51 -0
  158. data/lib/plaid/models/credit_bank_income_cause.rb +259 -0
  159. data/lib/plaid/models/credit_bank_income_error_type.rb +53 -0
  160. data/lib/plaid/models/credit_bank_income_get_request.rb +249 -0
  161. data/lib/plaid/models/credit_bank_income_get_request_options.rb +222 -0
  162. data/lib/plaid/models/credit_bank_income_get_response.rb +236 -0
  163. data/lib/plaid/models/credit_bank_income_historical_summary.rb +273 -0
  164. data/lib/plaid/models/credit_bank_income_item.rb +274 -0
  165. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +42 -0
  166. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +245 -0
  167. data/lib/plaid/models/credit_bank_income_refresh_request.rb +254 -0
  168. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +230 -0
  169. data/lib/plaid/models/credit_bank_income_refresh_response.rb +225 -0
  170. data/lib/plaid/models/credit_bank_income_source.rb +309 -0
  171. data/lib/plaid/models/credit_bank_income_summary.rb +303 -0
  172. data/lib/plaid/models/credit_bank_income_transaction.rb +304 -0
  173. data/lib/plaid/models/credit_bank_income_warning.rb +237 -0
  174. data/lib/plaid/models/credit_bank_income_warning_code.rb +41 -0
  175. data/lib/plaid/models/credit_bank_income_warning_type.rb +38 -0
  176. data/lib/plaid/models/credit_card_liability.rb +315 -0
  177. data/lib/plaid/models/credit_category.rb +240 -0
  178. data/lib/plaid/models/credit_document_metadata.rb +258 -0
  179. data/lib/plaid/models/credit_employer_verification.rb +221 -0
  180. data/lib/plaid/models/credit_employment_get_request.rb +245 -0
  181. data/lib/plaid/models/credit_employment_get_response.rb +242 -0
  182. data/lib/plaid/models/credit_employment_item.rb +251 -0
  183. data/lib/plaid/models/credit_employment_verification.rb +315 -0
  184. data/lib/plaid/models/credit_filter.rb +227 -0
  185. data/lib/plaid/models/credit_pay_stub.rb +319 -0
  186. data/lib/plaid/models/credit_pay_stub_address.rb +265 -0
  187. data/lib/plaid/models/credit_pay_stub_deductions.rb +240 -0
  188. data/lib/plaid/models/credit_pay_stub_earnings.rb +240 -0
  189. data/lib/plaid/models/credit_pay_stub_employee.rb +260 -0
  190. data/lib/plaid/models/credit_pay_stub_employer.rb +235 -0
  191. data/lib/plaid/models/credit_pay_stub_net_pay.rb +265 -0
  192. data/lib/plaid/models/credit_payroll_income_get_request.rb +240 -0
  193. data/lib/plaid/models/credit_payroll_income_get_response.rb +252 -0
  194. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +282 -0
  195. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +239 -0
  196. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +240 -0
  197. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +240 -0
  198. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +240 -0
  199. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +252 -0
  200. data/lib/plaid/models/credit_platform_ids.rb +243 -0
  201. data/lib/plaid/models/credit_relay_create_request.rb +273 -0
  202. data/lib/plaid/models/credit_relay_create_response.rb +240 -0
  203. data/lib/plaid/models/credit_relay_get_request.rb +259 -0
  204. data/lib/plaid/models/credit_relay_refresh_request.rb +270 -0
  205. data/lib/plaid/models/credit_relay_refresh_response.rb +249 -0
  206. data/lib/plaid/models/credit_relay_remove_request.rb +245 -0
  207. data/lib/plaid/models/credit_relay_remove_response.rb +240 -0
  208. data/lib/plaid/models/credit_session.rb +251 -0
  209. data/lib/plaid/models/credit_session_bank_income_result.rb +239 -0
  210. data/lib/plaid/models/credit_session_bank_income_status.rb +40 -0
  211. data/lib/plaid/models/credit_session_document_income_result.rb +240 -0
  212. data/lib/plaid/models/credit_session_error.rb +251 -0
  213. data/lib/plaid/models/credit_session_item_add_result.rb +240 -0
  214. data/lib/plaid/models/credit_session_payroll_income_result.rb +250 -0
  215. data/lib/plaid/models/credit_session_results.rb +256 -0
  216. data/lib/plaid/models/credit_sessions_get_request.rb +245 -0
  217. data/lib/plaid/models/credit_sessions_get_response.rb +237 -0
  218. data/lib/plaid/models/credit_w2.rb +486 -0
  219. data/lib/plaid/models/customer_initiated_return_risk.rb +300 -0
  220. data/lib/plaid/models/dashboard_user.rb +269 -0
  221. data/lib/plaid/models/dashboard_user_get_request.rb +245 -0
  222. data/lib/plaid/models/dashboard_user_get_response.rb +284 -0
  223. data/lib/plaid/models/dashboard_user_list_request.rb +241 -0
  224. data/lib/plaid/models/dashboard_user_list_response.rb +253 -0
  225. data/lib/plaid/models/dashboard_user_status.rb +40 -0
  226. data/lib/plaid/models/date_range.rb +240 -0
  227. data/lib/plaid/models/deductions.rb +262 -0
  228. data/lib/plaid/models/deductions_breakdown.rb +265 -0
  229. data/lib/plaid/models/deductions_total.rb +254 -0
  230. data/lib/plaid/models/default_update_webhook.rb +294 -0
  231. data/lib/plaid/models/deposit_switch_address_data.rb +285 -0
  232. data/lib/plaid/models/deposit_switch_alt_create_request.rb +312 -0
  233. data/lib/plaid/models/deposit_switch_alt_create_response.rb +240 -0
  234. data/lib/plaid/models/deposit_switch_create_request.rb +314 -0
  235. data/lib/plaid/models/deposit_switch_create_request_options.rb +251 -0
  236. data/lib/plaid/models/deposit_switch_create_response.rb +240 -0
  237. data/lib/plaid/models/deposit_switch_get_request.rb +245 -0
  238. data/lib/plaid/models/deposit_switch_get_response.rb +448 -0
  239. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +259 -0
  240. data/lib/plaid/models/deposit_switch_target_account.rb +304 -0
  241. data/lib/plaid/models/deposit_switch_target_user.rb +289 -0
  242. data/lib/plaid/models/deposit_switch_token_create_request.rb +245 -0
  243. data/lib/plaid/models/deposit_switch_token_create_response.rb +255 -0
  244. data/lib/plaid/models/depository_account_subtype.rb +47 -0
  245. data/lib/plaid/models/depository_filter.rb +227 -0
  246. data/lib/plaid/models/disbursement_limits.rb +255 -0
  247. data/lib/plaid/models/distribution_breakdown.rb +296 -0
  248. data/lib/plaid/models/doc_type.rb +49 -0
  249. data/lib/plaid/models/document_analysis.rb +248 -0
  250. data/lib/plaid/models/document_authenticity_match_code.rb +41 -0
  251. data/lib/plaid/models/document_date_of_birth_match_code.rb +40 -0
  252. data/lib/plaid/models/document_metadata.rb +249 -0
  253. data/lib/plaid/models/document_name_match_code.rb +40 -0
  254. data/lib/plaid/models/document_risk_signal.rb +297 -0
  255. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +225 -0
  256. data/lib/plaid/models/document_risk_signals_object.rb +255 -0
  257. data/lib/plaid/models/document_risk_summary.rb +221 -0
  258. data/lib/plaid/models/document_status.rb +40 -0
  259. data/lib/plaid/models/documentary_verification.rb +242 -0
  260. data/lib/plaid/models/documentary_verification_document.rb +277 -0
  261. data/lib/plaid/models/earnings.rb +252 -0
  262. data/lib/plaid/models/earnings_breakdown.rb +297 -0
  263. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +47 -0
  264. data/lib/plaid/models/earnings_total.rb +283 -0
  265. data/lib/plaid/models/email.rb +289 -0
  266. data/lib/plaid/models/email_address_match_score.rb +221 -0
  267. data/lib/plaid/models/employee.rb +255 -0
  268. data/lib/plaid/models/employee_income_summary_field_string.rb +246 -0
  269. data/lib/plaid/models/employer.rb +265 -0
  270. data/lib/plaid/models/employer_income_summary_field_string.rb +246 -0
  271. data/lib/plaid/models/employer_verification.rb +221 -0
  272. data/lib/plaid/models/employers_search_request.rb +262 -0
  273. data/lib/plaid/models/employers_search_response.rb +242 -0
  274. data/lib/plaid/models/employment_details.rb +230 -0
  275. data/lib/plaid/models/employment_verification.rb +271 -0
  276. data/lib/plaid/models/employment_verification_get_request.rb +245 -0
  277. data/lib/plaid/models/employment_verification_get_response.rb +242 -0
  278. data/lib/plaid/models/employment_verification_status.rb +40 -0
  279. data/lib/plaid/models/enhancements.rb +342 -0
  280. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  281. data/lib/plaid/models/enrichments.rb +342 -0
  282. data/lib/plaid/models/entity_document.rb +260 -0
  283. data/lib/plaid/models/entity_document_type.rb +43 -0
  284. data/lib/plaid/models/entity_screening_hit_analysis.rb +279 -0
  285. data/lib/plaid/models/entity_screening_hit_data.rb +282 -0
  286. data/lib/plaid/models/entity_screening_hit_documents_items.rb +228 -0
  287. data/lib/plaid/models/entity_screening_hit_emails.rb +225 -0
  288. data/lib/plaid/models/entity_screening_hit_emails_items.rb +228 -0
  289. data/lib/plaid/models/entity_screening_hit_names.rb +254 -0
  290. data/lib/plaid/models/entity_screening_hit_names_items.rb +228 -0
  291. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +239 -0
  292. data/lib/plaid/models/entity_screening_hit_urls.rb +225 -0
  293. data/lib/plaid/models/entity_screening_hit_urls_items.rb +228 -0
  294. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +228 -0
  295. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +265 -0
  296. data/lib/plaid/models/entity_watchlist_code.rb +50 -0
  297. data/lib/plaid/models/entity_watchlist_program.rb +363 -0
  298. data/lib/plaid/models/entity_watchlist_screening.rb +306 -0
  299. data/lib/plaid/models/entity_watchlist_screening_hit.rb +351 -0
  300. data/lib/plaid/models/entity_watchlist_screening_review.rb +301 -0
  301. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +365 -0
  302. data/lib/plaid/models/entity_watchlist_search_terms.rb +350 -0
  303. data/lib/plaid/models/expiration_date.rb +40 -0
  304. data/lib/plaid/models/external_payment_initiation_consent_options.rb +296 -0
  305. data/lib/plaid/models/external_payment_options.rb +306 -0
  306. data/lib/plaid/models/external_payment_refund_details.rb +246 -0
  307. data/lib/plaid/models/external_payment_schedule_base.rb +261 -0
  308. data/lib/plaid/models/external_payment_schedule_get.rb +283 -0
  309. data/lib/plaid/models/external_payment_schedule_request.rb +283 -0
  310. data/lib/plaid/models/fdx_content_types.rb +43 -0
  311. data/lib/plaid/models/fdx_hateoas_link.rb +256 -0
  312. data/lib/plaid/models/fdx_hateoas_link_action.rb +42 -0
  313. data/lib/plaid/models/fdx_notification.rb +332 -0
  314. data/lib/plaid/models/fdx_notification_category.rb +42 -0
  315. data/lib/plaid/models/fdx_notification_payload.rb +238 -0
  316. data/lib/plaid/models/fdx_notification_payload_id_type.rb +42 -0
  317. data/lib/plaid/models/fdx_notification_priority.rb +40 -0
  318. data/lib/plaid/models/fdx_notification_severity.rb +42 -0
  319. data/lib/plaid/models/fdx_notification_type.rb +43 -0
  320. data/lib/plaid/models/fdx_party.rb +288 -0
  321. data/lib/plaid/models/fdx_party_registry.rb +41 -0
  322. data/lib/plaid/models/fdx_party_type.rb +43 -0
  323. data/lib/plaid/models/fdxfi_attribute.rb +230 -0
  324. data/lib/plaid/models/form1099_type.rb +40 -0
  325. data/lib/plaid/models/generic_screening_hit_location_items.rb +228 -0
  326. data/lib/plaid/models/health_incident.rb +268 -0
  327. data/lib/plaid/models/historical_balance.rb +262 -0
  328. data/lib/plaid/models/historical_update_webhook.rb +294 -0
  329. data/lib/plaid/models/holding.rb +340 -0
  330. data/lib/plaid/models/holdings_default_update_webhook.rb +309 -0
  331. data/lib/plaid/models/holdings_override.rb +289 -0
  332. data/lib/plaid/models/id_number_type.rb +72 -0
  333. data/lib/plaid/models/identity_default_update_webhook.rb +296 -0
  334. data/lib/plaid/models/identity_get_request.rb +254 -0
  335. data/lib/plaid/models/identity_get_request_options.rb +222 -0
  336. data/lib/plaid/models/identity_get_response.rb +256 -0
  337. data/lib/plaid/models/identity_match_request.rb +263 -0
  338. data/lib/plaid/models/identity_match_request_options.rb +222 -0
  339. data/lib/plaid/models/identity_match_response.rb +256 -0
  340. data/lib/plaid/models/identity_match_user.rb +253 -0
  341. data/lib/plaid/models/identity_update_types.rb +41 -0
  342. data/lib/plaid/models/identity_verification.rb +396 -0
  343. data/lib/plaid/models/identity_verification_create_request.rb +302 -0
  344. data/lib/plaid/models/identity_verification_create_response.rb +411 -0
  345. data/lib/plaid/models/identity_verification_get_request.rb +245 -0
  346. data/lib/plaid/models/identity_verification_get_response.rb +411 -0
  347. data/lib/plaid/models/identity_verification_list_request.rb +292 -0
  348. data/lib/plaid/models/identity_verification_list_response.rb +253 -0
  349. data/lib/plaid/models/identity_verification_request_user.rb +307 -0
  350. data/lib/plaid/models/identity_verification_retried_webhook.rb +265 -0
  351. data/lib/plaid/models/identity_verification_retry_request.rb +305 -0
  352. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +270 -0
  353. data/lib/plaid/models/identity_verification_retry_response.rb +411 -0
  354. data/lib/plaid/models/identity_verification_status.rb +43 -0
  355. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +265 -0
  356. data/lib/plaid/models/identity_verification_step_status.rb +48 -0
  357. data/lib/plaid/models/identity_verification_step_summary.rb +308 -0
  358. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +265 -0
  359. data/lib/plaid/models/identity_verification_template_reference.rb +240 -0
  360. data/lib/plaid/models/identity_verification_user_address.rb +301 -0
  361. data/lib/plaid/models/identity_verification_user_data.rb +284 -0
  362. data/lib/plaid/models/image_quality.rb +40 -0
  363. data/lib/plaid/models/incident_update.rb +274 -0
  364. data/lib/plaid/models/income_breakdown.rb +253 -0
  365. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  366. data/lib/plaid/models/income_override.rb +222 -0
  367. data/lib/plaid/models/income_summary.rb +300 -0
  368. data/lib/plaid/models/income_summary_field_number.rb +239 -0
  369. data/lib/plaid/models/income_summary_field_string.rb +239 -0
  370. data/lib/plaid/models/income_verification_create_request.rb +264 -0
  371. data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
  372. data/lib/plaid/models/income_verification_create_response.rb +240 -0
  373. data/lib/plaid/models/income_verification_documents_download_request.rb +263 -0
  374. data/lib/plaid/models/income_verification_payroll_flow_type.rb +39 -0
  375. data/lib/plaid/models/income_verification_paystubs_get_request.rb +252 -0
  376. data/lib/plaid/models/income_verification_paystubs_get_response.rb +263 -0
  377. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  378. data/lib/plaid/models/income_verification_precheck_employer.rb +253 -0
  379. data/lib/plaid/models/income_verification_precheck_employer_address.rb +267 -0
  380. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +260 -0
  381. data/lib/plaid/models/income_verification_precheck_military_info.rb +232 -0
  382. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +221 -0
  383. data/lib/plaid/models/income_verification_precheck_request.rb +291 -0
  384. data/lib/plaid/models/income_verification_precheck_response.rb +254 -0
  385. data/lib/plaid/models/income_verification_precheck_user.rb +253 -0
  386. data/lib/plaid/models/income_verification_source_type.rb +39 -0
  387. data/lib/plaid/models/income_verification_status_webhook.rb +294 -0
  388. data/lib/plaid/models/income_verification_taxforms_get_request.rb +252 -0
  389. data/lib/plaid/models/income_verification_taxforms_get_response.rb +263 -0
  390. data/lib/plaid/models/income_verification_webhook_status.rb +224 -0
  391. data/lib/plaid/models/individual_name.rb +240 -0
  392. data/lib/plaid/models/individual_screening_hit_names.rb +254 -0
  393. data/lib/plaid/models/individual_watchlist_code.rb +59 -0
  394. data/lib/plaid/models/individual_watchlist_program.rb +363 -0
  395. data/lib/plaid/models/inflow_model.rb +285 -0
  396. data/lib/plaid/models/initial_update_webhook.rb +295 -0
  397. data/lib/plaid/models/institution.rb +369 -0
  398. data/lib/plaid/models/institution_status.rb +303 -0
  399. data/lib/plaid/models/institutions_get_by_id_request.rb +292 -0
  400. data/lib/plaid/models/institutions_get_by_id_request_options.rb +258 -0
  401. data/lib/plaid/models/institutions_get_by_id_response.rb +239 -0
  402. data/lib/plaid/models/institutions_get_request.rb +358 -0
  403. data/lib/plaid/models/institutions_get_request_options.rb +298 -0
  404. data/lib/plaid/models/institutions_get_response.rb +257 -0
  405. data/lib/plaid/models/institutions_search_account_filter.rb +254 -0
  406. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +232 -0
  407. data/lib/plaid/models/institutions_search_request.rb +322 -0
  408. data/lib/plaid/models/institutions_search_request_options.rb +267 -0
  409. data/lib/plaid/models/institutions_search_response.rb +242 -0
  410. data/lib/plaid/models/investment_account_subtype.rb +87 -0
  411. data/lib/plaid/models/investment_filter.rb +227 -0
  412. data/lib/plaid/models/investment_holdings_get_request_options.rb +222 -0
  413. data/lib/plaid/models/investment_transaction.rb +398 -0
  414. data/lib/plaid/models/investment_transaction_subtype.rb +85 -0
  415. data/lib/plaid/models/investment_transaction_type.rb +43 -0
  416. data/lib/plaid/models/investments_default_update_webhook.rb +309 -0
  417. data/lib/plaid/models/investments_holdings_get_request.rb +254 -0
  418. data/lib/plaid/models/investments_holdings_get_response.rb +290 -0
  419. data/lib/plaid/models/investments_transactions_get_request.rb +284 -0
  420. data/lib/plaid/models/investments_transactions_get_request_options.rb +289 -0
  421. data/lib/plaid/models/investments_transactions_get_response.rb +305 -0
  422. data/lib/plaid/models/investments_transactions_override.rb +319 -0
  423. data/lib/plaid/models/issuing_country.rb +39 -0
  424. data/lib/plaid/models/item.rb +375 -0
  425. data/lib/plaid/models/item_access_token_invalidate_request.rb +245 -0
  426. data/lib/plaid/models/item_access_token_invalidate_response.rb +240 -0
  427. data/lib/plaid/models/item_application_list_request.rb +241 -0
  428. data/lib/plaid/models/item_application_list_response.rb +237 -0
  429. data/lib/plaid/models/item_application_list_user_auth.rb +232 -0
  430. data/lib/plaid/models/item_application_scopes_update_request.rb +298 -0
  431. data/lib/plaid/models/item_application_scopes_update_response.rb +225 -0
  432. data/lib/plaid/models/item_error_webhook.rb +279 -0
  433. data/lib/plaid/models/item_get_request.rb +245 -0
  434. data/lib/plaid/models/item_get_response.rb +249 -0
  435. data/lib/plaid/models/item_import_request.rb +291 -0
  436. data/lib/plaid/models/item_import_request_options.rb +220 -0
  437. data/lib/plaid/models/item_import_request_user_auth.rb +240 -0
  438. data/lib/plaid/models/item_import_response.rb +240 -0
  439. data/lib/plaid/models/item_product_ready_webhook.rb +279 -0
  440. data/lib/plaid/models/item_public_token_create_request.rb +245 -0
  441. data/lib/plaid/models/item_public_token_create_response.rb +249 -0
  442. data/lib/plaid/models/item_public_token_exchange_request.rb +245 -0
  443. data/lib/plaid/models/item_public_token_exchange_response.rb +255 -0
  444. data/lib/plaid/models/item_remove_request.rb +245 -0
  445. data/lib/plaid/models/item_remove_response.rb +225 -0
  446. data/lib/plaid/models/item_status.rb +240 -0
  447. data/lib/plaid/models/item_status_investments.rb +232 -0
  448. data/lib/plaid/models/item_status_last_webhook.rb +232 -0
  449. data/lib/plaid/models/item_status_nullable.rb +247 -0
  450. data/lib/plaid/models/item_status_transactions.rb +232 -0
  451. data/lib/plaid/models/item_webhook_update_request.rb +256 -0
  452. data/lib/plaid/models/item_webhook_update_response.rb +239 -0
  453. data/lib/plaid/models/jwk_public_key.rb +341 -0
  454. data/lib/plaid/models/jwt_header.rb +224 -0
  455. data/lib/plaid/models/kyc_check_address_summary.rb +252 -0
  456. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +224 -0
  457. data/lib/plaid/models/kyc_check_details.rb +295 -0
  458. data/lib/plaid/models/kyc_check_id_number_summary.rb +224 -0
  459. data/lib/plaid/models/kyc_check_name_summary.rb +224 -0
  460. data/lib/plaid/models/kyc_check_phone_summary.rb +224 -0
  461. data/lib/plaid/models/liabilities_default_update_webhook.rb +313 -0
  462. data/lib/plaid/models/liabilities_get_request.rb +254 -0
  463. data/lib/plaid/models/liabilities_get_request_options.rb +222 -0
  464. data/lib/plaid/models/liabilities_get_response.rb +270 -0
  465. data/lib/plaid/models/liabilities_object.rb +249 -0
  466. data/lib/plaid/models/liability_override.rb +566 -0
  467. data/lib/plaid/models/link_delivery_create_request.rb +274 -0
  468. data/lib/plaid/models/link_delivery_create_response.rb +255 -0
  469. data/lib/plaid/models/link_delivery_delivery_method.rb +39 -0
  470. data/lib/plaid/models/link_delivery_get_request.rb +245 -0
  471. data/lib/plaid/models/link_delivery_get_response.rb +277 -0
  472. data/lib/plaid/models/link_delivery_session_status.rb +41 -0
  473. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +245 -0
  474. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +240 -0
  475. data/lib/plaid/models/link_token_account_filters.rb +246 -0
  476. data/lib/plaid/models/link_token_create_credit_filter.rb +222 -0
  477. data/lib/plaid/models/link_token_create_depository_filter.rb +222 -0
  478. data/lib/plaid/models/link_token_create_institution_data.rb +220 -0
  479. data/lib/plaid/models/link_token_create_investment_filter.rb +222 -0
  480. data/lib/plaid/models/link_token_create_loan_filter.rb +222 -0
  481. data/lib/plaid/models/link_token_create_request.rb +505 -0
  482. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +246 -0
  483. data/lib/plaid/models/link_token_create_request_auth.rb +296 -0
  484. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +225 -0
  485. data/lib/plaid/models/link_token_create_request_identity_verification.rb +246 -0
  486. data/lib/plaid/models/link_token_create_request_income_verification.rb +294 -0
  487. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +233 -0
  488. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +233 -0
  489. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +264 -0
  490. data/lib/plaid/models/link_token_create_request_transfer.rb +230 -0
  491. data/lib/plaid/models/link_token_create_request_update.rb +222 -0
  492. data/lib/plaid/models/link_token_create_request_user.rb +324 -0
  493. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +267 -0
  494. data/lib/plaid/models/link_token_create_response.rb +255 -0
  495. data/lib/plaid/models/link_token_eu_config.rb +220 -0
  496. data/lib/plaid/models/link_token_get_metadata_response.rb +306 -0
  497. data/lib/plaid/models/link_token_get_request.rb +245 -0
  498. data/lib/plaid/models/link_token_get_response.rb +276 -0
  499. data/lib/plaid/models/link_token_investments.rb +220 -0
  500. data/lib/plaid/models/loan.rb +224 -0
  501. data/lib/plaid/models/loan_account_subtype.rb +49 -0
  502. data/lib/plaid/models/loan_filter.rb +227 -0
  503. data/lib/plaid/models/loan_identifier.rb +231 -0
  504. data/lib/plaid/models/loan_identifier_type.rb +39 -0
  505. data/lib/plaid/models/loan_identifiers.rb +224 -0
  506. data/lib/plaid/models/loans.rb +224 -0
  507. data/lib/plaid/models/location.rb +298 -0
  508. data/lib/plaid/models/match_summary.rb +224 -0
  509. data/lib/plaid/models/match_summary_code.rb +42 -0
  510. data/lib/plaid/models/meta.rb +311 -0
  511. data/lib/plaid/models/mfa.rb +285 -0
  512. data/lib/plaid/models/mortgage_interest_rate.rb +232 -0
  513. data/lib/plaid/models/mortgage_liability.rb +444 -0
  514. data/lib/plaid/models/mortgage_property_address.rb +265 -0
  515. data/lib/plaid/models/multi_document_risk_signal.rb +244 -0
  516. data/lib/plaid/models/name_match_score.rb +254 -0
  517. data/lib/plaid/models/net_pay.rb +274 -0
  518. data/lib/plaid/models/new_accounts_available_webhook.rb +259 -0
  519. data/lib/plaid/models/numbers.rb +290 -0
  520. data/lib/plaid/models/numbers_ach.rb +288 -0
  521. data/lib/plaid/models/numbers_ach_nullable.rb +295 -0
  522. data/lib/plaid/models/numbers_bacs.rb +255 -0
  523. data/lib/plaid/models/numbers_bacs_nullable.rb +262 -0
  524. data/lib/plaid/models/numbers_eft.rb +270 -0
  525. data/lib/plaid/models/numbers_eft_nullable.rb +277 -0
  526. data/lib/plaid/models/numbers_iban_nullable.rb +210 -0
  527. data/lib/plaid/models/numbers_international.rb +255 -0
  528. data/lib/plaid/models/numbers_international_iban.rb +300 -0
  529. data/lib/plaid/models/numbers_international_nullable.rb +262 -0
  530. data/lib/plaid/models/originator.rb +239 -0
  531. data/lib/plaid/models/override_account_type.rb +43 -0
  532. data/lib/plaid/models/override_accounts.rb +393 -0
  533. data/lib/plaid/models/owner.rb +278 -0
  534. data/lib/plaid/models/owner_override.rb +278 -0
  535. data/lib/plaid/models/ownership_type.rb +42 -0
  536. data/lib/plaid/models/parties.rb +226 -0
  537. data/lib/plaid/models/partner_customer_create_request.rb +398 -0
  538. data/lib/plaid/models/partner_customer_create_response.rb +229 -0
  539. data/lib/plaid/models/partner_customer_enable_request.rb +244 -0
  540. data/lib/plaid/models/partner_customer_enable_response.rb +230 -0
  541. data/lib/plaid/models/partner_customer_get_request.rb +244 -0
  542. data/lib/plaid/models/partner_customer_get_response.rb +229 -0
  543. data/lib/plaid/models/partner_customer_remove_request.rb +244 -0
  544. data/lib/plaid/models/partner_customer_remove_response.rb +220 -0
  545. data/lib/plaid/models/partner_end_customer.rb +237 -0
  546. data/lib/plaid/models/partner_end_customer_address.rb +256 -0
  547. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +238 -0
  548. data/lib/plaid/models/partner_end_customer_billing_contact.rb +237 -0
  549. data/lib/plaid/models/partner_end_customer_secrets.rb +230 -0
  550. data/lib/plaid/models/partner_end_customer_status.rb +41 -0
  551. data/lib/plaid/models/partner_end_customer_technical_contact.rb +237 -0
  552. data/lib/plaid/models/partner_end_customer_with_secrets.rb +254 -0
  553. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +218 -0
  554. data/lib/plaid/models/party.rb +252 -0
  555. data/lib/plaid/models/party_individual.rb +224 -0
  556. data/lib/plaid/models/party_role_type.rb +38 -0
  557. data/lib/plaid/models/pay.rb +232 -0
  558. data/lib/plaid/models/pay_frequency.rb +238 -0
  559. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  560. data/lib/plaid/models/pay_period_details.rb +332 -0
  561. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +265 -0
  562. data/lib/plaid/models/pay_stub_deductions_total.rb +254 -0
  563. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +287 -0
  564. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +298 -0
  565. data/lib/plaid/models/pay_stub_earnings_total.rb +265 -0
  566. data/lib/plaid/models/pay_stub_pay_period_details.rb +314 -0
  567. data/lib/plaid/models/pay_stub_taxpayer_id.rb +232 -0
  568. data/lib/plaid/models/payment_amount.rb +239 -0
  569. data/lib/plaid/models/payment_amount_currency.rb +45 -0
  570. data/lib/plaid/models/payment_amount_nullable.rb +239 -0
  571. data/lib/plaid/models/payment_amount_refunded.rb +246 -0
  572. data/lib/plaid/models/payment_amount_to_refund.rb +246 -0
  573. data/lib/plaid/models/payment_channel.rb +40 -0
  574. data/lib/plaid/models/payment_consent_max_payment_amount.rb +246 -0
  575. data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
  576. data/lib/plaid/models/payment_consent_periodic_amount.rb +252 -0
  577. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +246 -0
  578. data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
  579. data/lib/plaid/models/payment_consent_valid_date_time.rb +232 -0
  580. data/lib/plaid/models/payment_initiation_address.rb +383 -0
  581. data/lib/plaid/models/payment_initiation_consent.rb +357 -0
  582. data/lib/plaid/models/payment_initiation_consent_constraints.rb +272 -0
  583. data/lib/plaid/models/payment_initiation_consent_create_request.rb +373 -0
  584. data/lib/plaid/models/payment_initiation_consent_create_response.rb +254 -0
  585. data/lib/plaid/models/payment_initiation_consent_get_request.rb +266 -0
  586. data/lib/plaid/models/payment_initiation_consent_get_response.rb +380 -0
  587. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +325 -0
  588. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +254 -0
  589. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +266 -0
  590. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +220 -0
  591. data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
  592. data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
  593. data/lib/plaid/models/payment_initiation_metadata.rb +282 -0
  594. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +289 -0
  595. data/lib/plaid/models/payment_initiation_payment.rb +425 -0
  596. data/lib/plaid/models/payment_initiation_payment_create_request.rb +344 -0
  597. data/lib/plaid/models/payment_initiation_payment_create_response.rb +254 -0
  598. data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
  599. data/lib/plaid/models/payment_initiation_payment_get_request.rb +266 -0
  600. data/lib/plaid/models/payment_initiation_payment_get_response.rb +448 -0
  601. data/lib/plaid/models/payment_initiation_payment_list_request.rb +308 -0
  602. data/lib/plaid/models/payment_initiation_payment_list_response.rb +253 -0
  603. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +365 -0
  604. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +254 -0
  605. data/lib/plaid/models/payment_initiation_payment_status.rb +51 -0
  606. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +266 -0
  607. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +255 -0
  608. data/lib/plaid/models/payment_initiation_recipient.rb +271 -0
  609. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +323 -0
  610. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +240 -0
  611. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +266 -0
  612. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +294 -0
  613. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +219 -0
  614. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +230 -0
  615. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +242 -0
  616. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +257 -0
  617. data/lib/plaid/models/payment_limits.rb +255 -0
  618. data/lib/plaid/models/payment_meta.rb +298 -0
  619. data/lib/plaid/models/payment_profile_create_request.rb +230 -0
  620. data/lib/plaid/models/payment_profile_create_response.rb +240 -0
  621. data/lib/plaid/models/payment_profile_get_request.rb +245 -0
  622. data/lib/plaid/models/payment_profile_get_response.rb +280 -0
  623. data/lib/plaid/models/payment_profile_remove_request.rb +245 -0
  624. data/lib/plaid/models/payment_profile_remove_response.rb +225 -0
  625. data/lib/plaid/models/payment_profile_status.rb +40 -0
  626. data/lib/plaid/models/payment_schedule_interval.rb +39 -0
  627. data/lib/plaid/models/payment_scheme.rb +41 -0
  628. data/lib/plaid/models/payment_status_update_webhook.rb +366 -0
  629. data/lib/plaid/models/payroll_income_account_data.rb +246 -0
  630. data/lib/plaid/models/payroll_income_object.rb +272 -0
  631. data/lib/plaid/models/payroll_income_rate_of_pay.rb +232 -0
  632. data/lib/plaid/models/payroll_item.rb +308 -0
  633. data/lib/plaid/models/payroll_item_status.rb +221 -0
  634. data/lib/plaid/models/payroll_risk_signals_item.rb +242 -0
  635. data/lib/plaid/models/paystub.rb +347 -0
  636. data/lib/plaid/models/paystub_address.rb +298 -0
  637. data/lib/plaid/models/paystub_deduction.rb +243 -0
  638. data/lib/plaid/models/paystub_details.rb +264 -0
  639. data/lib/plaid/models/paystub_employer.rb +230 -0
  640. data/lib/plaid/models/paystub_override.rb +248 -0
  641. data/lib/plaid/models/paystub_override_employee.rb +229 -0
  642. data/lib/plaid/models/paystub_override_employee_address.rb +260 -0
  643. data/lib/plaid/models/paystub_override_employer.rb +220 -0
  644. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  645. data/lib/plaid/models/paystub_ytd_details.rb +232 -0
  646. data/lib/plaid/models/pending_expiration_webhook.rb +284 -0
  647. data/lib/plaid/models/personal_finance_category.rb +240 -0
  648. data/lib/plaid/models/phone_number.rb +289 -0
  649. data/lib/plaid/models/phone_number_match_score.rb +221 -0
  650. data/lib/plaid/models/phone_type.rb +39 -0
  651. data/lib/plaid/models/physical_document_category.rb +42 -0
  652. data/lib/plaid/models/physical_document_extracted_data.rb +293 -0
  653. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +266 -0
  654. data/lib/plaid/models/physical_document_images.rb +269 -0
  655. data/lib/plaid/models/plaid_error.rb +319 -0
  656. data/lib/plaid/models/plaid_error_type.rb +51 -0
  657. data/lib/plaid/models/platform_ids.rb +243 -0
  658. data/lib/plaid/models/po_box_status.rb +40 -0
  659. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +260 -0
  660. data/lib/plaid/models/processor_auth_get_request.rb +245 -0
  661. data/lib/plaid/models/processor_auth_get_response.rb +253 -0
  662. data/lib/plaid/models/processor_balance_get_request.rb +254 -0
  663. data/lib/plaid/models/processor_balance_get_request_options.rb +220 -0
  664. data/lib/plaid/models/processor_balance_get_response.rb +239 -0
  665. data/lib/plaid/models/processor_bank_transfer_create_request.rb +459 -0
  666. data/lib/plaid/models/processor_bank_transfer_create_response.rb +239 -0
  667. data/lib/plaid/models/processor_identity_get_request.rb +245 -0
  668. data/lib/plaid/models/processor_identity_get_response.rb +239 -0
  669. data/lib/plaid/models/processor_number.rb +250 -0
  670. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +260 -0
  671. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +240 -0
  672. data/lib/plaid/models/processor_token_create_request.rb +309 -0
  673. data/lib/plaid/models/processor_token_create_response.rb +240 -0
  674. data/lib/plaid/models/product_access.rb +327 -0
  675. data/lib/plaid/models/product_status.rb +288 -0
  676. data/lib/plaid/models/product_status_breakdown.rb +299 -0
  677. data/lib/plaid/models/products.rb +54 -0
  678. data/lib/plaid/models/program_name_sensitivity.rb +41 -0
  679. data/lib/plaid/models/projected_income_summary_field_number.rb +246 -0
  680. data/lib/plaid/models/pslf_status.rb +243 -0
  681. data/lib/plaid/models/recaptcha_required_error.rb +314 -0
  682. data/lib/plaid/models/recipient_bacs.rb +282 -0
  683. data/lib/plaid/models/recipient_bacs_nullable.rb +289 -0
  684. data/lib/plaid/models/recurring_transaction_frequency.rb +42 -0
  685. data/lib/plaid/models/recurring_transactions_update_webhook.rb +286 -0
  686. data/lib/plaid/models/recurring_transfer.rb +431 -0
  687. data/lib/plaid/models/removed_transaction.rb +220 -0
  688. data/lib/plaid/models/report_type.rb +39 -0
  689. data/lib/plaid/models/reporting_information.rb +225 -0
  690. data/lib/plaid/models/risk_signal_document_reference.rb +231 -0
  691. data/lib/plaid/models/role.rb +224 -0
  692. data/lib/plaid/models/role_detail.rb +224 -0
  693. data/lib/plaid/models/roles.rb +224 -0
  694. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +245 -0
  695. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +225 -0
  696. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +270 -0
  697. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +225 -0
  698. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +319 -0
  699. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +225 -0
  700. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +303 -0
  701. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +240 -0
  702. data/lib/plaid/models/sandbox_item_reset_login_request.rb +245 -0
  703. data/lib/plaid/models/sandbox_item_reset_login_response.rb +240 -0
  704. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +309 -0
  705. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +225 -0
  706. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +240 -0
  707. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +245 -0
  708. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +240 -0
  709. data/lib/plaid/models/sandbox_processor_token_create_request.rb +254 -0
  710. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +236 -0
  711. data/lib/plaid/models/sandbox_processor_token_create_response.rb +240 -0
  712. data/lib/plaid/models/sandbox_public_token_create_request.rb +302 -0
  713. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +220 -0
  714. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +264 -0
  715. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +231 -0
  716. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +230 -0
  717. data/lib/plaid/models/sandbox_public_token_create_response.rb +240 -0
  718. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +245 -0
  719. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +225 -0
  720. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +230 -0
  721. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +225 -0
  722. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +270 -0
  723. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +225 -0
  724. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +230 -0
  725. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +234 -0
  726. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +266 -0
  727. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +225 -0
  728. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +255 -0
  729. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +239 -0
  730. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +251 -0
  731. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +239 -0
  732. data/lib/plaid/models/scopes.rb +243 -0
  733. data/lib/plaid/models/scopes_context.rb +39 -0
  734. data/lib/plaid/models/scopes_nullable.rb +250 -0
  735. data/lib/plaid/models/screening_hit_analysis.rb +261 -0
  736. data/lib/plaid/models/screening_hit_data.rb +258 -0
  737. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +228 -0
  738. data/lib/plaid/models/screening_hit_documents_items.rb +228 -0
  739. data/lib/plaid/models/screening_hit_names_items.rb +228 -0
  740. data/lib/plaid/models/screening_status_updated_webhook.rb +265 -0
  741. data/lib/plaid/models/security.rb +390 -0
  742. data/lib/plaid/models/security_override.rb +270 -0
  743. data/lib/plaid/models/sender_bacs_nullable.rb +289 -0
  744. data/lib/plaid/models/service.rb +238 -0
  745. data/lib/plaid/models/service_product_fulfillment.rb +224 -0
  746. data/lib/plaid/models/service_product_fulfillment_detail.rb +235 -0
  747. data/lib/plaid/models/service_product_fulfillment_identifier.rb +38 -0
  748. data/lib/plaid/models/servicer_address_data.rb +265 -0
  749. data/lib/plaid/models/services.rb +224 -0
  750. data/lib/plaid/models/signal_address_data.rb +263 -0
  751. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  752. data/lib/plaid/models/signal_decision_report_request.rb +349 -0
  753. data/lib/plaid/models/signal_decision_report_response.rb +225 -0
  754. data/lib/plaid/models/signal_device.rb +232 -0
  755. data/lib/plaid/models/signal_evaluate_core_attributes.rb +925 -0
  756. data/lib/plaid/models/signal_evaluate_request.rb +398 -0
  757. data/lib/plaid/models/signal_evaluate_response.rb +248 -0
  758. data/lib/plaid/models/signal_payment_method.rb +43 -0
  759. data/lib/plaid/models/signal_person_name.rb +265 -0
  760. data/lib/plaid/models/signal_prepare_request.rb +245 -0
  761. data/lib/plaid/models/signal_prepare_response.rb +225 -0
  762. data/lib/plaid/models/signal_return_report_request.rb +301 -0
  763. data/lib/plaid/models/signal_return_report_response.rb +225 -0
  764. data/lib/plaid/models/signal_scores.rb +228 -0
  765. data/lib/plaid/models/signal_user.rb +252 -0
  766. data/lib/plaid/models/simulated_transfer_sweep.rb +288 -0
  767. data/lib/plaid/models/single_document_risk_signal.rb +255 -0
  768. data/lib/plaid/models/source.rb +41 -0
  769. data/lib/plaid/models/standalone_account_type.rb +285 -0
  770. data/lib/plaid/models/standalone_currency_code_list.rb +240 -0
  771. data/lib/plaid/models/standalone_investment_transaction_type.rb +300 -0
  772. data/lib/plaid/models/status.rb +232 -0
  773. data/lib/plaid/models/statuses.rb +224 -0
  774. data/lib/plaid/models/strategy.rb +41 -0
  775. data/lib/plaid/models/student_loan.rb +492 -0
  776. data/lib/plaid/models/student_loan_repayment_model.rb +255 -0
  777. data/lib/plaid/models/student_loan_status.rb +266 -0
  778. data/lib/plaid/models/student_repayment_plan.rb +266 -0
  779. data/lib/plaid/models/sync_updates_available_webhook.rb +299 -0
  780. data/lib/plaid/models/taxform.rb +244 -0
  781. data/lib/plaid/models/taxpayer_id.rb +269 -0
  782. data/lib/plaid/models/taxpayer_identifier.rb +231 -0
  783. data/lib/plaid/models/taxpayer_identifier_type.rb +39 -0
  784. data/lib/plaid/models/taxpayer_identifiers.rb +224 -0
  785. data/lib/plaid/models/total.rb +249 -0
  786. data/lib/plaid/models/total_canonical_description.rb +54 -0
  787. data/lib/plaid/models/transaction.rb +561 -0
  788. data/lib/plaid/models/transaction_all_of.rb +311 -0
  789. data/lib/plaid/models/transaction_base.rb +458 -0
  790. data/lib/plaid/models/transaction_code.rb +50 -0
  791. data/lib/plaid/models/transaction_data.rb +285 -0
  792. data/lib/plaid/models/transaction_frequency.rb +41 -0
  793. data/lib/plaid/models/transaction_override.rb +280 -0
  794. data/lib/plaid/models/transaction_stream.rb +426 -0
  795. data/lib/plaid/models/transaction_stream_amount.rb +242 -0
  796. data/lib/plaid/models/transaction_stream_status.rb +41 -0
  797. data/lib/plaid/models/transactions_category_rule.rb +259 -0
  798. data/lib/plaid/models/transactions_enhance_get_request.rb +262 -0
  799. data/lib/plaid/models/transactions_enhance_get_response.rb +227 -0
  800. data/lib/plaid/models/transactions_enrich_get_request.rb +274 -0
  801. data/lib/plaid/models/transactions_enrich_get_response.rb +237 -0
  802. data/lib/plaid/models/transactions_get_request.rb +284 -0
  803. data/lib/plaid/models/transactions_get_request_options.rb +326 -0
  804. data/lib/plaid/models/transactions_get_response.rb +288 -0
  805. data/lib/plaid/models/transactions_recurring_get_request.rb +271 -0
  806. data/lib/plaid/models/transactions_recurring_get_request_options.rb +222 -0
  807. data/lib/plaid/models/transactions_recurring_get_response.rb +274 -0
  808. data/lib/plaid/models/transactions_refresh_request.rb +245 -0
  809. data/lib/plaid/models/transactions_refresh_response.rb +225 -0
  810. data/lib/plaid/models/transactions_removed_webhook.rb +296 -0
  811. data/lib/plaid/models/transactions_rule_details.rb +253 -0
  812. data/lib/plaid/models/transactions_rule_field.rb +39 -0
  813. data/lib/plaid/models/transactions_rule_type.rb +39 -0
  814. data/lib/plaid/models/transactions_rules_create_request.rb +274 -0
  815. data/lib/plaid/models/transactions_rules_create_response.rb +239 -0
  816. data/lib/plaid/models/transactions_rules_list_request.rb +245 -0
  817. data/lib/plaid/models/transactions_rules_list_response.rb +242 -0
  818. data/lib/plaid/models/transactions_rules_remove_request.rb +260 -0
  819. data/lib/plaid/models/transactions_rules_remove_response.rb +225 -0
  820. data/lib/plaid/models/transactions_sync_request.rb +302 -0
  821. data/lib/plaid/models/transactions_sync_request_options.rb +235 -0
  822. data/lib/plaid/models/transactions_sync_response.rb +306 -0
  823. data/lib/plaid/models/transfer.rb +502 -0
  824. data/lib/plaid/models/transfer_authorization.rb +298 -0
  825. data/lib/plaid/models/transfer_authorization_create_request.rb +429 -0
  826. data/lib/plaid/models/transfer_authorization_create_response.rb +239 -0
  827. data/lib/plaid/models/transfer_authorization_decision.rb +39 -0
  828. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +239 -0
  829. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +45 -0
  830. data/lib/plaid/models/transfer_authorization_device.rb +230 -0
  831. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +40 -0
  832. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +239 -0
  833. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +42 -0
  834. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +328 -0
  835. data/lib/plaid/models/transfer_authorization_user_in_request.rb +254 -0
  836. data/lib/plaid/models/transfer_cancel_request.rb +245 -0
  837. data/lib/plaid/models/transfer_cancel_response.rb +225 -0
  838. data/lib/plaid/models/transfer_create_request.rb +428 -0
  839. data/lib/plaid/models/transfer_create_response.rb +239 -0
  840. data/lib/plaid/models/transfer_device.rb +240 -0
  841. data/lib/plaid/models/transfer_diligence_status.rb +40 -0
  842. data/lib/plaid/models/transfer_event.rb +399 -0
  843. data/lib/plaid/models/transfer_event_list_request.rb +397 -0
  844. data/lib/plaid/models/transfer_event_list_response.rb +241 -0
  845. data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
  846. data/lib/plaid/models/transfer_event_sync_request.rb +305 -0
  847. data/lib/plaid/models/transfer_event_sync_response.rb +241 -0
  848. data/lib/plaid/models/transfer_event_type.rb +46 -0
  849. data/lib/plaid/models/transfer_events_update_webhook.rb +254 -0
  850. data/lib/plaid/models/transfer_failure.rb +231 -0
  851. data/lib/plaid/models/transfer_get_request.rb +245 -0
  852. data/lib/plaid/models/transfer_get_response.rb +239 -0
  853. data/lib/plaid/models/transfer_intent_authorization_decision.rb +39 -0
  854. data/lib/plaid/models/transfer_intent_create.rb +395 -0
  855. data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
  856. data/lib/plaid/models/transfer_intent_create_request.rb +394 -0
  857. data/lib/plaid/models/transfer_intent_create_response.rb +239 -0
  858. data/lib/plaid/models/transfer_intent_get.rb +456 -0
  859. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +240 -0
  860. data/lib/plaid/models/transfer_intent_get_request.rb +245 -0
  861. data/lib/plaid/models/transfer_intent_get_response.rb +239 -0
  862. data/lib/plaid/models/transfer_intent_status.rb +40 -0
  863. data/lib/plaid/models/transfer_list_request.rb +341 -0
  864. data/lib/plaid/models/transfer_list_response.rb +241 -0
  865. data/lib/plaid/models/transfer_migrate_account_request.rb +285 -0
  866. data/lib/plaid/models/transfer_migrate_account_response.rb +255 -0
  867. data/lib/plaid/models/transfer_network.rb +40 -0
  868. data/lib/plaid/models/transfer_originator_create_request.rb +245 -0
  869. data/lib/plaid/models/transfer_originator_create_response.rb +255 -0
  870. data/lib/plaid/models/transfer_originator_get_request.rb +245 -0
  871. data/lib/plaid/models/transfer_originator_get_response.rb +239 -0
  872. data/lib/plaid/models/transfer_originator_list_request.rb +297 -0
  873. data/lib/plaid/models/transfer_originator_list_response.rb +241 -0
  874. data/lib/plaid/models/transfer_questionnaire_create_request.rb +302 -0
  875. data/lib/plaid/models/transfer_questionnaire_create_response.rb +240 -0
  876. data/lib/plaid/models/transfer_recurring_cancel_request.rb +255 -0
  877. data/lib/plaid/models/transfer_recurring_cancel_response.rb +225 -0
  878. data/lib/plaid/models/transfer_recurring_create_request.rb +424 -0
  879. data/lib/plaid/models/transfer_recurring_create_response.rb +239 -0
  880. data/lib/plaid/models/transfer_recurring_get_request.rb +255 -0
  881. data/lib/plaid/models/transfer_recurring_get_response.rb +239 -0
  882. data/lib/plaid/models/transfer_recurring_list_request.rb +329 -0
  883. data/lib/plaid/models/transfer_recurring_list_response.rb +241 -0
  884. data/lib/plaid/models/transfer_recurring_schedule.rb +260 -0
  885. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  886. data/lib/plaid/models/transfer_refund.rb +284 -0
  887. data/lib/plaid/models/transfer_refund_cancel_request.rb +245 -0
  888. data/lib/plaid/models/transfer_refund_cancel_response.rb +225 -0
  889. data/lib/plaid/models/transfer_refund_create_request.rb +296 -0
  890. data/lib/plaid/models/transfer_refund_create_response.rb +239 -0
  891. data/lib/plaid/models/transfer_refund_get_request.rb +245 -0
  892. data/lib/plaid/models/transfer_refund_get_response.rb +239 -0
  893. data/lib/plaid/models/transfer_refund_status.rb +41 -0
  894. data/lib/plaid/models/transfer_repayment.rb +270 -0
  895. data/lib/plaid/models/transfer_repayment_list_request.rb +320 -0
  896. data/lib/plaid/models/transfer_repayment_list_response.rb +241 -0
  897. data/lib/plaid/models/transfer_repayment_return.rb +291 -0
  898. data/lib/plaid/models/transfer_repayment_return_list_request.rb +313 -0
  899. data/lib/plaid/models/transfer_repayment_return_list_response.rb +241 -0
  900. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  901. data/lib/plaid/models/transfer_status.rb +43 -0
  902. data/lib/plaid/models/transfer_sweep.rb +281 -0
  903. data/lib/plaid/models/transfer_sweep_get_request.rb +245 -0
  904. data/lib/plaid/models/transfer_sweep_get_response.rb +239 -0
  905. data/lib/plaid/models/transfer_sweep_list_request.rb +331 -0
  906. data/lib/plaid/models/transfer_sweep_list_response.rb +241 -0
  907. data/lib/plaid/models/transfer_sweep_status.rb +42 -0
  908. data/lib/plaid/models/transfer_test_clock.rb +236 -0
  909. data/lib/plaid/models/transfer_type.rb +39 -0
  910. data/lib/plaid/models/transfer_user_address_in_request.rb +260 -0
  911. data/lib/plaid/models/transfer_user_address_in_response.rb +265 -0
  912. data/lib/plaid/models/transfer_user_in_request.rb +254 -0
  913. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +249 -0
  914. data/lib/plaid/models/transfer_user_in_response.rb +257 -0
  915. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +366 -0
  916. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +311 -0
  917. data/lib/plaid/models/user_address.rb +317 -0
  918. data/lib/plaid/models/user_create_request.rb +275 -0
  919. data/lib/plaid/models/user_create_response.rb +255 -0
  920. data/lib/plaid/models/user_custom_password.rb +297 -0
  921. data/lib/plaid/models/user_id_number.rb +239 -0
  922. data/lib/plaid/models/user_name.rb +240 -0
  923. data/lib/plaid/models/user_permission_revoked_webhook.rb +279 -0
  924. data/lib/plaid/models/user_stated_income_source_category.rb +48 -0
  925. data/lib/plaid/models/user_stated_income_source_frequency.rb +42 -0
  926. data/lib/plaid/models/user_stated_income_source_pay_type.rb +40 -0
  927. data/lib/plaid/models/validation_source.rb +232 -0
  928. data/lib/plaid/models/validation_sources.rb +227 -0
  929. data/lib/plaid/models/verification_expired_webhook.rb +284 -0
  930. data/lib/plaid/models/verification_of_asset.rb +252 -0
  931. data/lib/plaid/models/verification_of_asset_response.rb +224 -0
  932. data/lib/plaid/models/verification_refresh_status.rb +40 -0
  933. data/lib/plaid/models/verification_status.rb +42 -0
  934. data/lib/plaid/models/w2.rb +437 -0
  935. data/lib/plaid/models/w2_box12.rb +232 -0
  936. data/lib/plaid/models/w2_state_and_local_wages.rb +287 -0
  937. data/lib/plaid/models/wallet.rb +263 -0
  938. data/lib/plaid/models/wallet_balance.rb +240 -0
  939. data/lib/plaid/models/wallet_create_request.rb +244 -0
  940. data/lib/plaid/models/wallet_create_response.rb +286 -0
  941. data/lib/plaid/models/wallet_get_request.rb +266 -0
  942. data/lib/plaid/models/wallet_get_response.rb +286 -0
  943. data/lib/plaid/models/wallet_iso_currency_code.rb +39 -0
  944. data/lib/plaid/models/wallet_list_request.rb +304 -0
  945. data/lib/plaid/models/wallet_list_response.rb +252 -0
  946. data/lib/plaid/models/wallet_numbers.rb +230 -0
  947. data/lib/plaid/models/wallet_transaction.rb +372 -0
  948. data/lib/plaid/models/wallet_transaction_amount.rb +260 -0
  949. data/lib/plaid/models/wallet_transaction_counterparty.rb +260 -0
  950. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +289 -0
  951. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +246 -0
  952. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +229 -0
  953. data/lib/plaid/models/wallet_transaction_execute_request.rb +384 -0
  954. data/lib/plaid/models/wallet_transaction_execute_response.rb +254 -0
  955. data/lib/plaid/models/wallet_transaction_get_request.rb +266 -0
  956. data/lib/plaid/models/wallet_transaction_get_response.rb +395 -0
  957. data/lib/plaid/models/wallet_transaction_list_request.rb +341 -0
  958. data/lib/plaid/models/wallet_transaction_list_request_options.rb +230 -0
  959. data/lib/plaid/models/wallet_transaction_list_response.rb +252 -0
  960. data/lib/plaid/models/wallet_transaction_status.rb +43 -0
  961. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +312 -0
  962. data/lib/plaid/models/wallet_transactions_list_request.rb +341 -0
  963. data/lib/plaid/models/warning.rb +288 -0
  964. data/lib/plaid/models/watchlist_screening_audit_trail.rb +250 -0
  965. data/lib/plaid/models/watchlist_screening_document.rb +260 -0
  966. data/lib/plaid/models/watchlist_screening_document_type.rb +50 -0
  967. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +271 -0
  968. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +321 -0
  969. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +245 -0
  970. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +321 -0
  971. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +256 -0
  972. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +253 -0
  973. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +256 -0
  974. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +253 -0
  975. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +302 -0
  976. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +253 -0
  977. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +245 -0
  978. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +378 -0
  979. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +241 -0
  980. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +253 -0
  981. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +307 -0
  982. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +316 -0
  983. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +256 -0
  984. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +253 -0
  985. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +314 -0
  986. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +38 -0
  987. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +321 -0
  988. data/lib/plaid/models/watchlist_screening_hit.rb +351 -0
  989. data/lib/plaid/models/watchlist_screening_hit_locations.rb +261 -0
  990. data/lib/plaid/models/watchlist_screening_hit_status.rb +40 -0
  991. data/lib/plaid/models/watchlist_screening_individual.rb +306 -0
  992. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +271 -0
  993. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +321 -0
  994. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +245 -0
  995. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +321 -0
  996. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +256 -0
  997. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +253 -0
  998. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +256 -0
  999. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +253 -0
  1000. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +302 -0
  1001. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +253 -0
  1002. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +245 -0
  1003. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +378 -0
  1004. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +241 -0
  1005. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +253 -0
  1006. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +307 -0
  1007. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +316 -0
  1008. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +256 -0
  1009. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +253 -0
  1010. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +314 -0
  1011. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +38 -0
  1012. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +321 -0
  1013. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +325 -0
  1014. data/lib/plaid/models/watchlist_screening_review.rb +301 -0
  1015. data/lib/plaid/models/watchlist_screening_search_terms.rb +343 -0
  1016. data/lib/plaid/models/watchlist_screening_status.rb +40 -0
  1017. data/lib/plaid/models/weak_alias_determination.rb +40 -0
  1018. data/lib/plaid/models/webhook_environment_values.rb +40 -0
  1019. data/lib/plaid/models/webhook_type.rb +43 -0
  1020. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +294 -0
  1021. data/lib/plaid/models/webhook_verification_key_get_request.rb +245 -0
  1022. data/lib/plaid/models/webhook_verification_key_get_response.rb +239 -0
  1023. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +246 -0
  1024. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +246 -0
  1025. data/lib/plaid/version.rb +13 -2
  1026. data/lib/plaid.rb +1043 -61
  1027. data/plaid.gemspec +44 -48
  1028. data/templates/ruby/api_client.mustache +278 -0
  1029. data/templates/ruby/api_client_faraday_partial.mustache +118 -0
  1030. data/templates/ruby/api_error.mustache +49 -0
  1031. data/templates/ruby/configuration.mustache +355 -0
  1032. data/templates/ruby/gemspec.mustache +42 -0
  1033. data/templates/ruby/partial_model_enum_class.mustache +22 -0
  1034. data/templates/ruby/partial_model_generic.mustache +362 -0
  1035. data/test/test_accounts.rb +99 -0
  1036. data/test/test_api_client.rb +23 -0
  1037. data/test/test_asset_report.rb +147 -0
  1038. data/test/test_auth.rb +61 -0
  1039. data/test/test_bank_transfers.rb +219 -0
  1040. data/test/test_categories.rb +10 -0
  1041. data/test/test_configuration.rb +26 -0
  1042. data/test/test_deposit_switch.rb +73 -0
  1043. data/test/test_helper.rb +109 -0
  1044. data/test/test_identity.rb +38 -0
  1045. data/test/test_identity_verification.rb +51 -0
  1046. data/test/test_institutions.rb +159 -0
  1047. data/test/test_investments.rb +208 -0
  1048. data/test/test_item.rb +275 -0
  1049. data/test/test_liabilities.rb +45 -0
  1050. data/test/test_link_token.rb +131 -0
  1051. data/test/test_monitor.rb +55 -0
  1052. data/test/test_payment_initiation.rb +94 -0
  1053. data/test/test_processor.rb +52 -0
  1054. data/test/test_sandbox.rb +31 -0
  1055. data/test/test_transactions.rb +168 -0
  1056. data/test/test_webhooks.rb +22 -0
  1057. metadata +1092 -88
  1058. data/.circleci/config.yml +0 -21
  1059. data/.env.sample +0 -3
  1060. data/.github/workflows/add_to_project.yml +0 -21
  1061. data/.rubocop.yml +0 -18
  1062. data/PUBLISH.md +0 -20
  1063. data/bin/console +0 -14
  1064. data/bin/setup +0 -8
  1065. data/lib/plaid/client.rb +0 -190
  1066. data/lib/plaid/errors.rb +0 -89
  1067. data/lib/plaid/middleware.rb +0 -31
  1068. data/lib/plaid/models.rb +0 -2221
  1069. data/lib/plaid/products/accounts.rb +0 -63
  1070. data/lib/plaid/products/asset_report.rb +0 -199
  1071. data/lib/plaid/products/auth.rb +0 -42
  1072. data/lib/plaid/products/base_product.rb +0 -64
  1073. data/lib/plaid/products/categories.rb +0 -21
  1074. data/lib/plaid/products/credit_details.rb +0 -40
  1075. data/lib/plaid/products/deposit_switch.rb +0 -99
  1076. data/lib/plaid/products/identity.rb +0 -31
  1077. data/lib/plaid/products/income.rb +0 -31
  1078. data/lib/plaid/products/institutions.rb +0 -91
  1079. data/lib/plaid/products/investments.rb +0 -127
  1080. data/lib/plaid/products/item.rb +0 -209
  1081. data/lib/plaid/products/liabilities.rb +0 -39
  1082. data/lib/plaid/products/link_token.rb +0 -74
  1083. data/lib/plaid/products/payment_initiation.rb +0 -251
  1084. data/lib/plaid/products/processor.rb +0 -190
  1085. data/lib/plaid/products/sandbox.rb +0 -148
  1086. data/lib/plaid/products/transactions.rb +0 -81
  1087. data/lib/plaid/products/webhooks.rb +0 -23
@@ -0,0 +1,219 @@
1
+ require_relative "test_helper"
2
+
3
+ # Internal: The test for Plaid::BankTransfers.
4
+ class PlaidBankTransfersTest < PlaidTest
5
+ attr_reader :account
6
+
7
+ def setup
8
+ create_item initial_products: [:auth]
9
+
10
+ accounts_get_request = Plaid::AccountsGetRequest.new({
11
+ :access_token => access_token,
12
+ })
13
+
14
+ account_resp = client.accounts_get(accounts_get_request)
15
+ @account = account_resp.accounts[0]
16
+ end
17
+
18
+ # Helper method to create a bank transfer
19
+ def create_bank_transfer
20
+ bank_transfer_create_request = Plaid::BankTransferCreateRequest.new(
21
+ {
22
+ :idempotency_key => Random.rand(0..1_000_000_000).to_s,
23
+ :access_token => access_token,
24
+ :account_id => account.account_id,
25
+ :type => Plaid::BankTransferType::CREDIT,
26
+ :network => Plaid::BankTransferNetwork::ACH,
27
+ :amount => "1.00",
28
+ :iso_currency_code => "USD",
29
+ :description => "plaid",
30
+ :ach_class => "ppd",
31
+ :user => {
32
+ legal_name: "Firstname Lastname",
33
+ },
34
+ }
35
+ )
36
+
37
+ create_response = client.bank_transfer_create(bank_transfer_create_request)
38
+ refute_nil(create_response)
39
+ assert_kind_of(Plaid::BankTransfer, create_response.bank_transfer)
40
+ refute_nil(create_response.bank_transfer.id)
41
+ assert_equal(account.account_id, create_response.bank_transfer.account_id)
42
+ create_response.bank_transfer
43
+ end
44
+
45
+ # Used in case data is slow to propagate to read replica DB
46
+ def request_and_retry(func, bt)
47
+ num_retries = 3
48
+ retries = 0
49
+ while retries < num_retries
50
+ retries += 1
51
+ begin
52
+ res = func.call(bt)
53
+ rescue Exception => e
54
+ if retries < num_retries
55
+ puts "retrying failed test after sleeping for 1 second"
56
+ sleep(1)
57
+ next
58
+ else
59
+ puts "failed after retries"
60
+ raise e
61
+ end
62
+ end
63
+ return
64
+ end
65
+ end
66
+
67
+ def create_and_post_bank_transfer
68
+ bank_transfer = create_bank_transfer
69
+ checks = lambda do |bank_transfer|
70
+ sandbox_bank_transfer_simulate_request = Plaid::SandboxBankTransferSimulateRequest.new(
71
+ {
72
+ :bank_transfer_id => bank_transfer.id,
73
+ :event_type => Plaid::BankTransferEventType::POSTED,
74
+ }
75
+ )
76
+
77
+ simulate_response = client.sandbox_bank_transfer_simulate(sandbox_bank_transfer_simulate_request)
78
+ refute_nil(simulate_response)
79
+ assert_kind_of(Plaid::SandboxBankTransferSimulateResponse, simulate_response)
80
+ end
81
+ request_and_retry(checks, bank_transfer)
82
+ bank_transfer
83
+ end
84
+
85
+ def test_create_success
86
+ create_bank_transfer
87
+ end
88
+
89
+ def test_create_invalid_field
90
+ begin
91
+ client.bank_transfer_create({})
92
+ rescue Plaid::ApiError => e
93
+ json_response = JSON.parse(e.response_body)
94
+ assert_equal(json_response["error_code"], "MISSING_FIELDS")
95
+ end
96
+ end
97
+
98
+ def test_sandbox_bank_transfer_simulate_success
99
+ create_and_post_bank_transfer
100
+ end
101
+
102
+ def test_cancel_success
103
+ bank_transfer = create_bank_transfer
104
+ checks = lambda do |bank_transfer|
105
+ bank_transfer_cancel_request = Plaid::BankTransferCancelRequest.new({
106
+ :bank_transfer_id => bank_transfer.id,
107
+ })
108
+
109
+ cancel_response = client.bank_transfer_cancel(bank_transfer_cancel_request)
110
+ refute_nil(cancel_response)
111
+ assert_kind_of(Plaid::BankTransferCancelResponse, cancel_response)
112
+ end
113
+ request_and_retry(checks, bank_transfer)
114
+ end
115
+
116
+ def test_cancel_not_cancelable
117
+ bank_transfer = create_and_post_bank_transfer
118
+
119
+ bank_transfer_cancel_request = Plaid::BankTransferCancelRequest.new({
120
+ :bank_transfer_id => bank_transfer.id,
121
+ })
122
+
123
+ begin
124
+ client.bank_transfer_cancel(bank_transfer_cancel_request)
125
+ rescue Plaid::ApiError => e
126
+ json_response = JSON.parse(e.response_body)
127
+ assert_equal(json_response["error_code"], "BANK_TRANSFER_NOT_CANCELLABLE")
128
+ end
129
+ end
130
+
131
+ def test_migrate_account_success
132
+ migrate_account_request = Plaid::BankTransferMigrateAccountRequest.new({
133
+ :account_number => "100000000",
134
+ :routing_number => "121122676",
135
+ :account_type => "checking",
136
+ })
137
+
138
+ migrate_account_response = client.bank_transfer_migrate_account(migrate_account_request)
139
+ refute_nil(migrate_account_response)
140
+ assert_kind_of(Plaid::BankTransferMigrateAccountResponse, migrate_account_response)
141
+ refute_nil(migrate_account_response.access_token)
142
+ refute_nil(migrate_account_response.account_id)
143
+ end
144
+
145
+ def test_origination_balance_get_success
146
+ bank_transfer_balance_get_request = Plaid::BankTransferBalanceGetRequest.new()
147
+
148
+ balance_get_response = client.bank_transfer_balance_get(bank_transfer_balance_get_request)
149
+ refute_nil(balance_get_response)
150
+ refute_nil(balance_get_response.balance)
151
+ end
152
+
153
+ def test_get_success
154
+ bank_transfer = create_bank_transfer
155
+ checks = lambda do |bank_transfer|
156
+ bank_transfer_get_request = Plaid::BankTransferGetRequest.new({
157
+ :bank_transfer_id => bank_transfer.id,
158
+ })
159
+
160
+ get_response = client.bank_transfer_get(bank_transfer_get_request)
161
+ refute_nil(get_response)
162
+ assert_kind_of(Plaid::BankTransferGetResponse, get_response)
163
+ assert_equal(get_response.bank_transfer, bank_transfer)
164
+ end
165
+ request_and_retry(checks, bank_transfer)
166
+ end
167
+
168
+ def test_list_success
169
+ bank_transfer = create_bank_transfer
170
+ checks = lambda do |bank_transfer|
171
+ bank_transfer_list_request = Plaid::BankTransferListRequest.new({
172
+ :count => 1,
173
+ })
174
+
175
+ list_response = client.bank_transfer_list(bank_transfer_list_request)
176
+ refute_nil(list_response)
177
+ assert_kind_of(Plaid::BankTransferListResponse, list_response)
178
+ refute_nil(list_response.bank_transfers)
179
+ assert_equal(1, list_response.bank_transfers.length)
180
+ assert_equal(bank_transfer, list_response.bank_transfers[0])
181
+ end
182
+ request_and_retry(checks, bank_transfer)
183
+ end
184
+
185
+ def test_event_sync_success
186
+ bank_transfer = create_and_post_bank_transfer
187
+ checks = lambda do |bank_transfer|
188
+ bank_transfer_event_sync_request = Plaid::BankTransferEventSyncRequest.new({
189
+ :after_id => 0,
190
+ })
191
+
192
+ event_sync_response = client.bank_transfer_event_sync(bank_transfer_event_sync_request)
193
+ refute_nil(event_sync_response)
194
+ assert_kind_of(Plaid::BankTransferEventSyncResponse, event_sync_response)
195
+ refute_nil(event_sync_response.bank_transfer_events)
196
+ assert(event_sync_response.bank_transfer_events.length >= 2)
197
+ end
198
+ request_and_retry(checks, bank_transfer)
199
+ end
200
+
201
+ def test_event_list_success
202
+ bank_transfer = create_and_post_bank_transfer
203
+ checks = lambda do |bank_transfer|
204
+ bank_transfer_list_request = Plaid::BankTransferEventListRequest.new({
205
+ bank_transfer_id: bank_transfer.id,
206
+ })
207
+
208
+ event_list_response = client.bank_transfer_event_list(bank_transfer_list_request)
209
+ refute_nil(event_list_response)
210
+ assert_kind_of(Plaid::BankTransferEventListResponse, event_list_response)
211
+ refute_nil(event_list_response.bank_transfer_events)
212
+ assert_equal(1, event_list_response.bank_transfer_events.length)
213
+ event_list_response.bank_transfer_events.each do |event|
214
+ assert_equal(bank_transfer.id, event.bank_transfer_id)
215
+ end
216
+ end
217
+ request_and_retry(checks, bank_transfer)
218
+ end
219
+ end
@@ -0,0 +1,10 @@
1
+ require_relative 'test_helper'
2
+
3
+ # Internal: The test for Plaid::CategoriesGet.
4
+ class PlaidCategoriesTest < PlaidTest
5
+ def test_get
6
+ response = client.categories_get({})
7
+ assert_instance_of(Plaid::CategoriesGetResponse, response)
8
+ refute_empty(response.to_hash)
9
+ end
10
+ end
@@ -0,0 +1,26 @@
1
+
2
+ require_relative "test_helper"
3
+
4
+ # Internal: The test for Plaid::Configuration.
5
+ class PlaidConfigurationTest < PlaidTest
6
+ def test_api_host
7
+ configuration = Plaid::Configuration.new
8
+ configuration.server_index = 2
9
+
10
+ assert_equal "https://sandbox.plaid.com",
11
+ configuration.base_url
12
+
13
+ configuration.server_index = 1
14
+ assert_equal "https://development.plaid.com",
15
+ configuration.base_url
16
+
17
+ configuration.server_index = 0
18
+ assert_equal "https://production.plaid.com",
19
+ configuration.base_url
20
+
21
+ assert_raises(ArgumentError) do
22
+ configuration.server_index = 3
23
+ configuration.base_url
24
+ end
25
+ end
26
+ end
@@ -0,0 +1,73 @@
1
+ require_relative "test_helper"
2
+
3
+ class PlaidDepositSwitchTest < PlaidTest
4
+ # rubocop:disable Metrics/MethodLength
5
+ def test_all_routes
6
+ # import item
7
+ item_import_request = Plaid::ItemImportRequest.new
8
+
9
+ item_import_request.products = %w[identity auth]
10
+ item_import_request.user_auth = {
11
+ user_id: "user_good",
12
+ auth_token: "pass_good",
13
+ }
14
+
15
+ import_response = client.item_import(
16
+ item_import_request
17
+ )
18
+
19
+ refute_empty(import_response.access_token)
20
+ access_token = import_response.access_token
21
+ assert_kind_of(Plaid::ItemImportResponse, import_response)
22
+
23
+ # get account id
24
+ accounts_get_request = Plaid::AccountsGetRequest.new
25
+ accounts_get_request.access_token = access_token
26
+
27
+ get_accounts_response = client.accounts_get(accounts_get_request)
28
+ refute_empty(get_accounts_response.accounts)
29
+ assert_kind_of(Plaid::AccountsGetResponse, get_accounts_response)
30
+
31
+ depository_accounts = get_accounts_response.accounts.select do |account|
32
+ account.type == "depository"
33
+ end
34
+ account_id = depository_accounts[0].account_id
35
+
36
+ # create deposit switch
37
+ deposit_switch_create_request = Plaid::DepositSwitchCreateRequest.new
38
+ deposit_switch_create_request.target_account_id = account_id
39
+ deposit_switch_create_request.target_access_token = access_token
40
+
41
+ create_response = client.deposit_switch_create(
42
+ deposit_switch_create_request
43
+ )
44
+ assert_kind_of(Plaid::DepositSwitchCreateResponse, create_response)
45
+
46
+ refute_empty(create_response.deposit_switch_id)
47
+ deposit_switch_id = create_response.deposit_switch_id
48
+
49
+ # get deposit switch
50
+ deposit_switch_get_request = Plaid::DepositSwitchGetRequest.new()
51
+ deposit_switch_get_request.deposit_switch_id = deposit_switch_id
52
+
53
+ get_response = client.deposit_switch_get(deposit_switch_get_request)
54
+ assert_kind_of(Plaid::DepositSwitchGetResponse, get_response)
55
+
56
+ refute_empty(get_response.deposit_switch_id)
57
+ refute_empty(get_response.target_item_id)
58
+ refute_empty(get_response.target_account_id)
59
+ refute_empty(get_response.state)
60
+ refute_nil(get_response.date_created)
61
+
62
+ # create deposit switch token
63
+ deposit_switch_create_token_request = Plaid::DepositSwitchTokenCreateRequest.new
64
+ deposit_switch_create_token_request.deposit_switch_id = deposit_switch_id
65
+
66
+ create_token_response = client.deposit_switch_token_create(deposit_switch_create_token_request)
67
+
68
+ refute_empty(create_token_response.deposit_switch_token)
69
+ refute_empty(create_token_response.deposit_switch_token_expiration_time)
70
+ end
71
+ end
72
+
73
+ # rubocop:enable Metrics/MethodLength
@@ -0,0 +1,109 @@
1
+ require "minitest/autorun"
2
+ require "minitest/around/unit"
3
+ require "json"
4
+
5
+ require_relative "../lib/plaid"
6
+
7
+ # Internal: Default read timeout for HTTP calls in seconds.
8
+ NETWORK_TIMEOUT = 600
9
+
10
+ class PlaidTest < MiniTest::Test
11
+ attr_reader :client, :item, :access_token
12
+
13
+ def create_client
14
+ configuration = Plaid::Configuration.new
15
+ configuration.server_index = Plaid::Configuration::Environment["sandbox"]
16
+ configuration.timeout = NETWORK_TIMEOUT
17
+ configuration.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_RUBY_CLIENT_ID"]
18
+ configuration.api_key["PLAID-SECRET"] = ENV["PLAID_RUBY_SECRET"]
19
+ configuration.api_key["Plaid-Version"] = "2020-09-14"
20
+
21
+ api_client = Plaid::ApiClient.new(
22
+ configuration
23
+ )
24
+
25
+ @client = Plaid::PlaidApi.new(api_client)
26
+ @client_id = ENV["PLAID_RUBY_CLIENT_ID"]
27
+ end
28
+
29
+ # Helper used to create a test item with given products
30
+ def create_item(institution_id: SANDBOX_INSTITUTION,
31
+ initial_products: [:transactions],
32
+ transactions_start_date: nil,
33
+ transactions_end_date: nil,
34
+ webhook: nil,
35
+ options: nil)
36
+ sandbox_public_token_create_request = Plaid::SandboxPublicTokenCreateRequest.new
37
+
38
+ options_payload = {}
39
+ options_payload[:webhook] = webhook unless webhook.nil?
40
+ options_payload[:transactions] = {
41
+ start_date: transactions_start_date.is_a?(String) ? transactions_start_date : transactions_start_date.to_date.strftime("%Y-%m-%d"),
42
+ end_date: transactions_end_date.is_a?(String) ? transactions_end_date : transactions_end_date.to_date.strftime("%Y-%m-%d"),
43
+ } unless transactions_start_date.nil? || transactions_end_date.nil?
44
+ options_payload = options_payload.merge(options) unless options.nil?
45
+
46
+ sandbox_public_token_create_request.options = options_payload
47
+ sandbox_public_token_create_request.institution_id = institution_id
48
+ sandbox_public_token_create_request.initial_products = initial_products
49
+
50
+ begin
51
+ public_token_response = @client.sandbox_public_token_create(sandbox_public_token_create_request)
52
+ end
53
+
54
+ # public_token must be present
55
+ refute_empty(public_token_response.to_hash)
56
+
57
+ public_token = public_token_response.public_token
58
+
59
+ # exchange public_token for access_token
60
+ item_public_token_exchange_request = Plaid::ItemPublicTokenExchangeRequest.new
61
+ item_public_token_exchange_request.public_token = public_token
62
+
63
+ exchange_token_response = client.item_public_token_exchange(item_public_token_exchange_request)
64
+
65
+ @access_token = exchange_token_response.access_token
66
+ refute_empty(@access_token)
67
+
68
+ item_get_request = Plaid::ItemGetRequest.new
69
+ item_get_request.access_token = @access_token
70
+
71
+ @item = client.item_get(item_get_request)
72
+ refute_empty(@item.to_hash)
73
+ end
74
+
75
+ # If create_item was used, remove the item
76
+ def teardown
77
+ if access_token
78
+ item_remove_request = Plaid::ItemRemoveRequest.new
79
+ item_remove_request.access_token = access_token
80
+
81
+ begin
82
+ @client.item_remove(item_remove_request)
83
+ end
84
+ end
85
+ end
86
+
87
+ # This method is called around every test method.
88
+ def around
89
+ create_client
90
+ yield
91
+ end
92
+
93
+ BAD_STRING = "ABCDEFG1234567".freeze
94
+
95
+ BAD_ARRAY = ["ABCDEFG1234567"].freeze
96
+
97
+ SANDBOX_INSTITUTION = "ins_109508".freeze
98
+
99
+ SANDBOX_INSTITUTION_NAME = "First Platypus Bank".freeze
100
+
101
+ SANDBOX_INSTITUTIONS = %w[ins_109508 ins_109509 ins_109510
102
+ ins_109511 ins_109512].freeze
103
+
104
+ # NOTE: Data is only generated over the past 2 years. Ensure that the date
105
+ # range used for transactions/get is within 2 years old or otherwise the tests will not work properly
106
+
107
+ START_DATE = "2020-01-01".freeze
108
+ END_DATE = "2021-01-01".freeze
109
+ end
@@ -0,0 +1,38 @@
1
+ require_relative 'test_helper'
2
+
3
+ # Internal: The test for Plaid::Identity.
4
+ class PlaidIdentityTest < PlaidTest
5
+ def test_get
6
+ create_item initial_products: [:identity]
7
+
8
+ identity_get_request = Plaid::IdentityGetRequest.new
9
+ identity_get_request.access_token = access_token
10
+
11
+ response = client.identity_get(identity_get_request)
12
+ assert_kind_of(Plaid::IdentityGetResponse, response)
13
+
14
+ refute_empty(response.accounts)
15
+
16
+ response.accounts.each do |account|
17
+ refute_empty(account.owners)
18
+ account.owners.each do |identity|
19
+ refute_empty(identity.addresses)
20
+ refute_empty(identity.emails)
21
+ refute_empty(identity.names)
22
+ refute_empty(identity.phone_numbers)
23
+ end
24
+ end
25
+ end
26
+
27
+ def test_get_invalid_access_token
28
+ identity_get_request = Plaid::IdentityGetRequest.new
29
+ identity_get_request.access_token = BAD_STRING
30
+
31
+ begin
32
+ client.identity_get(identity_get_request)
33
+ rescue Plaid::ApiError => e
34
+ json_response = JSON.parse(e.response_body)
35
+ assert_equal(json_response["error_code"], "INVALID_ACCESS_TOKEN")
36
+ end
37
+ end
38
+ end
@@ -0,0 +1,51 @@
1
+ require_relative 'test_helper'
2
+
3
+ # Internal: The test for Plaid::IdentityVerification.
4
+
5
+ TEMPLATE_ID = "flwtmp_aWogUuKsL6NEHU"
6
+ CLIENT_USER_ID = "idv-user-" + Time.now.to_i.to_s
7
+ class PlaidIdentityVerificationTest < PlaidTest
8
+ def test_all_routes
9
+ user = Plaid::IdentityVerificationRequestUser.new({
10
+ :client_user_id => CLIENT_USER_ID,
11
+ :email_address => CLIENT_USER_ID + "@example.com",
12
+ })
13
+ identity_verification_create_request = Plaid::IdentityVerificationCreateRequest.new({
14
+ :is_shareable => true,
15
+ :template_id => TEMPLATE_ID,
16
+ :gave_consent => true,
17
+ :user => user,
18
+ })
19
+ response = client.identity_verification_create(identity_verification_create_request)
20
+ assert_kind_of(Plaid::IdentityVerificationCreateResponse, response)
21
+ refute_nil(response.shareable_url)
22
+ assert_equal("active", response.status)
23
+
24
+ identity_verification_retry_request = Plaid::IdentityVerificationRetryRequest.new({
25
+ :template_id => TEMPLATE_ID,
26
+ :client_user_id => CLIENT_USER_ID,
27
+ :strategy => Plaid::Strategy::RESET,
28
+ })
29
+ response = client.identity_verification_retry(identity_verification_retry_request)
30
+ assert_kind_of(Plaid::IdentityVerificationRetryResponse, response)
31
+ refute_nil(response.shareable_url)
32
+ assert_equal("active", response.status)
33
+
34
+ identity_verification_list_request = Plaid::IdentityVerificationListRequest.new({
35
+ :template_id => TEMPLATE_ID,
36
+ :client_user_id => CLIENT_USER_ID,
37
+ })
38
+ response = client.identity_verification_list(identity_verification_list_request)
39
+ assert_kind_of(Plaid::IdentityVerificationListResponse, response)
40
+ refute_nil(response.identity_verifications[0])
41
+ assert_equal(CLIENT_USER_ID, response.identity_verifications[0].client_user_id)
42
+
43
+ identity_verification_id = response.identity_verifications[0].id
44
+ identity_verification_get_request = Plaid::IdentityVerificationGetRequest.new({
45
+ :identity_verification_id => identity_verification_id,
46
+ })
47
+ response = client.identity_verification_get(identity_verification_get_request)
48
+ assert_kind_of(Plaid::IdentityVerificationGetResponse, response)
49
+ assert_equal(identity_verification_id, response.id)
50
+ end
51
+ end
@@ -0,0 +1,159 @@
1
+ require_relative "test_helper"
2
+
3
+ # Internal: The test for Plaid::Institutions.
4
+ class PlaidInstitutionsTest < PlaidTest
5
+ def test_get
6
+ institutions_get_request = Plaid::InstitutionsGetRequest.new({
7
+ :count => 3,
8
+ :offset => 4,
9
+ :country_codes => ["US"],
10
+ })
11
+
12
+ response = client.institutions_get(institutions_get_request)
13
+ assert_equal(3, response.to_hash[:institutions].length)
14
+ end
15
+
16
+ def test_get_with_options
17
+ institutions_get_request = Plaid::InstitutionsGetRequest.new({
18
+ :count => 3,
19
+ :offset => 4,
20
+ :country_codes => ["US"],
21
+ :options => {
22
+ products: ["transactions"],
23
+ include_optional_metadata: true,
24
+ },
25
+ })
26
+ response = client.institutions_get institutions_get_request
27
+
28
+ assert_kind_of(Plaid::InstitutionsGetResponse, response)
29
+ assert_equal(3, response.institutions.length)
30
+ end
31
+
32
+ def test_get_invalid_parameters
33
+ assert_raises(ArgumentError) do
34
+ institutions_get_request = Plaid::InstitutionsGetRequest.new({
35
+ :count => BAD_STRING,
36
+ :offset => BAD_STRING,
37
+ :country_codes => ["XX"],
38
+ })
39
+ end
40
+ end
41
+
42
+ def test_get_by_id
43
+ institutions_get_by_id_request = Plaid::InstitutionsGetByIdRequest.new({
44
+ :institution_id => SANDBOX_INSTITUTION,
45
+ :country_codes => ["US"],
46
+ })
47
+
48
+ response = client.institutions_get_by_id(institutions_get_by_id_request)
49
+
50
+ assert_equal(SANDBOX_INSTITUTION, response.institution.institution_id)
51
+ assert_equal(["US"], response.institution.country_codes)
52
+ assert_kind_of(Plaid::InstitutionsGetByIdResponse, response)
53
+ end
54
+
55
+ def test_get_by_id_invalid_parameters
56
+ institutions_get_by_id_request = Plaid::InstitutionsGetByIdRequest.new({
57
+ :institution_id => BAD_STRING,
58
+ :country_codes => ["US"],
59
+ })
60
+
61
+ begin
62
+ client.institutions_get_by_id institutions_get_by_id_request
63
+ rescue Plaid::ApiError => e
64
+ json_response = JSON.parse(e.response_body)
65
+ assert_equal(json_response["error_code"], "INVALID_INSTITUTION")
66
+ end
67
+ end
68
+
69
+ def test_get_by_id_include_optional_metadata
70
+ institutions_get_by_id_request = Plaid::InstitutionsGetByIdRequest.new({
71
+ :institution_id => SANDBOX_INSTITUTION,
72
+ :country_codes => ["US"],
73
+ :options => { include_optional_metadata: true },
74
+ })
75
+
76
+ response = client.institutions_get_by_id(institutions_get_by_id_request)
77
+ assert_equal(SANDBOX_INSTITUTION, response.institution.institution_id)
78
+ assert_kind_of(Plaid::InstitutionsGetByIdResponse, response)
79
+ end
80
+
81
+ def test_get_by_id_include_status_false
82
+ institutions_get_by_id_request = Plaid::InstitutionsGetByIdRequest.new({
83
+ :institution_id => SANDBOX_INSTITUTION,
84
+ :country_codes => ["US"],
85
+ })
86
+
87
+ response = client.institutions_get_by_id(institutions_get_by_id_request)
88
+ assert_equal(SANDBOX_INSTITUTION, response.institution.institution_id)
89
+ assert_nil(response.institution.status)
90
+ assert_kind_of(Plaid::InstitutionsGetByIdResponse, response)
91
+ end
92
+
93
+ def test_search
94
+ institutions_search_request = Plaid::InstitutionsSearchRequest.new({
95
+ :query => SANDBOX_INSTITUTION_NAME,
96
+ :products => [:transactions],
97
+ :country_codes => ["US"],
98
+ })
99
+
100
+ response = client.institutions_search(institutions_search_request)
101
+ refute_empty(response.institutions)
102
+ assert_kind_of(Plaid::InstitutionsSearchResponse, response)
103
+ end
104
+
105
+ def test_search_with_include_optional_metadata
106
+ institutions_search_request = Plaid::InstitutionsSearchRequest.new({
107
+ :query => SANDBOX_INSTITUTION_NAME,
108
+ :products => [:transactions],
109
+ :country_codes => ["US"],
110
+ :options => { include_optional_metadata: true },
111
+ })
112
+
113
+ response = client.institutions_search institutions_search_request
114
+ refute_empty(response.institutions)
115
+ assert_kind_of(Plaid::InstitutionsSearchResponse, response)
116
+ end
117
+
118
+ def test_search_with_products
119
+ institutions_search_request = Plaid::InstitutionsSearchRequest.new({
120
+ :query => SANDBOX_INSTITUTION_NAME,
121
+ :products => [:transactions],
122
+ :country_codes => ["US"],
123
+ })
124
+
125
+ response = client.institutions_search institutions_search_request
126
+ refute_empty(response.institutions)
127
+ assert_kind_of(Plaid::InstitutionsSearchResponse, response)
128
+ end
129
+
130
+ def test_search_invalid_products
131
+ institutions_search_request = Plaid::InstitutionsSearchRequest.new({
132
+ :query => SANDBOX_INSTITUTION_NAME,
133
+ :products => BAD_ARRAY,
134
+ :country_codes => ["XX"],
135
+ })
136
+
137
+ begin
138
+ client.institutions_search institutions_search_request
139
+ rescue Plaid::ApiError => e
140
+ json_response = JSON.parse(e.response_body)
141
+ assert_equal(json_response["error_code"], "INVALID_PRODUCT")
142
+ end
143
+ end
144
+
145
+ def test_search_bad_products
146
+ institutions_search_request = Plaid::InstitutionsSearchRequest.new({
147
+ :query => SANDBOX_INSTITUTION_NAME,
148
+ :products => BAD_STRING,
149
+ :country_codes => ["XX"],
150
+ })
151
+
152
+ begin
153
+ client.institutions_search institutions_search_request
154
+ rescue Plaid::ApiError => e
155
+ json_response = JSON.parse(e.response_body)
156
+ assert_equal(json_response["error_type"], "INVALID_REQUEST")
157
+ end
158
+ end
159
+ end