plaid 45.4.0 → 46.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2035) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +100 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +245 -41
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/aamva_analysis.rb +1 -1
  10. data/lib/plaid/models/aamva_detailed_match_result.rb +1 -1
  11. data/lib/plaid/models/aamva_match_result.rb +1 -1
  12. data/lib/plaid/models/account_access.rb +1 -1
  13. data/lib/plaid/models/account_assets.rb +1 -1
  14. data/lib/plaid/models/account_balance.rb +1 -1
  15. data/lib/plaid/models/account_base.rb +1 -1
  16. data/lib/plaid/models/account_base_nullable.rb +1 -1
  17. data/lib/plaid/models/account_filter.rb +1 -1
  18. data/lib/plaid/models/account_filters_response.rb +1 -1
  19. data/lib/plaid/models/account_holder_category.rb +1 -1
  20. data/lib/plaid/models/account_identity.rb +1 -1
  21. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  22. data/lib/plaid/models/account_identity_document_upload.rb +1 -1
  23. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  24. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  25. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  26. data/lib/plaid/models/account_insights.rb +1 -1
  27. data/lib/plaid/models/account_product_access.rb +1 -1
  28. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  29. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  30. data/lib/plaid/models/account_subtype.rb +9 -1
  31. data/lib/plaid/models/account_type.rb +1 -1
  32. data/lib/plaid/models/account_verification_insights.rb +1 -1
  33. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  34. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  35. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  36. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  37. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  38. data/lib/plaid/models/accounts_get_request.rb +1 -1
  39. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  40. data/lib/plaid/models/accounts_get_response.rb +1 -1
  41. data/lib/plaid/models/ach_class.rb +1 -1
  42. data/lib/plaid/models/action_state.rb +1 -1
  43. data/lib/plaid/models/activity.rb +1 -1
  44. data/lib/plaid/models/activity_type.rb +1 -1
  45. data/lib/plaid/models/address.rb +1 -1
  46. data/lib/plaid/models/address_data.rb +1 -1
  47. data/lib/plaid/models/address_data_not_required.rb +1 -1
  48. data/lib/plaid/models/address_data_nullable.rb +1 -1
  49. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  50. data/lib/plaid/models/address_match_score.rb +1 -1
  51. data/lib/plaid/models/address_nullable.rb +1 -1
  52. data/lib/plaid/models/address_purpose_label.rb +1 -1
  53. data/lib/plaid/models/affordability_insights.rb +1 -1
  54. data/lib/plaid/models/amount_with_currency.rb +2 -2
  55. data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +1 -1
  56. data/lib/plaid/models/application.rb +1 -1
  57. data/lib/plaid/models/application_get_request.rb +1 -1
  58. data/lib/plaid/models/application_get_response.rb +1 -1
  59. data/lib/plaid/models/apr.rb +1 -1
  60. data/lib/plaid/models/asset.rb +1 -1
  61. data/lib/plaid/models/asset_detail.rb +1 -1
  62. data/lib/plaid/models/asset_holder.rb +1 -1
  63. data/lib/plaid/models/asset_holder_name.rb +1 -1
  64. data/lib/plaid/models/asset_holding.rb +1 -1
  65. data/lib/plaid/models/asset_holdings.rb +1 -1
  66. data/lib/plaid/models/asset_investment_transaction_type.rb +1 -1
  67. data/lib/plaid/models/asset_owner.rb +1 -1
  68. data/lib/plaid/models/asset_owners.rb +1 -1
  69. data/lib/plaid/models/asset_report.rb +1 -1
  70. data/lib/plaid/models/asset_report_account_balance.rb +1 -1
  71. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  72. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  75. data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  78. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  80. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  81. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  84. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  85. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  86. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  90. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  91. data/lib/plaid/models/asset_report_investment_transaction.rb +1 -1
  92. data/lib/plaid/models/asset_report_investments.rb +1 -1
  93. data/lib/plaid/models/asset_report_item.rb +1 -1
  94. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  95. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  96. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  97. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  98. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  99. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  100. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  101. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  102. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  103. data/lib/plaid/models/asset_report_type.rb +1 -1
  104. data/lib/plaid/models/asset_report_user.rb +1 -1
  105. data/lib/plaid/models/asset_transaction.rb +1 -1
  106. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  107. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  108. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  109. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  110. data/lib/plaid/models/asset_transactions.rb +1 -1
  111. data/lib/plaid/models/asset_type.rb +1 -1
  112. data/lib/plaid/models/assets.rb +1 -1
  113. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  114. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  115. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  116. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  117. data/lib/plaid/models/auth_get_request.rb +1 -1
  118. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  119. data/lib/plaid/models/auth_get_response.rb +1 -1
  120. data/lib/plaid/models/auth_metadata.rb +1 -1
  121. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  122. data/lib/plaid/models/auth_update_types.rb +1 -1
  123. data/lib/plaid/models/auth_verify_numbers_ach.rb +1 -1
  124. data/lib/plaid/models/auth_verify_request.rb +1 -1
  125. data/lib/plaid/models/auth_verify_request_numbers.rb +1 -1
  126. data/lib/plaid/models/auth_verify_response.rb +1 -1
  127. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  128. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  129. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  130. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  131. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  132. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  133. data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
  134. data/lib/plaid/models/bank_penalties_indicators.rb +1 -1
  135. data/lib/plaid/models/bank_transfer.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  156. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  157. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  158. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  159. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  160. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  161. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  162. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  163. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  164. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  165. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  166. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  167. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  168. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  169. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  170. data/lib/plaid/models/base_report.rb +1 -1
  171. data/lib/plaid/models/base_report_account.rb +1 -1
  172. data/lib/plaid/models/base_report_account_balances.rb +1 -1
  173. data/lib/plaid/models/base_report_account_insights.rb +1 -1
  174. data/lib/plaid/models/base_report_account_metadata.rb +1 -1
  175. data/lib/plaid/models/base_report_attributes.rb +1 -1
  176. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  177. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  178. data/lib/plaid/models/base_report_historical_balance.rb +1 -1
  179. data/lib/plaid/models/base_report_investment_holding.rb +1 -1
  180. data/lib/plaid/models/base_report_investment_security.rb +1 -1
  181. data/lib/plaid/models/base_report_investment_transaction.rb +1 -1
  182. data/lib/plaid/models/base_report_investments.rb +1 -1
  183. data/lib/plaid/models/base_report_item.rb +1 -1
  184. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  185. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  186. data/lib/plaid/models/base_report_transaction.rb +1 -1
  187. data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +1 -1
  188. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  189. data/lib/plaid/models/base_report_user_attributes.rb +1 -1
  190. data/lib/plaid/models/base_report_warning.rb +1 -1
  191. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  192. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  193. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  194. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  195. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  196. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  197. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  198. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  199. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  200. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  201. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  202. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  203. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  204. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  205. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  206. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  207. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  208. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  209. data/lib/plaid/models/beacon_report.rb +1 -1
  210. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  211. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  212. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  213. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  214. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  215. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  216. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  217. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  218. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  219. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  220. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  221. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  222. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  223. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  224. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  225. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  226. data/lib/plaid/models/beacon_report_type.rb +1 -1
  227. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  228. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  229. data/lib/plaid/models/beacon_user.rb +1 -1
  230. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  231. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  232. data/lib/plaid/models/beacon_user_address.rb +1 -1
  233. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  234. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  235. data/lib/plaid/models/beacon_user_data.rb +1 -1
  236. data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
  237. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  238. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  239. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  240. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  241. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  242. data/lib/plaid/models/beacon_user_name.rb +1 -1
  243. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  244. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  245. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  246. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  247. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  248. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  249. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  250. data/lib/plaid/models/beacon_user_status.rb +1 -1
  251. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  252. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  253. data/lib/plaid/models/beacon_user_update_request_data.rb +1 -1
  254. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  255. data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +1 -1
  256. data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +18 -5
  257. data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +3 -3
  258. data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +1 -1
  259. data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +1 -1
  260. data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +1 -1
  261. data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +1 -1
  262. data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +1 -1
  263. data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +1 -1
  264. data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +1 -1
  265. data/lib/plaid/models/beta_partner_end_customer.rb +1 -1
  266. data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +2 -2
  267. data/lib/plaid/models/business_account.rb +1 -1
  268. data/lib/plaid/models/business_account_all_of.rb +1 -1
  269. data/lib/plaid/models/business_check_boolean_status.rb +1 -1
  270. data/lib/plaid/models/business_digital_presence_check.rb +1 -1
  271. data/lib/plaid/models/business_email_address.rb +1 -1
  272. data/lib/plaid/models/business_entity_type.rb +1 -1
  273. data/lib/plaid/models/business_field_match_summary.rb +1 -1
  274. data/lib/plaid/models/business_finance_category.rb +1 -1
  275. data/lib/plaid/models/business_industry_prediction.rb +1 -1
  276. data/lib/plaid/models/business_industry_prediction_nullable.rb +1 -1
  277. data/lib/plaid/models/business_kyb_check.rb +1 -1
  278. data/lib/plaid/models/business_kyb_match_details.rb +16 -10
  279. data/lib/plaid/models/business_phone_number.rb +1 -1
  280. data/lib/plaid/models/business_risk_check.rb +1 -1
  281. data/lib/plaid/models/business_search_terms.rb +19 -2
  282. data/lib/plaid/models/business_verification_create_request.rb +1 -1
  283. data/lib/plaid/models/business_verification_create_request_business.rb +13 -2
  284. data/lib/plaid/models/business_verification_create_response.rb +1 -1
  285. data/lib/plaid/models/business_verification_get_request.rb +1 -1
  286. data/lib/plaid/models/business_verification_get_response.rb +1 -1
  287. data/lib/plaid/models/business_verification_status_kyb_check.rb +1 -1
  288. data/lib/plaid/models/business_verification_status_overall.rb +1 -1
  289. data/lib/plaid/models/business_verification_status_risk_check.rb +1 -1
  290. data/lib/plaid/models/business_verification_status_web_presence_check.rb +1 -1
  291. data/lib/plaid/models/business_website.rb +1 -1
  292. data/lib/plaid/models/business_website_analysis.rb +1 -1
  293. data/lib/plaid/models/business_website_build_status.rb +1 -1
  294. data/lib/plaid/models/business_website_ssl.rb +1 -1
  295. data/lib/plaid/models/business_whois_record.rb +1 -1
  296. data/lib/plaid/models/cash_flow_insight.rb +1 -1
  297. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +1 -1
  298. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +1 -1
  299. data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +1 -1
  300. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +1 -1
  301. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +1 -1
  302. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +1 -1
  303. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +1 -1
  304. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +1 -1
  305. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +1 -1
  306. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  307. data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
  308. data/lib/plaid/models/cashflow_report_get_request.rb +1 -1
  309. data/lib/plaid/models/cashflow_report_get_request_options.rb +1 -1
  310. data/lib/plaid/models/cashflow_report_get_response.rb +1 -1
  311. data/lib/plaid/models/cashflow_report_historical_balance.rb +1 -1
  312. data/lib/plaid/models/cashflow_report_insights_get_request.rb +1 -1
  313. data/lib/plaid/models/cashflow_report_insights_get_response.rb +1 -1
  314. data/lib/plaid/models/cashflow_report_monthly_summary.rb +1 -1
  315. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +1 -1
  316. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +1 -1
  317. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +1 -1
  318. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +1 -1
  319. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +1 -1
  320. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +1 -1
  321. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +1 -1
  322. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +1 -1
  323. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +1 -1
  324. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +1 -1
  325. data/lib/plaid/models/cashflow_report_payment_meta.rb +1 -1
  326. data/lib/plaid/models/cashflow_report_refresh_request.rb +1 -1
  327. data/lib/plaid/models/cashflow_report_refresh_response.rb +1 -1
  328. data/lib/plaid/models/cashflow_report_transaction.rb +1 -1
  329. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +1 -1
  330. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +1 -1
  331. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +1 -1
  332. data/lib/plaid/models/categories_get_response.rb +1 -1
  333. data/lib/plaid/models/category.rb +1 -1
  334. data/lib/plaid/models/category_expenses.rb +1 -1
  335. data/lib/plaid/models/category_insight_details.rb +1 -1
  336. data/lib/plaid/models/category_insights.rb +1 -1
  337. data/lib/plaid/models/cause.rb +1 -1
  338. data/lib/plaid/models/cause_all_of.rb +1 -1
  339. data/lib/plaid/models/check_report_warning.rb +1 -1
  340. data/lib/plaid/models/check_report_warning_code.rb +1 -1
  341. data/lib/plaid/models/client_customization.rb +1 -1
  342. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  343. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  344. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  345. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  346. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  347. data/lib/plaid/models/client_user_identity.rb +1 -1
  348. data/lib/plaid/models/client_user_identity_address.rb +1 -1
  349. data/lib/plaid/models/client_user_identity_email.rb +1 -1
  350. data/lib/plaid/models/client_user_identity_name.rb +1 -1
  351. data/lib/plaid/models/client_user_identity_phone_number.rb +1 -1
  352. data/lib/plaid/models/connected_application.rb +1 -1
  353. data/lib/plaid/models/consent_event.rb +1 -1
  354. data/lib/plaid/models/consent_event_code.rb +1 -1
  355. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  356. data/lib/plaid/models/consent_event_type.rb +1 -1
  357. data/lib/plaid/models/consent_events_get_request.rb +1 -1
  358. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  359. data/lib/plaid/models/consented_account.rb +1 -1
  360. data/lib/plaid/models/consumer_dispute.rb +1 -1
  361. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  362. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  363. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  364. data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
  365. data/lib/plaid/models/counterparty.rb +1 -1
  366. data/lib/plaid/models/counterparty_insights.rb +1 -1
  367. data/lib/plaid/models/counterparty_numbers.rb +1 -1
  368. data/lib/plaid/models/counterparty_numbers_bacs.rb +1 -1
  369. data/lib/plaid/models/counterparty_numbers_international.rb +1 -1
  370. data/lib/plaid/models/counterparty_type.rb +1 -1
  371. data/lib/plaid/models/country_code.rb +1 -1
  372. data/lib/plaid/models/cra_annual_income_values.rb +241 -0
  373. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  374. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  375. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  376. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  377. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  378. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  379. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  380. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  381. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  382. data/lib/plaid/models/cra_bank_income_income_provider.rb +1 -1
  383. data/lib/plaid/models/cra_bank_income_item.rb +15 -3
  384. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  385. data/lib/plaid/models/cra_bank_income_status.rb +1 -1
  386. data/lib/plaid/models/cra_bank_income_summary.rb +2 -2
  387. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  388. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  389. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  390. data/lib/plaid/models/cra_cashflow_insights_report.rb +2 -12
  391. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +37 -5
  392. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  393. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +2 -12
  394. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +1 -1
  395. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
  396. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +16 -6
  397. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +2 -14
  398. data/lib/plaid/models/cra_check_report_create_request.rb +12 -2
  399. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  400. data/lib/plaid/models/cra_check_report_failed_webhook.rb +15 -2
  401. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
  402. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
  403. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
  404. data/lib/plaid/models/cra_check_report_gse_options.rb +1 -1
  405. data/lib/plaid/models/{plaid_check_score.rb → cra_check_report_home_lending_report_options.rb} +26 -33
  406. data/lib/plaid/models/{recurrence.rb → cra_check_report_income_insights_get_options.rb} +20 -21
  407. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +15 -5
  408. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  409. data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +1 -1
  410. data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +1 -1
  411. data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +1 -1
  412. data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +1 -1
  413. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +1 -1
  414. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +1 -1
  415. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +2 -14
  416. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +1 -1
  417. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +34 -2
  418. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
  419. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
  420. data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
  421. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +1 -1
  422. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +1 -1
  423. data/lib/plaid/models/cra_check_report_verification_get_request.rb +1 -1
  424. data/lib/plaid/models/cra_check_report_verification_get_response.rb +1 -1
  425. data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +1 -1
  426. data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +1 -1
  427. data/lib/plaid/models/cra_current_modeled_income.rb +239 -0
  428. data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
  429. data/lib/plaid/models/cra_employment_refresh_report_account.rb +1 -1
  430. data/lib/plaid/models/cra_employment_refresh_report_item.rb +1 -1
  431. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
  432. data/lib/plaid/models/cra_income_category.rb +241 -0
  433. data/lib/plaid/models/cra_income_insights.rb +24 -2
  434. data/lib/plaid/models/cra_income_insights_user_summary.rb +228 -0
  435. data/lib/plaid/models/cra_income_metrics.rb +253 -0
  436. data/lib/plaid/models/cra_income_next_payment.rb +226 -0
  437. data/lib/plaid/models/cra_income_stream.rb +316 -0
  438. data/lib/plaid/models/cra_income_stream_insights.rb +295 -0
  439. data/lib/plaid/models/cra_income_transaction.rb +337 -0
  440. data/lib/plaid/models/cra_income_transaction_outlier.rb +237 -0
  441. data/lib/plaid/models/cra_lend_score_report.rb +1 -1
  442. data/lib/plaid/models/cra_loan_application.rb +1 -1
  443. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  444. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  445. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  446. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  447. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  448. data/lib/plaid/models/cra_loan_register.rb +1 -1
  449. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  450. data/lib/plaid/models/cra_loan_status.rb +1 -1
  451. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  452. data/lib/plaid/models/cra_loan_type.rb +1 -1
  453. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  454. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  455. data/lib/plaid/models/cra_loan_update.rb +1 -1
  456. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  457. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  458. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  459. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  460. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  461. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  462. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  463. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +1 -1
  464. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  465. data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
  466. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +1 -1
  467. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  468. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  469. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  470. data/lib/plaid/models/cra_monthly_income_values.rb +241 -0
  471. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  472. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  473. data/lib/plaid/models/cra_partner_insights.rb +2 -1
  474. data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +1 -1
  475. data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +2 -1
  476. data/lib/plaid/models/cra_partner_insights_bureau.rb +1 -1
  477. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  478. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  479. data/lib/plaid/models/cra_partner_insights_fico_input.rb +1 -1
  480. data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +442 -0
  481. data/lib/plaid/models/cra_partner_insights_fico_results.rb +15 -5
  482. data/lib/plaid/models/cra_partner_insights_get_request.rb +37 -5
  483. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  484. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  485. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  486. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  487. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  488. data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +46 -2
  489. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +1 -1
  490. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +1 -1
  491. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +1 -1
  492. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  493. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  494. data/lib/plaid/models/cra_projected_modeled_income.rb +239 -0
  495. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  496. data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +15 -2
  497. data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +3 -2
  498. data/lib/plaid/models/{recurring_frequency.rb → cra_user_tier.rb} +4 -10
  499. data/lib/plaid/models/cra_verification_report.rb +12 -2
  500. data/lib/plaid/models/cra_voa_report.rb +1 -1
  501. data/lib/plaid/models/cra_voa_report_account.rb +1 -1
  502. data/lib/plaid/models/cra_voa_report_account_balances.rb +1 -1
  503. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
  504. data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
  505. data/lib/plaid/models/cra_voa_report_item.rb +1 -1
  506. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +1 -1
  507. data/lib/plaid/models/credit1099.rb +1 -1
  508. data/lib/plaid/models/credit1099_filer.rb +1 -1
  509. data/lib/plaid/models/credit1099_payer.rb +1 -1
  510. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  511. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  512. data/lib/plaid/models/credit_ach_class.rb +1 -1
  513. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  514. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  515. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  516. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  517. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  518. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  519. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  520. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  521. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  522. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  523. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  524. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  525. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  526. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  527. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  528. data/lib/plaid/models/credit_bank_income.rb +1 -1
  529. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  530. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  531. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  532. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  533. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  534. data/lib/plaid/models/credit_bank_income_get_request.rb +11 -2
  535. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  536. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  537. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  538. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  539. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  540. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +14 -5
  541. data/lib/plaid/models/credit_bank_income_refresh_request.rb +11 -2
  542. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  543. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  544. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  545. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  546. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  547. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  548. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  549. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  550. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +11 -2
  551. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  552. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  553. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  554. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  555. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  556. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  557. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  558. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  559. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  560. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  561. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  562. data/lib/plaid/models/credit_card_liability.rb +1 -1
  563. data/lib/plaid/models/credit_category.rb +1 -1
  564. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  565. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  566. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  567. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  568. data/lib/plaid/models/credit_employment_item.rb +1 -1
  569. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  570. data/lib/plaid/models/credit_filter.rb +1 -1
  571. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  572. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  573. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  574. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  575. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  576. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  577. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  578. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  579. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  580. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  581. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  582. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  583. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  584. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  585. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  586. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  587. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  588. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  589. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  590. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  591. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  592. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  593. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  594. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  595. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  596. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  597. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  598. data/lib/plaid/models/credit_payroll_income_get_request.rb +11 -2
  599. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  600. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  601. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +11 -2
  602. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  603. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +11 -2
  604. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  605. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +11 -2
  606. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  607. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  608. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +14 -5
  609. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  610. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  611. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  612. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  613. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  614. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  615. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  616. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  617. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  618. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  619. data/lib/plaid/models/credit_session.rb +1 -1
  620. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  621. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  622. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  623. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  624. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  625. data/lib/plaid/models/credit_session_error.rb +1 -1
  626. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  627. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  628. data/lib/plaid/models/credit_session_results.rb +1 -1
  629. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  630. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  631. data/lib/plaid/models/credit_w2.rb +1 -1
  632. data/lib/plaid/models/custom_sandbox_transaction.rb +1 -1
  633. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  634. data/lib/plaid/models/dashboard_user.rb +1 -1
  635. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  636. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  637. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  638. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  639. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  640. data/lib/plaid/models/data_sources.rb +1 -1
  641. data/lib/plaid/models/date_range.rb +1 -1
  642. data/lib/plaid/models/deductions.rb +1 -1
  643. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  644. data/lib/plaid/models/deductions_total.rb +1 -1
  645. data/lib/plaid/models/default_update_webhook.rb +1 -1
  646. data/lib/plaid/models/depository_account_subtype.rb +2 -1
  647. data/lib/plaid/models/depository_filter.rb +17 -5
  648. data/lib/plaid/models/detailed_originator.rb +1 -1
  649. data/lib/plaid/models/detected_account.rb +1 -1
  650. data/lib/plaid/models/device_id.rb +1 -1
  651. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  652. data/lib/plaid/models/doc_type.rb +1 -1
  653. data/lib/plaid/models/document_analysis.rb +1 -1
  654. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  655. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  656. data/lib/plaid/models/document_metadata.rb +1 -1
  657. data/lib/plaid/models/document_name_match_code.rb +1 -1
  658. data/lib/plaid/models/document_risk_signal.rb +1 -1
  659. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  660. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  661. data/lib/plaid/models/document_risk_summary.rb +1 -1
  662. data/lib/plaid/models/document_status.rb +1 -1
  663. data/lib/plaid/models/documentary_verification.rb +1 -1
  664. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  665. data/lib/plaid/models/earnings.rb +1 -1
  666. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  667. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  668. data/lib/plaid/models/earnings_total.rb +1 -1
  669. data/lib/plaid/models/email.rb +1 -1
  670. data/lib/plaid/models/email_address_match_score.rb +1 -1
  671. data/lib/plaid/models/employee.rb +1 -1
  672. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  673. data/lib/plaid/models/employer.rb +1 -1
  674. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  675. data/lib/plaid/models/employer_verification.rb +1 -1
  676. data/lib/plaid/models/employers_search_request.rb +1 -1
  677. data/lib/plaid/models/employers_search_response.rb +1 -1
  678. data/lib/plaid/models/employment_details.rb +1 -1
  679. data/lib/plaid/models/employment_source_type.rb +1 -1
  680. data/lib/plaid/models/employment_verification.rb +1 -1
  681. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  682. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  683. data/lib/plaid/models/employment_verification_status.rb +1 -1
  684. data/lib/plaid/models/enhancements.rb +1 -1
  685. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  686. data/lib/plaid/models/enrichments.rb +2 -12
  687. data/lib/plaid/models/entity_document.rb +1 -1
  688. data/lib/plaid/models/entity_document_type.rb +1 -1
  689. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  690. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  691. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  692. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  693. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  694. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  695. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  696. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  697. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  698. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  699. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  700. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  701. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  702. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  703. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  704. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  705. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  706. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  707. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  708. data/lib/plaid/models/ewa_score.rb +1 -1
  709. data/lib/plaid/models/expenditure_insights.rb +1 -1
  710. data/lib/plaid/models/expenditure_insights_cash_flow.rb +1 -1
  711. data/lib/plaid/models/expenditure_summary.rb +1 -1
  712. data/lib/plaid/models/expiration_date.rb +1 -1
  713. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  714. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  715. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  716. data/lib/plaid/models/external_payment_options.rb +1 -1
  717. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  718. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  719. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  720. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  721. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  722. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  723. data/lib/plaid/models/fdx_content_types.rb +1 -1
  724. data/lib/plaid/models/fdx_event_status.rb +1 -1
  725. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  726. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  727. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  728. data/lib/plaid/models/fdx_lifecycle_event.rb +1 -1
  729. data/lib/plaid/models/fdx_notification.rb +12 -2
  730. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  731. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  732. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  733. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  734. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  735. data/lib/plaid/models/fdx_notification_type.rb +14 -3
  736. data/lib/plaid/models/fdx_party.rb +1 -1
  737. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  738. data/lib/plaid/models/fdx_party_type.rb +1 -1
  739. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  740. data/lib/plaid/models/fdx_update_reason.rb +1 -1
  741. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  742. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  743. data/lib/plaid/models/fixed_income.rb +1 -1
  744. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  745. data/lib/plaid/models/form1099_type.rb +1 -1
  746. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  747. data/lib/plaid/models/fraud_amount.rb +1 -1
  748. data/lib/plaid/models/fraud_analysis_details.rb +1 -1
  749. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  750. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  751. data/lib/plaid/models/gambling_indicators.rb +1 -1
  752. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  753. data/lib/plaid/models/get_recipient_response.rb +1 -1
  754. data/lib/plaid/models/get_recipients_response.rb +1 -1
  755. data/lib/plaid/models/gse_report_type.rb +1 -1
  756. data/lib/plaid/models/health_incident.rb +1 -1
  757. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  758. data/lib/plaid/models/historical_annual_income.rb +1 -1
  759. data/lib/plaid/models/historical_balance.rb +1 -1
  760. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  761. data/lib/plaid/models/holding.rb +1 -1
  762. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  763. data/lib/plaid/models/holdings_override.rb +1 -1
  764. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  765. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  766. data/lib/plaid/models/human_review.rb +1 -1
  767. data/lib/plaid/models/human_review_status.rb +1 -1
  768. data/lib/plaid/models/id_number_type.rb +1 -1
  769. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  770. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  771. data/lib/plaid/models/identity_document_upload.rb +1 -1
  772. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  773. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  774. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  775. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  776. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  777. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  778. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  779. data/lib/plaid/models/identity_get_request.rb +1 -1
  780. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  781. data/lib/plaid/models/identity_get_response.rb +1 -1
  782. data/lib/plaid/models/identity_match_request.rb +1 -1
  783. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  784. data/lib/plaid/models/identity_match_response.rb +1 -1
  785. data/lib/plaid/models/identity_match_user.rb +1 -1
  786. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  787. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  788. data/lib/plaid/models/identity_update_types.rb +1 -1
  789. data/lib/plaid/models/identity_verification.rb +1 -1
  790. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  791. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  792. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  793. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  794. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  795. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  796. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  797. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  798. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  799. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  800. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  801. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  802. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  803. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  804. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  805. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  806. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  807. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  808. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  809. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  810. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  811. data/lib/plaid/models/identity_verification_status.rb +1 -1
  812. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  813. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  814. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  815. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  816. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  817. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  818. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  819. data/lib/plaid/models/idv_protect_event.rb +1 -1
  820. data/lib/plaid/models/image_quality.rb +1 -1
  821. data/lib/plaid/models/image_quality_details.rb +1 -1
  822. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  823. data/lib/plaid/models/incident_update.rb +1 -1
  824. data/lib/plaid/models/income_breakdown.rb +1 -1
  825. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  826. data/lib/plaid/models/income_insights.rb +1 -1
  827. data/lib/plaid/models/income_insights_filter.rb +240 -0
  828. data/lib/plaid/models/income_insights_income_excluding_transfers.rb +1 -1
  829. data/lib/plaid/models/income_insights_total_income.rb +2 -2
  830. data/lib/plaid/models/income_insights_transfers_in.rb +1 -1
  831. data/lib/plaid/models/{plaid_check_score_version.rb → income_insights_version.rb} +3 -4
  832. data/lib/plaid/models/income_override.rb +1 -1
  833. data/lib/plaid/models/income_sources_counts.rb +1 -1
  834. data/lib/plaid/models/income_summary.rb +1 -1
  835. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  836. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  837. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  838. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  839. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  840. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  841. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  842. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  843. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  844. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  845. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  846. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  847. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  848. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  849. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  850. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  851. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  852. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  853. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  854. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  855. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  856. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  857. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  858. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  859. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  860. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  861. data/lib/plaid/models/individual_name.rb +1 -1
  862. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  863. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  864. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  865. data/lib/plaid/models/inflow_model.rb +1 -1
  866. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  867. data/lib/plaid/models/institution.rb +2 -2
  868. data/lib/plaid/models/institution_status.rb +1 -1
  869. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  870. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  871. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  872. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  873. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  874. data/lib/plaid/models/institutions_get_request.rb +1 -1
  875. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  876. data/lib/plaid/models/institutions_get_response.rb +1 -1
  877. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  878. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  879. data/lib/plaid/models/institutions_search_request.rb +1 -1
  880. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  881. data/lib/plaid/models/institutions_search_response.rb +1 -1
  882. data/lib/plaid/models/investment_account.rb +392 -0
  883. data/lib/plaid/models/investment_account_all_of.rb +224 -0
  884. data/lib/plaid/models/investment_account_balance.rb +296 -0
  885. data/lib/plaid/models/investment_account_balance_all_of.rb +221 -0
  886. data/lib/plaid/models/investment_account_subtype.rb +9 -1
  887. data/lib/plaid/models/investment_filter.rb +1 -1
  888. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  889. data/lib/plaid/models/investment_transaction.rb +1 -1
  890. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  891. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  892. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  893. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  894. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  895. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  896. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  897. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  898. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  899. data/lib/plaid/models/investments_auth_get_response.rb +2 -2
  900. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  901. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  902. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  903. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  904. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  905. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  906. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  907. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  908. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  909. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  910. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  911. data/lib/plaid/models/iso_currency_code.rb +1 -1
  912. data/lib/plaid/models/issue.rb +1 -1
  913. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  914. data/lib/plaid/models/issues_get_request.rb +1 -1
  915. data/lib/plaid/models/issues_get_response.rb +1 -1
  916. data/lib/plaid/models/issues_search_request.rb +1 -1
  917. data/lib/plaid/models/issues_search_response.rb +1 -1
  918. data/lib/plaid/models/issues_status.rb +1 -1
  919. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  920. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  921. data/lib/plaid/models/issuing_country.rb +1 -1
  922. data/lib/plaid/models/item.rb +1 -1
  923. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  924. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  925. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  926. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  927. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  928. data/lib/plaid/models/item_application_list_request.rb +1 -1
  929. data/lib/plaid/models/item_application_list_response.rb +1 -1
  930. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  931. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  932. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  933. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  934. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  935. data/lib/plaid/models/item_auth_method.rb +1 -1
  936. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  937. data/lib/plaid/models/item_create_authentication.rb +1 -1
  938. data/lib/plaid/models/item_error_webhook.rb +1 -1
  939. data/lib/plaid/models/item_get_request.rb +1 -1
  940. data/lib/plaid/models/item_get_response.rb +1 -1
  941. data/lib/plaid/models/item_handle_fraud_report_request.rb +380 -0
  942. data/lib/plaid/models/item_handle_fraud_report_response.rb +241 -0
  943. data/lib/plaid/models/item_import_request.rb +1 -1
  944. data/lib/plaid/models/item_import_request_options.rb +1 -1
  945. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  946. data/lib/plaid/models/item_import_response.rb +1 -1
  947. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  948. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  949. data/lib/plaid/models/{prism_product.rb → item_products_terminate_reason_code.rb} +3 -4
  950. data/lib/plaid/models/item_products_terminate_request.rb +310 -0
  951. data/lib/plaid/models/item_products_terminate_response.rb +226 -0
  952. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  953. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  954. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  955. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  956. data/lib/plaid/models/item_remove_reason_code.rb +1 -1
  957. data/lib/plaid/models/item_remove_request.rb +1 -1
  958. data/lib/plaid/models/item_remove_response.rb +1 -1
  959. data/lib/plaid/models/item_status.rb +1 -1
  960. data/lib/plaid/models/item_status_investments.rb +1 -1
  961. data/lib/plaid/models/item_status_last_webhook.rb +1 -2
  962. data/lib/plaid/models/item_status_nullable.rb +1 -1
  963. data/lib/plaid/models/item_status_transactions.rb +1 -1
  964. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  965. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  966. data/lib/plaid/models/item_with_consent_fields.rb +2 -2
  967. data/lib/plaid/models/item_with_consent_fields_all_of.rb +2 -2
  968. data/lib/plaid/models/jwk_public_key.rb +1 -1
  969. data/lib/plaid/models/jwt_header.rb +1 -1
  970. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  971. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  972. data/lib/plaid/models/kyc_check_details.rb +1 -1
  973. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  974. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  975. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  976. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  977. data/lib/plaid/models/last_data_access_times.rb +1 -1
  978. data/lib/plaid/models/latest_scored_event.rb +1 -1
  979. data/lib/plaid/models/layer_authentication_passed_webhook.rb +1 -1
  980. data/lib/plaid/models/ledger_event_source_type.rb +1 -1
  981. data/lib/plaid/models/lend_score.rb +2 -2
  982. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  983. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  984. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  985. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  986. data/lib/plaid/models/liabilities_object.rb +1 -1
  987. data/lib/plaid/models/liability_override.rb +1 -1
  988. data/lib/plaid/models/limited_purpose_type.rb +38 -0
  989. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  990. data/lib/plaid/models/link_delivery_account.rb +1 -1
  991. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  992. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  993. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  994. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  995. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  996. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  997. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  998. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  999. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  1000. data/lib/plaid/models/link_delivery_options.rb +1 -1
  1001. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  1002. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  1003. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  1004. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  1005. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  1006. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  1007. data/lib/plaid/models/link_event.rb +1 -1
  1008. data/lib/plaid/models/link_event_metadata.rb +1 -1
  1009. data/lib/plaid/models/link_event_name.rb +1 -1
  1010. data/lib/plaid/models/link_events_webhook.rb +1 -1
  1011. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  1012. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  1013. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  1014. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  1015. data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
  1016. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  1017. data/lib/plaid/models/link_session_cra_update_result.rb +1 -1
  1018. data/lib/plaid/models/link_session_exit.rb +1 -1
  1019. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  1020. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  1021. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  1022. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  1023. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  1024. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  1025. data/lib/plaid/models/link_session_protect_result.rb +1 -1
  1026. data/lib/plaid/models/link_session_results.rb +1 -1
  1027. data/lib/plaid/models/link_session_success.rb +1 -1
  1028. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  1029. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  1030. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  1031. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  1032. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  1033. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  1034. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  1035. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  1036. data/lib/plaid/models/link_token_create_depository_filter.rb +17 -5
  1037. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  1038. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  1039. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  1040. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  1041. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  1042. data/lib/plaid/models/link_token_create_request.rb +3 -3
  1043. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  1044. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
  1045. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  1046. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  1047. data/lib/plaid/models/link_token_create_request_cra_options.rb +15 -6
  1048. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +16 -6
  1049. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +1 -1
  1050. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +2 -12
  1051. data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +253 -0
  1052. data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +1 -1
  1053. data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +1 -1
  1054. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +2 -14
  1055. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +5 -17
  1056. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  1057. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  1058. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  1059. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  1060. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  1061. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  1062. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  1063. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  1064. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  1065. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  1066. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  1067. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  1068. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  1069. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  1070. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  1071. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  1072. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  1073. data/lib/plaid/models/link_token_create_response.rb +1 -1
  1074. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  1075. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  1076. data/lib/plaid/models/link_token_get_request.rb +1 -1
  1077. data/lib/plaid/models/link_token_get_response.rb +1 -1
  1078. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  1079. data/lib/plaid/models/link_token_investments.rb +1 -1
  1080. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  1081. data/lib/plaid/models/link_token_transactions.rb +1 -1
  1082. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  1083. data/lib/plaid/models/loan.rb +1 -1
  1084. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  1085. data/lib/plaid/models/loan_disbursements_indicators.rb +1 -1
  1086. data/lib/plaid/models/loan_filter.rb +1 -1
  1087. data/lib/plaid/models/loan_identifier.rb +1 -1
  1088. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  1089. data/lib/plaid/models/loan_identifiers.rb +1 -1
  1090. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  1091. data/lib/plaid/models/loan_payments_indicators.rb +1 -1
  1092. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  1093. data/lib/plaid/models/loans.rb +1 -1
  1094. data/lib/plaid/models/location.rb +1 -1
  1095. data/lib/plaid/models/match_summary.rb +1 -1
  1096. data/lib/plaid/models/match_summary_code.rb +1 -1
  1097. data/lib/plaid/models/merchant_insights.rb +1 -1
  1098. data/lib/plaid/models/meta.rb +1 -1
  1099. data/lib/plaid/models/mfa.rb +1 -1
  1100. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  1101. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  1102. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  1103. data/lib/plaid/models/monitoring_insights.rb +1 -1
  1104. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  1105. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  1106. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  1107. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  1108. data/lib/plaid/models/monthly_average.rb +1 -1
  1109. data/lib/plaid/models/monthly_summary.rb +1 -1
  1110. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  1111. data/lib/plaid/models/mortgage_liability.rb +1 -1
  1112. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  1113. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  1114. data/lib/plaid/models/name_match_score.rb +1 -1
  1115. data/lib/plaid/models/negative_balance_insights.rb +1 -1
  1116. data/lib/plaid/models/negative_balance_occurrence.rb +1 -1
  1117. data/lib/plaid/models/net_pay.rb +1 -1
  1118. data/lib/plaid/models/network_insights_item.rb +1 -1
  1119. data/lib/plaid/models/network_insights_report.rb +1 -1
  1120. data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
  1121. data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
  1122. data/lib/plaid/models/network_insights_version.rb +1 -1
  1123. data/lib/plaid/models/network_status_get_request.rb +1 -1
  1124. data/lib/plaid/models/network_status_get_response.rb +1 -1
  1125. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  1126. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  1127. data/lib/plaid/models/network_status_get_user.rb +1 -1
  1128. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  1129. data/lib/plaid/models/numbers.rb +1 -1
  1130. data/lib/plaid/models/numbers_acats.rb +1 -1
  1131. data/lib/plaid/models/numbers_ach.rb +1 -1
  1132. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  1133. data/lib/plaid/models/numbers_aton.rb +1 -1
  1134. data/lib/plaid/models/numbers_bacs.rb +1 -1
  1135. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  1136. data/lib/plaid/models/numbers_eft.rb +1 -1
  1137. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  1138. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  1139. data/lib/plaid/models/numbers_international.rb +1 -1
  1140. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  1141. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  1142. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  1143. data/lib/plaid/models/o_auth_error_code.rb +1 -1
  1144. data/lib/plaid/models/o_auth_error_response.rb +1 -1
  1145. data/lib/plaid/models/o_auth_grant_type.rb +1 -1
  1146. data/lib/plaid/models/o_auth_introspect_request.rb +1 -1
  1147. data/lib/plaid/models/o_auth_introspect_response.rb +1 -1
  1148. data/lib/plaid/models/o_auth_revoke_request.rb +1 -1
  1149. data/lib/plaid/models/o_auth_revoke_response.rb +1 -1
  1150. data/lib/plaid/models/o_auth_subject_token_type.rb +1 -1
  1151. data/lib/plaid/models/o_auth_token_request.rb +1 -1
  1152. data/lib/plaid/models/o_auth_token_response.rb +1 -1
  1153. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1154. data/lib/plaid/models/option_contract.rb +1 -1
  1155. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1156. data/lib/plaid/models/originator.rb +1 -1
  1157. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1158. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1159. data/lib/plaid/models/other_filter.rb +1 -1
  1160. data/lib/plaid/models/outlier_transactions_insights.rb +1 -1
  1161. data/lib/plaid/models/override_account_type.rb +1 -1
  1162. data/lib/plaid/models/override_accounts.rb +1 -1
  1163. data/lib/plaid/models/owner.rb +1 -1
  1164. data/lib/plaid/models/owner_override.rb +1 -1
  1165. data/lib/plaid/models/ownership_type.rb +1 -1
  1166. data/lib/plaid/models/parties.rb +1 -1
  1167. data/lib/plaid/models/partner_customer_create_request.rb +3 -3
  1168. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1169. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1170. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1171. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1172. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1173. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1174. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1175. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1176. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1177. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1178. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1179. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1180. data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +1 -1
  1181. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1182. data/lib/plaid/models/partner_end_customer_cra_purposes.rb +1 -1
  1183. data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +1 -1
  1184. data/lib/plaid/models/partner_end_customer_cra_use_case.rb +1 -1
  1185. data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +1 -1
  1186. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  1187. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1188. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  1189. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1190. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1191. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1192. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1193. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1194. data/lib/plaid/models/partner_end_customer_questionnaires.rb +1 -1
  1195. data/lib/plaid/models/partner_end_customer_requirement_due.rb +1 -1
  1196. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1197. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1198. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1199. data/lib/plaid/models/partner_end_customer_with_secrets.rb +2 -2
  1200. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1201. data/lib/plaid/models/party.rb +1 -1
  1202. data/lib/plaid/models/party_individual.rb +1 -1
  1203. data/lib/plaid/models/party_role_type.rb +1 -1
  1204. data/lib/plaid/models/pay.rb +1 -1
  1205. data/lib/plaid/models/pay_frequency.rb +1 -1
  1206. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1207. data/lib/plaid/models/pay_period_details.rb +1 -1
  1208. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1209. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  1210. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  1211. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  1212. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  1213. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  1214. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1215. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1216. data/lib/plaid/models/payment_amount.rb +1 -1
  1217. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1218. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1219. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1220. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1221. data/lib/plaid/models/payment_channel.rb +1 -1
  1222. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1223. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1224. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1225. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1226. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1227. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1228. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1229. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1230. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1231. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1232. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1233. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1234. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  1235. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1236. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
  1237. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1238. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1239. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1240. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1241. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1242. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1243. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1244. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1245. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1246. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1247. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1248. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  1249. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1250. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1251. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1252. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1253. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  1254. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1255. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1256. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1257. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1258. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1259. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1260. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1261. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1262. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1263. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1264. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1265. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1266. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1267. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1268. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1269. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1270. data/lib/plaid/models/payment_meta.rb +1 -1
  1271. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1272. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1273. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1274. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1275. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1276. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1277. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1278. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1279. data/lib/plaid/models/payment_scheme.rb +1 -1
  1280. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  1281. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1282. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1283. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1284. data/lib/plaid/models/payroll_item.rb +1 -1
  1285. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1286. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1287. data/lib/plaid/models/paystub.rb +1 -1
  1288. data/lib/plaid/models/paystub_address.rb +1 -1
  1289. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1290. data/lib/plaid/models/paystub_details.rb +1 -1
  1291. data/lib/plaid/models/paystub_employer.rb +1 -1
  1292. data/lib/plaid/models/paystub_override.rb +1 -1
  1293. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1294. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1295. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1296. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1297. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1298. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1299. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1300. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1301. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1302. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1303. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1304. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1305. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1306. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1307. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1308. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1309. data/lib/plaid/models/pending_disconnect_webhook.rb +17 -2
  1310. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1311. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1312. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1313. data/lib/plaid/models/personal_finance_category_version.rb +1 -1
  1314. data/lib/plaid/models/phone_number.rb +1 -1
  1315. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1316. data/lib/plaid/models/phone_type.rb +1 -1
  1317. data/lib/plaid/models/physical_document_category.rb +1 -1
  1318. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1319. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1320. data/lib/plaid/models/physical_document_images.rb +1 -1
  1321. data/lib/plaid/models/plaid_error.rb +1 -1
  1322. data/lib/plaid/models/plaid_error_type.rb +1 -1
  1323. data/lib/plaid/models/plaid_lend_score_version.rb +1 -1
  1324. data/lib/plaid/models/platform_ids.rb +1 -1
  1325. data/lib/plaid/models/po_box_status.rb +1 -1
  1326. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1327. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1328. data/lib/plaid/models/prism_cash_score_version.rb +2 -1
  1329. data/lib/plaid/models/prism_detect.rb +1 -1
  1330. data/lib/plaid/models/prism_detect_version.rb +2 -1
  1331. data/lib/plaid/models/prism_extend.rb +1 -1
  1332. data/lib/plaid/models/prism_extend_version.rb +2 -1
  1333. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1334. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1335. data/lib/plaid/models/prism_insights.rb +1 -1
  1336. data/lib/plaid/models/prism_insights_version.rb +2 -1
  1337. data/lib/plaid/models/prism_versions.rb +1 -1
  1338. data/lib/plaid/models/prism_versions_deprecated.rb +1 -1
  1339. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1340. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1341. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1342. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1343. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1344. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1345. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1346. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1347. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1348. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1349. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1350. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1351. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1352. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1353. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1354. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1355. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1356. data/lib/plaid/models/processor_investments_auth_get_request.rb +246 -0
  1357. data/lib/plaid/models/processor_investments_auth_get_response.rb +341 -0
  1358. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1359. data/lib/plaid/models/processor_investments_holdings_get_response.rb +2 -2
  1360. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1361. data/lib/plaid/models/processor_investments_transactions_get_response.rb +2 -2
  1362. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1363. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1364. data/lib/plaid/models/processor_number.rb +1 -1
  1365. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1366. data/lib/plaid/models/processor_signal_decision_report_request.rb +2 -2
  1367. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1368. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1369. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1370. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1371. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1372. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1373. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1374. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1375. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1376. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1377. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  1378. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1379. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1380. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1381. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1382. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1383. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1384. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1385. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1386. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1387. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1388. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1389. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1390. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1391. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1392. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1393. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1394. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1395. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1396. data/lib/plaid/models/product_access.rb +1 -1
  1397. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1398. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1399. data/lib/plaid/models/product_status.rb +1 -1
  1400. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1401. data/lib/plaid/models/products.rb +2 -1
  1402. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1403. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1404. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1405. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1406. data/lib/plaid/models/protect_bank_account.rb +1 -1
  1407. data/lib/plaid/models/protect_compute_request.rb +1 -1
  1408. data/lib/plaid/models/protect_compute_response.rb +1 -1
  1409. data/lib/plaid/models/protect_event.rb +1 -1
  1410. data/lib/plaid/models/protect_event_get_request.rb +1 -1
  1411. data/lib/plaid/models/protect_event_get_response.rb +1 -1
  1412. data/lib/plaid/models/protect_event_send_request.rb +1 -1
  1413. data/lib/plaid/models/protect_event_send_response.rb +1 -1
  1414. data/lib/plaid/models/protect_incident_amount.rb +1 -1
  1415. data/lib/plaid/models/protect_incident_event.rb +1 -1
  1416. data/lib/plaid/models/protect_incident_event_response.rb +1 -1
  1417. data/lib/plaid/models/protect_link_model_inputs.rb +1 -1
  1418. data/lib/plaid/models/protect_model_inputs.rb +1 -1
  1419. data/lib/plaid/models/protect_report.rb +1 -1
  1420. data/lib/plaid/models/protect_report_confidence.rb +1 -1
  1421. data/lib/plaid/models/protect_report_create_request.rb +1 -1
  1422. data/lib/plaid/models/protect_report_create_response.rb +1 -1
  1423. data/lib/plaid/models/protect_report_source.rb +1 -1
  1424. data/lib/plaid/models/protect_report_type.rb +1 -1
  1425. data/lib/plaid/models/protect_sdk_model_inputs.rb +1 -1
  1426. data/lib/plaid/models/protect_user.rb +1 -1
  1427. data/lib/plaid/models/protect_user_event_webhook.rb +13 -2
  1428. data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
  1429. data/lib/plaid/models/protect_user_insights_get_response.rb +1 -1
  1430. data/lib/plaid/models/provider_business_address.rb +1 -1
  1431. data/lib/plaid/models/provider_business_name.rb +237 -0
  1432. data/lib/plaid/models/proxy_type.rb +1 -1
  1433. data/lib/plaid/models/pslf_status.rb +1 -1
  1434. data/lib/plaid/models/reason_code.rb +1 -1
  1435. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1436. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1437. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1438. data/lib/plaid/models/recommendation_string.rb +1 -1
  1439. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1440. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1441. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1442. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1443. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1444. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1445. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1446. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1447. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1448. data/lib/plaid/models/refresh_result.rb +1 -1
  1449. data/lib/plaid/models/removed_transaction.rb +1 -1
  1450. data/lib/plaid/models/report_type.rb +1 -1
  1451. data/lib/plaid/models/reporting_information.rb +1 -1
  1452. data/lib/plaid/models/request_business_address.rb +1 -1
  1453. data/lib/plaid/models/response_business_address.rb +1 -1
  1454. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1455. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1456. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1457. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1458. data/lib/plaid/models/risk_check_details.rb +1 -1
  1459. data/lib/plaid/models/risk_check_device.rb +1 -1
  1460. data/lib/plaid/models/risk_check_email.rb +1 -1
  1461. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1462. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1463. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1464. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1465. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1466. data/lib/plaid/models/risk_check_facial_duplicate.rb +1 -1
  1467. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1468. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1469. data/lib/plaid/models/risk_check_network.rb +1 -1
  1470. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1471. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1472. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1473. data/lib/plaid/models/risk_indicators.rb +1 -1
  1474. data/lib/plaid/models/risk_level.rb +1 -1
  1475. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1476. data/lib/plaid/models/risk_profile.rb +1 -1
  1477. data/lib/plaid/models/risk_reason.rb +1 -1
  1478. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1479. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1480. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1481. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1482. data/lib/plaid/models/role.rb +1 -1
  1483. data/lib/plaid/models/role_detail.rb +1 -1
  1484. data/lib/plaid/models/roles.rb +1 -1
  1485. data/lib/plaid/models/rule_details.rb +1 -1
  1486. data/lib/plaid/models/rule_result.rb +1 -1
  1487. data/lib/plaid/models/ruleset.rb +1 -1
  1488. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1489. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1490. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1491. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1492. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1493. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1494. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1495. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1496. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +1 -1
  1497. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
  1498. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1499. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1500. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1501. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  1502. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1503. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1504. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1505. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1506. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1507. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1508. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1509. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1510. data/lib/plaid/models/sandbox_payment_simulate_request.rb +1 -1
  1511. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1512. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1513. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1514. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1515. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1516. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1517. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1518. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1519. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1520. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1521. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1522. data/lib/plaid/models/sandbox_transactions_create_request.rb +1 -1
  1523. data/lib/plaid/models/sandbox_transactions_create_response.rb +1 -1
  1524. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1525. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1526. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1527. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1528. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  1529. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1530. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1531. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1532. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1533. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1534. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1535. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1536. data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +1 -1
  1537. data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +1 -1
  1538. data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +1 -1
  1539. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1540. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1541. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1542. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1543. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1544. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1545. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1546. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1547. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1548. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1549. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1550. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1551. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1552. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1553. data/lib/plaid/models/scopes.rb +1 -1
  1554. data/lib/plaid/models/scopes_context.rb +1 -1
  1555. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1556. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1557. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1558. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1559. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1560. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1561. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1562. data/lib/plaid/models/security.rb +13 -2
  1563. data/lib/plaid/models/security_override.rb +1 -1
  1564. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1565. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1566. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1567. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1568. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1569. data/lib/plaid/models/selfie_capture.rb +1 -1
  1570. data/lib/plaid/models/selfie_check.rb +1 -1
  1571. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1572. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1573. data/lib/plaid/models/selfie_status.rb +1 -1
  1574. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1575. data/lib/plaid/models/service.rb +1 -1
  1576. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1577. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1578. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1579. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1580. data/lib/plaid/models/services.rb +1 -1
  1581. data/lib/plaid/models/session_token_create_request.rb +2 -2
  1582. data/lib/plaid/models/session_token_create_request_user.rb +1 -1
  1583. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1584. data/lib/plaid/models/session_token_create_response_link.rb +1 -1
  1585. data/lib/plaid/models/signal_address_data.rb +1 -1
  1586. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1587. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1588. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1589. data/lib/plaid/models/signal_device.rb +1 -1
  1590. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  1591. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1592. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1593. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1594. data/lib/plaid/models/signal_person_name.rb +1 -1
  1595. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1596. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1597. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1598. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1599. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -1
  1600. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1601. data/lib/plaid/models/signal_schedule_request.rb +1 -1
  1602. data/lib/plaid/models/signal_schedule_response.rb +1 -1
  1603. data/lib/plaid/models/signal_scores.rb +1 -1
  1604. data/lib/plaid/models/signal_user.rb +1 -1
  1605. data/lib/plaid/models/signal_warning.rb +1 -1
  1606. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1607. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1608. data/lib/plaid/models/sms_verification.rb +1 -1
  1609. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1610. data/lib/plaid/models/source.rb +1 -1
  1611. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1612. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1613. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1614. data/lib/plaid/models/statements_account.rb +1 -1
  1615. data/lib/plaid/models/statements_download_request.rb +1 -1
  1616. data/lib/plaid/models/statements_list_request.rb +1 -1
  1617. data/lib/plaid/models/statements_list_response.rb +1 -1
  1618. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1619. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1620. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1621. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1622. data/lib/plaid/models/statements_statement.rb +1 -1
  1623. data/lib/plaid/models/status.rb +1 -1
  1624. data/lib/plaid/models/statuses.rb +1 -1
  1625. data/lib/plaid/models/strategy.rb +1 -1
  1626. data/lib/plaid/models/student_loan.rb +1 -1
  1627. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1628. data/lib/plaid/models/student_loan_status.rb +1 -1
  1629. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1630. data/lib/plaid/models/sweep_failure.rb +1 -1
  1631. data/lib/plaid/models/sweep_status.rb +1 -1
  1632. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1633. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1634. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1635. data/lib/plaid/models/taxform.rb +1 -1
  1636. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1637. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1638. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1639. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1640. data/lib/plaid/models/total.rb +1 -1
  1641. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1642. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1643. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1644. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1645. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1646. data/lib/plaid/models/total_monthly_income_insights.rb +1 -1
  1647. data/lib/plaid/models/total_outflow_amount.rb +1 -1
  1648. data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
  1649. data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
  1650. data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
  1651. data/lib/plaid/models/total_report_inflow_amount.rb +1 -1
  1652. data/lib/plaid/models/total_report_inflow_amount30d.rb +1 -1
  1653. data/lib/plaid/models/total_report_inflow_amount60d.rb +1 -1
  1654. data/lib/plaid/models/total_report_inflow_amount90d.rb +1 -1
  1655. data/lib/plaid/models/total_report_outflow_amount.rb +1 -1
  1656. data/lib/plaid/models/total_report_outflow_amount30d.rb +1 -1
  1657. data/lib/plaid/models/total_report_outflow_amount60d.rb +1 -1
  1658. data/lib/plaid/models/total_report_outflow_amount90d.rb +1 -1
  1659. data/lib/plaid/models/transaction.rb +1 -1
  1660. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1661. data/lib/plaid/models/transaction_base.rb +1 -1
  1662. data/lib/plaid/models/transaction_code.rb +1 -1
  1663. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1664. data/lib/plaid/models/transaction_data.rb +1 -1
  1665. data/lib/plaid/models/transaction_override.rb +1 -1
  1666. data/lib/plaid/models/transaction_stream.rb +1 -1
  1667. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1668. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1669. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1670. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1671. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1672. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1673. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1674. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1675. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1676. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  1677. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1678. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1679. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1680. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1681. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1682. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1683. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1684. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1685. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1686. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1687. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1688. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1689. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1690. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1691. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1692. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1693. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1694. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1695. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1696. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1697. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1698. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1699. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1700. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1701. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1702. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1703. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  1704. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1705. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1706. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1707. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1708. data/lib/plaid/models/transfer.rb +1 -1
  1709. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1710. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1711. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1712. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1713. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  1714. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1715. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1716. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1717. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1718. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1719. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1720. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1721. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1722. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1723. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1724. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1725. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1726. data/lib/plaid/models/transfer_balance.rb +1 -1
  1727. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1728. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1729. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1730. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1731. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1732. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1733. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1734. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1735. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1736. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1737. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1738. data/lib/plaid/models/transfer_create_request.rb +2 -2
  1739. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1740. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1741. data/lib/plaid/models/transfer_credit_usage_configuration.rb +2 -2
  1742. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1743. data/lib/plaid/models/transfer_device.rb +1 -1
  1744. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1745. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1746. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1747. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1748. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1749. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1750. data/lib/plaid/models/transfer_event.rb +1 -1
  1751. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1752. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1753. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1754. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1755. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1756. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1757. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1758. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1759. data/lib/plaid/models/transfer_failure.rb +1 -1
  1760. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1761. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +1 -1
  1762. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
  1763. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1764. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1765. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1766. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1767. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1768. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1769. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1770. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1771. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1772. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1773. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1774. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1775. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1776. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1777. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  1778. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1779. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1780. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1781. data/lib/plaid/models/transfer_ledger_event.rb +1 -1
  1782. data/lib/plaid/models/transfer_ledger_event_list_request.rb +1 -1
  1783. data/lib/plaid/models/transfer_ledger_event_list_response.rb +1 -1
  1784. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1785. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1786. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1787. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  1788. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1789. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1790. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1791. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1792. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1793. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1794. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1795. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1796. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1797. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1798. data/lib/plaid/models/transfer_network.rb +1 -1
  1799. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1800. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1801. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1802. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1803. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +1 -1
  1804. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +1 -1
  1805. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1806. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1807. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1808. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1809. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1810. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1811. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  1812. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1813. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1814. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1815. data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
  1816. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1817. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1818. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1819. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1820. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1821. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1822. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1823. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1824. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1825. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1826. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1827. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1828. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1829. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1830. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1831. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1832. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1833. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1834. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1835. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1836. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1837. data/lib/plaid/models/transfer_refund.rb +1 -1
  1838. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1839. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1840. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1841. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1842. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1843. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1844. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1845. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1846. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1847. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1848. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1849. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1850. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1851. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1852. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1853. data/lib/plaid/models/transfer_status.rb +1 -1
  1854. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1855. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1856. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1857. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1858. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1859. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1860. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1861. data/lib/plaid/models/transfer_type.rb +1 -1
  1862. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1863. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1864. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1865. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1866. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1867. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1868. data/lib/plaid/models/trust_index.rb +2 -2
  1869. data/lib/plaid/models/trust_index_subscore.rb +1 -1
  1870. data/lib/plaid/models/trust_index_subscores.rb +1 -1
  1871. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1872. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1873. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1874. data/lib/plaid/models/user_account_identity.rb +2 -2
  1875. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1876. data/lib/plaid/models/user_account_identity_edit_counts.rb +1 -1
  1877. data/lib/plaid/models/user_account_identity_edit_history.rb +1 -1
  1878. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1879. data/lib/plaid/models/user_account_identity_official_document.rb +1 -1
  1880. data/lib/plaid/models/user_account_item.rb +1 -1
  1881. data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
  1882. data/lib/plaid/models/user_account_session_event.rb +1 -1
  1883. data/lib/plaid/models/user_account_session_event_send_request.rb +1 -1
  1884. data/lib/plaid/models/user_account_session_event_send_response.rb +1 -1
  1885. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1886. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1887. data/lib/plaid/models/user_address.rb +1 -1
  1888. data/lib/plaid/models/user_based_products.rb +2 -1
  1889. data/lib/plaid/models/user_create_request.rb +2 -2
  1890. data/lib/plaid/models/user_create_response.rb +1 -1
  1891. data/lib/plaid/models/user_custom_password.rb +1 -1
  1892. data/lib/plaid/models/user_data_overview.rb +1 -1
  1893. data/lib/plaid/models/user_financial_data_refresh_request.rb +1 -1
  1894. data/lib/plaid/models/user_financial_data_refresh_response.rb +1 -1
  1895. data/lib/plaid/models/user_get_request.rb +1 -1
  1896. data/lib/plaid/models/user_get_response.rb +1 -1
  1897. data/lib/plaid/models/user_id_number.rb +1 -1
  1898. data/lib/plaid/models/user_identity_remove_request.rb +1 -1
  1899. data/lib/plaid/models/user_identity_remove_response.rb +1 -1
  1900. data/lib/plaid/models/user_items_associate_request.rb +1 -1
  1901. data/lib/plaid/models/user_items_associate_response.rb +1 -1
  1902. data/lib/plaid/models/user_items_get_request.rb +1 -1
  1903. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1904. data/lib/plaid/models/user_items_remove_request.rb +1 -1
  1905. data/lib/plaid/models/user_items_remove_response.rb +1 -1
  1906. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1907. data/lib/plaid/models/user_products_terminate_request.rb +1 -1
  1908. data/lib/plaid/models/user_products_terminate_response.rb +1 -1
  1909. data/lib/plaid/models/user_remove_request.rb +1 -1
  1910. data/lib/plaid/models/user_remove_response.rb +1 -1
  1911. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1912. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1913. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1914. data/lib/plaid/models/user_third_party_token_create_request.rb +1 -1
  1915. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1916. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  1917. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  1918. data/lib/plaid/models/user_transactions_refresh_request.rb +1 -1
  1919. data/lib/plaid/models/user_transactions_refresh_response.rb +1 -1
  1920. data/lib/plaid/models/user_update_request.rb +1 -1
  1921. data/lib/plaid/models/user_update_response.rb +1 -1
  1922. data/lib/plaid/models/validation_source.rb +1 -1
  1923. data/lib/plaid/models/validation_sources.rb +1 -1
  1924. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1925. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1926. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1927. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1928. data/lib/plaid/models/verification_status.rb +1 -1
  1929. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1930. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1931. data/lib/plaid/models/w2.rb +1 -1
  1932. data/lib/plaid/models/w2_box12.rb +1 -1
  1933. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1934. data/lib/plaid/models/w2_override.rb +1 -1
  1935. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1936. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1937. data/lib/plaid/models/wallet.rb +1 -1
  1938. data/lib/plaid/models/wallet_balance.rb +1 -1
  1939. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1940. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1941. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1942. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1943. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1944. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1945. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1946. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1947. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1948. data/lib/plaid/models/wallet_status.rb +1 -1
  1949. data/lib/plaid/models/wallet_transaction.rb +1 -1
  1950. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1951. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1952. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1953. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1954. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1955. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1956. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1957. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1958. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1959. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  1960. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1961. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1962. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1963. data/lib/plaid/models/wallet_transaction_payee_verification_status.rb +1 -1
  1964. data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
  1965. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1966. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1967. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1968. data/lib/plaid/models/warning.rb +1 -1
  1969. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1970. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1971. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1972. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1973. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1974. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1975. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1976. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1977. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1978. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1979. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1980. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1981. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1982. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1983. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1984. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1985. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1986. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1987. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1988. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1989. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1990. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1991. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1992. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1993. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1994. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1995. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1996. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1997. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1998. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1999. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  2000. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  2001. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  2002. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  2003. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  2004. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  2005. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  2006. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  2007. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  2008. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  2009. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  2010. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  2011. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  2012. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  2013. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  2014. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  2015. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  2016. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  2017. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  2018. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  2019. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  2020. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  2021. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  2022. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  2023. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  2024. data/lib/plaid/models/webhook_type.rb +1 -1
  2025. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  2026. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  2027. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  2028. data/lib/plaid/models/yield_rate.rb +1 -1
  2029. data/lib/plaid/models/yield_rate_type.rb +1 -1
  2030. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  2031. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  2032. data/lib/plaid/version.rb +2 -2
  2033. data/lib/plaid.rb +33 -6
  2034. data/plaid.gemspec +1 -1
  2035. metadata +34 -7
