plaid 17.3.0 → 18.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1150) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +159 -0
  3. data/Gemfile.lock +3 -3
  4. data/Makefile +1 -1
  5. data/README.md +2 -2
  6. data/lib/plaid/api/plaid_api.rb +417 -92
  7. data/lib/plaid/api_client.rb +2 -2
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +1 -1
  10. data/lib/plaid/models/account_access.rb +1 -1
  11. data/lib/plaid/models/account_assets.rb +12 -2
  12. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  13. data/lib/plaid/models/account_balance.rb +1 -1
  14. data/lib/plaid/models/account_base.rb +15 -5
  15. data/lib/plaid/models/account_filter.rb +1 -1
  16. data/lib/plaid/models/account_filters_response.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +12 -2
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score.rb +12 -2
  20. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  21. data/lib/plaid/models/account_product_access.rb +1 -1
  22. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  23. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  24. data/lib/plaid/models/account_subtype.rb +1 -1
  25. data/lib/plaid/models/account_type.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  30. data/lib/plaid/models/accounts_get_response.rb +1 -1
  31. data/lib/plaid/models/ach_class.rb +1 -1
  32. data/lib/plaid/models/action_state.rb +1 -1
  33. data/lib/plaid/models/activity.rb +1 -1
  34. data/lib/plaid/models/activity_type.rb +1 -1
  35. data/lib/plaid/models/address.rb +1 -1
  36. data/lib/plaid/models/address_data.rb +2 -6
  37. data/lib/plaid/models/address_data_nullable.rb +2 -6
  38. data/lib/plaid/models/address_match_score.rb +3 -3
  39. data/lib/plaid/models/address_nullable.rb +1 -1
  40. data/lib/plaid/models/address_purpose_label.rb +1 -1
  41. data/lib/plaid/models/application.rb +1 -1
  42. data/lib/plaid/models/application_get_request.rb +1 -1
  43. data/lib/plaid/models/application_get_response.rb +1 -1
  44. data/lib/plaid/models/apr.rb +1 -1
  45. data/lib/plaid/models/asset.rb +1 -1
  46. data/lib/plaid/models/asset_detail.rb +1 -1
  47. data/lib/plaid/models/asset_holder.rb +1 -1
  48. data/lib/plaid/models/asset_holder_name.rb +1 -1
  49. data/lib/plaid/models/asset_owner.rb +1 -1
  50. data/lib/plaid/models/asset_owners.rb +1 -1
  51. data/lib/plaid/models/asset_report.rb +1 -1
  52. data/lib/plaid/models/asset_report_add_ons.rb +39 -0
  53. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  55. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_create_request.rb +16 -15
  59. data/lib/plaid/models/asset_report_create_request_options.rb +14 -2
  60. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  62. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  63. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  64. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  67. data/lib/plaid/models/asset_report_get_request_options.rb +2 -2
  68. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_item.rb +1 -1
  70. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  72. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  74. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  75. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  77. data/lib/plaid/models/asset_report_transaction.rb +106 -106
  78. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  79. data/lib/plaid/models/asset_report_user.rb +1 -1
  80. data/lib/plaid/models/asset_transaction.rb +1 -1
  81. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  82. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  83. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  84. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  85. data/lib/plaid/models/asset_transactions.rb +1 -1
  86. data/lib/plaid/models/asset_type.rb +1 -1
  87. data/lib/plaid/models/assets.rb +1 -1
  88. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  89. data/lib/plaid/models/assets_product_ready_webhook.rb +16 -6
  90. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  91. data/lib/plaid/models/auth_get_request.rb +1 -1
  92. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  93. data/lib/plaid/models/auth_get_response.rb +1 -1
  94. data/lib/plaid/models/auth_metadata.rb +1 -1
  95. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  96. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  97. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  98. data/lib/plaid/models/bank_transfer.rb +2 -2
  99. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_create_request.rb +2 -2
  105. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  131. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  132. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  133. data/lib/plaid/models/categories_get_response.rb +1 -1
  134. data/lib/plaid/models/category.rb +1 -1
  135. data/lib/plaid/models/cause.rb +1 -1
  136. data/lib/plaid/models/cause_all_of.rb +1 -1
  137. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  138. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  139. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  140. data/lib/plaid/models/client_provided_transaction.rb +3 -3
  141. data/lib/plaid/models/client_provided_transaction_location.rb +2 -2
  142. data/lib/plaid/models/connected_application.rb +1 -1
  143. data/lib/plaid/models/counterparty.rb +13 -2
  144. data/lib/plaid/models/counterparty_type.rb +1 -1
  145. data/lib/plaid/models/country_code.rb +2 -1
  146. data/lib/plaid/models/credit1099.rb +1 -1
  147. data/lib/plaid/models/credit1099_filer.rb +1 -1
  148. data/lib/plaid/models/credit1099_payer.rb +1 -1
  149. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  150. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  151. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  152. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  153. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  154. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  155. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  156. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  157. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +20 -5
  158. data/lib/plaid/models/credit_bank_employer.rb +225 -0
  159. data/lib/plaid/models/credit_bank_employment.rb +284 -0
  160. data/lib/plaid/models/credit_bank_employment_get_request.rb +245 -0
  161. data/lib/plaid/models/credit_bank_employment_get_response.rb +242 -0
  162. data/lib/plaid/models/credit_bank_employment_item.rb +304 -0
  163. data/lib/plaid/models/credit_bank_employment_report.rb +289 -0
  164. data/lib/plaid/models/credit_bank_employment_warning.rb +252 -0
  165. data/lib/plaid/models/credit_bank_employment_warning_type.rb +38 -0
  166. data/lib/plaid/models/credit_bank_income.rb +1 -1
  167. data/lib/plaid/models/credit_bank_income_account.rb +27 -2
  168. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  169. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  170. data/lib/plaid/models/credit_bank_income_cause.rb +26 -1
  171. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  172. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  173. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  174. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  175. data/lib/plaid/models/credit_bank_income_historical_summary.rb +2 -2
  176. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  177. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +2 -1
  178. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  179. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  180. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  181. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  182. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  183. data/lib/plaid/models/credit_bank_income_summary.rb +2 -2
  184. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  185. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  186. data/lib/plaid/models/credit_bank_income_warning_code.rb +2 -1
  187. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  188. data/lib/plaid/models/credit_card_liability.rb +1 -1
  189. data/lib/plaid/models/credit_category.rb +2 -2
  190. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  191. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  192. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  193. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  194. data/lib/plaid/models/credit_employment_item.rb +1 -1
  195. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  196. data/lib/plaid/models/credit_filter.rb +1 -1
  197. data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +1 -1
  198. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +1 -1
  199. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +1 -1
  200. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +1 -1
  201. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +1 -1
  202. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +1 -1
  203. data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +1 -1
  204. data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +1 -1
  205. data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +1 -1
  206. data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +1 -1
  207. data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +6 -1
  208. data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +1 -1
  209. data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +1 -1
  210. data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +1 -1
  211. data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +1 -1
  212. data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +1 -1
  213. data/lib/plaid/models/credit_freddie_mac_party_voa24.rb +1 -1
  214. data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +1 -1
  215. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  216. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +2 -6
  217. data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +1 -1
  218. data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +1 -1
  219. data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +1 -1
  220. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +1 -1
  221. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +1 -1
  222. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +1 -1
  223. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +1 -1
  224. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +1 -1
  225. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +1 -1
  226. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +25 -5
  227. data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +1 -1
  228. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +25 -5
  229. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  230. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  231. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  232. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  233. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  234. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  235. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  236. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  237. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  238. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  239. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  240. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  241. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +19 -5
  242. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +232 -0
  243. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  244. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  245. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  246. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  247. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  248. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  249. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  250. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  251. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  252. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  253. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  254. data/lib/plaid/models/credit_session.rb +1 -1
  255. data/lib/plaid/models/credit_session_bank_employment_result.rb +239 -0
  256. data/lib/plaid/models/credit_session_bank_employment_status.rb +40 -0
  257. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  258. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  259. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  260. data/lib/plaid/models/credit_session_error.rb +1 -1
  261. data/lib/plaid/models/credit_session_item_add_result.rb +2 -2
  262. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  263. data/lib/plaid/models/credit_session_results.rb +15 -3
  264. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  265. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  266. data/lib/plaid/models/credit_w2.rb +1 -1
  267. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  268. data/lib/plaid/models/dashboard_user.rb +1 -1
  269. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  270. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  271. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  272. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  273. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  274. data/lib/plaid/models/date_range.rb +1 -1
  275. data/lib/plaid/models/deductions.rb +1 -1
  276. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  277. data/lib/plaid/models/deductions_total.rb +1 -1
  278. data/lib/plaid/models/default_update_webhook.rb +1 -1
  279. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  280. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  281. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  282. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  283. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  284. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  285. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  286. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  287. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  288. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  289. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  290. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  291. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  292. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  293. data/lib/plaid/models/depository_filter.rb +1 -1
  294. data/lib/plaid/models/detailed_originator.rb +1 -1
  295. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  296. data/lib/plaid/models/doc_type.rb +1 -1
  297. data/lib/plaid/models/document_analysis.rb +1 -1
  298. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  299. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  300. data/lib/plaid/models/document_metadata.rb +3 -2
  301. data/lib/plaid/models/document_name_match_code.rb +1 -1
  302. data/lib/plaid/models/document_risk_signal.rb +1 -1
  303. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  304. data/lib/plaid/models/document_risk_signals_object.rb +2 -2
  305. data/lib/plaid/models/document_risk_summary.rb +1 -1
  306. data/lib/plaid/models/document_status.rb +1 -1
  307. data/lib/plaid/models/documentary_verification.rb +1 -1
  308. data/lib/plaid/models/documentary_verification_document.rb +16 -5
  309. data/lib/plaid/models/earnings.rb +1 -1
  310. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  311. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  312. data/lib/plaid/models/earnings_total.rb +1 -1
  313. data/lib/plaid/models/email.rb +1 -1
  314. data/lib/plaid/models/email_address_match_score.rb +2 -2
  315. data/lib/plaid/models/employee.rb +1 -1
  316. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  317. data/lib/plaid/models/employer.rb +1 -1
  318. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  319. data/lib/plaid/models/employer_verification.rb +1 -1
  320. data/lib/plaid/models/employers_search_request.rb +1 -1
  321. data/lib/plaid/models/employers_search_response.rb +1 -1
  322. data/lib/plaid/models/employment_details.rb +1 -1
  323. data/lib/plaid/models/employment_source_type.rb +39 -0
  324. data/lib/plaid/models/employment_verification.rb +1 -1
  325. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  326. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  327. data/lib/plaid/models/employment_verification_status.rb +1 -1
  328. data/lib/plaid/models/enhancements.rb +1 -1
  329. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  330. data/lib/plaid/models/enrichments.rb +13 -2
  331. data/lib/plaid/models/entity_document.rb +1 -1
  332. data/lib/plaid/models/entity_document_type.rb +1 -1
  333. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  334. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  335. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  336. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  337. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  338. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  339. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  340. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  341. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  342. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  343. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  344. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +7 -3
  345. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  346. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  347. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  348. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  349. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  350. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  351. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  352. data/lib/plaid/models/expiration_date.rb +1 -1
  353. data/lib/plaid/models/external_payment_initiation_consent_options.rb +3 -31
  354. data/lib/plaid/models/external_payment_options.rb +3 -31
  355. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  356. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  357. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  358. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  359. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +295 -0
  360. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +295 -0
  361. data/lib/plaid/models/fdx_content_types.rb +1 -1
  362. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  363. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  364. data/lib/plaid/models/fdx_notification.rb +1 -1
  365. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  366. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  367. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  368. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  369. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  370. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  371. data/lib/plaid/models/fdx_party.rb +1 -1
  372. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  373. data/lib/plaid/models/fdx_party_type.rb +1 -1
  374. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  375. data/lib/plaid/models/form1099_type.rb +1 -1
  376. data/lib/plaid/models/freddie_report_type.rb +1 -1
  377. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  378. data/lib/plaid/models/health_incident.rb +1 -1
  379. data/lib/plaid/models/historical_balance.rb +1 -1
  380. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  381. data/lib/plaid/models/holding.rb +2 -2
  382. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  383. data/lib/plaid/models/holdings_override.rb +1 -1
  384. data/lib/plaid/models/id_number_type.rb +1 -1
  385. data/lib/plaid/models/identity_default_update_webhook.rb +2 -2
  386. data/lib/plaid/models/identity_get_request.rb +1 -1
  387. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  388. data/lib/plaid/models/identity_get_response.rb +1 -1
  389. data/lib/plaid/models/identity_match_request.rb +1 -1
  390. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  391. data/lib/plaid/models/identity_match_response.rb +1 -1
  392. data/lib/plaid/models/identity_match_user.rb +1 -1
  393. data/lib/plaid/models/identity_update_types.rb +1 -1
  394. data/lib/plaid/models/identity_verification.rb +27 -6
  395. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  396. data/lib/plaid/models/identity_verification_create_response.rb +23 -2
  397. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  398. data/lib/plaid/models/identity_verification_get_response.rb +23 -2
  399. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  400. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  401. data/lib/plaid/models/identity_verification_request_user.rb +2 -2
  402. data/lib/plaid/models/identity_verification_request_user_name.rb +240 -0
  403. data/lib/plaid/models/{user_name.rb → identity_verification_response_user_name.rb} +4 -4
  404. data/lib/plaid/models/identity_verification_retried_webhook.rb +7 -3
  405. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  406. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  407. data/lib/plaid/models/identity_verification_retry_response.rb +23 -2
  408. data/lib/plaid/models/identity_verification_status.rb +1 -1
  409. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +7 -3
  410. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  411. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  412. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +8 -4
  413. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  414. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  415. data/lib/plaid/models/identity_verification_user_data.rb +2 -2
  416. data/lib/plaid/models/image_quality.rb +1 -1
  417. data/lib/plaid/models/incident_update.rb +1 -1
  418. data/lib/plaid/models/income_breakdown.rb +1 -1
  419. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  420. data/lib/plaid/models/income_override.rb +1 -1
  421. data/lib/plaid/models/income_summary.rb +1 -1
  422. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  423. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  424. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  425. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  426. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  427. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  428. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  429. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  430. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  431. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  432. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  433. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  434. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  435. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  436. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  437. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  438. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  439. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  440. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  441. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  442. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  443. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  444. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  445. data/lib/plaid/models/individual_name.rb +1 -1
  446. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  447. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  448. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  449. data/lib/plaid/models/inflow_model.rb +1 -1
  450. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  451. data/lib/plaid/models/institution.rb +15 -3
  452. data/lib/plaid/models/institution_status.rb +1 -1
  453. data/lib/plaid/models/institution_supported_networks.rb +2 -2
  454. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  455. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  456. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  457. data/lib/plaid/models/institutions_get_request.rb +1 -1
  458. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  459. data/lib/plaid/models/institutions_get_response.rb +1 -1
  460. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  461. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  462. data/lib/plaid/models/institutions_search_request.rb +1 -1
  463. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  464. data/lib/plaid/models/institutions_search_response.rb +1 -1
  465. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  466. data/lib/plaid/models/investment_filter.rb +1 -1
  467. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  468. data/lib/plaid/models/investment_transaction.rb +1 -1
  469. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  470. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  471. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  472. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  473. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  474. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  475. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  476. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  477. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  478. data/lib/plaid/models/issuing_country.rb +1 -1
  479. data/lib/plaid/models/item.rb +1 -1
  480. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  481. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  482. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  483. data/lib/plaid/models/item_activity_list_response.rb +19 -2
  484. data/lib/plaid/models/item_application_list_request.rb +1 -1
  485. data/lib/plaid/models/item_application_list_response.rb +1 -1
  486. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  487. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  488. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  489. data/lib/plaid/models/item_error_webhook.rb +1 -1
  490. data/lib/plaid/models/item_get_request.rb +1 -1
  491. data/lib/plaid/models/item_get_response.rb +1 -1
  492. data/lib/plaid/models/item_import_request.rb +1 -1
  493. data/lib/plaid/models/item_import_request_options.rb +1 -1
  494. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  495. data/lib/plaid/models/item_import_response.rb +1 -1
  496. data/lib/plaid/models/item_login_repaired_webhook.rb +269 -0
  497. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  498. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  499. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  500. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  501. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  502. data/lib/plaid/models/item_remove_request.rb +1 -1
  503. data/lib/plaid/models/item_remove_response.rb +1 -1
  504. data/lib/plaid/models/item_status.rb +1 -1
  505. data/lib/plaid/models/item_status_investments.rb +1 -1
  506. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  507. data/lib/plaid/models/item_status_nullable.rb +1 -1
  508. data/lib/plaid/models/item_status_transactions.rb +1 -1
  509. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  510. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  511. data/lib/plaid/models/jwk_public_key.rb +1 -1
  512. data/lib/plaid/models/jwt_header.rb +1 -1
  513. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  514. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  515. data/lib/plaid/models/kyc_check_details.rb +1 -1
  516. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  517. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  518. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  519. data/lib/plaid/models/last_data_access_times.rb +313 -0
  520. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  521. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  522. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  523. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  524. data/lib/plaid/models/liabilities_object.rb +1 -1
  525. data/lib/plaid/models/liability_override.rb +1 -1
  526. data/lib/plaid/models/link_callback_metadata.rb +279 -0
  527. data/lib/plaid/models/link_delivery_account.rb +279 -0
  528. data/lib/plaid/models/link_delivery_callback_webhook.rb +294 -0
  529. data/lib/plaid/models/link_delivery_communication_method.rb +229 -0
  530. data/lib/plaid/models/link_delivery_create_request.rb +9 -29
  531. data/lib/plaid/models/link_delivery_create_response.rb +2 -2
  532. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  533. data/lib/plaid/models/link_delivery_get_request.rb +2 -2
  534. data/lib/plaid/models/link_delivery_get_response.rb +33 -19
  535. data/lib/plaid/models/link_delivery_institution.rb +230 -0
  536. data/lib/plaid/models/link_delivery_metadata.rb +228 -0
  537. data/lib/plaid/models/link_delivery_options.rb +219 -0
  538. data/lib/plaid/models/link_delivery_recipient.rb +232 -0
  539. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  540. data/lib/plaid/models/link_delivery_verification_status.rb +43 -0
  541. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +40 -0
  542. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +39 -0
  543. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +39 -0
  544. data/lib/plaid/models/link_event_name.rb +61 -0
  545. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  546. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  547. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  548. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  549. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  550. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  551. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  552. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  553. data/lib/plaid/models/link_token_create_request.rb +16 -7
  554. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  555. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  556. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  557. data/lib/plaid/models/link_token_create_request_employment.rb +231 -0
  558. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +225 -0
  559. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  560. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  561. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
  562. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +16 -5
  563. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -35
  564. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  565. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  566. data/lib/plaid/models/link_token_create_request_user.rb +6 -6
  567. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  568. data/lib/plaid/models/link_token_create_response.rb +1 -1
  569. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  570. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  571. data/lib/plaid/models/link_token_get_request.rb +1 -1
  572. data/lib/plaid/models/link_token_get_response.rb +1 -1
  573. data/lib/plaid/models/link_token_investments.rb +1 -1
  574. data/lib/plaid/models/link_user_delivery_status_webhook.rb +284 -0
  575. data/lib/plaid/models/loan.rb +1 -1
  576. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  577. data/lib/plaid/models/loan_filter.rb +1 -1
  578. data/lib/plaid/models/loan_identifier.rb +1 -1
  579. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  580. data/lib/plaid/models/loan_identifiers.rb +1 -1
  581. data/lib/plaid/models/loans.rb +1 -1
  582. data/lib/plaid/models/location.rb +1 -1
  583. data/lib/plaid/models/match_summary.rb +1 -1
  584. data/lib/plaid/models/match_summary_code.rb +1 -1
  585. data/lib/plaid/models/meta.rb +1 -1
  586. data/lib/plaid/models/mfa.rb +1 -1
  587. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  588. data/lib/plaid/models/mortgage_liability.rb +1 -1
  589. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  590. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  591. data/lib/plaid/models/name_match_score.rb +3 -3
  592. data/lib/plaid/models/net_pay.rb +1 -1
  593. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  594. data/lib/plaid/models/numbers.rb +1 -1
  595. data/lib/plaid/models/numbers_ach.rb +1 -1
  596. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  597. data/lib/plaid/models/numbers_bacs.rb +1 -1
  598. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  599. data/lib/plaid/models/numbers_eft.rb +1 -1
  600. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  601. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  602. data/lib/plaid/models/numbers_international.rb +1 -1
  603. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  604. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  605. data/lib/plaid/models/originator.rb +1 -1
  606. data/lib/plaid/models/override_account_type.rb +1 -1
  607. data/lib/plaid/models/override_accounts.rb +1 -1
  608. data/lib/plaid/models/owner.rb +1 -1
  609. data/lib/plaid/models/owner_override.rb +1 -1
  610. data/lib/plaid/models/ownership_type.rb +1 -1
  611. data/lib/plaid/models/parties.rb +1 -1
  612. data/lib/plaid/models/partner_customer_create_request.rb +17 -5
  613. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  614. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  615. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  616. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  617. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  618. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  619. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  620. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  621. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  622. data/lib/plaid/models/partner_end_customer.rb +1 -1
  623. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  624. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  625. data/lib/plaid/models/partner_end_customer_billing_contact.rb +2 -2
  626. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  627. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  628. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  629. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  630. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  631. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +42 -0
  632. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +313 -0
  633. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  634. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  635. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  636. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  637. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  638. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  639. data/lib/plaid/models/party.rb +1 -1
  640. data/lib/plaid/models/party_individual.rb +1 -1
  641. data/lib/plaid/models/party_role_type.rb +1 -1
  642. data/lib/plaid/models/pay.rb +1 -1
  643. data/lib/plaid/models/pay_frequency.rb +1 -1
  644. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  645. data/lib/plaid/models/pay_period_details.rb +1 -1
  646. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  647. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  648. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  649. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  650. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  651. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  652. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  653. data/lib/plaid/models/payment_amount.rb +1 -1
  654. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  655. data/lib/plaid/models/payment_amount_nullable.rb +23 -2
  656. data/lib/plaid/models/payment_amount_refunded.rb +23 -2
  657. data/lib/plaid/models/payment_amount_to_refund.rb +23 -2
  658. data/lib/plaid/models/payment_channel.rb +1 -1
  659. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  660. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  661. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  662. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  663. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  664. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  665. data/lib/plaid/models/payment_initiation_address.rb +2 -2
  666. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  667. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  668. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -22
  669. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  670. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -22
  671. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  672. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -22
  673. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  674. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -22
  675. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  676. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  677. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  678. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  679. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  680. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  681. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -22
  682. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  683. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  684. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -22
  685. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  686. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -18
  687. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  688. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +7 -28
  689. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  690. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  691. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -22
  692. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  693. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  694. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  695. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  696. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -22
  697. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  698. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  699. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  700. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  701. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  702. data/lib/plaid/models/payment_meta.rb +1 -1
  703. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  704. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  705. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  706. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  707. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  708. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  709. data/lib/plaid/models/payment_profile_status.rb +1 -1
  710. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  711. data/lib/plaid/models/payment_scheme.rb +1 -1
  712. data/lib/plaid/models/payment_status_update_webhook.rb +13 -2
  713. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  714. data/lib/plaid/models/payroll_income_object.rb +1 -1
  715. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  716. data/lib/plaid/models/payroll_item.rb +1 -1
  717. data/lib/plaid/models/payroll_item_status.rb +1 -1
  718. data/lib/plaid/models/payroll_risk_signals_item.rb +3 -3
  719. data/lib/plaid/models/paystub.rb +1 -1
  720. data/lib/plaid/models/paystub_address.rb +1 -1
  721. data/lib/plaid/models/paystub_deduction.rb +1 -1
  722. data/lib/plaid/models/paystub_details.rb +1 -1
  723. data/lib/plaid/models/paystub_employer.rb +1 -1
  724. data/lib/plaid/models/paystub_override.rb +1 -1
  725. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  726. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  727. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  728. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  729. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  730. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  731. data/lib/plaid/models/personal_finance_category.rb +1 -1
  732. data/lib/plaid/models/phone_number.rb +1 -1
  733. data/lib/plaid/models/phone_number_match_score.rb +2 -2
  734. data/lib/plaid/models/phone_type.rb +1 -1
  735. data/lib/plaid/models/physical_document_category.rb +1 -1
  736. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  737. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  738. data/lib/plaid/models/physical_document_images.rb +2 -6
  739. data/lib/plaid/models/plaid_error.rb +1 -1
  740. data/lib/plaid/models/plaid_error_type.rb +1 -1
  741. data/lib/plaid/models/platform_ids.rb +1 -1
  742. data/lib/plaid/models/po_box_status.rb +1 -1
  743. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  744. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  745. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  746. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  747. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  748. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  749. data/lib/plaid/models/processor_bank_transfer_create_request.rb +2 -2
  750. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  751. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  752. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  753. data/lib/plaid/models/processor_number.rb +1 -1
  754. data/lib/plaid/models/processor_signal_decision_report_request.rb +364 -0
  755. data/lib/plaid/models/processor_signal_decision_report_response.rb +225 -0
  756. data/lib/plaid/models/processor_signal_evaluate_request.rb +383 -0
  757. data/lib/plaid/models/processor_signal_evaluate_response.rb +248 -0
  758. data/lib/plaid/models/processor_signal_return_report_request.rb +316 -0
  759. data/lib/plaid/models/processor_signal_return_report_response.rb +225 -0
  760. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  761. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  762. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  763. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  764. data/lib/plaid/models/product_access.rb +1 -1
  765. data/lib/plaid/models/product_status.rb +1 -1
  766. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  767. data/lib/plaid/models/products.rb +2 -1
  768. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  769. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  770. data/lib/plaid/models/proxy_type.rb +42 -0
  771. data/lib/plaid/models/pslf_status.rb +1 -1
  772. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  773. data/lib/plaid/models/recipient_bacs.rb +1 -1
  774. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  775. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  776. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  777. data/lib/plaid/models/recurring_transaction_frequency.rb +2 -1
  778. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  779. data/lib/plaid/models/recurring_transfer.rb +18 -3
  780. data/lib/plaid/models/recurring_transfer_nullable.rb +18 -3
  781. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  782. data/lib/plaid/models/removed_transaction.rb +1 -1
  783. data/lib/plaid/models/report_type.rb +1 -1
  784. data/lib/plaid/models/reporting_information.rb +1 -1
  785. data/lib/plaid/models/risk_check_behavior.rb +252 -0
  786. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +40 -0
  787. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +40 -0
  788. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +41 -0
  789. data/lib/plaid/models/risk_check_details.rb +271 -0
  790. data/lib/plaid/models/risk_check_device.rb +242 -0
  791. data/lib/plaid/models/risk_check_email.rb +352 -0
  792. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +40 -0
  793. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +40 -0
  794. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +40 -0
  795. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +40 -0
  796. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +40 -0
  797. data/lib/plaid/models/risk_check_linked_service.rb +71 -0
  798. data/lib/plaid/models/risk_check_phone.rb +238 -0
  799. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  800. data/lib/plaid/models/role.rb +1 -1
  801. data/lib/plaid/models/role_detail.rb +1 -1
  802. data/lib/plaid/models/roles.rb +1 -1
  803. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  804. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  805. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  806. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  807. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  808. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  809. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  810. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  811. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  812. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  813. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  814. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  815. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  816. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  817. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  818. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  819. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  820. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  821. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  822. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  823. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  824. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  825. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  826. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  827. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  828. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  829. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  830. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  831. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  832. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  833. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  834. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  835. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  836. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  837. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  838. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  839. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  840. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  841. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  842. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  843. data/lib/plaid/models/scopes.rb +1 -1
  844. data/lib/plaid/models/scopes_context.rb +1 -1
  845. data/lib/plaid/models/scopes_nullable.rb +1 -1
  846. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  847. data/lib/plaid/models/screening_hit_data.rb +1 -1
  848. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  849. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  850. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  851. data/lib/plaid/models/screening_status_updated_webhook.rb +7 -3
  852. data/lib/plaid/models/security.rb +1 -1
  853. data/lib/plaid/models/security_override.rb +1 -1
  854. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  855. data/lib/plaid/models/service.rb +1 -1
  856. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  857. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  858. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  859. data/lib/plaid/models/servicer_address_data.rb +1 -1
  860. data/lib/plaid/models/services.rb +1 -1
  861. data/lib/plaid/models/signal_address_data.rb +1 -1
  862. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  863. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  864. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  865. data/lib/plaid/models/signal_device.rb +1 -1
  866. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  867. data/lib/plaid/models/signal_evaluate_request.rb +3 -3
  868. data/lib/plaid/models/signal_evaluate_response.rb +17 -5
  869. data/lib/plaid/models/signal_payment_method.rb +1 -1
  870. data/lib/plaid/models/signal_person_name.rb +1 -1
  871. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  872. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  873. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  874. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  875. data/lib/plaid/models/signal_scores.rb +1 -1
  876. data/lib/plaid/models/signal_user.rb +1 -1
  877. data/lib/plaid/models/signal_warning.rb +240 -0
  878. data/lib/plaid/models/simulated_transfer_sweep.rb +17 -2
  879. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  880. data/lib/plaid/models/source.rb +1 -1
  881. data/lib/plaid/models/standalone_account_type.rb +1 -1
  882. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  883. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  884. data/lib/plaid/models/status.rb +1 -1
  885. data/lib/plaid/models/statuses.rb +1 -1
  886. data/lib/plaid/models/strategy.rb +1 -1
  887. data/lib/plaid/models/student_loan.rb +1 -1
  888. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  889. data/lib/plaid/models/student_loan_status.rb +1 -1
  890. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  891. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  892. data/lib/plaid/models/taxform.rb +1 -1
  893. data/lib/plaid/models/taxpayer_id.rb +1 -1
  894. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  895. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  896. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  897. data/lib/plaid/models/total.rb +1 -1
  898. data/lib/plaid/models/total_canonical_description.rb +1 -1
  899. data/lib/plaid/models/transaction.rb +140 -140
  900. data/lib/plaid/models/transaction_all_of.rb +21 -21
  901. data/lib/plaid/models/transaction_base.rb +110 -110
  902. data/lib/plaid/models/transaction_code.rb +1 -1
  903. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  904. data/lib/plaid/models/transaction_data.rb +1 -1
  905. data/lib/plaid/models/transaction_override.rb +1 -1
  906. data/lib/plaid/models/transaction_stream.rb +18 -18
  907. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  908. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  909. data/lib/plaid/models/transactions_category_rule.rb +2 -2
  910. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  911. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  912. data/lib/plaid/models/transactions_enrich_get_request.rb +1 -1
  913. data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
  914. data/lib/plaid/models/transactions_enrich_request_options.rb +2 -2
  915. data/lib/plaid/models/transactions_get_request.rb +1 -1
  916. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  917. data/lib/plaid/models/transactions_get_response.rb +1 -1
  918. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  919. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  920. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  921. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  922. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  923. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  924. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  925. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  926. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  927. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  928. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  929. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  930. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  931. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  932. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  933. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  934. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  935. data/lib/plaid/models/transactions_sync_response.rb +5 -5
  936. data/lib/plaid/models/transfer.rb +30 -4
  937. data/lib/plaid/models/transfer_authorization.rb +2 -2
  938. data/lib/plaid/models/transfer_authorization_create_request.rb +14 -3
  939. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  940. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  941. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  942. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  943. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  944. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  945. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  946. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  947. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +17 -2
  948. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  949. data/lib/plaid/models/transfer_cancel_request.rb +16 -5
  950. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  951. data/lib/plaid/models/transfer_capabilities_get_request.rb +2 -2
  952. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  953. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +2 -2
  954. data/lib/plaid/models/transfer_configuration_get_request.rb +241 -0
  955. data/lib/plaid/models/transfer_configuration_get_response.rb +300 -0
  956. data/lib/plaid/models/transfer_create_request.rb +4 -4
  957. data/lib/plaid/models/transfer_create_response.rb +1 -1
  958. data/lib/plaid/models/transfer_device.rb +1 -1
  959. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  960. data/lib/plaid/models/transfer_event.rb +17 -2
  961. data/lib/plaid/models/transfer_event_list_request.rb +17 -6
  962. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  963. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  964. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  965. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  966. data/lib/plaid/models/transfer_event_type.rb +1 -1
  967. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  968. data/lib/plaid/models/transfer_failure.rb +1 -1
  969. data/lib/plaid/models/transfer_get_request.rb +16 -5
  970. data/lib/plaid/models/transfer_get_response.rb +1 -1
  971. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  972. data/lib/plaid/models/transfer_intent_create.rb +30 -4
  973. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  974. data/lib/plaid/models/transfer_intent_create_network.rb +39 -0
  975. data/lib/plaid/models/transfer_intent_create_request.rb +26 -4
  976. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  977. data/lib/plaid/models/transfer_intent_get.rb +29 -3
  978. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  979. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  980. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  981. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  982. data/lib/plaid/models/transfer_list_request.rb +17 -6
  983. data/lib/plaid/models/transfer_list_response.rb +1 -1
  984. data/lib/plaid/models/transfer_metrics_get_request.rb +241 -0
  985. data/lib/plaid/models/transfer_metrics_get_response.rb +285 -0
  986. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  987. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  988. data/lib/plaid/models/transfer_network.rb +1 -1
  989. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  990. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  991. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  992. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  993. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  994. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  995. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  996. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  997. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  998. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  999. data/lib/plaid/models/transfer_recurring_create_request.rb +14 -3
  1000. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1001. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1002. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1003. data/lib/plaid/models/transfer_recurring_list_request.rb +16 -5
  1004. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1005. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1006. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1007. data/lib/plaid/models/transfer_refund.rb +1 -1
  1008. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1009. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1010. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1011. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1012. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1013. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1014. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1015. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1016. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1017. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1018. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1019. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1020. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1021. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1022. data/lib/plaid/models/transfer_status.rb +1 -1
  1023. data/lib/plaid/models/transfer_sweep.rb +17 -2
  1024. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1025. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1026. data/lib/plaid/models/transfer_sweep_list_request.rb +17 -6
  1027. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1028. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1029. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1030. data/lib/plaid/models/transfer_type.rb +1 -1
  1031. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1032. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1033. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1034. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1035. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1036. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1037. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1038. data/lib/plaid/models/user_address.rb +1 -1
  1039. data/lib/plaid/models/user_create_request.rb +1 -1
  1040. data/lib/plaid/models/user_create_response.rb +1 -1
  1041. data/lib/plaid/models/user_custom_password.rb +1 -1
  1042. data/lib/plaid/models/user_id_number.rb +1 -1
  1043. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1044. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1045. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1046. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1047. data/lib/plaid/models/validation_source.rb +1 -1
  1048. data/lib/plaid/models/validation_sources.rb +1 -1
  1049. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1050. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1051. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1052. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1053. data/lib/plaid/models/verification_status.rb +1 -1
  1054. data/lib/plaid/models/w2.rb +1 -1
  1055. data/lib/plaid/models/w2_box12.rb +1 -1
  1056. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1057. data/lib/plaid/models/wallet.rb +19 -5
  1058. data/lib/plaid/models/wallet_balance.rb +1 -1
  1059. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1060. data/lib/plaid/models/wallet_create_response.rb +16 -2
  1061. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1062. data/lib/plaid/models/wallet_get_response.rb +16 -2
  1063. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1064. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1065. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1066. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1067. data/lib/plaid/models/wallet_status.rb +40 -0
  1068. data/lib/plaid/models/wallet_transaction.rb +17 -2
  1069. data/lib/plaid/models/wallet_transaction_amount.rb +6 -6
  1070. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1071. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1072. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1073. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1074. data/lib/plaid/models/wallet_transaction_execute_request.rb +7 -7
  1075. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1076. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1077. data/lib/plaid/models/wallet_transaction_get_response.rb +17 -2
  1078. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1079. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1080. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1081. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1082. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +23 -2
  1083. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1084. data/lib/plaid/models/warning.rb +4 -4
  1085. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1086. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1087. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1088. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1089. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1090. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1091. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1092. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1093. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1094. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1095. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1096. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1097. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1098. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1099. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1100. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1101. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1102. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1103. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1104. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1105. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1106. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1107. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1108. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1109. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1110. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1111. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1112. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1113. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1114. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1115. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1116. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1117. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1118. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1119. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1120. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1121. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1122. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1123. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1124. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1125. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1126. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1127. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1128. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1129. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1130. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1131. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1132. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1133. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1134. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1135. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1136. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1137. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1138. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1139. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1140. data/lib/plaid/models/webhook_type.rb +1 -1
  1141. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1142. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1143. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1144. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1145. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1146. data/lib/plaid/version.rb +2 -2
  1147. data/lib/plaid.rb +66 -2
  1148. data/plaid.gemspec +1 -1
  1149. data/test/test_accounts.rb +23 -1
  1150. metadata +67 -3
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.214.0
6
+ The version of the OpenAPI document: 2020-09-14_1.343.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -800,7 +800,7 @@ module Plaid
800
800
  end
801
801
 
802
802
  # Retrieve auth data
803
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
803
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
804
804
  # @param auth_get_request [AuthGetRequest]
805
805
  # @param [Hash] opts the optional parameters
806
806
  # @return [AuthGetResponse]
@@ -810,7 +810,7 @@ module Plaid
810
810
  end
811
811
 
812
812
  # Retrieve auth data
813
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
813
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
814
814
  # @param auth_get_request [AuthGetRequest]
815
815
  # @param [Hash] opts the optional parameters
816
816
  # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
@@ -1060,7 +1060,7 @@ module Plaid
1060
1060
  end
1061
1061
 
1062
1062
  # List bank transfer events
1063
- # Use the `/bank_transfer/event/list` endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
1063
+ # Use the `/bank_transfer/event/list` endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).
1064
1064
  # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1065
1065
  # @param [Hash] opts the optional parameters
1066
1066
  # @return [BankTransferEventListResponse]
@@ -1070,7 +1070,7 @@ module Plaid
1070
1070
  end
1071
1071
 
1072
1072
  # List bank transfer events
1073
- # Use the &#x60;/bank_transfer/event/list&#x60; endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
1073
+ # Use the &#x60;/bank_transfer/event/list&#x60; endpoint to get a list of Plaid-initiated ACH or bank transfer events based on specified filter criteria. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).
1074
1074
  # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1075