@@ -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.682.2
6
+ The version of the OpenAPI document: 2020-09-14_1.688.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -224,7 +224,7 @@ module Plaid
224
224
  end
225
225
 
226
226
  # Create Asset Report Audit Copy
227
- # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
227
+ # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac’s Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
228
228
  # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
229
229
  # @param [Hash] opts the optional parameters
230
230
  # @return [AssetReportAuditCopyCreateResponse]
@@ -234,7 +234,7 @@ module Plaid
234
234
  end
235
235
 
236
236
  # Create Asset Report Audit Copy
237
- # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
237
+ # Plaid can provide an Audit Copy of any Asset Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy directly to the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac’s Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy contains the same underlying data as the Asset Report. To grant access to an Audit Copy, use the `/asset_report/audit_copy/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
238
238
  # @param asset_report_audit_copy_create_request [AssetReportAuditCopyCreateRequest]
239
239
  # @param [Hash] opts the optional parameters
240
240
  # @return [Array<(AssetReportAuditCopyCreateResponse, Integer, Hash)>] AssetReportAuditCopyCreateResponse data, response status code and response headers
@@ -972,7 +972,7 @@ module Plaid
972
972
  end
973
973
 
974
974
  # Verify auth data
975
- # The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact Sales or your Plaid account manager to request access.
975
+ # The `/auth/verify` endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid's database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact Sales or your Plaid account manager to request access.
976
976
  # @param auth_verify_request [AuthVerifyRequest]