1075
  # @param [Hash] opts the optional parameters
1076
1076
  # @return [Array<(BankTransferEventListResponse, Integer, Hash)>] BankTransferEventListResponse data, response status code and response headers
@@ -1125,7 +1125,7 @@ module Plaid
1125
1125
  end
1126
1126
 
1127
1127
  # Sync bank transfer events
1128
- # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1128
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1129
1129
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1130
1130
  # @param [Hash] opts the optional parameters
1131
1131
  # @return [BankTransferEventSyncResponse]
@@ -1135,7 +1135,7 @@ module Plaid
1135
1135
  end
1136
1136
 
1137
1137
  # Sync bank transfer events
1138
- # &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 bank transfer events that happened after a specific &#x60;event_id&#x60;. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1138
+ # &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific &#x60;event_id&#x60;. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1139
1139
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1140
1140
  # @param [Hash] opts the optional parameters
1141
1141
  # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
@@ -1839,6 +1839,71 @@ module Plaid
1839
1839
  return data, status_code, headers
1840
1840
  end
1841
1841
 
1842
+ # Retrieve information from the bank accounts used for employment verification
1843
+ # `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
1844
+ # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
1845
+ # @param [Hash] opts the optional parameters
1846
+ # @return [CreditBankEmploymentGetResponse]
1847
+ def credit_bank_employment_get(credit_bank_employment_get_request, opts = {})
1848
+ data, _status_code, _headers = credit_bank_employment_get_with_http_info(credit_bank_employment_get_request, opts)
1849
+ data
1850
+ end
1851
+
1852
+ # Retrieve information from the bank accounts used for employment verification
1853
+ # &#x60;/credit/bank_employment/get&#x60; returns the employment report(s) derived from bank transaction data for a specified user.
1854
+ # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
1855
+ # @param [Hash] opts the optional parameters
1856
+ # @return [Array<(CreditBankEmploymentGetResponse, Integer, Hash)>] CreditBankEmploymentGetResponse data, response status code and response headers
1857
+ def credit_bank_employment_get_with_http_info(credit_bank_employment_get_request, opts = {})
1858
+ if @api_client.config.debugging
1859
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_employment_get ...'
1860
+ end
1861
+ # verify the required parameter 'credit_bank_employment_get_request' is set
1862
+ if @api_client.config.client_side_validation && credit_bank_employment_get_request.nil?
1863
+ fail ArgumentError, "Missing the required parameter 'credit_bank_employment_get_request' when calling PlaidApi.credit_bank_employment_get"
1864
+ end
1865
+ # resource path
1866
+ local_var_path = '/beta/credit/v1/bank_employment/get'
1867
+
1868
+ # query parameters
1869
+ query_params = opts[:query_params] || {}
1870
+
1871
+ # header parameters
1872
+ header_params = opts[:header_params] || {}
1873
+ # HTTP header 'Accept' (if needed)
1874
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1875
+ # HTTP header 'Content-Type'
1876
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1877
+
1878
+ # form parameters
1879
+ form_params = opts[:form_params] || {}
1880
+
1881
+ # http body (model)
1882
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_employment_get_request)
1883
+
1884
+ # return_type
1885
+ return_type = opts[:debug_return_type] || 'CreditBankEmploymentGetResponse'
1886
+
1887
+ # auth_names
1888
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1889
+
1890
+ new_options = opts.merge(
1891
+ :operation => :"PlaidApi.credit_bank_employment_get",
1892
+ :header_params => header_params,
1893
+ :query_params => query_params,
1894
+ :form_params => form_params,
1895
+ :body => post_body,
1896
+ :auth_names => auth_names,
1897
+ :return_type => return_type
1898
+ )
1899
+
1900
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1901
+ if @api_client.config.debugging
1902
+ @api_client.config.logger.debug "API called: PlaidApi#credit_bank_employment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1903
+ end
1904
+ return data, status_code, headers
1905
+ end
1906
+
1842
1907
  # Retrieve information from the bank accounts used for income verification