977
977
  # @param [Hash] opts the optional parameters
978
978
  # @return [AuthVerifyResponse]
@@ -982,7 +982,7 @@ module Plaid
982
982
  end
983
983
 
984
984
  # Verify auth data
985
- # The &#x60;/auth/verify&#x60; endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid&#39;s database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact Sales or your Plaid account manager to request access.
985
+ # The &#x60;/auth/verify&#x60; endpoint verifies bank account and routing numbers and (optionally) account owner names against Plaid&#39;s database via [Database Auth](https://plaid.com/docs/auth/coverage/database-auth/). It can be used to verify account numbers that were not collected via the Plaid Link flow. This endpoint is currently in Early Availability; contact Sales or your Plaid account manager to request access.
986
986
  # @param auth_verify_request [AuthVerifyRequest]
987
987
  # @param [Hash] opts the optional parameters
988
988
  # @return [Array<(AuthVerifyResponse, Integer, Hash)>] AuthVerifyResponse data, response status code and response headers
@@ -3760,7 +3760,7 @@ module Plaid
3760
3760
  end
3761
3761
 
3762
3762
  # Retrieve cash flow information from your user's banks
3763
- # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
3763
+ # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after youve received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \"II2\". Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#heading=h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#bookmark=id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl).
3764
3764
  # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3765
3765
  # @param [Hash] opts the optional parameters
3766
3766
  # @return [CraCheckReportIncomeInsightsGetResponse]
@@ -3770,7 +3770,7 @@ module Plaid
3770
3770
  end
3771
3771
 
3772
3772
  # Retrieve cash flow information from your user&#39;s banks
3773
- # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.
3773
+ # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after youve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \&quot;II2\&quot;. Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.0#heading&#x3D;h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.0#bookmark&#x3D;id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.36c85n2ircqk#heading&#x3D;h.79dwr5c1iszl).
3774
3774
  # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3775
3775
  # @param [Hash] opts the optional parameters
3776
3776
  # @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
@@ -4100,7 +4100,7 @@ module Plaid
4100
4100
  end
4101
4101
 
4102
4102
  # Retrieve various home lending reports for a user.
4103
- # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
4103
+ # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
4104
4104
  # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
4105
4105
  # @param [Hash] opts the optional parameters
4106
4106
  # @return [CraCheckReportVerificationGetResponse]
@@ -4110,7 +4110,7 @@ module Plaid
4110
4110
  end
4111
4111
 
4112
4112
  # Retrieve various home lending reports for a user.
4113
- # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.\&quot;
4113
+ # This endpoint allows you to retrieve home lending reports for a user. To obtain a VoA or Employment Refresh report, you need to make sure that &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.\&quot;
4114
4114
  # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