1843
1908
  # `/credit/bank_income/get` returns the bank income report(s) for a specified user.
1844
1909
  # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
@@ -5089,7 +5154,7 @@ module Plaid
5089
5154
  return data, status_code, headers
5090
5155
  end
5091
5156
 
5092
- # Create link delivery session
5157
+ # Create Link Delivery session
5093
5158
  # Use the `/link_delivery/create` endpoint to create a Link Delivery session.
5094
5159
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5095
5160
  # @param [Hash] opts the optional parameters
@@ -5099,7 +5164,7 @@ module Plaid
5099
5164
  data
5100
5165
  end
5101
5166
 
5102
- # Create link delivery session
5167
+ # Create Link Delivery session
5103
5168
  # Use the &#x60;/link_delivery/create&#x60; endpoint to create a Link Delivery session.
5104
5169
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5105
5170
  # @param [Hash] opts the optional parameters
@@ -5154,7 +5219,7 @@ module Plaid
5154
5219
  return data, status_code, headers
5155
5220
  end
5156
5221
 
5157
- # Get link delivery session
5222
+ # Get Link Delivery session
5158
5223
  # Use the `/link_delivery/get` endpoint to get the status of a Link Delivery session.
5159
5224
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5160
5225
  # @param [Hash] opts the optional parameters