4115
4115
  # @param [Hash] opts the optional parameters
4116
4116
  # @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
@@ -4576,7 +4576,7 @@ module Plaid
4576
4576
  end
4577
4577
 
4578
4578
  # Subscribe to Monitoring Insights
4579
- # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated between one and four times per day (best-effort).
4579
+ # This endpoint allows you to subscribe to insights for a user's linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Updates beta experience, only one Item per user may be subscribed for monitoring updates.
4580
4580
  # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
4581
4581
  # @param [Hash] opts the optional parameters
4582
4582
  # @return [CraMonitoringInsightsSubscribeResponse]
@@ -4586,7 +4586,7 @@ module Plaid
4586
4586
  end
4587
4587
 
4588
4588
  # Subscribe to Monitoring Insights
4589
- # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated between one and four times per day (best-effort).
4589
+ # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA Item, which are updated between one and four times per day (best-effort). In the current Cash Flow Updates beta experience, only one Item per user may be subscribed for monitoring updates.
4590
4590
  # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
4591
4591
  # @param [Hash] opts the optional parameters
4592
4592
  # @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
@@ -4916,7 +4916,7 @@ module Plaid
4916
4916
  end
4917
4917
 
4918
4918
  # Create Asset or Income Report Audit Copy Token
4919
- # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of `/credit/payroll_income/get`). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
4919
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Mac's Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of `/credit/payroll_income/get`). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
4920
4920
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4921
4921
  # @param [Hash] opts the optional parameters
4922
4922
  # @return [CreditAuditCopyTokenCreateResponse]
@@ -4926,7 +4926,7 @@ module Plaid
4926
4926
  end
4927
4927
 
4928
4928
  # Create Asset or Income Report Audit Copy Token
4929
- # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of &#x60;/credit/payroll_income/get&#x60;). Use the &#x60;/credit/audit_copy_token/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the GSE who needs access.
4929
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government Sponsored Entity (GSE) if you participate in Fannie Mae&#39;s Day 1 Certainty™ program or utilize Freddie Mac&#39;s Loan Product Advisor® (LPA®) Asset and Income Modeler (AIM). An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of &#x60;/credit/payroll_income/get&#x60;). Use the &#x60;/credit/audit_copy_token/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the GSE who needs access.
4930
4930
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4931
4931
  # @param [Hash] opts the optional parameters
4932
4932
  # @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
@@ -8982,6 +8982,74 @@ module Plaid
8982
8982
  return data, status_code, headers
8983
8983
  end
8984
8984
 
8985
+ # Report fraud for an Item
8986
+ # Use this endpoint to create a fraud report and terminate the associated Item. The `access_token` associated with the Item will be deactivated and billing for the Item's products will be ended. This endpoint allows you to report various types of fraud incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
8987
+ # @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
8988
+ # @param [Hash] opts the optional parameters
8989
+ # @return [ItemHandleFraudReportResponse]
8990
+ def item_handle_fraud_report(item_handle_fraud_report_request, opts = {})
8991
+ data, _status_code, _headers = item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts)
8992
+ data
8993
+ end
8994
+
8995
+ # Report fraud for an Item
8996
+ # Use this endpoint to create a fraud report and terminate the associated Item. The &#x60;access_token&#x60; associated with the Item will be deactivated and billing for the Item&#39;s products will be ended. This endpoint allows you to report various types of fraud incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
8997
+ # @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
8998
+ # @param [Hash] opts the optional parameters
8999
+ # @return [Array<(ItemHandleFraudReportResponse, Integer, Hash)>] ItemHandleFraudReportResponse data, response status code and response headers
9000
+ def item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts = {})
9001
+ if @api_client.config.debugging
9002
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_handle_fraud_report ...'
9003
+ end
9004
+ # verify the required parameter 'item_handle_fraud_report_request' is set
9005
+ if @api_client.config.client_side_validation && item_handle_fraud_report_request.nil?
9006
+ fail ArgumentError, "Missing the required parameter 'item_handle_fraud_report_request' when calling PlaidApi.item_handle_fraud_report"
9007
+ end
9008
+ # resource path
9009
+ local_var_path = '/item/handle_fraud_report'
9010
+
9011
+ # query parameters
9012
+ query_params = opts[:query_params] || {}
9013
+
9014
+ # header parameters
9015
+ header_params = opts[:header_params] || {}
9016
+ # HTTP header 'Accept' (if needed)
9017
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9018
+ # HTTP header 'Content-Type'
9019
+ content_type = @api_client.select_header_content_type(['application/json'])
9020
+ if !content_type.nil?
9021
+ header_params['Content-Type'] = content_type
9022
+ end
9023
+
9024
+ # form parameters
9025
+ form_params = opts[:form_params] || {}
9026
+
9027
+ # http body (model)
9028
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_handle_fraud_report_request)
9029
+
9030
+ # return_type
9031
+ return_type = opts[:debug_return_type] || 'ItemHandleFraudReportResponse'
9032
+
9033
+ # auth_names
9034
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9035
+
9036
+ new_options = opts.merge(
9037
+ :operation => :"PlaidApi.item_handle_fraud_report",
9038
+ :header_params => header_params,
9039
+ :query_params => query_params,
9040
+ :form_params => form_params,
9041
+ :body => post_body,
9042
+ :auth_names => auth_names,
9043
+ :return_type => return_type
9044
+ )
9045
+
9046
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9047
+ if @api_client.config.debugging
9048
+ @api_client.config.logger.debug "API called: PlaidApi#item_handle_fraud_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9049
+ end
9050
+ return data, status_code, headers
9051
+ end
9052
+
8985
9053
  # Import Item
8986
9054
  # `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.
8987
9055
  # @param item_import_request [ItemImportRequest]
@@ -9050,6 +9118,74 @@ module Plaid
9050
9118
  return data, status_code, headers
9051
9119
  end
9052
9120
 
9121
+ # Terminate products for an Item
9122
+ # The `/item/products/terminate` endpoint allows you to terminate an Item. Once terminated, the `access_token` associated with the Item is no longer valid, billing for the Item's products is ended, and relevant webhooks are fired. `/item/products/terminate` is the recommended way to offboard users or disconnect accounts linked via Plaid.
9123
+ # @param item_products_terminate_request [ItemProductsTerminateRequest]
9124
+ # @param [Hash] opts the optional parameters
9125
+ # @return [ItemProductsTerminateResponse]
9126
+ def item_products_terminate(item_products_terminate_request, opts = {})
9127
+ data, _status_code, _headers = item_products_terminate_with_http_info(item_products_terminate_request, opts)
9128
+ data
9129
+ end
9130
+
9131
+ # Terminate products for an Item
9132
+ # The &#x60;/item/products/terminate&#x60; endpoint allows you to terminate an Item. Once terminated, the &#x60;access_token&#x60; associated with the Item is no longer valid, billing for the Item&#39;s products is ended, and relevant webhooks are fired. &#x60;/item/products/terminate&#x60; is the recommended way to offboard users or disconnect accounts linked via Plaid.
9133
+ # @param item_products_terminate_request [ItemProductsTerminateRequest]
9134
+ # @param [Hash] opts the optional parameters
9135
+ # @return [Array<(ItemProductsTerminateResponse, Integer, Hash)>] ItemProductsTerminateResponse data, response status code and response headers
9136
+ def item_products_terminate_with_http_info(item_products_terminate_request, opts = {})
9137
+ if @api_client.config.debugging
9138
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_products_terminate ...'
9139
+ end
9140
+ # verify the required parameter 'item_products_terminate_request' is set
9141
+ if @api_client.config.client_side_validation && item_products_terminate_request.nil?
9142
+ fail ArgumentError, "Missing the required parameter 'item_products_terminate_request' when calling PlaidApi.item_products_terminate"
9143
+ end
9144
+ # resource path
9145
+ local_var_path = '/item/products/terminate'
9146
+
9147
+ # query parameters
9148
+ query_params = opts[:query_params] || {}
9149
+
9150
+ # header parameters
9151
+ header_params = opts[:header_params] || {}
9152
+ # HTTP header 'Accept' (if needed)
9153
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9154
+ # HTTP header 'Content-Type'
9155
+ content_type = @api_client.select_header_content_type(['application/json'])
9156
+ if !content_type.nil?
9157
+ header_params['Content-Type'] = content_type
9158
+ end
9159
+
9160
+ # form parameters
9161
+ form_params = opts[:form_params] || {}
9162
+
9163
+ # http body (model)
9164
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_products_terminate_request)
9165
+
9166
+ # return_type
9167
+ return_type = opts[:debug_return_type] || 'ItemProductsTerminateResponse'
9168
+
9169
+ # auth_names
9170
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9171
+
9172
+ new_options = opts.merge(
9173
+ :operation => :"PlaidApi.item_products_terminate",
9174
+ :header_params => header_params,
9175
+ :query_params => query_params,
9176
+ :form_params => form_params,
9177
+ :body => post_body,
9178
+ :auth_names => auth_names,
9179
+ :return_type => return_type
9180
+ )
9181
+
9182
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9183
+ if @api_client.config.debugging
9184
+ @api_client.config.logger.debug "API called: PlaidApi#item_products_terminate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9185
+ end
9186
+ return data, status_code, headers
9187
+ end
9188
+
9053
9189
  # Exchange public token for an access token
9054
9190
  # Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
9055
9191
  # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
@@ -9119,7 +9255,7 @@ module Plaid
9119
9255
  end
9120
9256
 
9121
9257
  # Remove an Item
9122
- # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
9258
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). On a Trial plan, calling `/item/remove` does not impact the number of remaining Trial Items (bank connections) you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
9123
9259
  # @param item_remove_request [ItemRemoveRequest]
9124
9260
  # @param [Hash] opts the optional parameters
9125
9261
  # @return [ItemRemoveResponse]
@@ -9129,7 +9265,7 @@ module Plaid
9129
9265
  end
9130
9266
 
9131
9267
  # Remove an Item
9132
- # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
9268
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/)). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). On a Trial plan, calling &#x60;/item/remove&#x60; does not impact the number of remaining Trial Items (bank connections) you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
9133
9269
  # @param item_remove_request [ItemRemoveRequest]
9134
9270
  # @param [Hash] opts the optional parameters
9135
9271
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -9731,7 +9867,7 @@ module Plaid
9731
9867
  end
9732
9868
 
9733
9869
  # Check a user's Plaid Network status
9734
- # The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9870
+ # The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid Account Manager. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9735
9871
  # @param network_status_get_request [NetworkStatusGetRequest]
9736
9872
  # @param [Hash] opts the optional parameters
9737
9873
  # @return [NetworkStatusGetResponse]
@@ -9741,7 +9877,7 @@ module Plaid
9741
9877
  end
9742
9878
 
9743
9879
  # Check a user&#39;s Plaid Network status
9744
- # The &#x60;/network/status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. Note: it is strongly recommended to check for Layer eligibility in the frontend. &#x60;/network/status/get&#x60; should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9880
+ # The &#x60;/network/status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. To access this endpoint, contact your Plaid Account Manager. Note: it is strongly recommended to check for Layer eligibility in the frontend. &#x60;/network/status/get&#x60; should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9745
9881
  # @param network_status_get_request [NetworkStatusGetRequest]
9746
9882
  # @param [Hash] opts the optional parameters
9747
9883
  # @return [Array<(NetworkStatusGetResponse, Integer, Hash)>] NetworkStatusGetResponse data, response status code and response headers
@@ -10615,7 +10751,7 @@ module Plaid
10615
10751
  end
10616
10752
 
10617
10753
  # Create a payment
10618
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
10754
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
10619
10755
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10620
10756
  # @param [Hash] opts the optional parameters
10621
10757
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -10625,7 +10761,7 @@ module Plaid
10625
10761
  end
10626
10762
 
10627
10763
  # Create a payment
10628
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In Limited Production, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency), and standing orders, variable recurring payments, and Virtual Accounts are not supported.
10764
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am.
10629
10765
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10630
10766
  # @param [Hash] opts the optional parameters
10631
10767
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -11770,6 +11906,74 @@ module Plaid
11770
11906
  return data, status_code, headers
11771
11907
  end
11772
11908
 