@@ -5164,7 +5229,7 @@ module Plaid
5164
5229
  data
5165
5230
  end
5166
5231
 
5167
- # Get link delivery session
5232
+ # Get Link Delivery session
5168
5233
  # Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Link Delivery session.
5169
5234
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5170
5235
  # @param [Hash] opts the optional parameters
@@ -5610,7 +5675,7 @@ module Plaid
5610
5675
  end
5611
5676
 
5612
5677
  # Returns OAuth-institution registration information for a given end customer.
5613
- # The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
5678
+ # The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the [reseller documentation](https://plaid.com/docs/account/resellers/#enabling-end-customers).
5614
5679
  # @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
5615
5680
  # @param [Hash] opts the optional parameters
5616
5681
  # @return [PartnerCustomerOAuthInstitutionsGetResponse]
@@ -5620,7 +5685,7 @@ module Plaid
5620
5685
  end
5621
5686
 
5622
5687
  # Returns OAuth-institution registration information for a given end customer.
5623
- # The &#x60;/partner/customer/oauth_institutions/get&#x60; endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
5688
+ # The &#x60;/partner/customer/oauth_institutions/get&#x60; endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer. To learn how to set up a webhook to listen to status update events, visit the [reseller documentation](https://plaid.com/docs/account/resellers/#enabling-end-customers).
5624
5689
  # @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