11909
+ # Get investment account authentication data
11910
+ # The `/processor/investments/auth/get` endpoint allows you to retrieve information about the account authorized by a processor token, including account numbers, account owners, holdings, and data provenance information. To receive Investments Auth webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11911
+ # @param processor_investments_auth_get_request [ProcessorInvestmentsAuthGetRequest]
11912
+ # @param [Hash] opts the optional parameters
11913
+ # @return [ProcessorInvestmentsAuthGetResponse]
11914
+ def processor_investments_auth_get(processor_investments_auth_get_request, opts = {})
11915
+ data, _status_code, _headers = processor_investments_auth_get_with_http_info(processor_investments_auth_get_request, opts)
11916
+ data
11917
+ end
11918
+
11919
+ # Get investment account authentication data
11920
+ # The &#x60;/processor/investments/auth/get&#x60; endpoint allows you to retrieve information about the account authorized by a processor token, including account numbers, account owners, holdings, and data provenance information. To receive Investments Auth webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11921
+ # @param processor_investments_auth_get_request [ProcessorInvestmentsAuthGetRequest]
11922
+ # @param [Hash] opts the optional parameters
11923
+ # @return [Array<(ProcessorInvestmentsAuthGetResponse, Integer, Hash)>] ProcessorInvestmentsAuthGetResponse data, response status code and response headers
11924
+ def processor_investments_auth_get_with_http_info(processor_investments_auth_get_request, opts = {})
11925
+ if @api_client.config.debugging
11926
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_auth_get ...'
11927
+ end
11928
+ # verify the required parameter 'processor_investments_auth_get_request' is set
11929
+ if @api_client.config.client_side_validation && processor_investments_auth_get_request.nil?
11930
+ fail ArgumentError, "Missing the required parameter 'processor_investments_auth_get_request' when calling PlaidApi.processor_investments_auth_get"
11931
+ end
11932
+ # resource path
11933
+ local_var_path = '/processor/investments/auth/get'
11934
+
11935
+ # query parameters
11936
+ query_params = opts[:query_params] || {}
11937
+
11938
+ # header parameters
11939
+ header_params = opts[:header_params] || {}
11940
+ # HTTP header 'Accept' (if needed)
11941
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11942
+ # HTTP header 'Content-Type'
11943
+ content_type = @api_client.select_header_content_type(['application/json'])
11944
+ if !content_type.nil?
11945
+ header_params['Content-Type'] = content_type
11946
+ end
11947
+
11948
+ # form parameters
11949
+ form_params = opts[:form_params] || {}
11950
+
11951
+ # http body (model)
11952
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_auth_get_request)
11953
+
11954
+ # return_type
11955
+ return_type = opts[:debug_return_type] || 'ProcessorInvestmentsAuthGetResponse'
11956
+
11957
+ # auth_names
11958
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11959
+
11960
+ new_options = opts.merge(
11961
+ :operation => :"PlaidApi.processor_investments_auth_get",
11962
+ :header_params => header_params,
11963
+ :query_params => query_params,
11964
+ :form_params => form_params,
11965
+ :body => post_body,
11966
+ :auth_names => auth_names,
11967
+ :return_type => return_type
11968
+ )
11969
+
11970
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11971
+ if @api_client.config.debugging
11972
+ @api_client.config.logger.debug "API called: PlaidApi#processor_investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11973
+ end
11974
+ return data, status_code, headers
11975
+ end
11976
+
11773
11977
  # Retrieve Investment Holdings
11774
11978
  # This endpoint returns the stock position data of the account associated with a given processor token.
11775
11979
  # @param processor_investments_holdings_get_request [ProcessorInvestmentsHoldingsGetRequest]
@@ -11975,7 +12179,7 @@ module Plaid
11975
12179
  end
11976
12180
 
11977
12181
  # Report whether you initiated an ACH transaction
11978
- # After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/processor/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/processor/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/processor/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/processor/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
12182
+ # After you call `/processor/signal/evaluate`, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was `REVIEW`, or if you take a different action than the one determined by the Signal Rules, you will need to call `/processor/signal/decision/report`. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling `/processor/signal/decision/report` (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call `/processor/signal/decision/report` again for the transaction to correct Plaid's records. If you are using Plaid Transfer as your payment processor, you also do not need to call `/processor/signal/decision/report`, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
11979
12183
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
11980
12184
  # @param [Hash] opts the optional parameters
11981
12185
  # @return [ProcessorSignalDecisionReportResponse]
@@ -11985,7 +12189,7 @@ module Plaid
11985
12189
  end
11986
12190
 
11987
12191
  # Report whether you initiated an ACH transaction
11988
- # After you call &#x60;/processor/signal/evaluate&#x60;, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was &#x60;REVIEW&#x60;, or if you take a different action than the one determined by the Signal Rules, you will need to call &#x60;/processor/signal/decision/report&#x60;. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling &#x60;/processor/signal/decision/report&#x60; (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call &#x60;/processor/signal/decision/report&#x60; again for the transaction to correct Plaid&#39;s records. If you are using Plaid Transfer as your payment processor, you also do not need to call &#x60;/processor/signal/decision/report&#x60;, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
12192
+ # After you call &#x60;/processor/signal/evaluate&#x60;, Plaid will normally infer the outcome from your Signal Rules. However, if you are not using Signal Rules, if the Signal Rules outcome was &#x60;REVIEW&#x60;, or if you take a different action than the one determined by the Signal Rules, you will need to call &#x60;/processor/signal/decision/report&#x60;. This helps improve Signal Transaction Score accuracy for your account and is necessary for proper functioning of the rule performance and rule tuning capabilities in the Dashboard. If your effective decision changes after calling &#x60;/processor/signal/decision/report&#x60; (for example, you indicated that you accepted a transaction, but later on, your payment processor rejected it, so it was never initiated), call &#x60;/processor/signal/decision/report&#x60; again for the transaction to correct Plaid&#39;s records. If you are using Plaid Transfer as your payment processor, you also do not need to call &#x60;/processor/signal/decision/report&#x60;, as Plaid can infer outcomes from your Transfer activity. If using a Balance-only ruleset, this endpoint will not impact scores (Balance does not use scores), but is necessary to view accurate transaction outcomes and tune rule logic in the Dashboard.
11989
12193
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
11990
12194
  # @param [Hash] opts the optional parameters
11991
12195
  # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
@@ -12043,7 +12247,7 @@ module Plaid
12043
12247
  end
12044
12248
 
12045
12249
  # Evaluate a planned ACH transaction
12046
- # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/signal/evaluate` is used with Rulesets that are configured on the end customer Dashboard can can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
12250
+ # Use `/processor/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. `/processor/signal/evaluate` uses Rulesets that are configured on the end customer's Dashboard and can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. Note that only customer-configured rulesets work with this endpoint; as a processor partner, you cannot create or configure your own rulesets. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
12047
12251
  # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
12048
12252
  # @param [Hash] opts the optional parameters
12049
12253
  # @return [ProcessorSignalEvaluateResponse]
@@ -12053,7 +12257,7 @@ module Plaid
12053
12257
  end
12054
12258
 
12055
12259
  # Evaluate a planned ACH transaction
12056
- # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. &#x60;/signal/evaluate&#x60; is used with Rulesets that are configured on the end customer Dashboard can can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the &#x60;ruleset_key&#x60; that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
12260
+ # Use &#x60;/processor/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. &#x60;/processor/signal/evaluate&#x60; uses Rulesets that are configured on the end customer&#39;s Dashboard and can be used with either the Signal Transaction Scores product or the Balance product. Which product is used will be determined by the &#x60;ruleset_key&#x60; that you provide. Note that only customer-configured rulesets work with this endpoint; as a processor partner, you cannot create or configure your own rulesets. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency if Signal Transaction Scores is being added to an existing Item for the first time, or when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data.
12057
12261
  # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
12058
12262
  # @param [Hash] opts the optional parameters
12059
12263
  # @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
@@ -13131,7 +13335,7 @@ module Plaid
13131
13335
  end
13132
13336
 
13133
13337
  # Create a Protect report
13134
- # Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
13338
+ # Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
13135
13339
  # @param protect_report_create_request [ProtectReportCreateRequest]
13136
13340
  # @param [Hash] opts the optional parameters
13137
13341
  # @return [ProtectReportCreateResponse]
@@ -13141,7 +13345,7 @@ module Plaid
13141
13345
  end
13142
13346
 
13143
13347
  # Create a Protect report
13144
- # Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
13348
+ # Use this endpoint to create a Protect report to document fraud incidents, investigation outcomes, or other risk events. This endpoint allows you to report various types of incidents including account takeovers, identity fraud, unauthorized transactions, and other security events. The reported data helps improve fraud detection models and provides valuable feedback to enhance the overall security of the Plaid network. Reports can be created for confirmed incidents that have been fully investigated, or for suspected incidents that require further review. You can associate reports with specific users, sessions, or transactions to provide comprehensive context about the incident.
13145
13349
  # @param protect_report_create_request [ProtectReportCreateRequest]
13146
13350
  # @param [Hash] opts the optional parameters
13147
13351
  # @return [Array<(ProtectReportCreateResponse, Integer, Hash)>] ProtectReportCreateResponse data, response status code and response headers
@@ -13675,7 +13879,7 @@ module Plaid
13675
13879
  end
13676
13880
 
13677
13881
  # Force a Sandbox Item into an error state
13678
- # `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
13882
+ # `/sandbox/item/reset_login/` forces an Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/item/reset_login`, You can then use Plaid Link update mode to restore the Item to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
13679
13883
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
13680
13884
  # @param [Hash] opts the optional parameters
13681
13885
  # @return [SandboxItemResetLoginResponse]
@@ -13685,7 +13889,7 @@ module Plaid
13685
13889
  end
13686
13890
 
13687
13891
  # Force a Sandbox Item into an error state
13688
- # &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
13892
+ # &#x60;/sandbox/item/reset_login/&#x60; forces an Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/item/reset_login&#x60;, You can then use Plaid Link update mode to restore the Item to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
13689
13893
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
13690
13894
  # @param [Hash] opts the optional parameters
13691
13895
  # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
@@ -15035,7 +15239,7 @@ module Plaid
15035
15239
  end
15036
15240
 
15037
15241
  # Force item(s) for a Sandbox User into an error state
15038
- # `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
15242
+ # `/sandbox/user/reset_login/` functions the same as `/sandbox/item/reset_login`, but will modify Items related to a User. This endpoint forces each Item into an `ITEM_LOGIN_REQUIRED` state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link's [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling `/sandbox/user/reset_login`, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An `ITEM_LOGIN_REQUIRED` webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an `ITEM_LOGIN_REQUIRED` error state automatically after 30 days, even if this endpoint is not called.
15039
15243
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15040
15244
  # @param [Hash] opts the optional parameters
15041
15245
  # @return [SandboxUserResetLoginResponse]
@@ -15045,7 +15249,7 @@ module Plaid
15045
15249
  end
15046
15250
 
15047
15251
  # Force item(s) for a Sandbox User into an error state
15048
- # &#x60;/sandbox/user/reset_login/&#x60; functions the same as &#x60;/sandbox/item/reset_login&#x60;, but will modify Items related to a User. This endpoint forces each Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/user/reset_login&#x60;, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
15252
+ # &#x60;/sandbox/user/reset_login/&#x60; functions the same as &#x60;/sandbox/item/reset_login&#x60;, but will modify Items related to a User. This endpoint forces each Item into an &#x60;ITEM_LOGIN_REQUIRED&#x60; state in order to simulate an Item whose login is no longer valid. This makes it easy to test Link&#39;s [update mode](https://plaid.com/docs/link/update-mode) flow in the Sandbox environment. After calling &#x60;/sandbox/user/reset_login&#x60;, You can then use Plaid Link update mode to restore Items associated with the User to a good state. An &#x60;ITEM_LOGIN_REQUIRED&#x60; webhook will also be fired after a call to this endpoint, if one is associated with the Item. In the Sandbox, Items will transition to an &#x60;ITEM_LOGIN_REQUIRED&#x60; error state automatically after 30 days, even if this endpoint is not called.
15049
15253
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15050
15254
  # @param [Hash] opts the optional parameters
15051
15255
  # @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
@@ -15239,7 +15443,7 @@ module Plaid
15239
15443
  end
15240
15444
 
15241
15445
  # Evaluate a planned ACH transaction
15242
- # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal->Rules**](https://dashboard.plaid.com/signal/risk-profiles). `/signal/evaluate` can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
15446
+ # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using `/signal/evaluate`, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal->Rules**](https://dashboard.plaid.com/signal/risk-profiles). `/signal/evaluate` can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the `ruleset_key` that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
15243
15447
  # @param signal_evaluate_request [SignalEvaluateRequest]
15244
15448
  # @param [Hash] opts the optional parameters
15245
15449
  # @return [SignalEvaluateResponse]
@@ -15249,7 +15453,7 @@ module Plaid
15249
15453
  end
15250
15454
 
15251
15455
  # Evaluate a planned ACH transaction
15252
- # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using &#x60;/signal/evaluate&#x60;, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal-&gt;Rules**](https://dashboard.plaid.com/signal/risk-profiles). &#x60;/signal/evaluate&#x60; can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the &#x60;ruleset_key&#x60; that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
15456
+ # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment and additional risk signals. Before using &#x60;/signal/evaluate&#x60;, you must first [create a ruleset](https://plaid.com/docs/signal/signal-rules/) in the Dashboard under [**Signal-&gt;Rules**](https://dashboard.plaid.com/signal/risk-profiles). &#x60;/signal/evaluate&#x60; can be used with either Signal Transaction Scores or the Balance product. Which product is used will be determined by the &#x60;ruleset_key&#x60; that you provide. For more details, see [Signal Rules](https://plaid.com/docs/signal/signal-rules/). Note: This request may have higher latency when using a Balance-only ruleset. This is because Plaid must communicate directly with the institution to request data. Balance-only rulesets may have latency of up to 30 seconds or more; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
15253
15457
  # @param signal_evaluate_request [SignalEvaluateRequest]