5625
5690
  # @param [Hash] opts the optional parameters
5626
5691
  # @return [Array<(PartnerCustomerOAuthInstitutionsGetResponse, Integer, Hash)>] PartnerCustomerOAuthInstitutionsGetResponse data, response status code and response headers
@@ -6195,7 +6260,7 @@ module Plaid
6195
6260
  end
6196
6261
 
6197
6262
  # Reverse an existing payment
6198
- # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
6263
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
6199
6264
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
6200
6265
  # @param [Hash] opts the optional parameters
6201
6266
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -6205,7 +6270,7 @@ module Plaid
6205
6270
  end
6206
6271
 
6207
6272
  # Reverse an existing payment
6208
- # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
6273
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
6209
6274
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
6210
6275
  # @param [Hash] opts the optional parameters
6211
6276
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -6974,6 +7039,201 @@ module Plaid
6974
7039
  return data, status_code, headers
6975
7040
  end
6976
7041
 
7042
+ # Report whether you initiated an ACH transaction
7043
+ # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
7044
+ # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7045
+ # @param [Hash] opts the optional parameters
7046
+ # @return [ProcessorSignalDecisionReportResponse]
7047
+ def processor_signal_decision_report(processor_signal_decision_report_request, opts = {})
7048
+ data, _status_code, _headers = processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts)
7049
+ data
7050
+ end
7051
+
7052
+ # Report whether you initiated an ACH transaction
7053
+ # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
7054
+ # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7055
+ # @param [Hash] opts the optional parameters
7056
+ # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
7057
+ def processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts = {})
7058
+ if @api_client.config.debugging
7059
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_decision_report ...'
7060
+ end
7061
+ # verify the required parameter 'processor_signal_decision_report_request' is set
7062
+ if @api_client.config.client_side_validation && processor_signal_decision_report_request.nil?
7063
+ fail ArgumentError, "Missing the required parameter 'processor_signal_decision_report_request' when calling PlaidApi.processor_signal_decision_report"
7064
+ end
7065
+ # resource path
7066
+ local_var_path = '/processor/signal/decision/report'
7067
+
7068
+ # query parameters
7069
+ query_params = opts[:query_params] || {}
7070
+
7071
+ # header parameters
7072
+ header_params = opts[:header_params] || {}
7073
+ # HTTP header 'Accept' (if needed)
7074
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7075
+ # HTTP header 'Content-Type'
7076
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7077
+
7078
+ # form parameters
7079
+ form_params = opts[:form_params] || {}
7080
+
7081
+ # http body (model)
7082
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_decision_report_request)
7083
+
7084
+ # return_type
7085
+ return_type = opts[:debug_return_type] || 'ProcessorSignalDecisionReportResponse'
7086
+
7087
+ # auth_names
7088
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7089
+
7090
+ new_options = opts.merge(
7091
+ :operation => :"PlaidApi.processor_signal_decision_report",
7092
+ :header_params => header_params,
7093
+ :query_params => query_params,
7094
+ :form_params => form_params,
7095
+ :body => post_body,
7096
+ :auth_names => auth_names,
7097
+ :return_type => return_type
7098
+ )
7099
+
7100
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7101
+ if @api_client.config.debugging
7102
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7103
+ end
7104
+ return data, status_code, headers
7105
+ end
7106
+
7107
+ # Evaluate a planned ACH transaction
7108
+ # Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7109
+ # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7110
+ # @param [Hash] opts the optional parameters
7111
+ # @return [ProcessorSignalEvaluateResponse]
7112
+ def processor_signal_evaluate(processor_signal_evaluate_request, opts = {})
7113
+ data, _status_code, _headers = processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts)
7114
+ data
7115
+ end
7116
+
7117
+ # Evaluate a planned ACH transaction
7118
+ # Use &#x60;/processor/signal/evaluate&#x60; to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/processor/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7119
+ # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7120
+ # @param [Hash] opts the optional parameters
7121
+ # @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
7122
+ def processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts = {})
7123
+ if @api_client.config.debugging
7124
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_evaluate ...'
7125
+ end
7126
+ # verify the required parameter 'processor_signal_evaluate_request' is set
7127
+ if @api_client.config.client_side_validation && processor_signal_evaluate_request.nil?
7128
+ fail ArgumentError, "Missing the required parameter 'processor_signal_evaluate_request' when calling PlaidApi.processor_signal_evaluate"
7129
+ end
7130
+ # resource path
7131
+ local_var_path = '/processor/signal/evaluate'
7132
+
7133
+ # query parameters
7134
+ query_params = opts[:query_params] || {}
7135
+
7136
+ # header parameters
7137
+ header_params = opts[:header_params] || {}
7138
+ # HTTP header 'Accept' (if needed)
7139
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7140
+ # HTTP header 'Content-Type'
7141
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7142
+
7143
+ # form parameters
7144
+ form_params = opts[:form_params] || {}
7145
+
7146
+ # http body (model)
7147
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_evaluate_request)
7148
+
7149
+ # return_type
7150
+ return_type = opts[:debug_return_type] || 'ProcessorSignalEvaluateResponse'
7151
+
7152
+ # auth_names
7153
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7154
+
7155
+ new_options = opts.merge(
7156
+ :operation => :"PlaidApi.processor_signal_evaluate",
7157
+ :header_params => header_params,
7158
+ :query_params => query_params,
7159
+ :form_params => form_params,
7160
+ :body => post_body,
7161
+ :auth_names => auth_names,
7162
+ :return_type => return_type
7163
+ )
7164
+
7165
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7166
+ if @api_client.config.debugging
7167
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7168
+ end
7169
+ return data, status_code, headers
7170
+ end
7171
+
7172
+ # Report a return for an ACH transaction
7173
+ # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7174
+ # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
7175
+ # @param [Hash] opts the optional parameters
7176
+ # @return [ProcessorSignalReturnReportResponse]
7177
+ def processor_signal_return_report(processor_signal_return_report_request, opts = {})
7178
+ data, _status_code, _headers = processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts)
7179
+ data
7180
+ end
7181
+
7182
+ # Report a return for an ACH transaction
7183
+ # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7184
+ # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
7185
+ # @param [Hash] opts the optional parameters
7186
+ # @return [Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>] ProcessorSignalReturnReportResponse data, response status code and response headers
7187
+ def processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts = {})
7188
+ if @api_client.config.debugging
7189
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_return_report ...'
7190
+ end
7191
+ # verify the required parameter 'processor_signal_return_report_request' is set
7192
+ if @api_client.config.client_side_validation && processor_signal_return_report_request.nil?
7193
+ fail ArgumentError, "Missing the required parameter 'processor_signal_return_report_request' when calling PlaidApi.processor_signal_return_report"
7194
+ end
7195
+ # resource path
7196
+ local_var_path = '/processor/signal/return/report'
7197
+
7198
+ # query parameters
7199
+ query_params = opts[:query_params] || {}
7200
+
7201
+ # header parameters
7202
+ header_params = opts[:header_params] || {}
7203
+ # HTTP header 'Accept' (if needed)
7204
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7205
+ # HTTP header 'Content-Type'
7206
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7207
+
7208
+ # form parameters
7209
+ form_params = opts[:form_params] || {}
7210
+
7211
+ # http body (model)
7212
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_return_report_request)
7213
+
7214
+ # return_type
7215
+ return_type = opts[:debug_return_type] || 'ProcessorSignalReturnReportResponse'
7216
+
7217
+ # auth_names
7218
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7219
+
7220
+ new_options = opts.merge(
7221
+ :operation => :"PlaidApi.processor_signal_return_report",
7222
+ :header_params => header_params,
7223
+ :query_params => query_params,
7224
+ :form_params => form_params,
7225
+ :body => post_body,
7226
+ :auth_names => auth_names,
7227
+ :return_type => return_type
7228
+ )
7229
+
7230
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7231
+ if @api_client.config.debugging
7232
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7233
+ end
7234
+ return data, status_code, headers
7235
+ end
7236
+
6977
7237
  # Create Stripe bank account token