15254
15458
  # @param [Hash] opts the optional parameters
15255
15459
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
@@ -15307,7 +15511,7 @@ module Plaid
15307
15511
  end
15308
15512
 
15309
15513
  # Opt-in an Item to Signal Transaction Scores
15310
- # When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where `signal` was added in the `additional_consented_products` array but not in the `products`, `optional_products`, or `required_if_supported_products` array. If `/signal/prepare` is skipped on an Item that is not initialized with `signal`, the initial call to `/signal/evaluate` on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with `signal`, this endpoint will return a 200 response and will not modify the Item.
15514
+ # When an Item is not initialized with `signal`, call `/signal/prepare` to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where `signal` was added in the `additional_consented_products` array but not in the `products`, `optional_products`, or `required_if_supported_products` array. If `/signal/prepare` is skipped on an Item that is not initialized with `signal`, the initial call to `/signal/evaluate` on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with `signal`, this endpoint will return a 200 response and will not modify the Item.
15311
15515
  # @param signal_prepare_request [SignalPrepareRequest]
15312
15516
  # @param [Hash] opts the optional parameters
15313
15517
  # @return [SignalPrepareResponse]
@@ -15317,7 +15521,7 @@ module Plaid
15317
15521
  end
15318
15522
 
15319
15523
  # Opt-in an Item to Signal Transaction Scores
15320
- # When an Item is not initialized with &#x60;signal&#x60;, call &#x60;/signal/prepare&#x60; to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where &#x60;signal&#x60; was added in the &#x60;additional_consented_products&#x60; array but not in the &#x60;products&#x60;, &#x60;optional_products&#x60;, or &#x60;required_if_supported_products&#x60; array. If &#x60;/signal/prepare&#x60; is skipped on an Item that is not initialized with &#x60;signal&#x60;, the initial call to &#x60;/signal/evaluate&#x60; on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with &#x60;signal&#x60;, this endpoint will return a 200 response and will not modify the Item.
15524
+ # When an Item is not initialized with &#x60;signal&#x60;, call &#x60;/signal/prepare&#x60; to opt-in that Item to the data collection process used to develop a Signal Transaction Score. This should be done on Items where &#x60;signal&#x60; was added in the &#x60;additional_consented_products&#x60; array but not in the &#x60;products&#x60;, &#x60;optional_products&#x60;, or &#x60;required_if_supported_products&#x60; array. If &#x60;/signal/prepare&#x60; is skipped on an Item that is not initialized with &#x60;signal&#x60;, the initial call to &#x60;/signal/evaluate&#x60; on that Item will be less accurate, because Plaid will have access to less data for computing the Signal Transaction Score. If your integration is purely Balance-only, this endpoint will have no effect, as Balance-only rulesets do not calculate a Signal Transaction Score. If run on an Item that is already initialized with &#x60;signal&#x60;, this endpoint will return a 200 response and will not modify the Item.
15321
15525
  # @param signal_prepare_request [SignalPrepareRequest]
15322
15526
  # @param [Hash] opts the optional parameters
15323
15527
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -15851,7 +16055,7 @@ module Plaid
15851
16055
  end
15852
16056
 
15853
16057
  # Get transaction data
15854
- # Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive 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 the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. 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. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
16058
+ # Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive 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 the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. 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. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
15855
16059
  # @param transactions_get_request [TransactionsGetRequest]
15856
16060
  # @param [Hash] opts the optional parameters
15857
16061
  # @return [TransactionsGetResponse]
@@ -15861,7 +16065,7 @@ module Plaid
15861
16065
  end
15862
16066
 
15863
16067
  # Get transaction data
15864
- # Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. 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. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.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, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
16068
+ # Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. 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. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.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, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
15865
16069
  # @param transactions_get_request [TransactionsGetRequest]
15866
16070
  # @param [Hash] opts the optional parameters
15867
16071
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -19387,7 +19591,7 @@ module Plaid
19387
19591
  end
19388
19592
 
19389
19593
  # Create user
19390
- # For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before calling `/link/token/create` if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user's full SSN must be provided via the `id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
19594
+ # For Plaid products and flows that use the user object, `/user/create` provides you a single token to access all data associated with the user. You must call this endpoint before calling `/link/token/create` if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect (Identity). If you are using Plaid Protect Link session scoring, you do not need to call `/user/create` first; Plaid will resolve or create the user when `user.client_user_id` is provided in `/link/token/create`. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a `client_user_id` and an `identity` object and will return a `user_id`. For customers who began using it before that date, the endpoint takes a `client_user_id` and a `consumer_report_user_identity` object and will return a `user_token` and `user_id`. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the `identity` (new) or `consumer_report_user_identity` (legacy) object must be present. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. In order to generate a Plaid Check Consumer Report, the following `identity` fields, at minimum, are required and must be non-empty: `name`, `date_of_birth`, `emails`, `phone_numbers`, and `addresses`, (with at least one email, phone number, and address designated as `primary`). Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If creating a report for sharing with a GSE such as Fannie or Freddie, the user's full SSN must be provided via the `id_numbers` field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an `identity` object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
19391
19595
  # @param user_create_request [UserCreateRequest]
19392
19596
  # @param [Hash] opts the optional parameters
19393
19597
  # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
@@ -19398,7 +19602,7 @@ module Plaid
19398
19602
  end
19399
19603
 
19400
19604
  # Create user
19401
- # For Plaid products and flows that use the user object, &#x60;/user/create&#x60; provides you a single token to access all data associated with the user. You must call this endpoint before calling &#x60;/link/token/create&#x60; if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a &#x60;client_user_id&#x60; and an &#x60;identity&#x60; object and will return a &#x60;user_id&#x60;. For customers who began using it before that date, the endpoint takes a &#x60;client_user_id&#x60; and a &#x60;consumer_report_user_identity&#x60; object and will return a &#x60;user_token&#x60; and &#x60;user_id&#x60;. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the &#x60;identity&#x60; (new) or &#x60;consumer_report_user_identity&#x60; (legacy) object must be present. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. In order to generate a Plaid Check Consumer Report, the following &#x60;identity&#x60; fields, at minimum, are required and must be non-empty: &#x60;name&#x60;, &#x60;date_of_birth&#x60;, &#x60;emails&#x60;, &#x60;phone_numbers&#x60;, and &#x60;addresses&#x60;, (with at least one email, phone number, and address designated as &#x60;primary&#x60;). Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;. If creating a report for sharing with a GSE such as Fannie or Freddie, the user&#39;s full SSN must be provided via the &#x60;id_numbers&#x60; field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an &#x60;identity&#x60; object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
19605
+ # For Plaid products and flows that use the user object, &#x60;/user/create&#x60; provides you a single token to access all data associated with the user. You must call this endpoint before calling &#x60;/link/token/create&#x60; if you are using any of the following: Plaid Check, Income Verification, Multi-Item Link, or Plaid Protect (Identity). If you are using Plaid Protect Link session scoring, you do not need to call &#x60;/user/create&#x60; first; Plaid will resolve or create the user when &#x60;user.client_user_id&#x60; is provided in &#x60;/link/token/create&#x60;. For customers who began using this endpoint on or after December 10, 2025, this endpoint takes a &#x60;client_user_id&#x60; and an &#x60;identity&#x60; object and will return a &#x60;user_id&#x60;. For customers who began using it before that date, the endpoint takes a &#x60;client_user_id&#x60; and a &#x60;consumer_report_user_identity&#x60; object and will return a &#x60;user_token&#x60; and &#x60;user_id&#x60;. For more details, see [New User APIs](https://plaid.com/docs/api/users/user-apis). In order to create a Plaid Check Consumer Report for a user, the &#x60;identity&#x60; (new) or &#x60;consumer_report_user_identity&#x60; (legacy) object must be present. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. In order to generate a Plaid Check Consumer Report, the following &#x60;identity&#x60; fields, at minimum, are required and must be non-empty: &#x60;name&#x60;, &#x60;date_of_birth&#x60;, &#x60;emails&#x60;, &#x60;phone_numbers&#x60;, and &#x60;addresses&#x60;, (with at least one email, phone number, and address designated as &#x60;primary&#x60;). Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;. If creating a report for sharing with a GSE such as Fannie or Freddie, the user&#39;s full SSN must be provided via the &#x60;id_numbers&#x60; field. Providing at least a partial SSN is also strongly recommended for all use cases, since it improves the accuracy of matching user records during compliance processes such as file disclosure, dispute, or security freeze requests. When using Plaid Protect, it is highly recommended that you provide an &#x60;identity&#x60; object to better identify and block fraud across your Link sessions. Plaid will normalize identity fields before storing them and utilize the same identity across different user-based products.
19402
19606
  # @param user_create_request [UserCreateRequest]
19403
19607
  # @param [Hash] opts the optional parameters
19404
19608
  # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
@@ -19804,7 +20008,7 @@ module Plaid
19804
20008
  end
19805
20009
 
19806
20010
  # Remove Items from a User
19807
- # This endpoint is used to delete Items for a given User. Either a `user_id` or `user_token` must be provided. If any of the Items are not associated with the provided User, an error will be returned, and no Items will be deleted. This is equivalent to calling `/item/remove` on each Item, but this endpoint supports User-based use cases (CRA) where `/item/remove` is not supported. To obtain a list of Items associated with a User, call `/user/items/get`. After an Item is deleted, it will no longer appear in `/user/items/get`. Item deletion via `/user/items/remove` will permanently and irreversibly delete the Item; to re-create the Item, send the User back through the Link flow. This endpoint is not intended to remove all data for a User, as it will only remove items and no other data for the User. In the case of a user deleting their account with your product, call `/user/products/terminate` to stop billing for unneeded services. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
20011
+ # Removes specific Items associated with a user. It is equivalent to calling `/item/remove` on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to `/item/remove`, this deletes Item product data, terminates billing on the Item's products, and fires webhooks to the financial institution. Once removed, Items cannot be reconnected without going through Link again.
19808
20012
  # @param user_items_remove_request [UserItemsRemoveRequest]
19809
20013
  # @param [Hash] opts the optional parameters
19810
20014
  # @return [UserItemsRemoveResponse]
@@ -19814,7 +20018,7 @@ module Plaid
19814
20018
  end
19815
20019
 
19816
20020
  # Remove Items from a User
19817
- # This endpoint is used to delete Items for a given User. Either a &#x60;user_id&#x60; or &#x60;user_token&#x60; must be provided. If any of the Items are not associated with the provided User, an error will be returned, and no Items will be deleted. This is equivalent to calling &#x60;/item/remove&#x60; on each Item, but this endpoint supports User-based use cases (CRA) where &#x60;/item/remove&#x60; is not supported. To obtain a list of Items associated with a User, call &#x60;/user/items/get&#x60;. After an Item is deleted, it will no longer appear in &#x60;/user/items/get&#x60;. Item deletion via &#x60;/user/items/remove&#x60; will permanently and irreversibly delete the Item; to re-create the Item, send the User back through the Link flow. This endpoint is not intended to remove all data for a User, as it will only remove items and no other data for the User. In the case of a user deleting their account with your product, call &#x60;/user/products/terminate&#x60; to stop billing for unneeded services. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
20021
+ # Removes specific Items associated with a user. It is equivalent to calling &#x60;/item/remove&#x60; on each Item individually, but supports use cases (such as Plaid Check) where access tokens are not available. All specified Items must belong to the user or the entire operation fails. Similar to &#x60;/item/remove&#x60;, this deletes Item product data, terminates billing on the Item&#39;s products, and fires webhooks to the financial institution. Once removed, Items cannot be reconnected without going through Link again.
19818
20022
  # @param user_items_remove_request [UserItemsRemoveRequest]
19819
20023
  # @param [Hash] opts the optional parameters
19820
20024
  # @return [Array<(UserItemsRemoveResponse, Integer, Hash)>] UserItemsRemoveResponse data, response status code and response headers
@@ -20215,7 +20419,7 @@ module Plaid
20215
20419
  end
20216
20420
 
20217
20421
  # Update user information
20218
- # This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use `/user/update` to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
20422
+ # This endpoint updates user information for an existing `user_id` or `user_token`. If an existing `user_id` or `user_token` is missing fields required for a given use case (e.g. creating a Consumer Report) use `/user/update` to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
20219
20423
  # @param user_update_request [UserUpdateRequest]
20220
20424
  # @param [Hash] opts the optional parameters
20221
20425
  # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
@@ -20226,7 +20430,7 @@ module Plaid
20226
20430
  end
20227
20431
 
20228
20432
  # Update user information
20229
- # This endpoint updates user information for an existing &#x60;user_id&#x60; or &#x60;user_token&#x60;. If an existing &#x60;user_id&#x60; or &#x60;user_token&#x60; is missing fields required for a given use case (e.g. creating a Consumer Report) use &#x60;/user/update&#x60; to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
20433
+ # This endpoint updates user information for an existing &#x60;user_id&#x60; or &#x60;user_token&#x60;. If an existing &#x60;user_id&#x60; or &#x60;user_token&#x60; is missing fields required for a given use case (e.g. creating a Consumer Report) use &#x60;/user/update&#x60; to add values for those fields. Identity updates use merge semantics: provided fields overwrite existing ones; omitted fields remain unchanged.
20230
20434
  # @param user_update_request [UserUpdateRequest]
20231
20435
  # @param [Hash] opts the optional parameters
20232
20436
  # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)