6978
7238
  # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
6979
7239
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
@@ -8340,7 +8600,7 @@ module Plaid
8340
8600
  end
8341
8601
 
8342
8602
  # Evaluate a planned ACH transaction
8343
- # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
8603
+ # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on [Item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
8344
8604
  # @param signal_evaluate_request [SignalEvaluateRequest]
8345
8605
  # @param [Hash] opts the optional parameters
8346
8606
  # @return [SignalEvaluateResponse]
@@ -8350,7 +8610,7 @@ module Plaid
8350
8610
  end
8351
8611
 
8352
8612
  # Evaluate a planned ACH transaction
8353
- # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
8613
+ # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to the error documentation on [Item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
8354
8614
  # @param signal_evaluate_request [SignalEvaluateRequest]
8355
8615
  # @param [Hash] opts the optional parameters
8356
8616
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
@@ -8405,7 +8665,7 @@ module Plaid
8405
8665
  end
8406
8666
 
8407
8667
  # Opt-in an Item to Signal
8408
- # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account & routing number, call `/identity/get` to retrieve bank ownership details, call `/signal/prepare` to begin Signal data collection, then call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
8668
+ # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).
8409
8669
  # @param signal_prepare_request [SignalPrepareRequest]
8410
8670
  # @param [Hash] opts the optional parameters
8411
8671
  # @return [SignalPrepareResponse]
@@ -8415,7 +8675,7 @@ module Plaid
8415
8675
  end
8416
8676
 
8417
8677
  # Opt-in an Item to Signal
8418
- # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account &amp; routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, call &#x60;/signal/prepare&#x60; to begin Signal data collection, then call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
8678
+ # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations).
8419
8679
  # @param signal_prepare_request [SignalPrepareRequest]
8420
8680
  # @param [Hash] opts the optional parameters
8421
8681
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -8600,7 +8860,7 @@ module Plaid
8600
8860
  end
8601
8861
 
8602
8862
  # Enrich locally-held transaction data
8603
- # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8863
+ # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. To request access to Enrich, reach out to your Plaid point of contact or send a note to enrich-feedback@plaid.com
8604
8864
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8605
8865
  # @param [Hash] opts the optional parameters
8606
8866
  # @return [TransactionsEnrichGetResponse]
@@ -8610,7 +8870,7 @@ module Plaid
8610
8870
  end
8611
8871
 
8612
8872
  # Enrich locally-held transaction data
8613
- # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8873
+ # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. To request access to Enrich, reach out to your Plaid point of contact or send a note to enrich-feedback@plaid.com
8614
8874
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8615
8875
  # @param [Hash] opts the optional parameters
8616
8876
  # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
@@ -8730,7 +8990,7 @@ module Plaid
8730
8990
  end
8731
8991
 
8732
8992
  # Fetch recurring transaction streams
8733
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get`). After the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8993
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8734
8994
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8735
8995
  # @param [Hash] opts the optional parameters
8736
8996
  # @return [TransactionsRecurringGetResponse]
@@ -8740,7 +9000,7 @@ module Plaid
8740
9000
  end
8741
9001
 
8742
9002
  # Fetch recurring transaction streams
8743
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60;). After the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
9003
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8744
9004
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8745
9005
  # @param [Hash] opts the optional parameters
8746
9006
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -8795,7 +9055,7 @@ module Plaid
8795
9055
  end
8796
9056
 
8797
9057
  # Refresh transaction data
8798
- # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
9058
+ # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8799
9059
  # @param transactions_refresh_request [TransactionsRefreshRequest]
8800
9060
  # @param [Hash] opts the optional parameters
8801
9061
  # @return [TransactionsRefreshResponse]
@@ -8805,7 +9065,7 @@ module Plaid
8805
9065
  end
8806
9066
 
8807
9067
  # Refresh transaction data
8808
- # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UDPATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
9068
+ # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on an Item from that institution. &#x60;/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8809
9069
  # @param transactions_refresh_request [TransactionsRefreshRequest]
8810
9070
  # @param [Hash] opts the optional parameters
8811
9071
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
@@ -9055,7 +9315,7 @@ module Plaid
9055
9315
  end
9056
9316
 
9057
9317
  # Get incremental transaction updates on an Item
9058
- # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9318
+ # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9059
9319
  # @param transactions_sync_request [TransactionsSyncRequest]
9060
9320
  # @param [Hash] opts the optional parameters
9061
9321
  # @return [TransactionsSyncResponse]
@@ -9065,7 +9325,7 @@ module Plaid
9065
9325
  end
9066
9326
 
9067
9327
  # Get incremental transaction updates on an Item
9068
- # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9328
+ # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update, which can occur as a result of the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9069
9329
  # @param transactions_sync_request [TransactionsSyncRequest]
9070
9330
  # @param [Hash] opts the optional parameters
9071
9331
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -9314,6 +9574,71 @@ module Plaid
9314
9574
  return data, status_code, headers
9315
9575
  end
9316
9576
 
9577
+ # Get transfer product configuration
9578
+ # Use the `/transfer/configuration/get` endpoint to view your transfer product configurations.
9579
+ # @param transfer_configuration_get_request [TransferConfigurationGetRequest]
9580
+ # @param [Hash] opts the optional parameters
9581
+ # @return [TransferConfigurationGetResponse]
9582
+ def transfer_configuration_get(transfer_configuration_get_request, opts = {})
9583
+ data, _status_code, _headers = transfer_configuration_get_with_http_info(transfer_configuration_get_request, opts)
9584
+ data
9585
+ end
9586
+
9587
+ # Get transfer product configuration
9588
+ # Use the &#x60;/transfer/configuration/get&#x60; endpoint to view your transfer product configurations.
9589
+ # @param transfer_configuration_get_request [TransferConfigurationGetRequest]
9590
+ # @param [Hash] opts the optional parameters
9591
+ # @return [Array<(TransferConfigurationGetResponse, Integer, Hash)>] TransferConfigurationGetResponse data, response status code and response headers
9592
+ def transfer_configuration_get_with_http_info(transfer_configuration_get_request, opts = {})
9593
+ if @api_client.config.debugging
9594
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_configuration_get ...'
9595
+ end
9596
+ # verify the required parameter 'transfer_configuration_get_request' is set
9597
+ if @api_client.config.client_side_validation && transfer_configuration_get_request.nil?
9598
+ fail ArgumentError, "Missing the required parameter 'transfer_configuration_get_request' when calling PlaidApi.transfer_configuration_get"
9599
+ end
9600
+ # resource path
9601
+ local_var_path = '/transfer/configuration/get'
9602
+
9603
+ # query parameters
9604
+ query_params = opts[:query_params] || {}
9605
+
9606
+ # header parameters
9607
+ header_params = opts[:header_params] || {}
9608
+ # HTTP header 'Accept' (if needed)
9609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9610
+ # HTTP header 'Content-Type'
9611
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9612
+
9613
+ # form parameters
9614
+ form_params = opts[:form_params] || {}
9615
+
9616
+ # http body (model)
9617
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_configuration_get_request)
9618
+
9619
+ # return_type
9620
+ return_type = opts[:debug_return_type] || 'TransferConfigurationGetResponse'
9621
+
9622
+ # auth_names
9623
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9624
+
9625
+ new_options = opts.merge(
9626
+ :operation => :"PlaidApi.transfer_configuration_get",
9627
+ :header_params => header_params,
9628
+ :query_params => query_params,
9629
+ :form_params => form_params,
9630
+ :body => post_body,
9631
+ :auth_names => auth_names,
9632
+ :return_type => return_type
9633
+ )
9634
+
9635
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9636
+ if @api_client.config.debugging
9637
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_configuration_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9638
+ end
9639
+ return data, status_code, headers
9640
+ end
9641
+
9317
9642
  # Create a transfer
9318
9643
  # Use the `/transfer/create` endpoint to initiate a new transfer.
9319
9644
  # @param transfer_create_request [TransferCreateRequest]
@@ -9769,6 +10094,71 @@ module Plaid
9769
10094
  return data, status_code, headers
9770
10095
  end
9771
10096
 
10097
+ # Get transfer product usage metrics
10098
+ # Use the `/transfer/metrics/get` endpoint to view your transfer product usage metrics.
10099
+ # @param transfer_metrics_get_request [TransferMetricsGetRequest]
10100
+ # @param [Hash] opts the optional parameters
10101
+ # @return [TransferMetricsGetResponse]
10102
+ def transfer_metrics_get(transfer_metrics_get_request, opts = {})
10103
+ data, _status_code, _headers = transfer_metrics_get_with_http_info(transfer_metrics_get_request, opts)
10104
+ data
10105
+ end
10106
+
10107
+ # Get transfer product usage metrics
10108
+ # Use the &#x60;/transfer/metrics/get&#x60; endpoint to view your transfer product usage metrics.
10109
+ # @param transfer_metrics_get_request [TransferMetricsGetRequest]
10110
+ # @param [Hash] opts the optional parameters
10111
+ # @return [Array<(TransferMetricsGetResponse, Integer, Hash)>] TransferMetricsGetResponse data, response status code and response headers
10112
+ def transfer_metrics_get_with_http_info(transfer_metrics_get_request, opts = {})
10113
+ if @api_client.config.debugging
10114
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_metrics_get ...'
10115
+ end
10116
+ # verify the required parameter 'transfer_metrics_get_request' is set
10117
+ if @api_client.config.client_side_validation && transfer_metrics_get_request.nil?
10118
+ fail ArgumentError, "Missing the required parameter 'transfer_metrics_get_request' when calling PlaidApi.transfer_metrics_get"
10119
+ end
10120
+ # resource path
10121
+ local_var_path = '/transfer/metrics/get'
10122
+
10123
+ # query parameters
10124
+ query_params = opts[:query_params] || {}
10125
+
10126
+ # header parameters
10127
+ header_params = opts[:header_params] || {}
10128
+ # HTTP header 'Accept' (if needed)
10129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10130
+ # HTTP header 'Content-Type'
10131
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10132
+
10133
+ # form parameters
10134
+ form_params = opts[:form_params] || {}
10135
+
10136
+ # http body (model)
10137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_metrics_get_request)
10138
+
10139
+ # return_type
10140
+ return_type = opts[:debug_return_type] || 'TransferMetricsGetResponse'
10141
+
10142
+ # auth_names
10143
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10144
+
10145
+ new_options = opts.merge(
10146
+ :operation => :"PlaidApi.transfer_metrics_get",
10147
+ :header_params => header_params,
10148
+ :query_params => query_params,
10149
+ :form_params => form_params,
10150
+ :body => post_body,
10151
+ :auth_names => auth_names,
10152
+ :return_type => return_type
10153
+ )
10154
+
10155
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10156
+ if @api_client.config.debugging
10157
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_metrics_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10158
+ end
10159
+ return data, status_code, headers
10160
+ end
10161
+
9772
10162
  # Migrate account into Transfers
9773
10163
  # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
9774
10164
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
@@ -11264,71 +11654,6 @@ module Plaid
11264
11654
  return data, status_code, headers
11265
11655
  end
11266
11656
 
11267
- # List e-wallet transactions
11268
- # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
11269
- # @param wallet_transactions_list_request [WalletTransactionsListRequest]
11270
- # @param [Hash] opts the optional parameters
11271
- # @return [WalletTransactionListResponse]
11272
- def wallet_transactions_list(wallet_transactions_list_request, opts = {})
11273
- data, _status_code, _headers = wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts)
11274
- data
11275
- end
11276
-
11277
- # List e-wallet transactions
11278
- # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
11279
- # @param wallet_transactions_list_request [WalletTransactionsListRequest]
11280
- # @param [Hash] opts the optional parameters
11281
- # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
11282
- def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
11283
- if @api_client.config.debugging
11284
- @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
11285
- end
11286
- # verify the required parameter 'wallet_transactions_list_request' is set
11287
- if @api_client.config.client_side_validation && wallet_transactions_list_request.nil?
11288
- fail ArgumentError, "Missing the required parameter 'wallet_transactions_list_request' when calling PlaidApi.wallet_transactions_list"
11289
- end
11290
- # resource path
11291
- local_var_path = '/wallet/transactions/list'
11292
-
11293
- # query parameters
11294
- query_params = opts[:query_params] || {}
11295
-
11296
- # header parameters
11297
- header_params = opts[:header_params] || {}
11298
- # HTTP header 'Accept' (if needed)
11299
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11300
- # HTTP header 'Content-Type'
11301
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
11302
-
11303
- # form parameters
11304
- form_params = opts[:form_params] || {}
11305
-
11306
- # http body (model)
11307
- post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transactions_list_request)
11308
-
11309
- # return_type
11310
- return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
11311
-
11312
- # auth_names
11313
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11314
-
11315
- new_options = opts.merge(
11316
- :operation => :"PlaidApi.wallet_transactions_list",
11317
- :header_params => header_params,
11318
- :query_params => query_params,
11319
- :form_params => form_params,
11320
- :body => post_body,
11321
- :auth_names => auth_names,
11322
- :return_type => return_type
11323
- )
11324
-
11325
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11326
- if @api_client.config.debugging
11327
- @api_client.config.logger.debug "API called: PlaidApi#wallet_transactions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11328
- end
11329
- return data, status_code, headers
11330
- end
11331
-
11332
11657
  # Create a watchlist screening for an entity
11333
11658
  # Create a new entity watchlist screening to check your customer against watchlists defined in the associated entity watchlist program. If your associated program has ongoing screening enabled, this is the profile information that will be used to monitor your customer over time.
11334
11659
  # @param watchlist_screening_entity_create_request [WatchlistScreeningEntityCreateRequest]