plaid 46.2.0 → 48.0.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 (2100) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +254 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/README.md +1 -1
  6. data/lib/plaid/api/plaid_api.rb +735 -400
  7. data/lib/plaid/api_client.rb +2 -2
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +8 -1
  10. data/lib/plaid/models/aamva_analysis.rb +1 -1
  11. data/lib/plaid/models/aamva_detailed_match_result.rb +1 -1
  12. data/lib/plaid/models/aamva_match_result.rb +1 -1
  13. data/lib/plaid/models/account_access.rb +2 -2
  14. data/lib/plaid/models/account_assets.rb +4 -4
  15. data/lib/plaid/models/account_balance.rb +4 -4
  16. data/lib/plaid/models/account_base.rb +5 -5
  17. data/lib/plaid/models/account_base_nullable.rb +5 -5
  18. data/lib/plaid/models/account_filter.rb +1 -1
  19. data/lib/plaid/models/account_filters_response.rb +1 -1
  20. data/lib/plaid/models/account_holder_category.rb +1 -1
  21. data/lib/plaid/models/account_identity.rb +4 -8
  22. data/lib/plaid/models/account_identity_all_of.rb +40 -2
  23. data/lib/plaid/models/account_identity_document_upload.rb +5 -5
  24. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  25. data/lib/plaid/models/account_identity_match_score.rb +4 -8
  26. data/lib/plaid/models/account_identity_match_score_all_of.rb +40 -2
  27. data/lib/plaid/models/account_insights.rb +1 -1
  28. data/lib/plaid/models/account_product_access.rb +1 -1
  29. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  30. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  31. data/lib/plaid/models/account_subtype.rb +1 -1
  32. data/lib/plaid/models/account_type.rb +1 -1
  33. data/lib/plaid/models/account_verification_insights.rb +1 -1
  34. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  35. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  36. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  37. data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
  38. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  39. data/lib/plaid/models/accounts_get_request.rb +2 -2
  40. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  41. data/lib/plaid/models/accounts_get_response.rb +1 -1
  42. data/lib/plaid/models/ach_class.rb +1 -1
  43. data/lib/plaid/models/action_state.rb +1 -1
  44. data/lib/plaid/models/activity.rb +2 -2
  45. data/lib/plaid/models/activity_type.rb +1 -1
  46. data/lib/plaid/models/address.rb +1 -1
  47. data/lib/plaid/models/address_data.rb +1 -1
  48. data/lib/plaid/models/address_data_not_required.rb +1 -1
  49. data/lib/plaid/models/address_data_nullable.rb +1 -1
  50. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  51. data/lib/plaid/models/address_match_score.rb +1 -1
  52. data/lib/plaid/models/address_nullable.rb +1 -1
  53. data/lib/plaid/models/address_purpose_label.rb +1 -1
  54. data/lib/plaid/models/affordability_insights.rb +2 -2
  55. data/lib/plaid/models/amount_with_currency.rb +1 -1
  56. data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +1 -1
  57. data/lib/plaid/models/application.rb +8 -8
  58. data/lib/plaid/models/application_get_request.rb +2 -2
  59. data/lib/plaid/models/application_get_response.rb +1 -1
  60. data/lib/plaid/models/apr.rb +1 -1
  61. data/lib/plaid/models/asset.rb +1 -1
  62. data/lib/plaid/models/asset_detail.rb +8 -8
  63. data/lib/plaid/models/asset_holder.rb +1 -1
  64. data/lib/plaid/models/asset_holder_name.rb +1 -1
  65. data/lib/plaid/models/asset_holding.rb +3 -3
  66. data/lib/plaid/models/asset_holdings.rb +1 -1
  67. data/lib/plaid/models/asset_investment_transaction_type.rb +1 -1
  68. data/lib/plaid/models/asset_owner.rb +1 -1
  69. data/lib/plaid/models/asset_owners.rb +2 -2
  70. data/lib/plaid/models/asset_report.rb +1 -1
  71. data/lib/plaid/models/asset_report_account_balance.rb +3 -3
  72. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  73. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
  74. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  75. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  79. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  80. data/lib/plaid/models/asset_report_create_request_options.rb +3 -3
  81. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  82. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  83. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  84. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  85. data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
  86. data/lib/plaid/models/asset_report_freddie_get_response.rb +2 -2
  87. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  89. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  90. data/lib/plaid/models/asset_report_investment_holding.rb +2 -2
  91. data/lib/plaid/models/asset_report_investment_security.rb +2 -2
  92. data/lib/plaid/models/asset_report_investment_transaction.rb +4 -4
  93. data/lib/plaid/models/asset_report_investments.rb +1 -1
  94. data/lib/plaid/models/asset_report_item.rb +2 -2
  95. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  96. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  97. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  98. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  99. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  100. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  101. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  102. data/lib/plaid/models/asset_report_transaction.rb +2 -2
  103. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  104. data/lib/plaid/models/asset_report_type.rb +1 -1
  105. data/lib/plaid/models/asset_report_user.rb +2 -2
  106. data/lib/plaid/models/asset_transaction.rb +2 -2
  107. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  108. data/lib/plaid/models/asset_transaction_description.rb +2 -2
  109. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  110. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  111. data/lib/plaid/models/asset_transactions.rb +1 -1
  112. data/lib/plaid/models/asset_type.rb +1 -1
  113. data/lib/plaid/models/assets.rb +1 -1
  114. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  115. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  116. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  117. data/lib/plaid/models/auth_get_numbers.rb +3 -3
  118. data/lib/plaid/models/auth_get_request.rb +2 -2
  119. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  120. data/lib/plaid/models/auth_get_response.rb +1 -1
  121. data/lib/plaid/models/auth_metadata.rb +1 -1
  122. data/lib/plaid/models/auth_supported_methods.rb +3 -3
  123. data/lib/plaid/models/auth_update_types.rb +1 -1
  124. data/lib/plaid/models/auth_verify_numbers_ach.rb +1 -1
  125. data/lib/plaid/models/auth_verify_request.rb +1 -1
  126. data/lib/plaid/models/auth_verify_request_numbers.rb +1 -1
  127. data/lib/plaid/models/auth_verify_response.rb +2 -2
  128. data/lib/plaid/models/authorization_guarantee_details.rb +264 -0
  129. data/lib/plaid/models/authorization_guarantee_schedule_item.rb +241 -0
  130. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  131. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  132. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  133. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  134. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +2 -2
  135. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +2 -2
  136. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  137. data/lib/plaid/models/bank_penalties_indicators.rb +1 -1
  138. data/lib/plaid/models/bank_transfer.rb +3 -3
  139. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  143. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_create_request.rb +3 -3
  145. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_event.rb +18 -8
  148. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
  151. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  156. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  157. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  158. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  159. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  160. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  161. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  162. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  163. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  164. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  165. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  166. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  167. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  168. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  169. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  170. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  171. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  172. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +2 -2
  173. data/lib/plaid/models/base_report.rb +2 -2
  174. data/lib/plaid/models/base_report_account.rb +2 -2
  175. data/lib/plaid/models/base_report_account_balances.rb +3 -3
  176. data/lib/plaid/models/base_report_account_insights.rb +2 -2
  177. data/lib/plaid/models/base_report_account_metadata.rb +1 -1
  178. data/lib/plaid/models/base_report_attributes.rb +1 -1
  179. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  180. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  181. data/lib/plaid/models/base_report_historical_balance.rb +1 -1
  182. data/lib/plaid/models/base_report_investment_holding.rb +2 -2
  183. data/lib/plaid/models/base_report_investment_security.rb +2 -2
  184. data/lib/plaid/models/base_report_investment_transaction.rb +4 -4
  185. data/lib/plaid/models/base_report_investments.rb +1 -1
  186. data/lib/plaid/models/base_report_item.rb +2 -2
  187. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  188. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  189. data/lib/plaid/models/base_report_transaction.rb +2 -2
  190. data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +2 -2
  191. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  192. data/lib/plaid/models/base_report_user_attributes.rb +1 -1
  193. data/lib/plaid/models/base_report_warning.rb +1 -1
  194. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  195. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  196. data/lib/plaid/models/beacon_account_risk_attributes.rb +3 -3
  197. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  198. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +2 -2
  199. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  200. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +4 -4
  201. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  202. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  203. data/lib/plaid/models/beacon_audit_trail.rb +2 -2
  204. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  205. data/lib/plaid/models/beacon_bank_account_insights.rb +2 -2
  206. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  207. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  208. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  209. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  210. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  211. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  212. data/lib/plaid/models/beacon_report.rb +1 -1
  213. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  214. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  215. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  216. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  217. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  218. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  219. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  220. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  221. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  222. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  223. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  224. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  225. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  226. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  227. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  228. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  229. data/lib/plaid/models/beacon_report_type.rb +1 -1
  230. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  231. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +2 -2
  232. data/lib/plaid/models/beacon_user.rb +1 -1
  233. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +2 -2
  234. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +2 -2
  235. data/lib/plaid/models/beacon_user_address.rb +1 -1
  236. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  237. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  238. data/lib/plaid/models/beacon_user_data.rb +2 -2
  239. data/lib/plaid/models/beacon_user_depository_account.rb +2 -2
  240. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  241. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  242. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  243. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  244. data/lib/plaid/models/beacon_user_id_number.rb +2 -2
  245. data/lib/plaid/models/beacon_user_name.rb +1 -1
  246. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  247. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  248. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  249. data/lib/plaid/models/beacon_user_request_data.rb +2 -2
  250. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  251. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  252. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  253. data/lib/plaid/models/beacon_user_status.rb +1 -1
  254. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  255. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  256. data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
  257. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  258. data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +2 -2
  259. data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +2 -2
  260. data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +2 -2
  261. data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +1 -1
  262. data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +1 -1
  263. data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +1 -1
  264. data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +1 -1
  265. data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +1 -1
  266. data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +1 -1
  267. data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +1 -1
  268. data/lib/plaid/models/beta_partner_end_customer.rb +1 -1
  269. data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +1 -1
  270. data/lib/plaid/models/business_account.rb +4 -8
  271. data/lib/plaid/models/business_account_all_of.rb +40 -2
  272. data/lib/plaid/models/business_check_boolean_status.rb +1 -1
  273. data/lib/plaid/models/business_digital_presence_check.rb +1 -1
  274. data/lib/plaid/models/business_email_address.rb +1 -1
  275. data/lib/plaid/models/business_entity_type.rb +1 -1
  276. data/lib/plaid/models/business_field_match_summary.rb +1 -1
  277. data/lib/plaid/models/business_finance_category.rb +2 -2
  278. data/lib/plaid/models/business_industry_prediction.rb +1 -1
  279. data/lib/plaid/models/business_industry_prediction_nullable.rb +1 -1
  280. data/lib/plaid/models/business_kyb_check.rb +1 -1
  281. data/lib/plaid/models/business_kyb_match_details.rb +1 -1
  282. data/lib/plaid/models/business_phone_number.rb +1 -1
  283. data/lib/plaid/models/business_risk_check.rb +1 -1
  284. data/lib/plaid/models/business_search_terms.rb +1 -1
  285. data/lib/plaid/models/business_verification_create_request.rb +1 -1
  286. data/lib/plaid/models/business_verification_create_request_business.rb +1 -1
  287. data/lib/plaid/models/business_verification_create_response.rb +1 -1
  288. data/lib/plaid/models/business_verification_get_request.rb +1 -1
  289. data/lib/plaid/models/business_verification_get_response.rb +1 -1
  290. data/lib/plaid/models/business_verification_status_kyb_check.rb +1 -1
  291. data/lib/plaid/models/business_verification_status_overall.rb +1 -1
  292. data/lib/plaid/models/business_verification_status_risk_check.rb +1 -1
  293. data/lib/plaid/models/business_verification_status_web_presence_check.rb +1 -1
  294. data/lib/plaid/models/business_website.rb +1 -1
  295. data/lib/plaid/models/business_website_analysis.rb +1 -1
  296. data/lib/plaid/models/business_website_build_status.rb +1 -1
  297. data/lib/plaid/models/business_website_ssl.rb +1 -1
  298. data/lib/plaid/models/business_whois_record.rb +1 -1
  299. data/lib/plaid/models/cash_flow_insight.rb +1 -1
  300. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +1 -1
  301. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +2 -2
  302. data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +2 -2
  303. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +1 -1
  304. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +2 -2
  305. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +2 -2
  306. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +2 -2
  307. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +2 -2
  308. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +2 -2
  309. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  310. data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
  311. data/lib/plaid/models/cashflow_report_get_request.rb +2 -2
  312. data/lib/plaid/models/cashflow_report_get_request_options.rb +1 -1
  313. data/lib/plaid/models/cashflow_report_get_response.rb +2 -2
  314. data/lib/plaid/models/cashflow_report_historical_balance.rb +1 -1
  315. data/lib/plaid/models/cashflow_report_insights_get_request.rb +2 -2
  316. data/lib/plaid/models/cashflow_report_insights_get_response.rb +2 -2
  317. data/lib/plaid/models/cashflow_report_monthly_summary.rb +1 -1
  318. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +1 -1
  319. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +1 -1
  320. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +1 -1
  321. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +1 -1
  322. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +1 -1
  323. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +1 -1
  324. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +1 -1
  325. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +1 -1
  326. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +1 -1
  327. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +1 -1
  328. data/lib/plaid/models/cashflow_report_payment_meta.rb +1 -1
  329. data/lib/plaid/models/cashflow_report_refresh_request.rb +2 -2
  330. data/lib/plaid/models/cashflow_report_refresh_response.rb +2 -2
  331. data/lib/plaid/models/cashflow_report_transaction.rb +6 -6
  332. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +2 -2
  333. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +1 -1
  334. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +2 -2
  335. data/lib/plaid/models/categories_get_response.rb +1 -1
  336. data/lib/plaid/models/category.rb +1 -1
  337. data/lib/plaid/models/category_expenses.rb +1 -1
  338. data/lib/plaid/models/category_insight_details.rb +1 -1
  339. data/lib/plaid/models/category_insights.rb +1 -1
  340. data/lib/plaid/models/cause.rb +2 -2
  341. data/lib/plaid/models/cause_all_of.rb +1 -1
  342. data/lib/plaid/models/check_report_repairable_item.rb +303 -0
  343. data/lib/plaid/models/check_report_warning.rb +2 -2
  344. data/lib/plaid/models/check_report_warning_code.rb +1 -1
  345. data/lib/plaid/models/client_customization.rb +1 -1
  346. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  347. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  348. data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
  349. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  350. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  351. data/lib/plaid/models/client_user_identity.rb +1 -1
  352. data/lib/plaid/models/client_user_identity_address.rb +1 -1
  353. data/lib/plaid/models/client_user_identity_email.rb +1 -1
  354. data/lib/plaid/models/client_user_identity_name.rb +1 -1
  355. data/lib/plaid/models/client_user_identity_phone_number.rb +1 -1
  356. data/lib/plaid/models/connected_application.rb +3 -3
  357. data/lib/plaid/models/consent_event.rb +3 -3
  358. data/lib/plaid/models/consent_event_code.rb +1 -1
  359. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  360. data/lib/plaid/models/consent_event_type.rb +1 -1
  361. data/lib/plaid/models/consent_events_get_request.rb +2 -2
  362. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  363. data/lib/plaid/models/consented_account.rb +2 -2
  364. data/lib/plaid/models/consumer_dispute.rb +1 -1
  365. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  366. data/lib/plaid/models/consumer_report_pdf_get_request.rb +2 -2
  367. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  368. data/lib/plaid/models/consumer_report_user_identity.rb +4 -4
  369. data/lib/plaid/models/counterparty.rb +4 -4
  370. data/lib/plaid/models/counterparty_insights.rb +3 -3
  371. data/lib/plaid/models/counterparty_numbers.rb +1 -1
  372. data/lib/plaid/models/counterparty_numbers_bacs.rb +4 -4
  373. data/lib/plaid/models/counterparty_numbers_international.rb +2 -2
  374. data/lib/plaid/models/counterparty_type.rb +1 -1
  375. data/lib/plaid/models/country_code.rb +1 -1
  376. data/lib/plaid/models/cra_annual_income_values.rb +1 -1
  377. data/lib/plaid/models/cra_bank_income_account.rb +2 -2
  378. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  379. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  380. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  381. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  382. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +2 -2
  383. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  384. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  385. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  386. data/lib/plaid/models/cra_bank_income_income_provider.rb +1 -1
  387. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  388. data/lib/plaid/models/cra_bank_income_source.rb +4 -4
  389. data/lib/plaid/models/cra_bank_income_status.rb +1 -1
  390. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  391. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  392. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  393. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  394. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  395. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +29 -10
  396. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  397. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +2 -2
  398. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +3 -3
  399. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
  400. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +1 -1
  401. data/lib/plaid/models/cra_check_report_create_cashflow_insights_options.rb +243 -0
  402. data/lib/plaid/models/cra_check_report_create_employment_refresh_options.rb +247 -0
  403. data/lib/plaid/models/{network_insights_report_get_request.rb → cra_check_report_create_income_insights_options.rb} +42 -37
  404. data/lib/plaid/models/cra_check_report_create_lend_score_options.rb +243 -0
  405. data/lib/plaid/models/{link_session_protect_result.rb → cra_check_report_create_network_insights_options.rb} +34 -40
  406. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +1 -1
  407. data/lib/plaid/models/cra_check_report_create_request.rb +8 -8
  408. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  409. data/lib/plaid/models/cra_check_report_failed_webhook.rb +36 -2
  410. data/lib/plaid/models/cra_check_report_failed_webhook_error.rb +384 -0
  411. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
  412. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
  413. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
  414. data/lib/plaid/models/cra_check_report_gse_options.rb +1 -1
  415. data/lib/plaid/models/cra_check_report_home_lending_report_options.rb +2 -2
  416. data/lib/plaid/models/cra_check_report_income_insights_get_options.rb +2 -2
  417. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +27 -8
  418. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  419. data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +2 -2
  420. data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +3 -3
  421. data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +1 -1
  422. data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +2 -2
  423. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +3 -3
  424. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +2 -2
  425. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  426. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +2 -2
  427. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +4 -4
  428. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +2 -2
  429. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +3 -3
  430. data/lib/plaid/models/cra_check_report_permissible_purpose.rb +39 -0
  431. data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
  432. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +2 -2
  433. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +2 -1
  434. data/lib/plaid/models/cra_check_report_verification_get_request.rb +3 -3
  435. data/lib/plaid/models/cra_check_report_verification_get_response.rb +1 -1
  436. data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +40 -28
  437. data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +2 -1
  438. data/lib/plaid/models/cra_credit_profile_inquiry_type.rb +1 -1
  439. data/lib/plaid/models/cra_credit_profile_lend_score.rb +2 -2
  440. data/lib/plaid/models/cra_credit_profile_report.rb +1 -1
  441. data/lib/plaid/models/cra_credit_profile_report_get_request.rb +2 -2
  442. data/lib/plaid/models/cra_credit_profile_report_get_response.rb +12 -2
  443. data/lib/plaid/models/cra_credit_profile_report_metadata.rb +1 -1
  444. data/lib/plaid/models/cra_credit_profile_report_type.rb +1 -1
  445. data/lib/plaid/models/cra_credit_profile_report_version.rb +1 -1
  446. data/lib/plaid/models/cra_current_modeled_income.rb +1 -1
  447. data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
  448. data/lib/plaid/models/cra_employment_refresh_report_account.rb +2 -2
  449. data/lib/plaid/models/cra_employment_refresh_report_item.rb +2 -2
  450. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
  451. data/lib/plaid/models/cra_income_category.rb +1 -1
  452. data/lib/plaid/models/cra_income_insights.rb +6 -1
  453. data/lib/plaid/models/cra_income_insights_user_summary.rb +1 -1
  454. data/lib/plaid/models/cra_income_metrics.rb +1 -1
  455. data/lib/plaid/models/cra_income_next_payment.rb +1 -1
  456. data/lib/plaid/models/cra_income_stream.rb +1 -1
  457. data/lib/plaid/models/cra_income_stream_insights.rb +1 -1
  458. data/lib/plaid/models/cra_income_transaction.rb +1 -1
  459. data/lib/plaid/models/cra_income_transaction_outlier.rb +1 -1
  460. data/lib/plaid/models/cra_lend_score_report.rb +1 -1
  461. data/lib/plaid/models/cra_loan_application.rb +1 -1
  462. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  463. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  464. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  465. data/lib/plaid/models/cra_loan_payment_history.rb +2 -2
  466. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  467. data/lib/plaid/models/cra_loan_register.rb +1 -1
  468. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  469. data/lib/plaid/models/cra_loan_status.rb +1 -1
  470. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  471. data/lib/plaid/models/cra_loan_type.rb +1 -1
  472. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  473. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  474. data/lib/plaid/models/cra_loan_update.rb +1 -1
  475. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  476. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  477. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  478. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  479. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  480. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  481. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  482. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +3 -3
  483. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +2 -2
  484. data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
  485. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +4 -4
  486. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +2 -2
  487. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  488. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +2 -2
  489. data/lib/plaid/models/cra_monthly_income_values.rb +1 -1
  490. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  491. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  492. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  493. data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +29 -8
  494. data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +1 -1
  495. data/lib/plaid/models/cra_partner_insights_bureau.rb +1 -1
  496. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  497. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  498. data/lib/plaid/models/cra_partner_insights_fico_input.rb +5 -5
  499. data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +2 -2
  500. data/lib/plaid/models/cra_partner_insights_fico_results.rb +3 -3
  501. data/lib/plaid/models/cra_partner_insights_get_request.rb +2 -2
  502. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  503. data/lib/plaid/models/cra_partner_insights_item.rb +3 -3
  504. data/lib/plaid/models/cra_partner_insights_item_account.rb +2 -2
  505. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  506. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  507. data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +54 -12
  508. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +4 -4
  509. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +19 -8
  510. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +1 -1
  511. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  512. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  513. data/lib/plaid/models/cra_projected_modeled_income.rb +1 -1
  514. data/lib/plaid/models/cra_report_decision_stage.rb +40 -0
  515. data/lib/plaid/models/cra_report_get_report.rb +307 -0
  516. data/lib/plaid/models/{item_handle_fraud_report_request.rb → cra_report_get_request.rb} +59 -96
  517. data/lib/plaid/models/cra_report_get_request_product.rb +240 -0
  518. data/lib/plaid/models/cra_report_get_response.rb +272 -0
  519. data/lib/plaid/models/cra_report_get_response_product.rb +283 -0
  520. data/lib/plaid/models/cra_report_scope.rb +39 -0
  521. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  522. data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +38 -4
  523. data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +3 -3
  524. data/lib/plaid/models/cra_user_tier.rb +1 -1
  525. data/lib/plaid/models/cra_verification_income_account.rb +323 -0
  526. data/lib/plaid/models/cra_verification_income_category.rb +241 -0
  527. data/lib/plaid/models/cra_verification_income_item.rb +288 -0
  528. data/lib/plaid/models/cra_verification_income_metrics.rb +243 -0
  529. data/lib/plaid/models/cra_verification_income_next_payment.rb +226 -0
  530. data/lib/plaid/models/cra_verification_income_pay_frequency.rb +43 -0
  531. data/lib/plaid/models/cra_verification_income_provider.rb +241 -0
  532. data/lib/plaid/models/{network_insights_report.rb → cra_verification_income_report.rb} +46 -34
  533. data/lib/plaid/models/cra_verification_income_status.rb +40 -0
  534. data/lib/plaid/models/cra_verification_income_stream.rb +316 -0
  535. data/lib/plaid/models/cra_verification_income_stream_insights.rb +295 -0
  536. data/lib/plaid/models/cra_verification_income_transaction.rb +337 -0
  537. data/lib/plaid/models/cra_verification_income_transaction_outlier.rb +237 -0
  538. data/lib/plaid/models/cra_verification_income_user_summary.rb +228 -0
  539. data/lib/plaid/models/cra_verification_income_values.rb +241 -0
  540. data/lib/plaid/models/cra_verification_modeled_income.rb +239 -0
  541. data/lib/plaid/models/cra_verification_report.rb +16 -6
  542. data/lib/plaid/models/cra_voa_report.rb +1 -1
  543. data/lib/plaid/models/cra_voa_report_account.rb +2 -2
  544. data/lib/plaid/models/cra_voa_report_account_balances.rb +3 -3
  545. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
  546. data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
  547. data/lib/plaid/models/cra_voa_report_item.rb +2 -2
  548. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +1 -1
  549. data/lib/plaid/models/credit1099.rb +1 -1
  550. data/lib/plaid/models/credit1099_filer.rb +1 -1
  551. data/lib/plaid/models/credit1099_payer.rb +1 -1
  552. data/lib/plaid/models/credit1099_recipient.rb +3 -3
  553. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  554. data/lib/plaid/models/credit_ach_class.rb +1 -1
  555. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  556. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  557. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +2 -2
  558. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  559. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  560. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  561. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  562. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  563. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  564. data/lib/plaid/models/credit_bank_employment_get_request.rb +2 -2
  565. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  566. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  567. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  568. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  569. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  570. data/lib/plaid/models/credit_bank_income.rb +1 -1
  571. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  572. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  573. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  574. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  575. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  576. data/lib/plaid/models/credit_bank_income_get_request.rb +2 -2
  577. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  578. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  579. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  580. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  581. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  582. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +2 -2
  583. data/lib/plaid/models/credit_bank_income_refresh_request.rb +2 -2
  584. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  585. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  586. data/lib/plaid/models/credit_bank_income_source.rb +3 -3
  587. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  588. data/lib/plaid/models/credit_bank_income_transaction.rb +2 -2
  589. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  590. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  591. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  592. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +2 -2
  593. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  594. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  595. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  596. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  597. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  598. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  599. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  600. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  601. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +2 -2
  602. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +2 -2
  603. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  604. data/lib/plaid/models/credit_card_liability.rb +1 -1
  605. data/lib/plaid/models/credit_category.rb +1 -1
  606. data/lib/plaid/models/credit_document_metadata.rb +3 -3
  607. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  608. data/lib/plaid/models/credit_employment_get_request.rb +2 -2
  609. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  610. data/lib/plaid/models/credit_employment_item.rb +1 -1
  611. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  612. data/lib/plaid/models/credit_filter.rb +1 -1
  613. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  614. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  615. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  616. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  617. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  618. data/lib/plaid/models/credit_freddie_mac_loan.rb +2 -2
  619. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  620. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  621. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  622. data/lib/plaid/models/credit_freddie_mac_party.rb +2 -2
  623. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  624. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +3 -3
  625. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +2 -2
  626. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  627. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  628. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  629. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  630. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  631. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  632. data/lib/plaid/models/credit_i20.rb +339 -0
  633. data/lib/plaid/models/credit_i20_student.rb +288 -0
  634. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  635. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  636. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  637. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  638. data/lib/plaid/models/credit_pay_stub_employee.rb +2 -2
  639. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  640. data/lib/plaid/models/credit_pay_stub_net_pay.rb +2 -2
  641. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  642. data/lib/plaid/models/credit_payroll_income_get_request.rb +2 -2
  643. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +2 -2
  644. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  645. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +3 -3
  646. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +2 -2
  647. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +2 -2
  648. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  649. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +2 -2
  650. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  651. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  652. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
  653. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -2
  654. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  655. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  656. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  657. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  658. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  659. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  660. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  661. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  662. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  663. data/lib/plaid/models/credit_session.rb +1 -1
  664. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  665. data/lib/plaid/models/credit_session_bank_employment_status.rb +3 -1
  666. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  667. data/lib/plaid/models/credit_session_bank_income_status.rb +3 -1
  668. data/lib/plaid/models/credit_session_document_income_result.rb +20 -5
  669. data/lib/plaid/models/credit_session_error.rb +1 -1
  670. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  671. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  672. data/lib/plaid/models/credit_session_results.rb +1 -1
  673. data/lib/plaid/models/credit_sessions_get_request.rb +2 -2
  674. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  675. data/lib/plaid/models/credit_w2.rb +5 -5
  676. data/lib/plaid/models/custom_sandbox_transaction.rb +1 -1
  677. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  678. data/lib/plaid/models/dashboard_user.rb +2 -2
  679. data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
  680. data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
  681. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  682. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  683. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  684. data/lib/plaid/models/data_sources.rb +1 -1
  685. data/lib/plaid/models/date_range.rb +1 -1
  686. data/lib/plaid/models/deductions.rb +1 -1
  687. data/lib/plaid/models/deductions_breakdown.rb +2 -2
  688. data/lib/plaid/models/deductions_total.rb +2 -2
  689. data/lib/plaid/models/default_update_webhook.rb +1 -1
  690. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  691. data/lib/plaid/models/depository_filter.rb +2 -2
  692. data/lib/plaid/models/detailed_originator.rb +2 -2
  693. data/lib/plaid/models/detected_account.rb +1 -1
  694. data/lib/plaid/models/device_id.rb +2 -2
  695. data/lib/plaid/models/distribution_breakdown.rb +2 -2
  696. data/lib/plaid/models/doc_type.rb +2 -1
  697. data/lib/plaid/models/document_analysis.rb +1 -1
  698. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  699. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  700. data/lib/plaid/models/document_metadata.rb +1 -1
  701. data/lib/plaid/models/document_name_match_code.rb +1 -1
  702. data/lib/plaid/models/document_risk_signal.rb +1 -1
  703. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  704. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  705. data/lib/plaid/models/document_risk_summary.rb +1 -1
  706. data/lib/plaid/models/document_status.rb +1 -1
  707. data/lib/plaid/models/documentary_verification.rb +1 -1
  708. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  709. data/lib/plaid/models/earnings.rb +1 -1
  710. data/lib/plaid/models/earnings_breakdown.rb +3 -3
  711. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  712. data/lib/plaid/models/earnings_total.rb +2 -2
  713. data/lib/plaid/models/email.rb +1 -1
  714. data/lib/plaid/models/email_address_match_score.rb +1 -1
  715. data/lib/plaid/models/employee.rb +1 -1
  716. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  717. data/lib/plaid/models/employer.rb +1 -1
  718. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  719. data/lib/plaid/models/employer_verification.rb +1 -1
  720. data/lib/plaid/models/employers_search_request.rb +1 -1
  721. data/lib/plaid/models/employers_search_response.rb +1 -1
  722. data/lib/plaid/models/employment_details.rb +1 -1
  723. data/lib/plaid/models/employment_source_type.rb +1 -1
  724. data/lib/plaid/models/employment_verification.rb +1 -1
  725. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  726. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  727. data/lib/plaid/models/employment_verification_status.rb +1 -1
  728. data/lib/plaid/models/enhancements.rb +3 -3
  729. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  730. data/lib/plaid/models/enrichments.rb +4 -4
  731. data/lib/plaid/models/entity_document.rb +1 -1
  732. data/lib/plaid/models/entity_document_type.rb +1 -1
  733. data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
  734. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  735. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  736. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  737. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  738. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  739. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  740. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  741. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  742. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  743. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  744. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  745. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  746. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  747. data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
  748. data/lib/plaid/models/entity_watchlist_screening_hit.rb +19 -2
  749. data/lib/plaid/models/entity_watchlist_screening_review.rb +2 -2
  750. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  751. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  752. data/lib/plaid/models/ewa_score.rb +1 -1
  753. data/lib/plaid/models/expenditure_insights.rb +1 -1
  754. data/lib/plaid/models/expenditure_insights_cash_flow.rb +1 -1
  755. data/lib/plaid/models/expenditure_summary.rb +2 -2
  756. data/lib/plaid/models/expiration_date.rb +1 -1
  757. data/lib/plaid/models/extended_recipient_metadata.rb +2 -2
  758. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +2 -2
  759. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  760. data/lib/plaid/models/external_payment_options.rb +1 -1
  761. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  762. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  763. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  764. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  765. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  766. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  767. data/lib/plaid/models/fdx_consent_grant.rb +331 -0
  768. data/lib/plaid/models/fdx_consent_grant_resource.rb +279 -0
  769. data/lib/plaid/models/fdx_consent_grant_status.rb +40 -0
  770. data/lib/plaid/models/fdx_consent_resource_type.rb +40 -0
  771. data/lib/plaid/models/fdx_consent_revocation.rb +281 -0
  772. data/lib/plaid/models/fdx_consent_revocation_record.rb +290 -0
  773. data/lib/plaid/models/fdx_consent_revocations.rb +228 -0
  774. data/lib/plaid/models/fdx_content_types.rb +1 -1
  775. data/lib/plaid/models/fdx_data_cluster.rb +53 -0
  776. data/lib/plaid/models/fdx_event_status.rb +1 -1
  777. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  778. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  779. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +2 -24
  780. data/lib/plaid/models/fdx_lifecycle_event.rb +2 -2
  781. data/lib/plaid/models/fdx_notification.rb +3 -3
  782. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  783. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  784. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  785. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  786. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  787. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  788. data/lib/plaid/models/fdx_party.rb +1 -1
  789. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  790. data/lib/plaid/models/fdx_party_type.rb +1 -1
  791. data/lib/plaid/models/fdx_recipient_metadata.rb +2 -2
  792. data/lib/plaid/models/fdx_update_reason.rb +1 -1
  793. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  794. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  795. data/lib/plaid/models/fixed_income.rb +1 -1
  796. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  797. data/lib/plaid/models/form1099_type.rb +1 -1
  798. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  799. data/lib/plaid/models/fraud_amount.rb +1 -1
  800. data/lib/plaid/models/fraud_analysis_details.rb +8 -23
  801. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  802. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  803. data/lib/plaid/models/gambling_indicators.rb +1 -1
  804. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  805. data/lib/plaid/models/{network_insights_item.rb → get_consents_response.rb} +18 -46
  806. data/lib/plaid/models/get_recipient_response.rb +1 -1
  807. data/lib/plaid/models/get_recipients_response.rb +1 -1
  808. data/lib/plaid/models/gse_report_type.rb +1 -1
  809. data/lib/plaid/models/health_incident.rb +1 -1
  810. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  811. data/lib/plaid/models/historical_annual_income.rb +1 -1
  812. data/lib/plaid/models/historical_balance.rb +1 -1
  813. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  814. data/lib/plaid/models/holding.rb +19 -7
  815. data/lib/plaid/models/holding_tax_lot.rb +309 -0
  816. data/lib/plaid/models/{item_products_terminate_reason_code.rb → holding_tax_lot_position_type.rb} +4 -3
  817. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  818. data/lib/plaid/models/holdings_override.rb +1 -1
  819. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  820. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +3 -3
  821. data/lib/plaid/models/human_review.rb +1 -1
  822. data/lib/plaid/models/human_review_status.rb +1 -1
  823. data/lib/plaid/models/id_number_type.rb +2 -1
  824. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  825. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  826. data/lib/plaid/models/identity_document_upload.rb +1 -1
  827. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  828. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  829. data/lib/plaid/models/identity_document_upload_risk_signal.rb +2 -2
  830. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  831. data/lib/plaid/models/identity_documents_uploads_get_request.rb +2 -2
  832. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  833. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  834. data/lib/plaid/models/identity_get_request.rb +2 -2
  835. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  836. data/lib/plaid/models/identity_get_response.rb +1 -1
  837. data/lib/plaid/models/identity_match_request.rb +2 -2
  838. data/lib/plaid/models/identity_match_request_options.rb +2 -2
  839. data/lib/plaid/models/identity_match_response.rb +1 -1
  840. data/lib/plaid/models/identity_match_user.rb +1 -1
  841. data/lib/plaid/models/identity_refresh_request.rb +2 -2
  842. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  843. data/lib/plaid/models/identity_update_types.rb +1 -1
  844. data/lib/plaid/models/identity_verification.rb +4 -4
  845. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  846. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  847. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  848. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  849. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  850. data/lib/plaid/models/identity_verification_create_request.rb +3 -3
  851. data/lib/plaid/models/identity_verification_create_request_user.rb +18 -7
  852. data/lib/plaid/models/identity_verification_create_response.rb +4 -4
  853. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  854. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  855. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  856. data/lib/plaid/models/identity_verification_get_response.rb +4 -4
  857. data/lib/plaid/models/identity_verification_list_request.rb +2 -2
  858. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  859. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  860. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  861. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  862. data/lib/plaid/models/identity_verification_retried_webhook.rb +2 -2
  863. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  864. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  865. data/lib/plaid/models/identity_verification_retry_response.rb +4 -4
  866. data/lib/plaid/models/identity_verification_status.rb +1 -1
  867. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  868. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  869. data/lib/plaid/models/identity_verification_step_summary.rb +2 -2
  870. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  871. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  872. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  873. data/lib/plaid/models/identity_verification_user_data.rb +2 -2
  874. data/lib/plaid/models/idv_protect_event.rb +2 -2
  875. data/lib/plaid/models/image_quality.rb +1 -1
  876. data/lib/plaid/models/image_quality_details.rb +4 -23
  877. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  878. data/lib/plaid/models/incident_update.rb +1 -1
  879. data/lib/plaid/models/income_breakdown.rb +1 -1
  880. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  881. data/lib/plaid/models/income_insights.rb +1 -1
  882. data/lib/plaid/models/income_insights_filter.rb +1 -1
  883. data/lib/plaid/models/income_insights_income_excluding_transfers.rb +1 -1
  884. data/lib/plaid/models/income_insights_total_income.rb +1 -1
  885. data/lib/plaid/models/income_insights_transfers_in.rb +1 -1
  886. data/lib/plaid/models/income_insights_version.rb +1 -1
  887. data/lib/plaid/models/income_override.rb +1 -1
  888. data/lib/plaid/models/income_sources_counts.rb +1 -1
  889. data/lib/plaid/models/income_summary.rb +1 -1
  890. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  891. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  892. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  893. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  894. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  895. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  896. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  897. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  898. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  899. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  900. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  901. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  902. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  903. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  904. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  905. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  906. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  907. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  908. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  909. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  910. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +6 -1
  911. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  912. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  913. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  914. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  915. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  916. data/lib/plaid/models/individual_name.rb +2 -2
  917. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  918. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  919. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  920. data/lib/plaid/models/inflow_model.rb +4 -4
  921. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  922. data/lib/plaid/models/institution.rb +1 -1
  923. data/lib/plaid/models/institution_status.rb +1 -1
  924. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  925. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  926. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  927. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  928. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  929. data/lib/plaid/models/institutions_get_request.rb +1 -1
  930. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  931. data/lib/plaid/models/institutions_get_response.rb +1 -1
  932. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  933. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  934. data/lib/plaid/models/institutions_search_request.rb +1 -1
  935. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  936. data/lib/plaid/models/institutions_search_response.rb +1 -1
  937. data/lib/plaid/models/investment_account.rb +4 -8
  938. data/lib/plaid/models/investment_account_all_of.rb +40 -2
  939. data/lib/plaid/models/investment_account_balance.rb +3 -3
  940. data/lib/plaid/models/investment_account_balance_all_of.rb +1 -1
  941. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  942. data/lib/plaid/models/investment_filter.rb +1 -1
  943. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  944. data/lib/plaid/models/investment_transaction.rb +4 -4
  945. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  946. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  947. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  948. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  949. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  950. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  951. data/lib/plaid/models/investments_auth_get_numbers.rb +2 -2
  952. data/lib/plaid/models/investments_auth_get_request.rb +2 -2
  953. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  954. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  955. data/lib/plaid/models/investments_auth_owner.rb +2 -2
  956. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  957. data/lib/plaid/models/investments_historical_update_webhook.rb +3 -3
  958. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  959. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  960. data/lib/plaid/models/investments_refresh_request.rb +2 -2
  961. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  962. data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
  963. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  964. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  965. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  966. data/lib/plaid/models/iso_currency_code.rb +1 -1
  967. data/lib/plaid/models/issue.rb +2 -2
  968. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  969. data/lib/plaid/models/issues_get_request.rb +1 -1
  970. data/lib/plaid/models/issues_get_response.rb +1 -1
  971. data/lib/plaid/models/issues_search_request.rb +1 -1
  972. data/lib/plaid/models/issues_search_response.rb +1 -1
  973. data/lib/plaid/models/issues_status.rb +1 -1
  974. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  975. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  976. data/lib/plaid/models/issuing_country.rb +1 -1
  977. data/lib/plaid/models/item.rb +3 -3
  978. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  979. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  980. data/lib/plaid/models/item_activity_list_request.rb +2 -2
  981. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  982. data/lib/plaid/models/item_add_result_webhook.rb +3 -3
  983. data/lib/plaid/models/item_application_list_request.rb +2 -2
  984. data/lib/plaid/models/item_application_list_response.rb +1 -1
  985. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  986. data/lib/plaid/models/item_application_scopes_update_request.rb +3 -3
  987. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  988. data/lib/plaid/models/item_application_unlink_request.rb +4 -4
  989. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  990. data/lib/plaid/models/item_auth_method.rb +1 -1
  991. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  992. data/lib/plaid/models/item_create_authentication.rb +1 -1
  993. data/lib/plaid/models/item_error_webhook.rb +2 -2
  994. data/lib/plaid/models/item_get_request.rb +2 -2
  995. data/lib/plaid/models/item_get_response.rb +1 -1
  996. data/lib/plaid/models/item_import_request.rb +1 -1
  997. data/lib/plaid/models/item_import_request_options.rb +1 -1
  998. data/lib/plaid/models/item_import_request_user_auth.rb +3 -3
  999. data/lib/plaid/models/item_import_response.rb +2 -2
  1000. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  1001. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  1002. data/lib/plaid/models/item_products_terminate_request.rb +3 -3
  1003. data/lib/plaid/models/item_products_terminate_response.rb +1 -1
  1004. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  1005. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  1006. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  1007. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  1008. data/lib/plaid/models/item_remove_reason_code.rb +1 -1
  1009. data/lib/plaid/models/item_remove_request.rb +3 -3
  1010. data/lib/plaid/models/item_remove_response.rb +1 -1
  1011. data/lib/plaid/models/item_status.rb +1 -1
  1012. data/lib/plaid/models/item_status_investments.rb +1 -1
  1013. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  1014. data/lib/plaid/models/item_status_nullable.rb +2 -2
  1015. data/lib/plaid/models/item_status_transactions.rb +2 -2
  1016. data/lib/plaid/models/item_webhook_update_request.rb +2 -2
  1017. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  1018. data/lib/plaid/models/item_with_consent_fields.rb +3 -3
  1019. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  1020. data/lib/plaid/models/jwk_public_key.rb +1 -1
  1021. data/lib/plaid/models/jwt_header.rb +1 -1
  1022. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  1023. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  1024. data/lib/plaid/models/kyc_check_details.rb +1 -1
  1025. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  1026. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  1027. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  1028. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  1029. data/lib/plaid/models/last_data_access_times.rb +1 -1
  1030. data/lib/plaid/models/latest_scored_event.rb +2 -2
  1031. data/lib/plaid/models/layer_authentication_passed_webhook.rb +1 -1
  1032. data/lib/plaid/models/ledger_event_source_type.rb +1 -1
  1033. data/lib/plaid/models/lend_score.rb +2 -2
  1034. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  1035. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  1036. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  1037. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  1038. data/lib/plaid/models/liabilities_object.rb +1 -1
  1039. data/lib/plaid/models/liability_override.rb +1 -1
  1040. data/lib/plaid/models/limited_purpose_type.rb +1 -1
  1041. data/lib/plaid/models/link_callback_metadata.rb +2 -2
  1042. data/lib/plaid/models/link_delivery_account.rb +1 -1
  1043. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  1044. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  1045. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  1046. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  1047. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  1048. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  1049. data/lib/plaid/models/link_delivery_get_response.rb +2 -2
  1050. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  1051. data/lib/plaid/models/link_delivery_metadata.rb +2 -2
  1052. data/lib/plaid/models/link_delivery_options.rb +1 -1
  1053. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  1054. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  1055. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  1056. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  1057. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  1058. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  1059. data/lib/plaid/models/link_event.rb +1 -1
  1060. data/lib/plaid/models/link_event_metadata.rb +3 -3
  1061. data/lib/plaid/models/link_event_name.rb +1 -1
  1062. data/lib/plaid/models/link_events_webhook.rb +42 -6
  1063. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  1064. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  1065. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  1066. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  1067. data/lib/plaid/models/link_session_cra_document_upload_result.rb +2 -2
  1068. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  1069. data/lib/plaid/models/link_session_cra_update_result.rb +2 -2
  1070. data/lib/plaid/models/link_session_exit.rb +2 -2
  1071. data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
  1072. data/lib/plaid/models/link_session_exit_metadata.rb +2 -2
  1073. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  1074. data/lib/plaid/models/link_session_finished_webhook.rb +3 -3
  1075. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  1076. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  1077. data/lib/plaid/models/link_session_results.rb +7 -17
  1078. data/lib/plaid/models/link_session_success.rb +2 -2
  1079. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  1080. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  1081. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  1082. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  1083. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  1084. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  1085. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  1086. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  1087. data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
  1088. data/lib/plaid/models/link_token_create_hosted_link.rb +2 -2
  1089. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  1090. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  1091. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  1092. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  1093. data/lib/plaid/models/link_token_create_request.rb +5 -5
  1094. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  1095. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
  1096. data/lib/plaid/models/link_token_create_request_auth.rb +4 -4
  1097. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  1098. data/lib/plaid/models/link_token_create_request_cra_options.rb +1 -1
  1099. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  1100. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +1 -1
  1101. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
  1102. data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +1 -1
  1103. data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +1 -1
  1104. data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +1 -1
  1105. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  1106. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  1107. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  1108. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  1109. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  1110. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  1111. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  1112. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  1113. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  1114. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  1115. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  1116. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  1117. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  1118. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  1119. data/lib/plaid/models/link_token_create_request_user.rb +3 -3
  1120. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  1121. data/lib/plaid/models/link_token_create_request_user_id_number.rb +2 -2
  1122. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  1123. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  1124. data/lib/plaid/models/link_token_create_response.rb +2 -2
  1125. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  1126. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  1127. data/lib/plaid/models/link_token_get_request.rb +1 -1
  1128. data/lib/plaid/models/link_token_get_response.rb +2 -2
  1129. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  1130. data/lib/plaid/models/link_token_investments.rb +1 -1
  1131. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  1132. data/lib/plaid/models/link_token_transactions.rb +1 -1
  1133. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  1134. data/lib/plaid/models/loan.rb +1 -1
  1135. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  1136. data/lib/plaid/models/loan_disbursements_indicators.rb +2 -2
  1137. data/lib/plaid/models/loan_filter.rb +1 -1
  1138. data/lib/plaid/models/loan_identifier.rb +1 -1
  1139. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  1140. data/lib/plaid/models/loan_identifiers.rb +1 -1
  1141. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  1142. data/lib/plaid/models/loan_payments_indicators.rb +2 -2
  1143. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  1144. data/lib/plaid/models/loans.rb +1 -1
  1145. data/lib/plaid/models/location.rb +1 -1
  1146. data/lib/plaid/models/match_summary.rb +1 -1
  1147. data/lib/plaid/models/match_summary_code.rb +1 -1
  1148. data/lib/plaid/models/merchant_insights.rb +2 -2
  1149. data/lib/plaid/models/meta.rb +1 -1
  1150. data/lib/plaid/models/mfa.rb +2 -2
  1151. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  1152. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  1153. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  1154. data/lib/plaid/models/monitoring_insights.rb +1 -1
  1155. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  1156. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  1157. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  1158. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  1159. data/lib/plaid/models/monthly_average.rb +1 -1
  1160. data/lib/plaid/models/monthly_summary.rb +1 -1
  1161. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  1162. data/lib/plaid/models/mortgage_liability.rb +1 -1
  1163. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  1164. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  1165. data/lib/plaid/models/name_match_score.rb +1 -1
  1166. data/lib/plaid/models/negative_balance_insights.rb +1 -1
  1167. data/lib/plaid/models/negative_balance_occurrence.rb +1 -1
  1168. data/lib/plaid/models/net_pay.rb +2 -2
  1169. data/lib/plaid/models/network_insights_version.rb +1 -1
  1170. data/lib/plaid/models/network_status_get_request.rb +1 -1
  1171. data/lib/plaid/models/network_status_get_response.rb +1 -1
  1172. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  1173. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  1174. data/lib/plaid/models/network_status_get_user.rb +1 -1
  1175. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  1176. data/lib/plaid/models/numbers.rb +4 -4
  1177. data/lib/plaid/models/numbers_acats.rb +2 -2
  1178. data/lib/plaid/models/numbers_ach.rb +3 -3
  1179. data/lib/plaid/models/numbers_ach_nullable.rb +3 -3
  1180. data/lib/plaid/models/numbers_aton.rb +2 -2
  1181. data/lib/plaid/models/numbers_bacs.rb +4 -4
  1182. data/lib/plaid/models/numbers_bacs_nullable.rb +4 -4
  1183. data/lib/plaid/models/numbers_eft.rb +1 -1
  1184. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  1185. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  1186. data/lib/plaid/models/numbers_international.rb +2 -2
  1187. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  1188. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  1189. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  1190. data/lib/plaid/models/o_auth_error_code.rb +1 -1
  1191. data/lib/plaid/models/o_auth_error_response.rb +1 -1
  1192. data/lib/plaid/models/o_auth_grant_type.rb +1 -1
  1193. data/lib/plaid/models/o_auth_introspect_request.rb +1 -1
  1194. data/lib/plaid/models/o_auth_introspect_response.rb +2 -2
  1195. data/lib/plaid/models/o_auth_revoke_request.rb +1 -1
  1196. data/lib/plaid/models/o_auth_revoke_response.rb +1 -1
  1197. data/lib/plaid/models/o_auth_subject_token_type.rb +1 -1
  1198. data/lib/plaid/models/o_auth_token_request.rb +3 -3
  1199. data/lib/plaid/models/o_auth_token_response.rb +3 -3
  1200. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1201. data/lib/plaid/models/option_contract.rb +1 -1
  1202. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1203. data/lib/plaid/models/originator.rb +2 -2
  1204. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1205. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1206. data/lib/plaid/models/other_filter.rb +1 -1
  1207. data/lib/plaid/models/outlier_transactions_insights.rb +1 -1
  1208. data/lib/plaid/models/override_account_type.rb +1 -1
  1209. data/lib/plaid/models/override_accounts.rb +2 -2
  1210. data/lib/plaid/models/owner.rb +1 -1
  1211. data/lib/plaid/models/owner_override.rb +1 -1
  1212. data/lib/plaid/models/ownership_type.rb +1 -1
  1213. data/lib/plaid/models/parties.rb +1 -1
  1214. data/lib/plaid/models/partner_customer_create_request.rb +2 -2
  1215. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1216. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1217. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1218. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1219. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1220. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1221. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1222. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1223. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1224. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1225. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1226. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1227. data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +1 -1
  1228. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1229. data/lib/plaid/models/partner_end_customer_cra_purposes.rb +1 -1
  1230. data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +1 -1
  1231. data/lib/plaid/models/partner_end_customer_cra_use_case.rb +1 -1
  1232. data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +1 -1
  1233. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  1234. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1235. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  1236. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1237. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1238. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1239. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1240. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1241. data/lib/plaid/models/partner_end_customer_questionnaires.rb +1 -1
  1242. data/lib/plaid/models/partner_end_customer_requirement_due.rb +1 -1
  1243. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1244. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1245. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1246. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  1247. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1248. data/lib/plaid/models/party.rb +2 -2
  1249. data/lib/plaid/models/party_individual.rb +1 -1
  1250. data/lib/plaid/models/party_role_type.rb +1 -1
  1251. data/lib/plaid/models/pay.rb +1 -1
  1252. data/lib/plaid/models/pay_frequency.rb +1 -1
  1253. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1254. data/lib/plaid/models/pay_period_details.rb +1 -1
  1255. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1256. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +2 -2
  1257. data/lib/plaid/models/pay_stub_deductions_total.rb +2 -2
  1258. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +2 -2
  1259. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +3 -3
  1260. data/lib/plaid/models/pay_stub_earnings_total.rb +2 -2
  1261. data/lib/plaid/models/pay_stub_pay_period_details.rb +2 -2
  1262. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1263. data/lib/plaid/models/payment_amount.rb +1 -1
  1264. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1265. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1266. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1267. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1268. data/lib/plaid/models/payment_channel.rb +1 -1
  1269. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1270. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1271. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1272. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1273. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1274. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1275. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1276. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1277. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1278. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1279. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1280. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1281. data/lib/plaid/models/payment_initiation_consent_get_response.rb +2 -2
  1282. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1283. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +2 -2
  1284. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1285. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1286. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1287. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1288. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
  1289. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1290. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1291. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1292. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1293. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1294. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1295. data/lib/plaid/models/payment_initiation_payment.rb +2 -2
  1296. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1297. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1298. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1299. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1300. data/lib/plaid/models/payment_initiation_payment_get_response.rb +3 -3
  1301. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1302. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1303. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1304. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
  1305. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1306. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1307. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1308. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1309. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  1310. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  1311. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1312. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1313. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1314. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1315. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1316. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1317. data/lib/plaid/models/payment_meta.rb +2 -2
  1318. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1319. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1320. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1321. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1322. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1323. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1324. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1325. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1326. data/lib/plaid/models/payment_scheme.rb +1 -1
  1327. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  1328. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1329. data/lib/plaid/models/payroll_income_object.rb +22 -5
  1330. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1331. data/lib/plaid/models/payroll_item.rb +1 -1
  1332. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1333. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1334. data/lib/plaid/models/paystub.rb +1 -1
  1335. data/lib/plaid/models/paystub_address.rb +1 -1
  1336. data/lib/plaid/models/paystub_deduction.rb +2 -2
  1337. data/lib/plaid/models/paystub_details.rb +1 -1
  1338. data/lib/plaid/models/paystub_employer.rb +1 -1
  1339. data/lib/plaid/models/paystub_override.rb +1 -1
  1340. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1341. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1342. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1343. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1344. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1345. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +2 -2
  1346. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1347. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1348. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1349. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1350. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1351. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1352. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1353. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1354. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1355. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1356. data/lib/plaid/models/pending_disconnect_webhook.rb +2 -2
  1357. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1358. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  1359. data/lib/plaid/models/personal_finance_category.rb +2 -2
  1360. data/lib/plaid/models/personal_finance_category_version.rb +1 -1
  1361. data/lib/plaid/models/phone_number.rb +1 -1
  1362. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1363. data/lib/plaid/models/phone_type.rb +1 -1
  1364. data/lib/plaid/models/physical_document_category.rb +1 -1
  1365. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1366. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1367. data/lib/plaid/models/physical_document_images.rb +1 -1
  1368. data/lib/plaid/models/plaid_error.rb +2 -2
  1369. data/lib/plaid/models/plaid_error_type.rb +16 -1
  1370. data/lib/plaid/models/plaid_lend_score_version.rb +1 -1
  1371. data/lib/plaid/models/platform_ids.rb +1 -1
  1372. data/lib/plaid/models/po_box_status.rb +1 -1
  1373. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1374. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1375. data/lib/plaid/models/prism_cash_score_version.rb +1 -1
  1376. data/lib/plaid/models/prism_detect.rb +1 -1
  1377. data/lib/plaid/models/prism_detect_version.rb +1 -1
  1378. data/lib/plaid/models/prism_extend.rb +1 -1
  1379. data/lib/plaid/models/prism_extend_version.rb +1 -1
  1380. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1381. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1382. data/lib/plaid/models/prism_insights.rb +13 -3
  1383. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1384. data/lib/plaid/models/prism_versions.rb +1 -1
  1385. data/lib/plaid/models/prism_versions_deprecated.rb +1 -1
  1386. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1387. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1388. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  1389. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1390. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1391. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1392. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1393. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1394. data/lib/plaid/models/processor_bank_transfer_create_request.rb +3 -3
  1395. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1396. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1397. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1398. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1399. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1400. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1401. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1402. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1403. data/lib/plaid/models/processor_investments_auth_get_request.rb +1 -1
  1404. data/lib/plaid/models/processor_investments_auth_get_response.rb +1 -1
  1405. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1406. data/lib/plaid/models/processor_investments_holdings_get_response.rb +2 -2
  1407. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1408. data/lib/plaid/models/processor_investments_transactions_get_response.rb +2 -2
  1409. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1410. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1411. data/lib/plaid/models/processor_number.rb +2 -2
  1412. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1413. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1414. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1415. data/lib/plaid/models/processor_signal_evaluate_request.rb +3 -3
  1416. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1417. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1418. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1419. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1420. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1421. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +3 -3
  1422. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  1423. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +2 -2
  1424. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  1425. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1426. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1427. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1428. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1429. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1430. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1431. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1432. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1433. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1434. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1435. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1436. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1437. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +2 -2
  1438. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1439. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1440. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1441. data/lib/plaid/models/processor_transactions_sync_request.rb +2 -2
  1442. data/lib/plaid/models/processor_transactions_sync_response.rb +2 -2
  1443. data/lib/plaid/models/product_access.rb +2 -2
  1444. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1445. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1446. data/lib/plaid/models/product_status.rb +1 -1
  1447. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  1448. data/lib/plaid/models/products.rb +2 -1
  1449. data/lib/plaid/models/products_terminate_reason_code.rb +50 -0
  1450. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1451. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1452. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1453. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1454. data/lib/plaid/models/protect_bank_account.rb +1 -1
  1455. data/lib/plaid/models/protect_compute_request.rb +2 -2
  1456. data/lib/plaid/models/protect_compute_response.rb +25 -4
  1457. data/lib/plaid/models/protect_compute_subscores.rb +288 -0
  1458. data/lib/plaid/models/protect_event.rb +2 -2
  1459. data/lib/plaid/models/protect_event_get_request.rb +1 -1
  1460. data/lib/plaid/models/protect_event_get_response.rb +2 -2
  1461. data/lib/plaid/models/protect_event_send_request.rb +1 -1
  1462. data/lib/plaid/models/protect_event_send_response.rb +2 -2
  1463. data/lib/plaid/models/protect_incident_amount.rb +1 -1
  1464. data/lib/plaid/models/protect_incident_event.rb +17 -6
  1465. data/lib/plaid/models/protect_incident_event_response.rb +1 -1
  1466. data/lib/plaid/models/protect_link_model_inputs.rb +1 -1
  1467. data/lib/plaid/models/protect_model_inputs.rb +2 -2
  1468. data/lib/plaid/models/protect_report.rb +1 -1
  1469. data/lib/plaid/models/protect_report_confidence.rb +1 -1
  1470. data/lib/plaid/models/protect_report_create_request.rb +2 -19
  1471. data/lib/plaid/models/protect_report_create_response.rb +1 -1
  1472. data/lib/plaid/models/protect_report_source.rb +1 -1
  1473. data/lib/plaid/models/protect_report_type.rb +1 -1
  1474. data/lib/plaid/models/protect_sdk_model_inputs.rb +1 -1
  1475. data/lib/plaid/models/protect_user.rb +3 -3
  1476. data/lib/plaid/models/protect_user_event_webhook.rb +2 -2
  1477. data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
  1478. data/lib/plaid/models/protect_user_insights_get_response.rb +1 -1
  1479. data/lib/plaid/models/provider_business_address.rb +1 -1
  1480. data/lib/plaid/models/provider_business_name.rb +1 -1
  1481. data/lib/plaid/models/proxy_type.rb +1 -1
  1482. data/lib/plaid/models/pslf_status.rb +1 -1
  1483. data/lib/plaid/models/reason_code.rb +1 -1
  1484. data/lib/plaid/models/recaptcha_required_error.rb +5 -24
  1485. data/lib/plaid/models/receiver_details.rb +222 -0
  1486. data/lib/plaid/models/recipient_bacs.rb +2 -2
  1487. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  1488. data/lib/plaid/models/recommendation_string.rb +1 -1
  1489. data/lib/plaid/models/recurring_cancelled_webhook.rb +2 -2
  1490. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1491. data/lib/plaid/models/recurring_new_transfer_webhook.rb +3 -3
  1492. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1493. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1494. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1495. data/lib/plaid/models/recurring_transfer.rb +4 -4
  1496. data/lib/plaid/models/recurring_transfer_nullable.rb +4 -4
  1497. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +2 -2
  1498. data/lib/plaid/models/refresh_result.rb +1 -1
  1499. data/lib/plaid/models/removed_transaction.rb +1 -1
  1500. data/lib/plaid/models/report_type.rb +1 -1
  1501. data/lib/plaid/models/reporting_information.rb +2 -2
  1502. data/lib/plaid/models/request_business_address.rb +1 -1
  1503. data/lib/plaid/models/response_business_address.rb +1 -1
  1504. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1505. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1506. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1507. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1508. data/lib/plaid/models/risk_check_details.rb +1 -1
  1509. data/lib/plaid/models/risk_check_device.rb +1 -1
  1510. data/lib/plaid/models/risk_check_email.rb +44 -2
  1511. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1512. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1513. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1514. data/lib/plaid/models/risk_check_email_includes_date_of_birth.rb +40 -0
  1515. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1516. data/lib/plaid/models/risk_check_email_is_edu.rb +40 -0
  1517. data/lib/plaid/models/risk_check_email_name.rb +43 -0
  1518. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1519. data/lib/plaid/models/risk_check_facial_duplicate.rb +2 -2
  1520. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1521. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1522. data/lib/plaid/models/risk_check_network.rb +1 -1
  1523. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1524. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1525. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1526. data/lib/plaid/models/risk_indicators.rb +1 -1
  1527. data/lib/plaid/models/risk_level.rb +1 -1
  1528. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1529. data/lib/plaid/models/risk_profile.rb +2 -2
  1530. data/lib/plaid/models/risk_reason.rb +2 -2
  1531. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1532. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1533. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1534. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1535. data/lib/plaid/models/role.rb +2 -2
  1536. data/lib/plaid/models/role_detail.rb +1 -1
  1537. data/lib/plaid/models/roles.rb +1 -1
  1538. data/lib/plaid/models/rule_details.rb +2 -2
  1539. data/lib/plaid/models/rule_result.rb +1 -1
  1540. data/lib/plaid/models/ruleset.rb +1 -1
  1541. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1542. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1543. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1544. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1545. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1546. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1547. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  1548. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1549. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +4 -4
  1550. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +2 -2
  1551. data/lib/plaid/models/sandbox_fdx_consent_seed_request.rb +271 -0
  1552. data/lib/plaid/models/{network_insights_report_get_response.rb → sandbox_fdx_consent_seed_response.rb} +16 -15
  1553. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1554. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1555. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1556. data/lib/plaid/models/sandbox_item_application_seed_request.rb +3 -3
  1557. data/lib/plaid/models/sandbox_item_application_seed_response.rb +1 -1
  1558. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
  1559. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1560. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  1561. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1562. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  1563. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1564. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +2 -2
  1565. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1566. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1567. data/lib/plaid/models/sandbox_payment_simulate_request.rb +1 -1
  1568. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1569. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1570. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +3 -3
  1571. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1572. data/lib/plaid/models/sandbox_public_token_create_request.rb +3 -3
  1573. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1574. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +3 -3
  1575. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1576. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1577. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1578. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1579. data/lib/plaid/models/sandbox_transactions_create_request.rb +2 -2
  1580. data/lib/plaid/models/sandbox_transactions_create_response.rb +1 -1
  1581. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1582. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1583. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +2 -2
  1584. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1585. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +3 -3
  1586. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1587. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +2 -2
  1588. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1589. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +3 -3
  1590. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1591. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1592. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1593. data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +1 -1
  1594. data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +2 -2
  1595. data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +1 -1
  1596. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +3 -3
  1597. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1598. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  1599. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1600. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1601. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1602. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1603. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1604. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1605. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1606. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1607. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1608. data/lib/plaid/models/sandbox_user_reset_login_request.rb +3 -3
  1609. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1610. data/lib/plaid/models/scopes.rb +1 -1
  1611. data/lib/plaid/models/scopes_context.rb +1 -1
  1612. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1613. data/lib/plaid/models/screening_hit_analysis.rb +2 -2
  1614. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1615. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1616. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1617. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1618. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1619. data/lib/plaid/models/security.rb +15 -4
  1620. data/lib/plaid/models/security_override.rb +2 -2
  1621. data/lib/plaid/models/selfie_age_check.rb +288 -0
  1622. data/lib/plaid/models/selfie_age_check_status.rb +41 -0
  1623. data/lib/plaid/models/selfie_analysis.rb +12 -2
  1624. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1625. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1626. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1627. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1628. data/lib/plaid/models/selfie_capture.rb +4 -4
  1629. data/lib/plaid/models/selfie_check.rb +1 -1
  1630. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1631. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1632. data/lib/plaid/models/selfie_status.rb +1 -1
  1633. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  1634. data/lib/plaid/models/service.rb +1 -1
  1635. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1636. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1637. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1638. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1639. data/lib/plaid/models/services.rb +1 -1
  1640. data/lib/plaid/models/session_token_create_request.rb +2 -2
  1641. data/lib/plaid/models/session_token_create_request_user.rb +1 -1
  1642. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1643. data/lib/plaid/models/session_token_create_response_link.rb +2 -2
  1644. data/lib/plaid/models/signal_address_data.rb +1 -1
  1645. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1646. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1647. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1648. data/lib/plaid/models/signal_device.rb +1 -1
  1649. data/lib/plaid/models/signal_evaluate_core_attributes.rb +8 -8
  1650. data/lib/plaid/models/signal_evaluate_request.rb +3 -3
  1651. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1652. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1653. data/lib/plaid/models/signal_person_name.rb +1 -1
  1654. data/lib/plaid/models/signal_prepare_request.rb +2 -2
  1655. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1656. data/lib/plaid/models/signal_return_report_request.rb +2 -2
  1657. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1658. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -1
  1659. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1660. data/lib/plaid/models/signal_schedule_request.rb +2 -2
  1661. data/lib/plaid/models/signal_schedule_response.rb +1 -1
  1662. data/lib/plaid/models/signal_scores.rb +1 -1
  1663. data/lib/plaid/models/signal_user.rb +1 -1
  1664. data/lib/plaid/models/signal_warning.rb +2 -2
  1665. data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
  1666. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1667. data/lib/plaid/models/sms_verification.rb +1 -1
  1668. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1669. data/lib/plaid/models/source.rb +2 -1
  1670. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1671. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1672. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1673. data/lib/plaid/models/statements_account.rb +1 -1
  1674. data/lib/plaid/models/statements_download_request.rb +2 -2
  1675. data/lib/plaid/models/statements_list_request.rb +2 -2
  1676. data/lib/plaid/models/statements_list_response.rb +1 -1
  1677. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1678. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1679. data/lib/plaid/models/statements_refresh_request.rb +2 -2
  1680. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1681. data/lib/plaid/models/statements_statement.rb +2 -2
  1682. data/lib/plaid/models/status.rb +2 -2
  1683. data/lib/plaid/models/statuses.rb +1 -1
  1684. data/lib/plaid/models/strategy.rb +1 -1
  1685. data/lib/plaid/models/student_loan.rb +3 -3
  1686. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1687. data/lib/plaid/models/student_loan_status.rb +1 -1
  1688. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  1689. data/lib/plaid/models/sweep_failure.rb +1 -1
  1690. data/lib/plaid/models/sweep_status.rb +1 -1
  1691. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1692. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1693. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1694. data/lib/plaid/models/taxform.rb +1 -1
  1695. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1696. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1697. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1698. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1699. data/lib/plaid/models/total.rb +1 -1
  1700. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1701. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1702. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1703. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1704. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1705. data/lib/plaid/models/total_monthly_income_insights.rb +2 -2
  1706. data/lib/plaid/models/total_outflow_amount.rb +2 -2
  1707. data/lib/plaid/models/total_outflow_amount30d.rb +2 -2
  1708. data/lib/plaid/models/total_outflow_amount60d.rb +2 -2
  1709. data/lib/plaid/models/total_outflow_amount90d.rb +2 -2
  1710. data/lib/plaid/models/total_report_inflow_amount.rb +1 -1
  1711. data/lib/plaid/models/total_report_inflow_amount30d.rb +1 -1
  1712. data/lib/plaid/models/total_report_inflow_amount60d.rb +1 -1
  1713. data/lib/plaid/models/total_report_inflow_amount90d.rb +2 -2
  1714. data/lib/plaid/models/total_report_outflow_amount.rb +2 -2
  1715. data/lib/plaid/models/total_report_outflow_amount30d.rb +2 -2
  1716. data/lib/plaid/models/total_report_outflow_amount60d.rb +2 -2
  1717. data/lib/plaid/models/total_report_outflow_amount90d.rb +2 -2
  1718. data/lib/plaid/models/transaction.rb +8 -8
  1719. data/lib/plaid/models/transaction_all_of.rb +2 -2
  1720. data/lib/plaid/models/transaction_base.rb +7 -7
  1721. data/lib/plaid/models/transaction_code.rb +7 -1
  1722. data/lib/plaid/models/transaction_counterparty.rb +3 -3
  1723. data/lib/plaid/models/transaction_data.rb +1 -1
  1724. data/lib/plaid/models/transaction_override.rb +1 -1
  1725. data/lib/plaid/models/transaction_stream.rb +1 -1
  1726. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1727. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1728. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1729. data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
  1730. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1731. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1732. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1733. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1734. data/lib/plaid/models/transactions_get_request.rb +2 -2
  1735. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1736. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1737. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1738. data/lib/plaid/models/transactions_recurring_create_request.rb +3 -3
  1739. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1740. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  1741. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1742. data/lib/plaid/models/transactions_recurring_get_response.rb +2 -2
  1743. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1744. data/lib/plaid/models/transactions_recurring_merge_request.rb +3 -3
  1745. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1746. data/lib/plaid/models/transactions_recurring_update_input.rb +3 -3
  1747. data/lib/plaid/models/transactions_recurring_update_request.rb +3 -3
  1748. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1749. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  1750. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1751. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1752. data/lib/plaid/models/transactions_rule_details.rb +2 -2
  1753. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1754. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1755. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  1756. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1757. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1758. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1759. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1760. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1761. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  1762. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  1763. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  1764. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1765. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1766. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1767. data/lib/plaid/models/transfer.rb +23 -9
  1768. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1769. data/lib/plaid/models/transfer_authorization.rb +18 -4
  1770. data/lib/plaid/models/transfer_authorization_cancel_request.rb +2 -2
  1771. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1772. data/lib/plaid/models/transfer_authorization_create_request.rb +32 -10
  1773. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1774. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1775. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1776. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1777. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1778. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1779. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1780. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1781. data/lib/plaid/models/transfer_authorization_payment_risk.rb +3 -3
  1782. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +18 -3
  1783. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1784. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1785. data/lib/plaid/models/transfer_balance.rb +2 -2
  1786. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1787. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1788. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1789. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  1790. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1791. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1792. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1793. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1794. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1795. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1796. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1797. data/lib/plaid/models/transfer_create_request.rb +5 -5
  1798. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1799. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1800. data/lib/plaid/models/transfer_credit_usage_configuration.rb +5 -5
  1801. data/lib/plaid/models/transfer_debit_usage_configuration.rb +5 -5
  1802. data/lib/plaid/models/transfer_device.rb +1 -1
  1803. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1804. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1805. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1806. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1807. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1808. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1809. data/lib/plaid/models/transfer_event.rb +18 -7
  1810. data/lib/plaid/models/transfer_event_list_request.rb +3 -3
  1811. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1812. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1813. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1814. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1815. data/lib/plaid/models/transfer_event_type.rb +5 -1
  1816. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1817. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1818. data/lib/plaid/models/transfer_failure.rb +1 -1
  1819. data/lib/plaid/models/transfer_funding_account.rb +2 -2
  1820. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +2 -2
  1821. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
  1822. data/lib/plaid/models/transfer_get_request.rb +3 -3
  1823. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1824. data/lib/plaid/models/transfer_guarantee_details.rb +243 -0
  1825. data/lib/plaid/models/transfer_guarantee_outcome.rb +41 -0
  1826. data/lib/plaid/models/transfer_guarantee_schedule_item.rb +260 -0
  1827. data/lib/plaid/models/transfer_guarantee_schedule_item_all_of.rb +221 -0
  1828. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1829. data/lib/plaid/models/transfer_intent_create.rb +3 -3
  1830. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1831. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1832. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  1833. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1834. data/lib/plaid/models/transfer_intent_get.rb +3 -3
  1835. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1836. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1837. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1838. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1839. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1840. data/lib/plaid/models/transfer_ledger_deposit_request.rb +3 -3
  1841. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1842. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1843. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1844. data/lib/plaid/models/transfer_ledger_event.rb +1 -1
  1845. data/lib/plaid/models/transfer_ledger_event_list_request.rb +1 -1
  1846. data/lib/plaid/models/transfer_ledger_event_list_response.rb +1 -1
  1847. data/lib/plaid/models/transfer_ledger_get_request.rb +2 -2
  1848. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1849. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1850. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +3 -3
  1851. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1852. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1853. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1854. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1855. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1856. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1857. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1858. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1859. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1860. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1861. data/lib/plaid/models/transfer_network.rb +2 -1
  1862. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1863. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1864. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1865. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1866. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +1 -1
  1867. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +1 -1
  1868. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1869. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1870. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1871. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1872. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1873. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1874. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  1875. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1876. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1877. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1878. data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
  1879. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1880. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1881. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1882. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1883. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1884. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1885. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1886. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1887. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1888. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1889. data/lib/plaid/models/transfer_recurring_cancel_request.rb +2 -2
  1890. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1891. data/lib/plaid/models/transfer_recurring_create_request.rb +3 -3
  1892. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1893. data/lib/plaid/models/transfer_recurring_get_request.rb +2 -2
  1894. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1895. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1896. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1897. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1898. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1899. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1900. data/lib/plaid/models/transfer_refund.rb +3 -3
  1901. data/lib/plaid/models/transfer_refund_cancel_request.rb +2 -2
  1902. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1903. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1904. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1905. data/lib/plaid/models/transfer_refund_failure.rb +2 -2
  1906. data/lib/plaid/models/transfer_refund_get_request.rb +2 -2
  1907. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1908. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1909. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1910. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1911. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  1912. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1913. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1914. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  1915. data/lib/plaid/models/transfer_return_recover_request.rb +297 -0
  1916. data/lib/plaid/models/{item_handle_fraud_report_response.rb → transfer_return_recover_response.rb} +6 -21
  1917. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1918. data/lib/plaid/models/transfer_status.rb +1 -1
  1919. data/lib/plaid/models/transfer_sweep.rb +2 -2
  1920. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1921. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1922. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1923. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1924. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1925. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  1926. data/lib/plaid/models/transfer_type.rb +1 -1
  1927. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1928. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1929. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1930. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1931. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1932. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1933. data/lib/plaid/models/trust_index.rb +1 -1
  1934. data/lib/plaid/models/trust_index_subscore.rb +1 -1
  1935. data/lib/plaid/models/trust_index_subscores.rb +1 -1
  1936. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1937. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1938. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1939. data/lib/plaid/models/user_account_identity.rb +3 -3
  1940. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1941. data/lib/plaid/models/user_account_identity_edit_counts.rb +1 -1
  1942. data/lib/plaid/models/user_account_identity_edit_history.rb +1 -1
  1943. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1944. data/lib/plaid/models/user_account_identity_official_document.rb +1 -1
  1945. data/lib/plaid/models/user_account_item.rb +2 -2
  1946. data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
  1947. data/lib/plaid/models/user_account_session_event.rb +1 -1
  1948. data/lib/plaid/models/user_account_session_event_send_request.rb +1 -1
  1949. data/lib/plaid/models/user_account_session_event_send_response.rb +1 -1
  1950. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1951. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1952. data/lib/plaid/models/user_address.rb +1 -1
  1953. data/lib/plaid/models/user_based_products.rb +1 -1
  1954. data/lib/plaid/models/user_create_request.rb +2 -2
  1955. data/lib/plaid/models/user_create_response.rb +3 -3
  1956. data/lib/plaid/models/user_custom_password.rb +1 -1
  1957. data/lib/plaid/models/user_data_overview.rb +1 -1
  1958. data/lib/plaid/models/user_financial_data_refresh_request.rb +2 -2
  1959. data/lib/plaid/models/user_financial_data_refresh_response.rb +2 -2
  1960. data/lib/plaid/models/user_get_request.rb +2 -2
  1961. data/lib/plaid/models/user_get_response.rb +2 -2
  1962. data/lib/plaid/models/user_id_number.rb +2 -2
  1963. data/lib/plaid/models/user_identity_remove_request.rb +2 -2
  1964. data/lib/plaid/models/user_identity_remove_response.rb +1 -1
  1965. data/lib/plaid/models/user_items_associate_request.rb +2 -2
  1966. data/lib/plaid/models/user_items_associate_response.rb +1 -1
  1967. data/lib/plaid/models/user_items_get_request.rb +3 -3
  1968. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1969. data/lib/plaid/models/user_items_remove_request.rb +3 -3
  1970. data/lib/plaid/models/user_items_remove_response.rb +1 -1
  1971. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1972. data/lib/plaid/models/user_products_terminate_request.rb +64 -12
  1973. data/lib/plaid/models/user_products_terminate_response.rb +1 -1
  1974. data/lib/plaid/models/user_remove_request.rb +3 -3
  1975. data/lib/plaid/models/user_remove_response.rb +1 -1
  1976. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1977. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1978. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1979. data/lib/plaid/models/user_third_party_token_create_request.rb +3 -3
  1980. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1981. data/lib/plaid/models/user_third_party_token_remove_request.rb +2 -2
  1982. data/lib/plaid/models/user_third_party_token_remove_response.rb +2 -2
  1983. data/lib/plaid/models/user_transactions_refresh_request.rb +2 -2
  1984. data/lib/plaid/models/user_transactions_refresh_response.rb +2 -2
  1985. data/lib/plaid/models/user_update_request.rb +3 -3
  1986. data/lib/plaid/models/user_update_response.rb +1 -1
  1987. data/lib/plaid/models/validation_source.rb +1 -1
  1988. data/lib/plaid/models/validation_sources.rb +1 -1
  1989. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1990. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1991. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1992. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1993. data/lib/plaid/models/verification_status.rb +1 -1
  1994. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1995. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1996. data/lib/plaid/models/w2.rb +5 -5
  1997. data/lib/plaid/models/w2_box12.rb +1 -1
  1998. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1999. data/lib/plaid/models/w2_override.rb +4 -4
  2000. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  2001. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  2002. data/lib/plaid/models/wallet.rb +1 -1
  2003. data/lib/plaid/models/wallet_balance.rb +1 -1
  2004. data/lib/plaid/models/wallet_create_request.rb +1 -1
  2005. data/lib/plaid/models/wallet_create_response.rb +1 -1
  2006. data/lib/plaid/models/wallet_get_request.rb +1 -1
  2007. data/lib/plaid/models/wallet_get_response.rb +1 -1
  2008. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  2009. data/lib/plaid/models/wallet_list_request.rb +1 -1
  2010. data/lib/plaid/models/wallet_list_response.rb +1 -1
  2011. data/lib/plaid/models/wallet_numbers.rb +1 -1
  2012. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  2013. data/lib/plaid/models/wallet_status.rb +1 -1
  2014. data/lib/plaid/models/wallet_transaction.rb +6 -6
  2015. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  2016. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  2017. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  2018. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  2019. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  2020. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  2021. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  2022. data/lib/plaid/models/wallet_transaction_failure_reason.rb +3 -1
  2023. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  2024. data/lib/plaid/models/wallet_transaction_get_response.rb +6 -6
  2025. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  2026. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  2027. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  2028. data/lib/plaid/models/wallet_transaction_payee_verification_status.rb +1 -1
  2029. data/lib/plaid/models/wallet_transaction_relation.rb +2 -2
  2030. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  2031. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +12 -2
  2032. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  2033. data/lib/plaid/models/warning.rb +4 -4
  2034. data/lib/plaid/models/watchlist_screening_audit_trail.rb +2 -2
  2035. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  2036. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  2037. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +2 -2
  2038. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
  2039. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  2040. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
  2041. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  2042. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  2043. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  2044. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  2045. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
  2046. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  2047. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  2048. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  2049. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  2050. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  2051. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +2 -2
  2052. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +2 -2
  2053. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  2054. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  2055. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
  2056. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  2057. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
  2058. data/lib/plaid/models/watchlist_screening_hit.rb +19 -2
  2059. data/lib/plaid/models/watchlist_screening_hit_locations.rb +2 -2
  2060. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  2061. data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
  2062. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  2063. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
  2064. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  2065. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
  2066. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  2067. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  2068. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  2069. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  2070. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +3 -3
  2071. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  2072. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  2073. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  2074. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  2075. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  2076. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +2 -2
  2077. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +2 -2
  2078. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  2079. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  2080. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
  2081. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  2082. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
  2083. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  2084. data/lib/plaid/models/watchlist_screening_review.rb +2 -2
  2085. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  2086. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  2087. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  2088. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  2089. data/lib/plaid/models/webhook_type.rb +1 -1
  2090. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  2091. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  2092. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  2093. data/lib/plaid/models/yield_rate.rb +1 -1
  2094. data/lib/plaid/models/yield_rate_type.rb +1 -1
  2095. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  2096. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  2097. data/lib/plaid/version.rb +2 -2
  2098. data/lib/plaid.rb +63 -9
  2099. data/plaid.gemspec +1 -1
  2100. metadata +64 -10
@@ -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.688.6
6
+ The version of the OpenAPI document: 2020-09-14_1.706.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -20,7 +20,7 @@ module Plaid
20
20
  @api_client = api_client
21
21
  end
22
22
  # Retrieve real-time balance data
23
- # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaids other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](/docs/balance/#balance-integration-options).
23
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid's other products. This endpoint can be used as long as Link has been initialized with any other product; `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](https://plaid.com/docs/balance/#balance-integration-options).
24
24
  # @param accounts_balance_get_request [AccountsBalanceGetRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [AccountsGetResponse]
@@ -30,7 +30,7 @@ module Plaid
30
30
  end
31
31
 
32
32
  # Retrieve real-time balance data
33
- # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaids other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](/docs/balance/#balance-integration-options).
33
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints, such as `/accounts/get`, return a balance object, `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid's other products. This endpoint can be used as long as Link has been initialized with any other product; `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. Note: If you are getting real-time balance for the purpose of assessing the return risk of a proposed ACH transaction, it is recommended to use `/signal/evaluate` instead of `/accounts/balance/get`. `/signal/evaluate` returns the same real-time balance information and also provides access to Signal Rules, which provides no-code transaction business logic configuration, backtesting and recommendations for tuning your transaction acceptance logic, and the ability to easily switch between Balance and Signal Transaction Scores as needed for ultra-low-latency, ML-powered risk assessments. For more details, see the [Balance documentation](https://plaid.com/docs/balance/#balance-integration-options).
34
34
  # @param accounts_balance_get_request [AccountsBalanceGetRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -88,7 +88,7 @@ module Plaid
88
88
  end
89
89
 
90
90
  # Retrieve accounts
91
- # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoints `/accounts/balance/get` or `/signal/evaluate` instead.
91
+ # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts -- that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. `/accounts/get` is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For real-time balance information, use the paid endpoints `/accounts/balance/get` or `/signal/evaluate` instead.
92
92
  # @param accounts_get_request [AccountsGetRequest]
93
93
  # @param [Hash] opts the optional parameters
94
94
  # @return [AccountsGetResponse]
@@ -98,7 +98,7 @@ module Plaid
98
98
  end
99
99
 
100
100
  # Retrieve accounts
101
- # The &#x60;/accounts/get&#x60; endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [&#x60;NEW_ACCOUNTS_AVAILABLE&#x60;](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link&#39;s [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. &#x60;/accounts/get&#x60; is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For realtime balance information, use the paid endpoints &#x60;/accounts/balance/get&#x60; or &#x60;/signal/evaluate&#x60; instead.
101
+ # The &#x60;/accounts/get&#x60; endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts -- that is, accounts that are not closed and are capable of carrying a balance. To return new accounts that were created after the user linked their Item, you can listen for the [&#x60;NEW_ACCOUNTS_AVAILABLE&#x60;](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link&#39;s [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. &#x60;/accounts/get&#x60; is free to use and retrieves cached information, rather than extracting fresh information from the institution. The balance returned will reflect the balance at the time of the last successful Item update. If the Item is enabled for a regularly updating product, such as Transactions, Investments, or Liabilities, the balance will typically update about once a day, as long as the Item is healthy. If the Item is enabled only for products that do not frequently update, such as Auth or Identity, balance data may be much older. For real-time balance information, use the paid endpoints &#x60;/accounts/balance/get&#x60; or &#x60;/signal/evaluate&#x60; instead.
102
102
  # @param accounts_get_request [AccountsGetRequest]
103
103
  # @param [Hash] opts the optional parameters
104
104
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -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 the GSEs on your behalf if you participate in Fannie Mae's Day 1 Certainty™ program or utilize Freddie Macs 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`. Youll 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 the GSEs on your behalf if you participate in Fannie Mae&#39;s Day 1 Certainty™ program or utilize Freddie Macs 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 &#x60;/asset_report/audit_copy/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;auditor_id&#x60;, for example &#x60;fannie_mae&#x60;. Youll 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&#39;s Day 1 Certainty™ program or utilize Freddie Mac&#39;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 &#x60;/asset_report/audit_copy/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;auditor_id&#x60;, for example &#x60;fannie_mae&#x60;. You&#39;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
@@ -632,7 +632,7 @@ module Plaid
632
632
  end
633
633
 
634
634
  # Retrieve an Asset Report
635
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
635
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
636
636
  # @param asset_report_get_request [AssetReportGetRequest]
637
637
  # @param [Hash] opts the optional parameters
638
638
  # @return [AssetReportGetResponse]
@@ -642,7 +642,7 @@ module Plaid
642
642
  end
643
643
 
644
644
  # Retrieve an Asset Report
645
- # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;. For latency-sensitive applications, you can optionally call &#x60;/asset_report/create&#x60; with &#x60;options.add_ons&#x60; set to &#x60;[\&quot;fast_assets\&quot;]&#x60;. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
645
+ # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;. For latency-sensitive applications, you can optionally call &#x60;/asset_report/create&#x60; with &#x60;options.add_ons&#x60; set to &#x60;[\&quot;fast_assets\&quot;]&#x60;. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
646
646
  # @param asset_report_get_request [AssetReportGetRequest]
647
647
  # @param [Hash] opts the optional parameters
648
648
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse 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
@@ -1039,7 +1039,7 @@ module Plaid
1039
1039
  return data, status_code, headers
1040
1040
  end
1041
1041
 
1042
- # Get balance of your Bank Transfer account
1042
+ # (Deprecated) Get balance of your Bank Transfer account
1043
1043
  # Use the `/bank_transfer/balance/get` endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
1044
1044
  # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
1045
1045
  # @param [Hash] opts the optional parameters
@@ -1049,7 +1049,7 @@ module Plaid
1049
1049
  data
1050
1050
  end
1051
1051
 
1052
- # Get balance of your Bank Transfer account
1052
+ # (Deprecated) Get balance of your Bank Transfer account
1053
1053
  # Use the &#x60;/bank_transfer/balance/get&#x60; endpoint to see the available balance in your bank transfer account. Debit transfers increase this balance once their status is posted. Credit transfers decrease this balance when they are created. The transactable balance shows the amount in your account that you are able to use for transfers, and is essentially your available balance minus your minimum balance. Note that this endpoint can only be used with FBO accounts, when using Bank Transfers in the Full Service configuration. It cannot be used on your own account when using Bank Transfers in the BTS Platform configuration.
1054
1054
  # @param bank_transfer_balance_get_request [BankTransferBalanceGetRequest]
1055
1055
  # @param [Hash] opts the optional parameters
@@ -1107,7 +1107,7 @@ module Plaid
1107
1107
  return data, status_code, headers
1108
1108
  end
1109
1109
 
1110
- # Cancel a bank transfer
1110
+ # (Deprecated) Cancel a bank transfer
1111
1111
  # Use the `/bank_transfer/cancel` endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the `cancellable` property returned by `/bank_transfer/get` is `true`.
1112
1112
  # @param bank_transfer_cancel_request [BankTransferCancelRequest]
1113
1113
  # @param [Hash] opts the optional parameters
@@ -1117,7 +1117,7 @@ module Plaid
1117
1117
  data
1118
1118
  end
1119
1119
 
1120
- # Cancel a bank transfer
1120
+ # (Deprecated) Cancel a bank transfer
1121
1121
  # Use the &#x60;/bank_transfer/cancel&#x60; endpoint to cancel a bank transfer. A transfer is eligible for cancelation if the &#x60;cancellable&#x60; property returned by &#x60;/bank_transfer/get&#x60; is &#x60;true&#x60;.
1122
1122
  # @param bank_transfer_cancel_request [BankTransferCancelRequest]
1123
1123
  # @param [Hash] opts the optional parameters
@@ -1175,7 +1175,7 @@ module Plaid
1175
1175
  return data, status_code, headers
1176
1176
  end
1177
1177
 
1178
- # Create a bank transfer
1178
+ # (Deprecated) Create a bank transfer
1179
1179
  # Use the `/bank_transfer/create` endpoint to initiate a new bank transfer.
1180
1180
  # @param bank_transfer_create_request [BankTransferCreateRequest]
1181
1181
  # @param [Hash] opts the optional parameters
@@ -1185,7 +1185,7 @@ module Plaid
1185
1185
  data
1186
1186
  end
1187
1187
 
1188
- # Create a bank transfer
1188
+ # (Deprecated) Create a bank transfer
1189
1189
  # Use the &#x60;/bank_transfer/create&#x60; endpoint to initiate a new bank transfer.
1190
1190
  # @param bank_transfer_create_request [BankTransferCreateRequest]
1191
1191
  # @param [Hash] opts the optional parameters
@@ -1379,7 +1379,7 @@ module Plaid
1379
1379
  return data, status_code, headers
1380
1380
  end
1381
1381
 
1382
- # Retrieve a bank transfer
1382
+ # (Deprecated) Retrieve a bank transfer
1383
1383
  # The `/bank_transfer/get` fetches information about the bank transfer corresponding to the given `bank_transfer_id`.
1384
1384
  # @param bank_transfer_get_request [BankTransferGetRequest]
1385
1385
  # @param [Hash] opts the optional parameters
@@ -1389,7 +1389,7 @@ module Plaid
1389
1389
  data
1390
1390
  end
1391
1391
 
1392
- # Retrieve a bank transfer
1392
+ # (Deprecated) Retrieve a bank transfer
1393
1393
  # The &#x60;/bank_transfer/get&#x60; fetches information about the bank transfer corresponding to the given &#x60;bank_transfer_id&#x60;.
1394
1394
  # @param bank_transfer_get_request [BankTransferGetRequest]
1395
1395
  # @param [Hash] opts the optional parameters
@@ -1447,7 +1447,7 @@ module Plaid
1447
1447
  return data, status_code, headers
1448
1448
  end
1449
1449
 
1450
- # List bank transfers
1450
+ # (Deprecated) List bank transfers
1451
1451
  # Use the `/bank_transfer/list` endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired bank transfers.
1452
1452
  # @param bank_transfer_list_request [BankTransferListRequest]
1453
1453
  # @param [Hash] opts the optional parameters
@@ -1457,7 +1457,7 @@ module Plaid
1457
1457
  data
1458
1458
  end
1459
1459
 
1460
- # List bank transfers
1460
+ # (Deprecated) List bank transfers
1461
1461
  # Use the &#x60;/bank_transfer/list&#x60; endpoint to see a list of all your bank transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired bank transfers.
1462
1462
  # @param bank_transfer_list_request [BankTransferListRequest]
1463
1463
  # @param [Hash] opts the optional parameters
@@ -1515,8 +1515,8 @@ module Plaid
1515
1515
  return data, status_code, headers
1516
1516
  end
1517
1517
 
1518
- # Migrate account into Bank Transfers
1519
- # As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
1518
+ # (Deprecated) Migrate account into Bank Transfers
1519
+ # As an alternative to adding Items via Link, you can also use the `/bank_transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/bank_transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager.
1520
1520
  # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1521
1521
  # @param [Hash] opts the optional parameters
1522
1522
  # @return [BankTransferMigrateAccountResponse]
@@ -1525,8 +1525,8 @@ module Plaid
1525
1525
  data
1526
1526
  end
1527
1527
 
1528
- # Migrate account into Bank Transfers
1529
- # As an alternative to adding Items via Link, you can also use the &#x60;/bank_transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/bank_transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
1528
+ # (Deprecated) Migrate account into Bank Transfers
1529
+ # As an alternative to adding Items via Link, you can also use the &#x60;/bank_transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Bank Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/bank_transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid account manager.
1530
1530
  # @param bank_transfer_migrate_account_request [BankTransferMigrateAccountRequest]
1531
1531
  # @param [Hash] opts the optional parameters
1532
1532
  # @return [Array<(BankTransferMigrateAccountResponse, Integer, Hash)>] BankTransferMigrateAccountResponse data, response status code and response headers
@@ -1583,7 +1583,7 @@ module Plaid
1583
1583
  return data, status_code, headers
1584
1584
  end
1585
1585
 
1586
- # Retrieve a sweep
1586
+ # (Deprecated) Retrieve a sweep
1587
1587
  # The `/bank_transfer/sweep/get` endpoint fetches information about the sweep corresponding to the given `sweep_id`.
1588
1588
  # @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
1589
1589
  # @param [Hash] opts the optional parameters
@@ -1593,7 +1593,7 @@ module Plaid
1593
1593
  data
1594
1594
  end
1595
1595
 
1596
- # Retrieve a sweep
1596
+ # (Deprecated) Retrieve a sweep
1597
1597
  # The &#x60;/bank_transfer/sweep/get&#x60; endpoint fetches information about the sweep corresponding to the given &#x60;sweep_id&#x60;.
1598
1598
  # @param bank_transfer_sweep_get_request [BankTransferSweepGetRequest]
1599
1599
  # @param [Hash] opts the optional parameters
@@ -1651,7 +1651,7 @@ module Plaid
1651
1651
  return data, status_code, headers
1652
1652
  end
1653
1653
 
1654
- # List sweeps
1654
+ # (Deprecated) List sweeps
1655
1655
  # The `/bank_transfer/sweep/list` endpoint fetches information about the sweeps matching the given filters.
1656
1656
  # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
1657
1657
  # @param [Hash] opts the optional parameters
@@ -1661,7 +1661,7 @@ module Plaid
1661
1661
  data
1662
1662
  end
1663
1663
 
1664
- # List sweeps
1664
+ # (Deprecated) List sweeps
1665
1665
  # The &#x60;/bank_transfer/sweep/list&#x60; endpoint fetches information about the sweeps matching the given filters.
1666
1666
  # @param bank_transfer_sweep_list_request [BankTransferSweepListRequest]
1667
1667
  # @param [Hash] opts the optional parameters
@@ -1719,7 +1719,7 @@ module Plaid
1719
1719
  return data, status_code, headers
1720
1720
  end
1721
1721
 
1722
- # Evaluate risk of a bank account
1722
+ # (Deprecated) Evaluate risk of a bank account
1723
1723
  # Use `/beacon/account_risk/v1/evaluate` to get risk insights for a linked account.
1724
1724
  # @param beacon_account_risk_evaluate_request [BeaconAccountRiskEvaluateRequest]
1725
1725
  # @param [Hash] opts the optional parameters
@@ -1729,7 +1729,7 @@ module Plaid
1729
1729
  data
1730
1730
  end
1731
1731
 
1732
- # Evaluate risk of a bank account
1732
+ # (Deprecated) Evaluate risk of a bank account
1733
1733
  # Use &#x60;/beacon/account_risk/v1/evaluate&#x60; to get risk insights for a linked account.
1734
1734
  # @param beacon_account_risk_evaluate_request [BeaconAccountRiskEvaluateRequest]
1735
1735
  # @param [Hash] opts the optional parameters
@@ -1787,7 +1787,7 @@ module Plaid
1787
1787
  return data, status_code, headers
1788
1788
  end
1789
1789
 
1790
- # Get a Beacon Duplicate
1790
+ # (Deprecated) Get a Beacon Duplicate
1791
1791
  # Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the `beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`.
1792
1792
  # @param beacon_duplicate_get_request [BeaconDuplicateGetRequest]
1793
1793
  # @param [Hash] opts the optional parameters
@@ -1797,7 +1797,7 @@ module Plaid
1797
1797
  data
1798
1798
  end
1799
1799
 
1800
- # Get a Beacon Duplicate
1800
+ # (Deprecated) Get a Beacon Duplicate
1801
1801
  # Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the &#x60;beacon_user1&#x60; or &#x60;beacon_user2&#x60; response fields. The &#x60;analysis&#x60; field in the response indicates which fields matched between &#x60;beacon_user1&#x60; and &#x60;beacon_user2&#x60;.
1802
1802
  # @param beacon_duplicate_get_request [BeaconDuplicateGetRequest]
1803
1803
  # @param [Hash] opts the optional parameters
@@ -1855,7 +1855,7 @@ module Plaid
1855
1855
  return data, status_code, headers
1856
1856
  end
1857
1857
 
1858
- # Create a Beacon Report
1858
+ # (Deprecated) Create a Beacon Report
1859
1859
  # Create a fraud report for a given Beacon User.
1860
1860
  # @param beacon_report_create_request [BeaconReportCreateRequest]
1861
1861
  # @param [Hash] opts the optional parameters
@@ -1865,7 +1865,7 @@ module Plaid
1865
1865
  data
1866
1866
  end
1867
1867
 
1868
- # Create a Beacon Report
1868
+ # (Deprecated) Create a Beacon Report
1869
1869
  # Create a fraud report for a given Beacon User.
1870
1870
  # @param beacon_report_create_request [BeaconReportCreateRequest]
1871
1871
  # @param [Hash] opts the optional parameters
@@ -1923,8 +1923,8 @@ module Plaid
1923
1923
  return data, status_code, headers
1924
1924
  end
1925
1925
 
1926
- # Get a Beacon Report
1927
- # Returns a Beacon report for a given Beacon report id.
1926
+ # (Deprecated) Get a Beacon Report
1927
+ # Returns a Beacon Report for a given Beacon Report ID.
1928
1928
  # @param beacon_report_get_request [BeaconReportGetRequest]
1929
1929
  # @param [Hash] opts the optional parameters
1930
1930
  # @return [BeaconReportGetResponse]
@@ -1933,8 +1933,8 @@ module Plaid
1933
1933
  data
1934
1934
  end
1935
1935
 
1936
- # Get a Beacon Report
1937
- # Returns a Beacon report for a given Beacon report id.
1936
+ # (Deprecated) Get a Beacon Report
1937
+ # Returns a Beacon Report for a given Beacon Report ID.
1938
1938
  # @param beacon_report_get_request [BeaconReportGetRequest]
1939
1939
  # @param [Hash] opts the optional parameters
1940
1940
  # @return [Array<(BeaconReportGetResponse, Integer, Hash)>] BeaconReportGetResponse data, response status code and response headers
@@ -1991,7 +1991,7 @@ module Plaid
1991
1991
  return data, status_code, headers
1992
1992
  end
1993
1993
 
1994
- # List Beacon Reports for a Beacon User
1994
+ # (Deprecated) List Beacon Reports for a Beacon User
1995
1995
  # Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
1996
1996
  # @param beacon_report_list_request [BeaconReportListRequest]
1997
1997
  # @param [Hash] opts the optional parameters
@@ -2001,7 +2001,7 @@ module Plaid
2001
2001
  data
2002
2002
  end
2003
2003
 
2004
- # List Beacon Reports for a Beacon User
2004
+ # (Deprecated) List Beacon Reports for a Beacon User
2005
2005
  # Use the &#x60;/beacon/report/list&#x60; endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.
2006
2006
  # @param beacon_report_list_request [BeaconReportListRequest]
2007
2007
  # @param [Hash] opts the optional parameters
@@ -2059,7 +2059,7 @@ module Plaid
2059
2059
  return data, status_code, headers
2060
2060
  end
2061
2061
 
2062
- # Get a Beacon Report Syndication
2062
+ # (Deprecated) Get a Beacon Report Syndication
2063
2063
  # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
2064
2064
  # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest]
2065
2065
  # @param [Hash] opts the optional parameters
@@ -2069,7 +2069,7 @@ module Plaid
2069
2069
  data
2070
2070
  end
2071
2071
 
2072
- # Get a Beacon Report Syndication
2072
+ # (Deprecated) Get a Beacon Report Syndication
2073
2073
  # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
2074
2074
  # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest]
2075
2075
  # @param [Hash] opts the optional parameters
@@ -2127,7 +2127,7 @@ module Plaid
2127
2127
  return data, status_code, headers
2128
2128
  end
2129
2129
 
2130
- # List Beacon Report Syndications for a Beacon User
2130
+ # (Deprecated) List Beacon Report Syndications for a Beacon User
2131
2131
  # Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
2132
2132
  # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
2133
2133
  # @param [Hash] opts the optional parameters
@@ -2137,7 +2137,7 @@ module Plaid
2137
2137
  data
2138
2138
  end
2139
2139
 
2140
- # List Beacon Report Syndications for a Beacon User
2140
+ # (Deprecated) List Beacon Report Syndications for a Beacon User
2141
2141
  # Use the &#x60;/beacon/report_syndication/list&#x60; endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the &#x60;next_cursor&#x60; field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the &#x60;next_cursor&#x60; value as the &#x60;cursor&#x60; parameter in the next request.
2142
2142
  # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
2143
2143
  # @param [Hash] opts the optional parameters
@@ -2195,7 +2195,7 @@ module Plaid
2195
2195
  return data, status_code, headers
2196
2196
  end
2197
2197
 
2198
- # Get Account Insights for a Beacon User
2198
+ # (Deprecated) Get Account Insights for a Beacon User
2199
2199
  # Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
2200
2200
  # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2201
2201
  # @param [Hash] opts the optional parameters
@@ -2205,7 +2205,7 @@ module Plaid
2205
2205
  data
2206
2206
  end
2207
2207
 
2208
- # Get Account Insights for a Beacon User
2208
+ # (Deprecated) Get Account Insights for a Beacon User
2209
2209
  # Get Account Insights for all Accounts linked to this Beacon User. The insights for each account are computed based on the information that was last retrieved from the financial institution.
2210
2210
  # @param beacon_user_account_insights_get_request [BeaconUserAccountInsightsGetRequest]
2211
2211
  # @param [Hash] opts the optional parameters
@@ -2263,8 +2263,8 @@ module Plaid
2263
2263
  return data, status_code, headers
2264
2264
  end
2265
2265
 
2266
- # Create a Beacon User
2267
- # Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
2266
+ # (Deprecated) Create a Beacon User
2267
+ # Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud reports shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
2268
2268
  # @param beacon_user_create_request [BeaconUserCreateRequest]
2269
2269
  # @param [Hash] opts the optional parameters
2270
2270
  # @return [BeaconUserCreateResponse]
@@ -2273,8 +2273,8 @@ module Plaid
2273
2273
  data
2274
2274
  end
2275
2275
 
2276
- # Create a Beacon User
2277
- # Create and scan a Beacon User against your Beacon Program, according to your program&#39;s settings. When you submit a new user to &#x60;/beacon/user/create&#x60;, several checks are performed immediately: - The user&#39;s PII (provided within the &#x60;user&#x60; object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud.
2276
+ # (Deprecated) Create a Beacon User
2277
+ # Create and scan a Beacon User against your Beacon Program, according to your program&#39;s settings. When you submit a new user to &#x60;/beacon/user/create&#x60;, several checks are performed immediately: - The user&#39;s PII (provided within the &#x60;user&#x60; object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud reports shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud.
2278
2278
  # @param beacon_user_create_request [BeaconUserCreateRequest]
2279
2279
  # @param [Hash] opts the optional parameters
2280
2280
  # @return [Array<(BeaconUserCreateResponse, Integer, Hash)>] BeaconUserCreateResponse data, response status code and response headers
@@ -2331,7 +2331,7 @@ module Plaid
2331
2331
  return data, status_code, headers
2332
2332
  end
2333
2333
 
2334
- # Get a Beacon User
2334
+ # (Deprecated) Get a Beacon User
2335
2335
  # Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks.
2336
2336
  # @param beacon_user_get_request [BeaconUserGetRequest]
2337
2337
  # @param [Hash] opts the optional parameters
@@ -2341,7 +2341,7 @@ module Plaid
2341
2341
  data
2342
2342
  end
2343
2343
 
2344
- # Get a Beacon User
2344
+ # (Deprecated) Get a Beacon User
2345
2345
  # Fetch a Beacon User. The Beacon User is returned with all of their associated information and a &#x60;status&#x60; based on the Beacon Network duplicate record and fraud checks.
2346
2346
  # @param beacon_user_get_request [BeaconUserGetRequest]
2347
2347
  # @param [Hash] opts the optional parameters
@@ -2399,7 +2399,7 @@ module Plaid
2399
2399
  return data, status_code, headers
2400
2400
  end
2401
2401
 
2402
- # List a Beacon User's history
2402
+ # (Deprecated) List a Beacon User's history
2403
2403
  # List all changes to the Beacon User in reverse-chronological order.
2404
2404
  # @param beacon_user_history_list_request [BeaconUserHistoryListRequest]
2405
2405
  # @param [Hash] opts the optional parameters
@@ -2409,7 +2409,7 @@ module Plaid
2409
2409
  data
2410
2410
  end
2411
2411
 
2412
- # List a Beacon User&#39;s history
2412
+ # (Deprecated) List a Beacon User&#39;s history
2413
2413
  # List all changes to the Beacon User in reverse-chronological order.
2414
2414
  # @param beacon_user_history_list_request [BeaconUserHistoryListRequest]
2415
2415
  # @param [Hash] opts the optional parameters
@@ -2467,7 +2467,7 @@ module Plaid
2467
2467
  return data, status_code, headers
2468
2468
  end
2469
2469
 
2470
- # Review a Beacon User
2470
+ # (Deprecated) Review a Beacon User
2471
2471
  # Update the status of a Beacon User. When updating a Beacon User's status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User's status to `rejected`, we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User's status to `cleared`, we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User's status to `cleared`. There are no restrictions on updating a Beacon User's status to `pending_review`. If these conditions are not met, the request will be rejected with an error explaining the issue.
2472
2472
  # @param beacon_user_review_request [BeaconUserReviewRequest]
2473
2473
  # @param [Hash] opts the optional parameters
@@ -2477,7 +2477,7 @@ module Plaid
2477
2477
  data
2478
2478
  end
2479
2479
 
2480
- # Review a Beacon User
2480
+ # (Deprecated) Review a Beacon User
2481
2481
  # Update the status of a Beacon User. When updating a Beacon User&#39;s status via this endpoint, Plaid validates that the status change is consistent with the related state for this Beacon User. Specifically, we will check: 1. Whether there are any associated Beacon Reports connected to the Beacon User, and 2. Whether there are any confirmed Beacon Report Syndications connected to the Beacon User. When updating a Beacon User&#39;s status to &#x60;rejected&#x60;, we enforce that either a Beacon Report has been created for the Beacon User or a Beacon Report Syndication has been confirmed. When updating a Beacon User&#39;s status to &#x60;cleared&#x60;, we enforce that there are no active Beacon Reports or confirmed Beacon Report Syndications associated with the user. If you previously created a Beacon Report for this user, you must delete it before updating the Beacon User&#39;s status to &#x60;cleared&#x60;. There are no restrictions on updating a Beacon User&#39;s status to &#x60;pending_review&#x60;. If these conditions are not met, the request will be rejected with an error explaining the issue.
2482
2482
  # @param beacon_user_review_request [BeaconUserReviewRequest]
2483
2483
  # @param [Hash] opts the optional parameters
@@ -2535,8 +2535,8 @@ module Plaid
2535
2535
  return data, status_code, headers
2536
2536
  end
2537
2537
 
2538
- # Update the identity data of a Beacon User
2539
- # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
2538
+ # (Deprecated) Update the identity data of a Beacon User
2539
+ # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to `/beacon/user/create`, several checks are performed immediately when you submit an identity data change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud reports shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
2540
2540
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2541
2541
  # @param [Hash] opts the optional parameters
2542
2542
  # @return [BeaconUserUpdateResponse]
@@ -2545,8 +2545,8 @@ module Plaid
2545
2545
  data
2546
2546
  end
2547
2547
 
2548
- # Update the identity data of a Beacon User
2549
- # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit an identity data change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
2548
+ # (Deprecated) Update the identity data of a Beacon User
2549
+ # Update the identity data for a Beacon User in your Beacon Program or add new accounts to the Beacon User. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit an identity data change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud reports shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
2550
2550
  # @param beacon_user_update_request [BeaconUserUpdateRequest]
2551
2551
  # @param [Hash] opts the optional parameters
2552
2552
  # @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
@@ -2604,7 +2604,7 @@ module Plaid
2604
2604
  end
2605
2605
 
2606
2606
  # Get EWA Score Report
2607
- # The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 199 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
2607
+ # The `/beta/ewa_report/v1/get` endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1-99 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
2608
2608
  # @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
2609
2609
  # @param [Hash] opts the optional parameters
2610
2610
  # @return [BetaEwaReportV1GetResponse]
@@ -2614,7 +2614,7 @@ module Plaid
2614
2614
  end
2615
2615
 
2616
2616
  # Get EWA Score Report
2617
- # The &#x60;/beta/ewa_report/v1/get&#x60; endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 199 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
2617
+ # The &#x60;/beta/ewa_report/v1/get&#x60; endpoint provides an Earned Wage Access (EWA) score that quantifies the delinquency risk associated with a given item. The score is derived from a combination of cashflow patterns and network-based behavioral features. The response returns a list of EWA scores, where each score corresponds to a potential advance amount range. These scores estimate the likelihood of repayment for advances within that range. Score range: 1-99 Interpretation: Higher scores indicate a greater likelihood of repayment. This endpoint enables clients to assess repayment risk and make data-driven decisions when determining eligibility or limits for earned wage advances.
2618
2618
  # @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
2619
2619
  # @param [Hash] opts the optional parameters
2620
2620
  # @return [Array<(BetaEwaReportV1GetResponse, Integer, Hash)>] BetaEwaReportV1GetResponse data, response status code and response headers
@@ -2943,7 +2943,7 @@ module Plaid
2943
2943
  return data, status_code, headers
2944
2944
  end
2945
2945
 
2946
- # Create a business verification
2946
+ # Create a Business Verification
2947
2947
  # Create a new business verification to check a business's identity and risk profile.
2948
2948
  # @param business_verification_create_request [BusinessVerificationCreateRequest]
2949
2949
  # @param [Hash] opts the optional parameters
@@ -2953,7 +2953,7 @@ module Plaid
2953
2953
  data
2954
2954
  end
2955
2955
 
2956
- # Create a business verification
2956
+ # Create a Business Verification
2957
2957
  # Create a new business verification to check a business&#39;s identity and risk profile.
2958
2958
  # @param business_verification_create_request [BusinessVerificationCreateRequest]
2959
2959
  # @param [Hash] opts the optional parameters
@@ -3011,7 +3011,7 @@ module Plaid
3011
3011
  return data, status_code, headers
3012
3012
  end
3013
3013
 
3014
- # Get a business verification
3014
+ # Get a Business Verification
3015
3015
  # Retrieve the current state of a specific business verification.
3016
3016
  # @param business_verification_get_request [BusinessVerificationGetRequest]
3017
3017
  # @param [Hash] opts the optional parameters
@@ -3021,7 +3021,7 @@ module Plaid
3021
3021
  data
3022
3022
  end
3023
3023
 
3024
- # Get a business verification
3024
+ # Get a Business Verification
3025
3025
  # Retrieve the current state of a specific business verification.
3026
3026
  # @param business_verification_get_request [BusinessVerificationGetRequest]
3027
3027
  # @param [Hash] opts the optional parameters
@@ -3080,7 +3080,7 @@ module Plaid
3080
3080
  end
3081
3081
 
3082
3082
  # Gets transaction data in `cashflow_report`
3083
- # The `/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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 `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
3083
+ # The `/cashflow_report/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. 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 `/cashflow_report/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 `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
3084
3084
  # @param cashflow_report_get_request [CashflowReportGetRequest]
3085
3085
  # @param [Hash] opts the optional parameters
3086
3086
  # @return [CashflowReportGetResponse]
@@ -3090,7 +3090,7 @@ module Plaid
3090
3090
  end
3091
3091
 
3092
3092
  # Gets transaction data in &#x60;cashflow_report&#x60;
3093
- # The &#x60;/cashflow_report/get&#x60; endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
3093
+ # The &#x60;/cashflow_report/get&#x60; endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. 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;/cashflow_report/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;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
3094
3094
  # @param cashflow_report_get_request [CashflowReportGetRequest]
3095
3095
  # @param [Hash] opts the optional parameters
3096
3096
  # @return [Array<(CashflowReportGetResponse, Integer, Hash)>] CashflowReportGetResponse data, response status code and response headers
@@ -3148,7 +3148,7 @@ module Plaid
3148
3148
  end
3149
3149
 
3150
3150
  # Gets insights data in Cashflow Report
3151
- # The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.
3151
+ # The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.
3152
3152
  # @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
3153
3153
  # @param [Hash] opts the optional parameters
3154
3154
  # @return [CashflowReportInsightsGetResponse]
@@ -3158,7 +3158,7 @@ module Plaid
3158
3158
  end
3159
3159
 
3160
3160
  # Gets insights data in Cashflow Report
3161
- # The &#x60;/cashflow_report/insights/get&#x60; endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.
3161
+ # The &#x60;/cashflow_report/insights/get&#x60; endpoint retrieves insights data associated with an Item. Insights are only calculated on credit and depository accounts.
3162
3162
  # @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
3163
3163
  # @param [Hash] opts the optional parameters
3164
3164
  # @return [Array<(CashflowReportInsightsGetResponse, Integer, Hash)>] CashflowReportInsightsGetResponse data, response status code and response headers
@@ -3216,7 +3216,7 @@ module Plaid
3216
3216
  end
3217
3217
 
3218
3218
  # Refresh transaction data in `cashflow_report`
3219
- # `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
3219
+ # `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item (given an `item_id`). The Item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
3220
3220
  # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
3221
3221
  # @param [Hash] opts the optional parameters
3222
3222
  # @return [CashflowReportRefreshResponse]
@@ -3226,7 +3226,7 @@ module Plaid
3226
3226
  end
3227
3227
 
3228
3228
  # Refresh transaction data in &#x60;cashflow_report&#x60;
3229
- # &#x60;/cashflow_report/refresh&#x60; is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an &#x60;item_id&#x60;). The item must already have Cashflow Report added as a product in order to call &#x60;/cashflow_report/refresh&#x60;. After calling &#x60;/cashflow_report/refresh&#x60;, Plaid will fire a webhook &#x60;CASHFLOW_REPORT_READY&#x60; alerting clients that new transactions data can then be ingested via &#x60;/cashflow_report/get&#x60; or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the &#x60;/cashflow_report/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
3229
+ # &#x60;/cashflow_report/refresh&#x60; is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an Item (given an &#x60;item_id&#x60;). The Item must already have Cashflow Report added as a product in order to call &#x60;/cashflow_report/refresh&#x60;. After calling &#x60;/cashflow_report/refresh&#x60;, Plaid will fire a webhook &#x60;CASHFLOW_REPORT_READY&#x60; alerting clients that new transactions data can then be ingested via &#x60;/cashflow_report/get&#x60; or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the &#x60;/cashflow_report/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
3230
3230
  # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
3231
3231
  # @param [Hash] opts the optional parameters
3232
3232
  # @return [Array<(CashflowReportRefreshResponse, Integer, Hash)>] CashflowReportRefreshResponse data, response status code and response headers
@@ -3283,8 +3283,8 @@ module Plaid
3283
3283
  return data, status_code, headers
3284
3284
  end
3285
3285
 
3286
- # Gets transaction data in cashflow_report
3287
- # The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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 `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
3286
+ # Gets transaction data in `cashflow_report`
3287
+ # The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. 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 `/cashflow_report/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 `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `cashflow_report`, or if it wasn't, upon the first call to `/cashflow_report/refresh`. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
3288
3288
  # @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
3289
3289
  # @param [Hash] opts the optional parameters
3290
3290
  # @return [CashflowReportTransactionsGetResponse]
@@ -3293,8 +3293,8 @@ module Plaid
3293
3293
  data
3294
3294
  end
3295
3295
 
3296
- # Gets transaction data in cashflow_report
3297
- # The &#x60;/cashflow_report/transactions/get&#x60; endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. 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;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
3296
+ # Gets transaction data in &#x60;cashflow_report&#x60;
3297
+ # The &#x60;/cashflow_report/transactions/get&#x60; endpoint retrieves transactions data associated with an Item. Transactions data is standardized across financial institutions. 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;/cashflow_report/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;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;cashflow_report&#x60;, or if it wasn&#39;t, upon the first call to &#x60;/cashflow_report/refresh&#x60;. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
3298
3298
  # @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
3299
3299
  # @param [Hash] opts the optional parameters
3300
3300
  # @return [Array<(CashflowReportTransactionsGetResponse, Integer, Hash)>] CashflowReportTransactionsGetResponse data, response status code and response headers
@@ -3487,7 +3487,7 @@ module Plaid
3487
3487
  return data, status_code, headers
3488
3488
  end
3489
3489
 
3490
- # Retrieve a PDF Reports
3490
+ # Retrieve PDF Reports
3491
3491
  # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
3492
3492
  # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
3493
3493
  # @param [Hash] opts the optional parameters
@@ -3497,7 +3497,7 @@ module Plaid
3497
3497
  data
3498
3498
  end
3499
3499
 
3500
- # Retrieve a PDF Reports
3500
+ # Retrieve PDF Reports
3501
3501
  # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
3502
3502
  # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
3503
3503
  # @param [Hash] opts the optional parameters
@@ -3604,7 +3604,7 @@ module Plaid
3604
3604
  return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'
3605
3605
 
3606
3606
  # auth_names
3607
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3607
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
3608
3608
 
3609
3609
  new_options = opts.merge(
3610
3610
  :operation => :"PlaidApi.cra_check_report_base_report_get",
@@ -3624,7 +3624,7 @@ module Plaid
3624
3624
  end
3625
3625
 
3626
3626
  # Retrieve cash flow insights from your user's banking data
3627
- # This endpoint allows you to retrieve the Cashflow 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 doesnt have sufficient data to generate the insights, 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`. If you did not initialize Link with the `cra_cashflow_insights` product or have generated a report using `/cra/check_report/create`, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
3627
+ # This endpoint allows you to retrieve the Cashflow 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 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`.
3628
3628
  # @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
3629
3629
  # @param [Hash] opts the optional parameters
3630
3630
  # @return [CraCheckReportCashflowInsightsGetResponse]
@@ -3634,7 +3634,7 @@ module Plaid
3634
3634
  end
3635
3635
 
3636
3636
  # Retrieve cash flow insights from your user&#39;s banking data
3637
- # This endpoint allows you to retrieve the Cashflow 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 doesnt have sufficient data to generate the insights, 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;. If you did not initialize Link with the &#x60;cra_cashflow_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
3637
+ # This endpoint allows you to retrieve the Cashflow 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&#39;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;.
3638
3638
  # @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
3639
3639
  # @param [Hash] opts the optional parameters
3640
3640
  # @return [Array<(CraCheckReportCashflowInsightsGetResponse, Integer, Hash)>] CraCheckReportCashflowInsightsGetResponse data, response status code and response headers
@@ -3672,7 +3672,7 @@ module Plaid
3672
3672
  return_type = opts[:debug_return_type] || 'CraCheckReportCashflowInsightsGetResponse'
3673
3673
 
3674
3674
  # auth_names
3675
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3675
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
3676
3676
 
3677
3677
  new_options = opts.merge(
3678
3678
  :operation => :"PlaidApi.cra_check_report_cashflow_insights_get",
@@ -3759,8 +3759,8 @@ module Plaid
3759
3759
  return data, status_code, headers
3760
3760
  end
3761
3761
 
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 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 doesnt 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).
3762
+ # Retrieve income insights 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 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]
@@ -3769,8 +3769,8 @@ module Plaid
3769
3769
  data
3770
3770
  end
3771
3771
 
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 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 doesnt 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).
3772
+ # Retrieve income insights 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&#39;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;. 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
@@ -3808,7 +3808,7 @@ module Plaid
3808
3808
  return_type = opts[:debug_return_type] || 'CraCheckReportIncomeInsightsGetResponse'
3809
3809
 
3810
3810
  # auth_names
3811
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3811
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
3812
3812
 
3813
3813
  new_options = opts.merge(
3814
3814
  :operation => :"PlaidApi.cra_check_report_income_insights_get",
@@ -3828,7 +3828,7 @@ module Plaid
3828
3828
  end
3829
3829
 
3830
3830
  # Retrieve the LendScore from your user's banking data
3831
- # This endpoint allows you to retrieve the LendScore 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 doesnt have sufficient data to generate the insights, 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`. If you did not initialize Link with the `cra_lend_score` product or call `/cra/check_report/create` with the `cra_lend_score` product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
3831
+ # This endpoint allows you to retrieve the LendScore 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 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`.
3832
3832
  # @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
3833
3833
  # @param [Hash] opts the optional parameters
3834
3834
  # @return [CraCheckReportLendScoreGetResponse]
@@ -3838,7 +3838,7 @@ module Plaid
3838
3838
  end
3839
3839
 
3840
3840
  # Retrieve the LendScore from your user&#39;s banking data
3841
- # This endpoint allows you to retrieve the LendScore 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 doesnt have sufficient data to generate the insights, 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;. If you did not initialize Link with the &#x60;cra_lend_score&#x60; product or call &#x60;/cra/check_report/create&#x60; with the &#x60;cra_lend_score&#x60; product, Plaid will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
3841
+ # This endpoint allows you to retrieve the LendScore 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&#39;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;.
3842
3842
  # @param cra_check_report_lend_score_get_request [CraCheckReportLendScoreGetRequest]
3843
3843
  # @param [Hash] opts the optional parameters
3844
3844
  # @return [Array<(CraCheckReportLendScoreGetResponse, Integer, Hash)>] CraCheckReportLendScoreGetResponse data, response status code and response headers
@@ -3876,7 +3876,7 @@ module Plaid
3876
3876
  return_type = opts[:debug_return_type] || 'CraCheckReportLendScoreGetResponse'
3877
3877
 
3878
3878
  # auth_names
3879
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3879
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
3880
3880
 
3881
3881
  new_options = opts.merge(
3882
3882
  :operation => :"PlaidApi.cra_check_report_lend_score_get",
@@ -3896,7 +3896,7 @@ module Plaid
3896
3896
  end
3897
3897
 
3898
3898
  # Retrieve network attributes for the user
3899
- # This endpoint allows you to retrieve the Network Insights product 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 doesnt 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`. If you did not initialize Link with the `cra_network_attributes` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
3899
+ # This endpoint allows you to retrieve the Network 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 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`.
3900
3900
  # @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
3901
3901
  # @param [Hash] opts the optional parameters
3902
3902
  # @return [CraCheckReportNetworkInsightsGetResponse]
@@ -3906,7 +3906,7 @@ module Plaid
3906
3906
  end
3907
3907
 
3908
3908
  # Retrieve network attributes for the user
3909
- # This endpoint allows you to retrieve the Network Insights product 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 doesnt 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;. If you did not initialize Link with the &#x60;cra_network_attributes&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, Plaid will generate the attributes when you call this endpoint.
3909
+ # This endpoint allows you to retrieve the Network 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&#39;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;.
3910
3910
  # @param cra_check_report_network_insights_get_request [CraCheckReportNetworkInsightsGetRequest]
3911
3911
  # @param [Hash] opts the optional parameters
3912
3912
  # @return [Array<(CraCheckReportNetworkInsightsGetResponse, Integer, Hash)>] CraCheckReportNetworkInsightsGetResponse data, response status code and response headers
@@ -3944,7 +3944,7 @@ module Plaid
3944
3944
  return_type = opts[:debug_return_type] || 'CraCheckReportNetworkInsightsGetResponse'
3945
3945
 
3946
3946
  # auth_names
3947
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3947
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
3948
3948
 
3949
3949
  new_options = opts.merge(
3950
3950
  :operation => :"PlaidApi.cra_check_report_network_insights_get",
@@ -3964,7 +3964,7 @@ module Plaid
3964
3964
  end
3965
3965
 
3966
3966
  # Retrieve cash flow insights from partners
3967
- # This endpoint allows you to retrieve the Partner 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 doesnt 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`. If you did not initialize Link with the `credit_partner_insights` product or have generated a report using `/cra/check_report/create`, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
3967
+ # This endpoint allows you to retrieve the Partner 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 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`.
3968
3968
  # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
3969
3969
  # @param [Hash] opts the optional parameters
3970
3970
  # @return [CraCheckReportPartnerInsightsGetResponse]
@@ -3974,7 +3974,7 @@ module Plaid
3974
3974
  end
3975
3975
 
3976
3976
  # Retrieve cash flow insights from partners
3977
- # This endpoint allows you to retrieve the Partner 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 doesnt 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;. If you did not initialize Link with the &#x60;credit_partner_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will call our partners to generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
3977
+ # This endpoint allows you to retrieve the Partner 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&#39;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;.
3978
3978
  # @param cra_check_report_partner_insights_get_request [CraCheckReportPartnerInsightsGetRequest]
3979
3979
  # @param [Hash] opts the optional parameters
3980
3980
  # @return [Array<(CraCheckReportPartnerInsightsGetResponse, Integer, Hash)>] CraCheckReportPartnerInsightsGetResponse data, response status code and response headers
@@ -4031,7 +4031,7 @@ module Plaid
4031
4031
  return data, status_code, headers
4032
4032
  end
4033
4033
 
4034
- # Retrieve Consumer Reports as a PDF
4034
+ # Retrieve a Consumer Report as a PDF
4035
4035
  # `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Partner Insights or Income Insights report be included in the PDF as well, use the `add-ons` field.
4036
4036
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
4037
4037
  # @param [Hash] opts the optional parameters
@@ -4041,7 +4041,7 @@ module Plaid
4041
4041
  data
4042
4042
  end
4043
4043
 
4044
- # Retrieve Consumer Reports as a PDF
4044
+ # Retrieve a Consumer Report as a PDF
4045
4045
  # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Consumer Report in PDF format. By default, the most recent Base Report (if it exists) for the user will be returned. To request that the most recent Partner Insights or Income Insights report be included in the PDF as well, use the &#x60;add-ons&#x60; field.
4046
4046
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
4047
4047
  # @param [Hash] opts the optional parameters
@@ -4099,8 +4099,8 @@ module Plaid
4099
4099
  return data, status_code, headers
4100
4100
  end
4101
4101
 
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 doesnt 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`.\"
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`.
4104
4104
  # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
4105
4105
  # @param [Hash] opts the optional parameters
4106
4106
  # @return [CraCheckReportVerificationGetResponse]
@@ -4109,8 +4109,8 @@ module Plaid
4109
4109
  data
4110
4110
  end
4111
4111
 
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 doesnt 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;
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&#39;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;.
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
@@ -4167,7 +4167,7 @@ module Plaid
4167
4167
  return data, status_code, headers
4168
4168
  end
4169
4169
 
4170
- # Retrieve Consumer Reports as a Verification PDF
4170
+ # Retrieve a Consumer Report as a Verification PDF
4171
4171
  # The `/cra/check_report/verification/pdf/get` endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you've created a VOA report through Link or the `/cra/check_report/create` endpoint, and have received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook. The response to `/cra/check_report/verification/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
4172
4172
  # @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
4173
4173
  # @param [Hash] opts the optional parameters
@@ -4177,7 +4177,7 @@ module Plaid
4177
4177
  data
4178
4178
  end
4179
4179
 
4180
- # Retrieve Consumer Reports as a Verification PDF
4180
+ # Retrieve a Consumer Report as a Verification PDF
4181
4181
  # The &#x60;/cra/check_report/verification/pdf/get&#x60; endpoint retrieves the most recent Consumer Report in PDF format, specifically formatted for Home Lending verification use cases. Before calling this endpoint, ensure that you&#39;ve created a VOA report through Link or the &#x60;/cra/check_report/create&#x60; endpoint, and have received a &#x60;CHECK_REPORT_READY&#x60; or a &#x60;USER_CHECK_REPORT_READY&#x60; webhook. The response to &#x60;/cra/check_report/verification/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
4182
4182
  # @param cra_check_report_verification_pdf_get_request [CraCheckReportVerificationPdfGetRequest]
4183
4183
  # @param [Hash] opts the optional parameters
@@ -4303,7 +4303,7 @@ module Plaid
4303
4303
  return data, status_code, headers
4304
4304
  end
4305
4305
 
4306
- # Register loan applications and decisions.
4306
+ # Register loan applications and decisions
4307
4307
  # `/cra/loans/applications/register` registers loan applications and decisions.
4308
4308
  # @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
4309
4309
  # @param [Hash] opts the optional parameters
@@ -4313,7 +4313,7 @@ module Plaid
4313
4313
  data
4314
4314
  end
4315
4315
 
4316
- # Register loan applications and decisions.
4316
+ # Register loan applications and decisions
4317
4317
  # &#x60;/cra/loans/applications/register&#x60; registers loan applications and decisions.
4318
4318
  # @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
4319
4319
  # @param [Hash] opts the optional parameters
@@ -4371,7 +4371,7 @@ module Plaid
4371
4371
  return data, status_code, headers
4372
4372
  end
4373
4373
 
4374
- # Register a list of loans to their applicants.
4374
+ # Register a list of loans to their applicants
4375
4375
  # `/cra/loans/register` registers a list of loans to their applicants.
4376
4376
  # @param cra_loans_register_request [CRALoansRegisterRequest]
4377
4377
  # @param [Hash] opts the optional parameters
@@ -4381,7 +4381,7 @@ module Plaid
4381
4381
  data
4382
4382
  end
4383
4383
 
4384
- # Register a list of loans to their applicants.
4384
+ # Register a list of loans to their applicants
4385
4385
  # &#x60;/cra/loans/register&#x60; registers a list of loans to their applicants.
4386
4386
  # @param cra_loans_register_request [CRALoansRegisterRequest]
4387
4387
  # @param [Hash] opts the optional parameters
@@ -4439,7 +4439,7 @@ module Plaid
4439
4439
  return data, status_code, headers
4440
4440
  end
4441
4441
 
4442
- # Unregister a list of loans.
4442
+ # Unregister a list of loans
4443
4443
  # `/cra/loans/unregister` indicates the loans have reached a final status and no further updates are expected.
4444
4444
  # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
4445
4445
  # @param [Hash] opts the optional parameters
@@ -4449,7 +4449,7 @@ module Plaid
4449
4449
  data
4450
4450
  end
4451
4451
 
4452
- # Unregister a list of loans.
4452
+ # Unregister a list of loans
4453
4453
  # &#x60;/cra/loans/unregister&#x60; indicates the loans have reached a final status and no further updates are expected.
4454
4454
  # @param cra_loans_unregister_request [CraLoansUnregisterRequest]
4455
4455
  # @param [Hash] opts the optional parameters
@@ -4507,7 +4507,7 @@ module Plaid
4507
4507
  return data, status_code, headers
4508
4508
  end
4509
4509
 
4510
- # Updates loan data.
4510
+ # Update loan data
4511
4511
  # `/cra/loans/update` updates loan information such as the status and payment history.
4512
4512
  # @param cra_loans_update_request [CraLoansUpdateRequest]
4513
4513
  # @param [Hash] opts the optional parameters
@@ -4517,7 +4517,7 @@ module Plaid
4517
4517
  data
4518
4518
  end
4519
4519
 
4520
- # Updates loan data.
4520
+ # Update loan data
4521
4521
  # &#x60;/cra/loans/update&#x60; updates loan information such as the status and payment history.
4522
4522
  # @param cra_loans_update_request [CraLoansUpdateRequest]
4523
4523
  # @param [Hash] opts the optional parameters
@@ -4847,8 +4847,76 @@ module Plaid
4847
4847
  return data, status_code, headers
4848
4848
  end
4849
4849
 
4850
+ # Retrieve a CRA Report for provided user
4851
+ # `/cra/report/get` retrieves a CRA Report for a user.
4852
+ # @param cra_report_get_request [CraReportGetRequest]
4853
+ # @param [Hash] opts the optional parameters
4854
+ # @return [CraReportGetResponse]
4855
+ def cra_report_get(cra_report_get_request, opts = {})
4856
+ data, _status_code, _headers = cra_report_get_with_http_info(cra_report_get_request, opts)
4857
+ data
4858
+ end
4859
+
4860
+ # Retrieve a CRA Report for provided user
4861
+ # &#x60;/cra/report/get&#x60; retrieves a CRA Report for a user.
4862
+ # @param cra_report_get_request [CraReportGetRequest]
4863
+ # @param [Hash] opts the optional parameters
4864
+ # @return [Array<(CraReportGetResponse, Integer, Hash)>] CraReportGetResponse data, response status code and response headers
4865
+ def cra_report_get_with_http_info(cra_report_get_request, opts = {})
4866
+ if @api_client.config.debugging
4867
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_report_get ...'
4868
+ end
4869
+ # verify the required parameter 'cra_report_get_request' is set
4870
+ if @api_client.config.client_side_validation && cra_report_get_request.nil?
4871
+ fail ArgumentError, "Missing the required parameter 'cra_report_get_request' when calling PlaidApi.cra_report_get"
4872
+ end
4873
+ # resource path
4874
+ local_var_path = '/cra/report/get'
4875
+
4876
+ # query parameters
4877
+ query_params = opts[:query_params] || {}
4878
+
4879
+ # header parameters
4880
+ header_params = opts[:header_params] || {}
4881
+ # HTTP header 'Accept' (if needed)
4882
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4883
+ # HTTP header 'Content-Type'
4884
+ content_type = @api_client.select_header_content_type(['application/json'])
4885
+ if !content_type.nil?
4886
+ header_params['Content-Type'] = content_type
4887
+ end
4888
+
4889
+ # form parameters
4890
+ form_params = opts[:form_params] || {}
4891
+
4892
+ # http body (model)
4893
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_report_get_request)
4894
+
4895
+ # return_type
4896
+ return_type = opts[:debug_return_type] || 'CraReportGetResponse'
4897
+
4898
+ # auth_names
4899
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4900
+
4901
+ new_options = opts.merge(
4902
+ :operation => :"PlaidApi.cra_report_get",
4903
+ :header_params => header_params,
4904
+ :query_params => query_params,
4905
+ :form_params => form_params,
4906
+ :body => post_body,
4907
+ :auth_names => auth_names,
4908
+ :return_type => return_type
4909
+ )
4910
+
4911
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4912
+ if @api_client.config.debugging
4913
+ @api_client.config.logger.debug "API called: PlaidApi#cra_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4914
+ end
4915
+ return data, status_code, headers
4916
+ end
4917
+
4850
4918
  # Create payment token
4851
- # The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
4919
+ # The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` endpoint is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
4852
4920
  # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
4853
4921
  # @param [Hash] opts the optional parameters
4854
4922
  # @return [PaymentInitiationPaymentTokenCreateResponse]
@@ -4858,7 +4926,7 @@ module Plaid
4858
4926
  end
4859
4927
 
4860
4928
  # Create payment token
4861
- # The &#x60;/payment_initiation/payment/token/create&#x60; endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, &#x60;link_token&#x60;-based flow. The recommended flow is to provide the &#x60;payment_id&#x60; to &#x60;/link/token/create&#x60;, which returns a &#x60;link_token&#x60; used to initialize Link. The &#x60;/payment_initiation/payment/token/create&#x60; is used to create a &#x60;payment_token&#x60;, which can then be used in Link initialization to enter a payment initiation flow. You can only use a &#x60;payment_token&#x60; once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
4929
+ # The &#x60;/payment_initiation/payment/token/create&#x60; endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, &#x60;link_token&#x60;-based flow. The recommended flow is to provide the &#x60;payment_id&#x60; to &#x60;/link/token/create&#x60;, which returns a &#x60;link_token&#x60; used to initialize Link. The &#x60;/payment_initiation/payment/token/create&#x60; endpoint is used to create a &#x60;payment_token&#x60;, which can then be used in Link initialization to enter a payment initiation flow. You can only use a &#x60;payment_token&#x60; once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
4862
4930
  # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
4863
4931
  # @param [Hash] opts the optional parameters
4864
4932
  # @return [Array<(PaymentInitiationPaymentTokenCreateResponse, Integer, Hash)>] PaymentInitiationPaymentTokenCreateResponse data, response status code and response headers
@@ -4916,7 +4984,7 @@ module Plaid
4916
4984
  end
4917
4985
 
4918
4986
  # Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
4919
- # The `credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
4987
+ # The `/credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
4920
4988
  # @param request_body [Hash<String, Object>]
4921
4989
  # @param [Hash] opts the optional parameters
4922
4990
  # @return [AssetReportFreddieGetResponse]
@@ -4926,7 +4994,7 @@ module Plaid
4926
4994
  end
4927
4995
 
4928
4996
  # Retrieve an Asset Report with Freddie Mac format. Only Freddie Mac can use this endpoint.
4929
- # The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Asset Report in Freddie Mac&#39;s JSON format.
4997
+ # The &#x60;/credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Asset Report in Freddie Mac&#39;s JSON format.
4930
4998
  # @param request_body [Hash<String, Object>]
4931
4999
  # @param [Hash] opts the optional parameters
4932
5000
  # @return [Array<(AssetReportFreddieGetResponse, Integer, Hash)>] AssetReportFreddieGetResponse data, response status code and response headers
@@ -4984,7 +5052,7 @@ module Plaid
4984
5052
  end
4985
5053
 
4986
5054
  # Create Asset or Income Report Audit Copy Token
4987
- # 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.
5055
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government-Sponsored Enterprise (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.
4988
5056
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4989
5057
  # @param [Hash] opts the optional parameters
4990
5058
  # @return [CreditAuditCopyTokenCreateResponse]
@@ -4994,7 +5062,7 @@ module Plaid
4994
5062
  end
4995
5063
 
4996
5064
  # Create Asset or Income Report Audit Copy Token
4997
- # 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.
5065
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with a participating Government-Sponsored Enterprise (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.
4998
5066
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4999
5067
  # @param [Hash] opts the optional parameters
5000
5068
  # @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
@@ -5052,7 +5120,7 @@ module Plaid
5052
5120
  end
5053
5121
 
5054
5122
  # Update an Audit Copy Token
5055
- # The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
5123
+ # The `/credit/audit_copy_token/update` endpoint updates an existing Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
5056
5124
  # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
5057
5125
  # @param [Hash] opts the optional parameters
5058
5126
  # @return [CreditAuditCopyTokenUpdateResponse]
@@ -5062,7 +5130,7 @@ module Plaid
5062
5130
  end
5063
5131
 
5064
5132
  # Update an Audit Copy Token
5065
- # The &#x60;/credit/audit_copy_token/update&#x60; endpoint updates an existing Audit Copy Token by adding the report tokens in the &#x60;report_tokens&#x60; field to the &#x60;audit_copy_token&#x60;. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the &#x60;report_tokens&#x60; field.
5133
+ # The &#x60;/credit/audit_copy_token/update&#x60; endpoint updates an existing Audit Copy Token by adding the report tokens in the &#x60;report_tokens&#x60; field to the &#x60;audit_copy_token&#x60;. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the &#x60;report_tokens&#x60; field.
5066
5134
  # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
5067
5135
  # @param [Hash] opts the optional parameters
5068
5136
  # @return [Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>] CreditAuditCopyTokenUpdateResponse data, response status code and response headers
@@ -5120,7 +5188,7 @@ module Plaid
5120
5188
  end
5121
5189
 
5122
5190
  # Retrieve information from the bank accounts used for employment verification
5123
- # `/credit/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
5191
+ # `/beta/credit/v1/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
5124
5192
  # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
5125
5193
  # @param [Hash] opts the optional parameters
5126
5194
  # @return [CreditBankEmploymentGetResponse]
@@ -5130,7 +5198,7 @@ module Plaid
5130
5198
  end
5131
5199
 
5132
5200
  # Retrieve information from the bank accounts used for employment verification
5133
- # &#x60;/credit/bank_employment/get&#x60; returns the employment report(s) derived from bank transaction data for a specified user.
5201
+ # &#x60;/beta/credit/v1/bank_employment/get&#x60; returns the employment report(s) derived from bank transaction data for a specified user.
5134
5202
  # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
5135
5203
  # @param [Hash] opts the optional parameters
5136
5204
  # @return [Array<(CreditBankEmploymentGetResponse, Integer, Hash)>] CreditBankEmploymentGetResponse data, response status code and response headers
@@ -5324,7 +5392,7 @@ module Plaid
5324
5392
  end
5325
5393
 
5326
5394
  # Refresh a user's bank income information
5327
- # `/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link Update Mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call `/cra/check_report/create`.
5395
+ # `/credit/bank_income/refresh` is deprecated. The backend implementation was removed (returns an `Unimplemented` error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link's update mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call `/cra/check_report/create`.
5328
5396
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
5329
5397
  # @param [Hash] opts the optional parameters
5330
5398
  # @return [CreditBankIncomeRefreshResponse]
@@ -5334,7 +5402,7 @@ module Plaid
5334
5402
  end
5335
5403
 
5336
5404
  # Refresh a user&#39;s bank income information
5337
- # &#x60;/credit/bank_income/refresh&#x60; is deprecated. The backend implementation was removed (returns an &#x60;Unimplemented&#x60; error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link Update Mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call &#x60;/cra/check_report/create&#x60;.
5405
+ # &#x60;/credit/bank_income/refresh&#x60; is deprecated. The backend implementation was removed (returns an &#x60;Unimplemented&#x60; error at runtime), and the endpoint is no longer part of the documented API surface. To refresh Bank Income data for an existing user, send the user through Link&#39;s update mode so they can confirm their income sources. For a fully backend refresh, migrate to CRA Income Insights and call &#x60;/cra/check_report/create&#x60;.
5338
5406
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
5339
5407
  # @param [Hash] opts the optional parameters
5340
5408
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
@@ -5596,7 +5664,7 @@ module Plaid
5596
5664
  end
5597
5665
 
5598
5666
  # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
5599
- # The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
5667
+ # The `/credit/freddie_mac/reports/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
5600
5668
  # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
5601
5669
  # @param [Hash] opts the optional parameters
5602
5670
  # @return [CreditFreddieMacReportsGetResponse]
@@ -5606,7 +5674,7 @@ module Plaid
5606
5674
  end
5607
5675
 
5608
5676
  # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
5609
- # The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.
5677
+ # The &#x60;/credit/freddie_mac/reports/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.
5610
5678
  # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
5611
5679
  # @param [Hash] opts the optional parameters
5612
5680
  # @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
@@ -6139,8 +6207,8 @@ module Plaid
6139
6207
  return data, status_code, headers
6140
6208
  end
6141
6209
 
6142
- # Retrieve the pdf reports associated with a relay token that was shared with you (beta)
6143
- # `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
6210
+ # Retrieve the PDF reports associated with a relay token that was shared with you (beta)
6211
+ # `/credit/relay/pdf/get` allows third parties to receive a PDF report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
6144
6212
  # @param credit_relay_pdf_get_request [CreditRelayPDFGetRequest]
6145
6213
  # @param [Hash] opts the optional parameters
6146
6214
  # @return [File]
@@ -6149,8 +6217,8 @@ module Plaid
6149
6217
  data
6150
6218
  end
6151
6219
 
6152
- # Retrieve the pdf reports associated with a relay token that was shared with you (beta)
6153
- # &#x60;/credit/relay/pdf/get&#x60; allows third parties to receive a pdf report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner. The &#x60;/credit/relay/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/credit/relay/pdf/get&#x60;, you must first create the Asset Report using &#x60;/credit/relay/create&#x60; and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/credit/relay/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
6220
+ # Retrieve the PDF reports associated with a relay token that was shared with you (beta)
6221
+ # &#x60;/credit/relay/pdf/get&#x60; allows third parties to receive a PDF report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner. The &#x60;/credit/relay/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/credit/relay/pdf/get&#x60;, you must first create the Asset Report using &#x60;/credit/relay/create&#x60; and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/credit/relay/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
6154
6222
  # @param credit_relay_pdf_get_request [CreditRelayPDFGetRequest]
6155
6223
  # @param [Hash] opts the optional parameters
6156
6224
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -6479,7 +6547,7 @@ module Plaid
6479
6547
  return data, status_code, headers
6480
6548
  end
6481
6549
 
6482
- # Retrieve a dashboard user
6550
+ # Retrieve a Dashboard user
6483
6551
  # The `/dashboard_user/get` endpoint provides details (such as email address) about a specific Dashboard user based on the `dashboard_user_id` field, which is returned in the `audit_trail` object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
6484
6552
  # @param dashboard_user_get_request [DashboardUserGetRequest]
6485
6553
  # @param [Hash] opts the optional parameters
@@ -6489,7 +6557,7 @@ module Plaid
6489
6557
  data
6490
6558
  end
6491
6559
 
6492
- # Retrieve a dashboard user
6560
+ # Retrieve a Dashboard user
6493
6561
  # The &#x60;/dashboard_user/get&#x60; endpoint provides details (such as email address) about a specific Dashboard user based on the &#x60;dashboard_user_id&#x60; field, which is returned in the &#x60;audit_trail&#x60; object of certain Monitor and Beacon endpoints. This can be used to identify the specific reviewer who performed a Dashboard action.
6494
6562
  # @param dashboard_user_get_request [DashboardUserGetRequest]
6495
6563
  # @param [Hash] opts the optional parameters
@@ -6547,8 +6615,8 @@ module Plaid
6547
6615
  return data, status_code, headers
6548
6616
  end
6549
6617
 
6550
- # List dashboard users
6551
- # The `/dashboard_user/list` endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
6618
+ # List Dashboard users
6619
+ # The `/dashboard_user/list` endpoint provides details (such as email address) about all Dashboard users associated with your account. This can be used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
6552
6620
  # @param dashboard_user_list_request [DashboardUserListRequest]
6553
6621
  # @param [Hash] opts the optional parameters
6554
6622
  # @return [DashboardUserListResponse]
@@ -6557,8 +6625,8 @@ module Plaid
6557
6625
  data
6558
6626
  end
6559
6627
 
6560
- # List dashboard users
6561
- # The &#x60;/dashboard_user/list&#x60; endpoint provides details (such as email address) all Dashboard users associated with your account. This can use used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
6628
+ # List Dashboard users
6629
+ # The &#x60;/dashboard_user/list&#x60; endpoint provides details (such as email address) about all Dashboard users associated with your account. This can be used to audit or track the list of reviewers for Monitor, Beacon, and Identity Verification products.
6562
6630
  # @param dashboard_user_list_request [DashboardUserListRequest]
6563
6631
  # @param [Hash] opts the optional parameters
6564
6632
  # @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
@@ -6615,8 +6683,8 @@ module Plaid
6615
6683
  return data, status_code, headers
6616
6684
  end
6617
6685
 
6618
- # Search employer database
6619
- # `/employers/search` allows you the ability to search Plaids database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6686
+ # (Deprecated) Search employer database
6687
+ # `/employers/search` allows you the ability to search Plaid's database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6620
6688
  # @param employers_search_request [EmployersSearchRequest]
6621
6689
  # @param [Hash] opts the optional parameters
6622
6690
  # @return [EmployersSearchResponse]
@@ -6625,8 +6693,8 @@ module Plaid
6625
6693
  data
6626
6694
  end
6627
6695
 
6628
- # Search employer database
6629
- # &#x60;/employers/search&#x60; allows you the ability to search Plaids database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6696
+ # (Deprecated) Search employer database
6697
+ # &#x60;/employers/search&#x60; allows you the ability to search Plaid&#39;s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6630
6698
  # @param employers_search_request [EmployersSearchRequest]
6631
6699
  # @param [Hash] opts the optional parameters
6632
6700
  # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
@@ -6751,6 +6819,273 @@ module Plaid
6751
6819
  return data, status_code, headers
6752
6820
  end
6753
6821
 
6822
+ # Get FDX Consent Grant
6823
+ # Returns a consent grant by its identifier
6824
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6825
+ # @param [Hash] opts the optional parameters
6826
+ # @return [FDXConsentGrant]
6827
+ def fdx_consents_get(consent_id, opts = {})
6828
+ data, _status_code, _headers = fdx_consents_get_with_http_info(consent_id, opts)
6829
+ data
6830
+ end
6831
+
6832
+ # Get FDX Consent Grant
6833
+ # Returns a consent grant by its identifier
6834
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6835
+ # @param [Hash] opts the optional parameters
6836
+ # @return [Array<(FDXConsentGrant, Integer, Hash)>] FDXConsentGrant data, response status code and response headers
6837
+ def fdx_consents_get_with_http_info(consent_id, opts = {})
6838
+ if @api_client.config.debugging
6839
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_get ...'
6840
+ end
6841
+ # verify the required parameter 'consent_id' is set
6842
+ if @api_client.config.client_side_validation && consent_id.nil?
6843
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_get"
6844
+ end
6845
+ # resource path
6846
+ local_var_path = '/fdx/consents/{consentId}'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
6847
+
6848
+ # query parameters
6849
+ query_params = opts[:query_params] || {}
6850
+
6851
+ # header parameters
6852
+ header_params = opts[:header_params] || {}
6853
+ # HTTP header 'Accept' (if needed)
6854
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6855
+
6856
+ # form parameters
6857
+ form_params = opts[:form_params] || {}
6858
+
6859
+ # http body (model)
6860
+ post_body = opts[:debug_body]
6861
+
6862
+ # return_type
6863
+ return_type = opts[:debug_return_type] || 'FDXConsentGrant'
6864
+
6865
+ # auth_names
6866
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6867
+
6868
+ new_options = opts.merge(
6869
+ :operation => :"PlaidApi.fdx_consents_get",
6870
+ :header_params => header_params,
6871
+ :query_params => query_params,
6872
+ :form_params => form_params,
6873
+ :body => post_body,
6874
+ :auth_names => auth_names,
6875
+ :return_type => return_type
6876
+ )
6877
+
6878
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6879
+ if @api_client.config.debugging
6880
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6881
+ end
6882
+ return data, status_code, headers
6883
+ end
6884
+
6885
+ # List FDX Consent Grants for a customer
6886
+ # Returns zero or more consent grants associated with the given data provider customer, optionally filtered by status.
6887
+ # @param customer_id [String] Data provider customer identifier whose consent grants to return.
6888
+ # @param [Hash] opts the optional parameters
6889
+ # @option opts [FDXConsentGrantStatus] :status Optional filter restricting results to a single consent grant status. One of &#x60;ACTIVE&#x60;, &#x60;REVOKED&#x60;, &#x60;EXPIRED&#x60;.
6890
+ # @return [GetConsentsResponse]
6891
+ def fdx_consents_list(customer_id, opts = {})
6892
+ data, _status_code, _headers = fdx_consents_list_with_http_info(customer_id, opts)
6893
+ data
6894
+ end
6895
+
6896
+ # List FDX Consent Grants for a customer
6897
+ # Returns zero or more consent grants associated with the given data provider customer, optionally filtered by status.
6898
+ # @param customer_id [String] Data provider customer identifier whose consent grants to return.
6899
+ # @param [Hash] opts the optional parameters
6900
+ # @option opts [FDXConsentGrantStatus] :status Optional filter restricting results to a single consent grant status. One of &#x60;ACTIVE&#x60;, &#x60;REVOKED&#x60;, &#x60;EXPIRED&#x60;.
6901
+ # @return [Array<(GetConsentsResponse, Integer, Hash)>] GetConsentsResponse data, response status code and response headers
6902
+ def fdx_consents_list_with_http_info(customer_id, opts = {})
6903
+ if @api_client.config.debugging
6904
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_list ...'
6905
+ end
6906
+ # verify the required parameter 'customer_id' is set
6907
+ if @api_client.config.client_side_validation && customer_id.nil?
6908
+ fail ArgumentError, "Missing the required parameter 'customer_id' when calling PlaidApi.fdx_consents_list"
6909
+ end
6910
+ # resource path
6911
+ local_var_path = '/fdx/consents'
6912
+
6913
+ # query parameters
6914
+ query_params = opts[:query_params] || {}
6915
+ query_params[:'customerId'] = customer_id
6916
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
6917
+
6918
+ # header parameters
6919
+ header_params = opts[:header_params] || {}
6920
+ # HTTP header 'Accept' (if needed)
6921
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6922
+
6923
+ # form parameters
6924
+ form_params = opts[:form_params] || {}
6925
+
6926
+ # http body (model)
6927
+ post_body = opts[:debug_body]
6928
+
6929
+ # return_type
6930
+ return_type = opts[:debug_return_type] || 'GetConsentsResponse'
6931
+
6932
+ # auth_names
6933
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6934
+
6935
+ new_options = opts.merge(
6936
+ :operation => :"PlaidApi.fdx_consents_list",
6937
+ :header_params => header_params,
6938
+ :query_params => query_params,
6939
+ :form_params => form_params,
6940
+ :body => post_body,
6941
+ :auth_names => auth_names,
6942
+ :return_type => return_type
6943
+ )
6944
+
6945
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6946
+ if @api_client.config.debugging
6947
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6948
+ end
6949
+ return data, status_code, headers
6950
+ end
6951
+
6952
+ # Retrieve FDX Consent Grant revocation records
6953
+ # Returns the revocation history of a consent grant
6954
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6955
+ # @param [Hash] opts the optional parameters
6956
+ # @return [FDXConsentRevocations]
6957
+ def fdx_consents_revocation_get(consent_id, opts = {})
6958
+ data, _status_code, _headers = fdx_consents_revocation_get_with_http_info(consent_id, opts)
6959
+ data
6960
+ end
6961
+
6962
+ # Retrieve FDX Consent Grant revocation records
6963
+ # Returns the revocation history of a consent grant
6964
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6965
+ # @param [Hash] opts the optional parameters
6966
+ # @return [Array<(FDXConsentRevocations, Integer, Hash)>] FDXConsentRevocations data, response status code and response headers
6967
+ def fdx_consents_revocation_get_with_http_info(consent_id, opts = {})
6968
+ if @api_client.config.debugging
6969
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revocation_get ...'
6970
+ end
6971
+ # verify the required parameter 'consent_id' is set
6972
+ if @api_client.config.client_side_validation && consent_id.nil?
6973
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revocation_get"
6974
+ end
6975
+ # resource path
6976
+ local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
6977
+
6978
+ # query parameters
6979
+ query_params = opts[:query_params] || {}
6980
+
6981
+ # header parameters
6982
+ header_params = opts[:header_params] || {}
6983
+ # HTTP header 'Accept' (if needed)
6984
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6985
+
6986
+ # form parameters
6987
+ form_params = opts[:form_params] || {}
6988
+
6989
+ # http body (model)
6990
+ post_body = opts[:debug_body]
6991
+
6992
+ # return_type
6993
+ return_type = opts[:debug_return_type] || 'FDXConsentRevocations'
6994
+
6995
+ # auth_names
6996
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6997
+
6998
+ new_options = opts.merge(
6999
+ :operation => :"PlaidApi.fdx_consents_revocation_get",
7000
+ :header_params => header_params,
7001
+ :query_params => query_params,
7002
+ :form_params => form_params,
7003
+ :body => post_body,
7004
+ :auth_names => auth_names,
7005
+ :return_type => return_type
7006
+ )
7007
+
7008
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
7009
+ if @api_client.config.debugging
7010
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revocation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7011
+ end
7012
+ return data, status_code, headers
7013
+ end
7014
+
7015
+ # Revoke FDX Consent Grant
7016
+ # Appends a REVOKED status record to the named consent grant
7017
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
7018
+ # @param request_body [Hash<String, Object>]
7019
+ # @param [Hash] opts the optional parameters
7020
+ # @return [nil]
7021
+ def fdx_consents_revoke(consent_id, request_body, opts = {})
7022
+ fdx_consents_revoke_with_http_info(consent_id, request_body, opts)
7023
+ nil
7024
+ end
7025
+
7026
+ # Revoke FDX Consent Grant
7027
+ # Appends a REVOKED status record to the named consent grant
7028
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
7029
+ # @param request_body [Hash<String, Object>]
7030
+ # @param [Hash] opts the optional parameters
7031
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
7032
+ def fdx_consents_revoke_with_http_info(consent_id, request_body, opts = {})
7033
+ if @api_client.config.debugging
7034
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revoke ...'
7035
+ end
7036
+ # verify the required parameter 'consent_id' is set
7037
+ if @api_client.config.client_side_validation && consent_id.nil?
7038
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revoke"
7039
+ end
7040
+ # verify the required parameter 'request_body' is set
7041
+ if @api_client.config.client_side_validation && request_body.nil?
7042
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.fdx_consents_revoke"
7043
+ end
7044
+ # resource path
7045
+ local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
7046
+
7047
+ # query parameters
7048
+ query_params = opts[:query_params] || {}
7049
+
7050
+ # header parameters
7051
+ header_params = opts[:header_params] || {}
7052
+ # HTTP header 'Accept' (if needed)
7053
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7054
+ # HTTP header 'Content-Type'
7055
+ content_type = @api_client.select_header_content_type(['application/json'])
7056
+ if !content_type.nil?
7057
+ header_params['Content-Type'] = content_type
7058
+ end
7059
+
7060
+ # form parameters
7061
+ form_params = opts[:form_params] || {}
7062
+
7063
+ # http body (model)
7064
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
7065
+
7066
+ # return_type
7067
+ return_type = opts[:debug_return_type]
7068
+
7069
+ # auth_names
7070
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7071
+
7072
+ new_options = opts.merge(
7073
+ :operation => :"PlaidApi.fdx_consents_revoke",
7074
+ :header_params => header_params,
7075
+ :query_params => query_params,
7076
+ :form_params => form_params,
7077
+ :body => post_body,
7078
+ :auth_names => auth_names,
7079
+ :return_type => return_type
7080
+ )
7081
+
7082
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
7083
+ if @api_client.config.debugging
7084
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7085
+ end
7086
+ return data, status_code, headers
7087
+ end
7088
+
6754
7089
  # Webhook receiver for fdx notifications
6755
7090
  # A generic webhook receiver endpoint for FDX Event Notifications
6756
7091
  # @param fdx_notification [FDXNotification]
@@ -7215,7 +7550,7 @@ module Plaid
7215
7550
  end
7216
7551
 
7217
7552
  # Create autofill for an Identity Verification
7218
- # Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.
7553
+ # Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
7219
7554
  # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
7220
7555
  # @param [Hash] opts the optional parameters
7221
7556
  # @return [IdentityVerificationAutofillCreateResponse]
@@ -7225,7 +7560,7 @@ module Plaid
7225
7560
  end
7226
7561
 
7227
7562
  # Create autofill for an Identity Verification
7228
- # Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.
7563
+ # Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
7229
7564
  # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
7230
7565
  # @param [Hash] opts the optional parameters
7231
7566
  # @return [Array<(IdentityVerificationAutofillCreateResponse, Integer, Hash)>] IdentityVerificationAutofillCreateResponse data, response status code and response headers
@@ -7283,7 +7618,7 @@ module Plaid
7283
7618
  end
7284
7619
 
7285
7620
  # Create a new Identity Verification
7286
- # Create a new Identity Verification for the user specified by the `client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the `template_id` provided. If `user_id` is provided, there must be an associated user otherwise an error will be returned. If you don't know whether an active Identity Verification exists for a given `client_user_id` and/or `user_id`, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and/or `user_id`, and `template_id`. If an Identity Verification is found, it will be returned unmodified with a `200 OK` HTTP status code. If `user_id` is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If `user_id` is provided, user information can not be included in the request body. Please use the `/user/update` endpoint to update user data instead.
7621
+ # Create a new Identity Verification for the user specified by the `client_user_id` and/or `user_id` field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the `template_id` provided. If `user_id` is provided, there must be an associated user; otherwise, an error will be returned. If you don't know whether an active Identity Verification exists for a given `client_user_id` and/or `user_id`, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and/or `user_id`, and `template_id`. If an Identity Verification is found, it will be returned unmodified with a `200 OK` HTTP status code. If `user_id` is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If `user_id` is provided, user information can not be included in the request body. Please use the `/user/update` endpoint to update user data instead.
7287
7622
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
7288
7623
  # @param [Hash] opts the optional parameters
7289
7624
  # @return [IdentityVerificationCreateResponse]
@@ -7293,7 +7628,7 @@ module Plaid
7293
7628
  end
7294
7629
 
7295
7630
  # Create a new Identity Verification
7296
- # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60; field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If &#x60;user_id&#x60; is provided, there must be an associated user otherwise an error will be returned. If you don&#39;t know whether an active Identity Verification exists for a given &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with a &#x60;200 OK&#x60; HTTP status code. If &#x60;user_id&#x60; is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If &#x60;user_id&#x60; is provided, user information can not be included in the request body. Please use the &#x60;/user/update&#x60; endpoint to update user data instead.
7631
+ # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60; field. At least one of these two fields must be provided. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If &#x60;user_id&#x60; is provided, there must be an associated user; otherwise, an error will be returned. If you don&#39;t know whether an active Identity Verification exists for a given &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and/or &#x60;user_id&#x60;, and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with a &#x60;200 OK&#x60; HTTP status code. If &#x60;user_id&#x60; is not provided, you can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow. If &#x60;user_id&#x60; is provided, user information can not be included in the request body. Please use the &#x60;/user/update&#x60; endpoint to update user data instead.
7297
7632
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
7298
7633
  # @param [Hash] opts the optional parameters
7299
7634
  # @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
@@ -7895,7 +8230,7 @@ module Plaid
7895
8230
  end
7896
8231
 
7897
8232
  # Get details of all supported institutions
7898
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institutions enabled products and a clients enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
8233
+ # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution's enabled products and a client's enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
7899
8234
  # @param institutions_get_request [InstitutionsGetRequest]
7900
8235
  # @param [Hash] opts the optional parameters
7901
8236
  # @return [InstitutionsGetResponse]
@@ -7905,7 +8240,7 @@ module Plaid
7905
8240
  end
7906
8241
 
7907
8242
  # Get details of all supported institutions
7908
- # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institutions enabled products and a clients enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
8243
+ # Returns a JSON response containing details on all financial institutions currently supported by Plaid. Because Plaid supports thousands of institutions, results are paginated. If there is no overlap between an institution&#39;s enabled products and a client&#39;s enabled products, then the institution will be filtered out from the response. As a result, the number of institutions returned may not match the count specified in the call.
7909
8244
  # @param institutions_get_request [InstitutionsGetRequest]
7910
8245
  # @param [Hash] opts the optional parameters
7911
8246
  # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
@@ -8710,8 +9045,8 @@ module Plaid
8710
9045
  return data, status_code, headers
8711
9046
  end
8712
9047
 
8713
- # List a users connected applications
8714
- # List a users connected applications
9048
+ # List a user's connected applications
9049
+ # List a user's connected applications
8715
9050
  # @param item_application_list_request [ItemApplicationListRequest]
8716
9051
  # @param [Hash] opts the optional parameters
8717
9052
  # @return [ItemApplicationListResponse]
@@ -8720,8 +9055,8 @@ module Plaid
8720
9055
  data
8721
9056
  end
8722
9057
 
8723
- # List a users connected applications
8724
- # List a users connected applications
9058
+ # List a user&#39;s connected applications
9059
+ # List a user&#39;s connected applications
8725
9060
  # @param item_application_list_request [ItemApplicationListRequest]
8726
9061
  # @param [Hash] opts the optional parameters
8727
9062
  # @return [Array<(ItemApplicationListResponse, Integer, Hash)>] ItemApplicationListResponse data, response status code and response headers
@@ -8846,8 +9181,8 @@ module Plaid
8846
9181
  return data, status_code, headers
8847
9182
  end
8848
9183
 
8849
- # Unlink a users connected application
8850
- # Unlink a users connected application. On an unlink request, Plaid will immediately revoke the Applications access to the Users data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
9184
+ # Unlink a user's connected application
9185
+ # Unlink a user's connected application. On an unlink request, Plaid will immediately revoke the Application's access to the User's data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
8851
9186
  # @param item_application_unlink_request [ItemApplicationUnlinkRequest]
8852
9187
  # @param [Hash] opts the optional parameters
8853
9188
  # @return [ItemApplicationUnlinkResponse]
@@ -8856,8 +9191,8 @@ module Plaid
8856
9191
  data
8857
9192
  end
8858
9193
 
8859
- # Unlink a users connected application
8860
- # Unlink a users connected application. On an unlink request, Plaid will immediately revoke the Applications access to the Users data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
9194
+ # Unlink a user&#39;s connected application
9195
+ # Unlink a user&#39;s connected application. On an unlink request, Plaid will immediately revoke the Application&#39;s access to the User&#39;s data. The User will have to redo the OAuth authentication process in order to restore functionality. This endpoint only removes ongoing data access permissions, therefore the User will need to reach out to the Application itself in order to disable and delete their account and delete any data that the Application already received (if the Application does not do so by default). This endpoint should be called in real time as the User is unlinking an Application, and should not be batched in order to ensure that the change is reflected as soon as possible.
8861
9196
  # @param item_application_unlink_request [ItemApplicationUnlinkRequest]
8862
9197
  # @param [Hash] opts the optional parameters
8863
9198
  # @return [Array<(ItemApplicationUnlinkResponse, Integer, Hash)>] ItemApplicationUnlinkResponse data, response status code and response headers
@@ -8914,7 +9249,7 @@ module Plaid
8914
9249
  return data, status_code, headers
8915
9250
  end
8916
9251
 
8917
- # Create public token
9252
+ # (Deprecated) Create public token
8918
9253
  # Note: As of July 2020, the `/item/public_token/create` endpoint is deprecated. Instead, use `/link/token/create` with an `access_token` to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the `/item/public_token/create` endpoint and then initialize Link with that `public_token`. A `public_token` is one-time use and expires after 30 minutes. You use a `public_token` to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a `public_token` for an Item even if you did not use Link to create the Item originally. The `/item/public_token/create` endpoint is **not** used to create your initial `public_token`. If you have not already received an `access_token` for a specific Item, use Link to obtain your `public_token` instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
8919
9254
  # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
8920
9255
  # @param [Hash] opts the optional parameters
@@ -8924,7 +9259,7 @@ module Plaid
8924
9259
  data
8925
9260
  end
8926
9261
 
8927
- # Create public token
9262
+ # (Deprecated) Create public token
8928
9263
  # Note: As of July 2020, the &#x60;/item/public_token/create&#x60; endpoint is deprecated. Instead, use &#x60;/link/token/create&#x60; with an &#x60;access_token&#x60; to create a Link token for use with [update mode](https://plaid.com/docs/link/update-mode). If you need your user to take action to restore or resolve an error associated with an Item, generate a public token with the &#x60;/item/public_token/create&#x60; endpoint and then initialize Link with that &#x60;public_token&#x60;. A &#x60;public_token&#x60; is one-time use and expires after 30 minutes. You use a &#x60;public_token&#x60; to initialize Link in [update mode](https://plaid.com/docs/link/update-mode) for a particular Item. You can generate a &#x60;public_token&#x60; for an Item even if you did not use Link to create the Item originally. The &#x60;/item/public_token/create&#x60; endpoint is **not** used to create your initial &#x60;public_token&#x60;. If you have not already received an &#x60;access_token&#x60; for a specific Item, use Link to obtain your &#x60;public_token&#x60; instead. See the [Quickstart](https://plaid.com/docs/quickstart) for more information.
8929
9264
  # @param item_public_token_create_request [ItemPublicTokenCreateRequest]
8930
9265
  # @param [Hash] opts the optional parameters
@@ -9050,74 +9385,6 @@ module Plaid
9050
9385
  return data, status_code, headers
9051
9386
  end
9052
9387
 
9053
- # Report fraud for an Item
9054
- # 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.
9055
- # @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
9056
- # @param [Hash] opts the optional parameters
9057
- # @return [ItemHandleFraudReportResponse]
9058
- def item_handle_fraud_report(item_handle_fraud_report_request, opts = {})
9059
- data, _status_code, _headers = item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts)
9060
- data
9061
- end
9062
-
9063
- # Report fraud for an Item
9064
- # 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.
9065
- # @param item_handle_fraud_report_request [ItemHandleFraudReportRequest]
9066
- # @param [Hash] opts the optional parameters
9067
- # @return [Array<(ItemHandleFraudReportResponse, Integer, Hash)>] ItemHandleFraudReportResponse data, response status code and response headers
9068
- def item_handle_fraud_report_with_http_info(item_handle_fraud_report_request, opts = {})
9069
- if @api_client.config.debugging
9070
- @api_client.config.logger.debug 'Calling API: PlaidApi.item_handle_fraud_report ...'
9071
- end
9072
- # verify the required parameter 'item_handle_fraud_report_request' is set
9073
- if @api_client.config.client_side_validation && item_handle_fraud_report_request.nil?
9074
- fail ArgumentError, "Missing the required parameter 'item_handle_fraud_report_request' when calling PlaidApi.item_handle_fraud_report"
9075
- end
9076
- # resource path
9077
- local_var_path = '/item/handle_fraud_report'
9078
-
9079
- # query parameters
9080
- query_params = opts[:query_params] || {}
9081
-
9082
- # header parameters
9083
- header_params = opts[:header_params] || {}
9084
- # HTTP header 'Accept' (if needed)
9085
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9086
- # HTTP header 'Content-Type'
9087
- content_type = @api_client.select_header_content_type(['application/json'])
9088
- if !content_type.nil?
9089
- header_params['Content-Type'] = content_type
9090
- end
9091
-
9092
- # form parameters
9093
- form_params = opts[:form_params] || {}
9094
-
9095
- # http body (model)
9096
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_handle_fraud_report_request)
9097
-
9098
- # return_type
9099
- return_type = opts[:debug_return_type] || 'ItemHandleFraudReportResponse'
9100
-
9101
- # auth_names
9102
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9103
-
9104
- new_options = opts.merge(
9105
- :operation => :"PlaidApi.item_handle_fraud_report",
9106
- :header_params => header_params,
9107
- :query_params => query_params,
9108
- :form_params => form_params,
9109
- :body => post_body,
9110
- :auth_names => auth_names,
9111
- :return_type => return_type
9112
- )
9113
-
9114
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9115
- if @api_client.config.debugging
9116
- @api_client.config.logger.debug "API called: PlaidApi#item_handle_fraud_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9117
- end
9118
- return data, status_code, headers
9119
- end
9120
-
9121
9388
  # Import Item
9122
9389
  # `/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.
9123
9390
  # @param item_import_request [ItemImportRequest]
@@ -9662,7 +9929,7 @@ module Plaid
9662
9929
  return data, status_code, headers
9663
9930
  end
9664
9931
 
9665
- # Exchange the Link Correlation Id for a Link Token
9932
+ # Exchange the Link Correlation ID for a Link Token
9666
9933
  # Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for `payment_initiation` products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the `link_token`.
9667
9934
  # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
9668
9935
  # @param [Hash] opts the optional parameters
@@ -9672,7 +9939,7 @@ module Plaid
9672
9939
  data
9673
9940
  end
9674
9941
 
9675
- # Exchange the Link Correlation Id for a Link Token
9942
+ # Exchange the Link Correlation ID for a Link Token
9676
9943
  # Exchange an OAuth &#x60;link_correlation_id&#x60; for the corresponding &#x60;link_token&#x60;. The &#x60;link_correlation_id&#x60; is only available for &#x60;payment_initiation&#x60; products and is provided to the client via the OAuth &#x60;redirect_uri&#x60; as a query parameter. The &#x60;link_correlation_id&#x60; is ephemeral and expires in a brief period, after which it can no longer be exchanged for the &#x60;link_token&#x60;.
9677
9944
  # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
9678
9945
  # @param [Hash] opts the optional parameters
@@ -9866,76 +10133,8 @@ module Plaid
9866
10133
  return data, status_code, headers
9867
10134
  end
9868
10135
 
9869
- # Retrieve network insights for the provided `access_tokens`
9870
- # This endpoint allows you to retrieve the Network Insights from a list of `access_tokens`.
9871
- # @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
9872
- # @param [Hash] opts the optional parameters
9873
- # @return [NetworkInsightsReportGetResponse]
9874
- def network_insights_report_get(network_insights_report_get_request, opts = {})
9875
- data, _status_code, _headers = network_insights_report_get_with_http_info(network_insights_report_get_request, opts)
9876
- data
9877
- end
9878
-
9879
- # Retrieve network insights for the provided &#x60;access_tokens&#x60;
9880
- # This endpoint allows you to retrieve the Network Insights from a list of &#x60;access_tokens&#x60;.
9881
- # @param network_insights_report_get_request [NetworkInsightsReportGetRequest]
9882
- # @param [Hash] opts the optional parameters
9883
- # @return [Array<(NetworkInsightsReportGetResponse, Integer, Hash)>] NetworkInsightsReportGetResponse data, response status code and response headers
9884
- def network_insights_report_get_with_http_info(network_insights_report_get_request, opts = {})
9885
- if @api_client.config.debugging
9886
- @api_client.config.logger.debug 'Calling API: PlaidApi.network_insights_report_get ...'
9887
- end
9888
- # verify the required parameter 'network_insights_report_get_request' is set
9889
- if @api_client.config.client_side_validation && network_insights_report_get_request.nil?
9890
- fail ArgumentError, "Missing the required parameter 'network_insights_report_get_request' when calling PlaidApi.network_insights_report_get"
9891
- end
9892
- # resource path
9893
- local_var_path = '/network_insights/report/get'
9894
-
9895
- # query parameters
9896
- query_params = opts[:query_params] || {}
9897
-
9898
- # header parameters
9899
- header_params = opts[:header_params] || {}
9900
- # HTTP header 'Accept' (if needed)
9901
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9902
- # HTTP header 'Content-Type'
9903
- content_type = @api_client.select_header_content_type(['application/json'])
9904
- if !content_type.nil?
9905
- header_params['Content-Type'] = content_type
9906
- end
9907
-
9908
- # form parameters
9909
- form_params = opts[:form_params] || {}
9910
-
9911
- # http body (model)
9912
- post_body = opts[:debug_body] || @api_client.object_to_http_body(network_insights_report_get_request)
9913
-
9914
- # return_type
9915
- return_type = opts[:debug_return_type] || 'NetworkInsightsReportGetResponse'
9916
-
9917
- # auth_names
9918
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9919
-
9920
- new_options = opts.merge(
9921
- :operation => :"PlaidApi.network_insights_report_get",
9922
- :header_params => header_params,
9923
- :query_params => query_params,
9924
- :form_params => form_params,
9925
- :body => post_body,
9926
- :auth_names => auth_names,
9927
- :return_type => return_type
9928
- )
9929
-
9930
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9931
- if @api_client.config.debugging
9932
- @api_client.config.logger.debug "API called: PlaidApi#network_insights_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9933
- end
9934
- return data, status_code, headers
9935
- end
9936
-
9937
10136
  # Check a user's Plaid Network status
9938
- # 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).
10137
+ # 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).
9939
10138
  # @param network_status_get_request [NetworkStatusGetRequest]
9940
10139
  # @param [Hash] opts the optional parameters
9941
10140
  # @return [NetworkStatusGetResponse]
@@ -9945,7 +10144,7 @@ module Plaid
9945
10144
  end
9946
10145
 
9947
10146
  # Check a user&#39;s Plaid Network status
9948
- # 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).
10147
+ # 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).
9949
10148
  # @param network_status_get_request [NetworkStatusGetRequest]
9950
10149
  # @param [Hash] opts the optional parameters
9951
10150
  # @return [Array<(NetworkStatusGetResponse, Integer, Hash)>] NetworkStatusGetResponse data, response status code and response headers
@@ -10819,7 +11018,7 @@ module Plaid
10819
11018
  end
10820
11019
 
10821
11020
  # Create a payment
10822
- # 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 recipients account, although at least 90% of standing order payments are sent by 6am.
11021
+ # 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 EUR, GBP, or another 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.
10823
11022
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10824
11023
  # @param [Hash] opts the optional parameters
10825
11024
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -10829,7 +11028,7 @@ module Plaid
10829
11028
  end
10830
11029
 
10831
11030
  # Create a payment
10832
- # 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 recipients account, although at least 90% of standing order payments are sent by 6am.
11031
+ # 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 EUR, GBP, or another 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&#39;s account, although at least 90% of standing order payments are sent by 6am.
10833
11032
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10834
11033
  # @param [Hash] opts the optional parameters
10835
11034
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -10887,7 +11086,7 @@ module Plaid
10887
11086
  end
10888
11087
 
10889
11088
  # Get payment details
10890
- # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment's status is unreliable and may trigger API rate limits. Only the `payment_status_update` webhook should be used to receive real-time status updates in Production. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
11089
+ # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment's status is unreliable and may trigger API rate limits. Only the `payment_status_update` webhook should be used to receive real-time status updates in Production.
10891
11090
  # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
10892
11091
  # @param [Hash] opts the optional parameters
10893
11092
  # @return [PaymentInitiationPaymentGetResponse]
@@ -10897,7 +11096,7 @@ module Plaid
10897
11096
  end
10898
11097
 
10899
11098
  # Get payment details
10900
- # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;payment_status_update&#x60; webhook should be used to receive real-time status updates in Production. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order.
11099
+ # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;payment_status_update&#x60; webhook should be used to receive real-time status updates in Production.
10901
11100
  # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
10902
11101
  # @param [Hash] opts the optional parameters
10903
11102
  # @return [Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>] PaymentInitiationPaymentGetResponse data, response status code and response headers
@@ -11091,7 +11290,7 @@ module Plaid
11091
11290
  end
11092
11291
 
11093
11292
  # Create payment recipient
11094
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
11293
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payments Area (SEPA) or a non-Eurozone country [supported](https://support.plaid.com/hc/en-us/articles/27895826947735-What-Plaid-products-are-supported-in-each-country-and-region) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
11095
11294
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
11096
11295
  # @param [Hash] opts the optional parameters
11097
11296
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -11101,7 +11300,7 @@ module Plaid
11101
11300
  end
11102
11301
 
11103
11302
  # Create payment recipient
11104
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
11303
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payments Area (SEPA) or a non-Eurozone country [supported](https://support.plaid.com/hc/en-us/articles/27895826947735-What-Plaid-products-are-supported-in-each-country-and-region) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
11105
11304
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
11106
11305
  # @param [Hash] opts the optional parameters
11107
11306
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -11227,7 +11426,7 @@ module Plaid
11227
11426
  end
11228
11427
 
11229
11428
  # List payment recipients
11230
- # The `/payment_initiation/recipient/list` endpoint list the payment recipients that you have previously created.
11429
+ # The `/payment_initiation/recipient/list` endpoint lists the payment recipients that you have previously created.
11231
11430
  # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
11232
11431
  # @param [Hash] opts the optional parameters
11233
11432
  # @return [PaymentInitiationRecipientListResponse]
@@ -11237,7 +11436,7 @@ module Plaid
11237
11436
  end
11238
11437
 
11239
11438
  # List payment recipients
11240
- # The &#x60;/payment_initiation/recipient/list&#x60; endpoint list the payment recipients that you have previously created.
11439
+ # The &#x60;/payment_initiation/recipient/list&#x60; endpoint lists the payment recipients that you have previously created.
11241
11440
  # @param payment_initiation_recipient_list_request [PaymentInitiationRecipientListRequest]
11242
11441
  # @param [Hash] opts the optional parameters
11243
11442
  # @return [Array<(PaymentInitiationRecipientListResponse, Integer, Hash)>] PaymentInitiationRecipientListResponse data, response status code and response headers
@@ -11431,7 +11630,7 @@ module Plaid
11431
11630
  end
11432
11631
 
11433
11632
  # Remove payment profile
11434
- # Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once its removed, it can no longer be used to create transfers.
11633
+ # Use the `/payment_profile/remove` endpoint to remove a given Payment Profile. Once it's removed, it can no longer be used to create transfers.
11435
11634
  # @param payment_profile_remove_request [PaymentProfileRemoveRequest]
11436
11635
  # @param [Hash] opts the optional parameters
11437
11636
  # @return [PaymentProfileRemoveResponse]
@@ -11441,7 +11640,7 @@ module Plaid
11441
11640
  end
11442
11641
 
11443
11642
  # Remove payment profile
11444
- # Use the &#x60;/payment_profile/remove&#x60; endpoint to remove a given Payment Profile. Once its removed, it can no longer be used to create transfers.
11643
+ # Use the &#x60;/payment_profile/remove&#x60; endpoint to remove a given Payment Profile. Once it&#39;s removed, it can no longer be used to create transfers.
11445
11644
  # @param payment_profile_remove_request [PaymentProfileRemoveRequest]
11446
11645
  # @param [Hash] opts the optional parameters
11447
11646
  # @return [Array<(PaymentProfileRemoveResponse, Integer, Hash)>] PaymentProfileRemoveResponse data, response status code and response headers
@@ -11499,7 +11698,7 @@ module Plaid
11499
11698
  end
11500
11699
 
11501
11700
  # Retrieve the account associated with a processor token
11502
- # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use `/processor/balance/get` instead. Note that some information is nullable.
11701
+ # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for real-time balance information, use `/processor/balance/get` instead. Note that some information is nullable.
11503
11702
  # @param processor_account_get_request [ProcessorAccountGetRequest]
11504
11703
  # @param [Hash] opts the optional parameters
11505
11704
  # @return [ProcessorAccountGetResponse]
@@ -11509,7 +11708,7 @@ module Plaid
11509
11708
  end
11510
11709
 
11511
11710
  # Retrieve the account associated with a processor token
11512
- # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for realtime balance information, use &#x60;/processor/balance/get&#x60; instead. Note that some information is nullable.
11711
+ # This endpoint returns the account associated with a given processor token. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, the account balance returned may not be up-to-date; for real-time balance information, use &#x60;/processor/balance/get&#x60; instead. Note that some information is nullable.
11513
11712
  # @param processor_account_get_request [ProcessorAccountGetRequest]
11514
11713
  # @param [Hash] opts the optional parameters
11515
11714
  # @return [Array<(ProcessorAccountGetResponse, Integer, Hash)>] ProcessorAccountGetResponse data, response status code and response headers
@@ -11566,7 +11765,7 @@ module Plaid
11566
11765
  return data, status_code, headers
11567
11766
  end
11568
11767
 
11569
- # Create Apex bank account token
11768
+ # Create Apex processor token
11570
11769
  # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
11571
11770
  # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
11572
11771
  # @param [Hash] opts the optional parameters
@@ -11576,7 +11775,7 @@ module Plaid
11576
11775
  data
11577
11776
  end
11578
11777
 
11579
- # Create Apex bank account token
11778
+ # Create Apex processor token
11580
11779
  # Used to create a token suitable for sending to Apex to enable Plaid-Apex integrations.
11581
11780
  # @param processor_apex_processor_token_create_request [ProcessorApexProcessorTokenCreateRequest]
11582
11781
  # @param [Hash] opts the optional parameters
@@ -11770,7 +11969,7 @@ module Plaid
11770
11969
  return data, status_code, headers
11771
11970
  end
11772
11971
 
11773
- # Create a bank transfer as a processor
11972
+ # (Deprecated) Create a bank transfer as a processor
11774
11973
  # Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
11775
11974
  # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
11776
11975
  # @param [Hash] opts the optional parameters
@@ -11780,7 +11979,7 @@ module Plaid
11780
11979
  data
11781
11980
  end
11782
11981
 
11783
- # Create a bank transfer as a processor
11982
+ # (Deprecated) Create a bank transfer as a processor
11784
11983
  # Use the &#x60;/processor/bank_transfer/create&#x60; endpoint to initiate a new bank transfer as a processor
11785
11984
  # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
11786
11985
  # @param [Hash] opts the optional parameters
@@ -11907,7 +12106,7 @@ module Plaid
11907
12106
  end
11908
12107
 
11909
12108
  # Retrieve identity match score
11910
- # The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/identity/match`. Instead, use the free `/accounts/get` endpoint to request balance cached data, or `/accounts/balance/get` for real-time data.
12109
+ # The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. Fields within the `balances` object will always be null when retrieved by `/processor/identity/match`. Instead, use the `/processor/balance/get` endpoint to retrieve balance data.
11911
12110
  # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
11912
12111
  # @param [Hash] opts the optional parameters
11913
12112
  # @return [ProcessorIdentityMatchResponse]
@@ -11917,7 +12116,7 @@ module Plaid
11917
12116
  end
11918
12117
 
11919
12118
  # Retrieve identity match score
11920
- # The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/identity/match&#x60;. Instead, use the free &#x60;/accounts/get&#x60; endpoint to request balance cached data, or &#x60;/accounts/balance/get&#x60; for real-time data.
12119
+ # The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. Fields within the &#x60;balances&#x60; object will always be null when retrieved by &#x60;/processor/identity/match&#x60;. Instead, use the &#x60;/processor/balance/get&#x60; endpoint to retrieve balance data.
11921
12120
  # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
11922
12121
  # @param [Hash] opts the optional parameters
11923
12122
  # @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
@@ -12859,7 +13058,7 @@ module Plaid
12859
13058
  end
12860
13059
 
12861
13060
  # Get transaction data
12862
- # The `/processor/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). 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 `/processor/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 a processor token, 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 `/processor/transactions/get` will be the data available for the processor token 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 force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13061
+ # The `/processor/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` or `mortgage`; coverage may be limited). 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 `/processor/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 a processor token, 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 `/processor/transactions/get` will be the data available for the processor token 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 force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12863
13062
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
12864
13063
  # @param [Hash] opts the optional parameters
12865
13064
  # @return [ProcessorTransactionsGetResponse]
@@ -12869,7 +13068,7 @@ module Plaid
12869
13068
  end
12870
13069
 
12871
13070
  # Get transaction data
12872
- # The &#x60;/processor/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). 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;/processor/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 a processor token, 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;/processor/transactions/get&#x60; will be the data available for the processor token 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 force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/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;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions 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.
13071
+ # The &#x60;/processor/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; or &#x60;mortgage&#x60;; coverage may be limited). 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;/processor/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 a processor token, 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;/processor/transactions/get&#x60; will be the data available for the processor token 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 force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/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;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions 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.
12873
13072
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
12874
13073
  # @param [Hash] opts the optional parameters
12875
13074
  # @return [Array<(ProcessorTransactionsGetResponse, Integer, Hash)>] ProcessorTransactionsGetResponse data, response status code and response headers
@@ -12927,7 +13126,7 @@ module Plaid
12927
13126
  end
12928
13127
 
12929
13128
  # Fetch recurring transaction streams
12930
- # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a users checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13129
+ # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call the `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12931
13130
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12932
13131
  # @param [Hash] opts the optional parameters
12933
13132
  # @return [ProcessorTransactionsRecurringGetResponse]
@@ -12937,7 +13136,7 @@ module Plaid
12937
13136
  end
12938
13137
 
12939
13138
  # Fetch recurring transaction streams
12940
- # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a users checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions 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.
13139
+ # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user&#39;s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call the &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions 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.
12941
13140
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12942
13141
  # @param [Hash] opts the optional parameters
12943
13142
  # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
@@ -12995,7 +13194,7 @@ module Plaid
12995
13194
  end
12996
13195
 
12997
13196
  # Refresh transaction data
12998
- # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
13197
+ # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/processor/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
12999
13198
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
13000
13199
  # @param [Hash] opts the optional parameters
13001
13200
  # @return [ProcessorTransactionsRefreshResponse]
@@ -13005,7 +13204,7 @@ module Plaid
13005
13204
  end
13006
13205
 
13007
13206
  # Refresh transaction data
13008
- # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
13207
+ # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/processor/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
13009
13208
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
13010
13209
  # @param [Hash] opts the optional parameters
13011
13210
  # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
@@ -13063,7 +13262,7 @@ module Plaid
13063
13262
  end
13064
13263
 
13065
13264
  # Get incremental transaction updates on a processor token
13066
- # The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13265
+ # The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student` or `mortgage`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g. due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13067
13266
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
13068
13267
  # @param [Hash] opts the optional parameters
13069
13268
  # @return [ProcessorTransactionsSyncResponse]
@@ -13073,7 +13272,7 @@ module Plaid
13073
13272
  end
13074
13273
 
13075
13274
  # Get incremental transaction updates on a processor token
13076
- # The &#x60;/processor/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the &#x60;/processor/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions 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.
13275
+ # The &#x60;/processor/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g. due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the &#x60;/processor/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions 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.
13077
13276
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
13078
13277
  # @param [Hash] opts the optional parameters
13079
13278
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -13198,8 +13397,8 @@ module Plaid
13198
13397
  return data, status_code, headers
13199
13398
  end
13200
13399
 
13201
- # Compute Protect Trust Index Score
13202
- # Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes. For link-session models, if the Link session is not yet complete, the endpoint returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION`.
13400
+ # Compute Protect Trust Index scores and subscores
13401
+ # Compute a Protect Trust Index score for a user. The model selected determines what is scored and what additional fields the response contains. For example, `ti-link-session-2.0` scores a completed Link session for fraud risk; `cash-advance-onboarding-1.0` scores repayment risk for a first-time cash advance and additionally populates per-amount-bucket subscores. Cash-advance models require that the user have a Plaid Item with Transactions enabled, or an Assets Report, before scoring. The endpoint returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION` when a required precondition is not met: for link-session models, when the Link session has not completed; for cash-advance models, when the user has not successfully linked any Item.
13203
13402
  # @param protect_compute_request [ProtectComputeRequest]
13204
13403
  # @param [Hash] opts the optional parameters
13205
13404
  # @return [ProtectComputeResponse]
@@ -13208,8 +13407,8 @@ module Plaid
13208
13407
  data
13209
13408
  end
13210
13409
 
13211
- # Compute Protect Trust Index Score
13212
- # Use this endpoint to compute a Protect Trust Index score and retrieve fraud attributes. For link-session models, if the Link session is not yet complete, the endpoint returns HTTP 400 with &#x60;error_type&#x60; &#x3D; &#x60;INVALID_REQUEST&#x60; and &#x60;error_code&#x60; &#x3D; &#x60;FAILED_PRECONDITION&#x60;.
13410
+ # Compute Protect Trust Index scores and subscores
13411
+ # Compute a Protect Trust Index score for a user. The model selected determines what is scored and what additional fields the response contains. For example, &#x60;ti-link-session-2.0&#x60; scores a completed Link session for fraud risk; &#x60;cash-advance-onboarding-1.0&#x60; scores repayment risk for a first-time cash advance and additionally populates per-amount-bucket subscores. Cash-advance models require that the user have a Plaid Item with Transactions enabled, or an Assets Report, before scoring. The endpoint returns HTTP 400 with &#x60;error_type&#x60; &#x3D; &#x60;INVALID_REQUEST&#x60; and &#x60;error_code&#x60; &#x3D; &#x60;FAILED_PRECONDITION&#x60; when a required precondition is not met: for link-session models, when the Link session has not completed; for cash-advance models, when the user has not successfully linked any Item.
13213
13412
  # @param protect_compute_request [ProtectComputeRequest]
13214
13413
  # @param [Hash] opts the optional parameters
13215
13414
  # @return [Array<(ProtectComputeResponse, Integer, Hash)>] ProtectComputeResponse data, response status code and response headers
@@ -13403,7 +13602,7 @@ module Plaid
13403
13602
  end
13404
13603
 
13405
13604
  # Create a Protect report
13406
- # 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.
13605
+ # 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. Each report must include `user_id`, or an `incident_event` with at least one supported identifier: `link_session_id`, `idv_session_id`, `protect_event_id`, `signal_client_transaction_id`, or `access_token`. Context fields such as `internal_reference`, `time`, `amount`, and `bank_account` do not satisfy this identifier requirement.
13407
13606
  # @param protect_report_create_request [ProtectReportCreateRequest]
13408
13607
  # @param [Hash] opts the optional parameters
13409
13608
  # @return [ProtectReportCreateResponse]
@@ -13413,7 +13612,7 @@ module Plaid
13413
13612
  end
13414
13613
 
13415
13614
  # Create a Protect report
13416
- # 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.
13615
+ # 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. Each report must include &#x60;user_id&#x60;, or an &#x60;incident_event&#x60; with at least one supported identifier: &#x60;link_session_id&#x60;, &#x60;idv_session_id&#x60;, &#x60;protect_event_id&#x60;, &#x60;signal_client_transaction_id&#x60;, or &#x60;access_token&#x60;. Context fields such as &#x60;internal_reference&#x60;, &#x60;time&#x60;, &#x60;amount&#x60;, and &#x60;bank_account&#x60; do not satisfy this identifier requirement.
13417
13616
  # @param protect_report_create_request [ProtectReportCreateRequest]
13418
13617
  # @param [Hash] opts the optional parameters
13419
13618
  # @return [Array<(ProtectReportCreateResponse, Integer, Hash)>] ProtectReportCreateResponse data, response status code and response headers
@@ -13538,7 +13737,7 @@ module Plaid
13538
13737
  return data, status_code, headers
13539
13738
  end
13540
13739
 
13541
- # Manually fire a bank income webhook in sandbox
13740
+ # (Deprecated) Manually fire a Bank Income webhook in Sandbox
13542
13741
  # Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
13543
13742
  # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
13544
13743
  # @param [Hash] opts the optional parameters
@@ -13548,7 +13747,7 @@ module Plaid
13548
13747
  data
13549
13748
  end
13550
13749
 
13551
- # Manually fire a bank income webhook in sandbox
13750
+ # (Deprecated) Manually fire a Bank Income webhook in Sandbox
13552
13751
  # Use the &#x60;/sandbox/bank_income/fire_webhook&#x60; endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
13553
13752
  # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
13554
13753
  # @param [Hash] opts the optional parameters
@@ -13606,7 +13805,7 @@ module Plaid
13606
13805
  return data, status_code, headers
13607
13806
  end
13608
13807
 
13609
- # Manually fire a Bank Transfer webhook
13808
+ # (Deprecated) Manually fire a Bank Transfer webhook
13610
13809
  # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
13611
13810
  # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
13612
13811
  # @param [Hash] opts the optional parameters
@@ -13616,7 +13815,7 @@ module Plaid
13616
13815
  data
13617
13816
  end
13618
13817
 
13619
- # Manually fire a Bank Transfer webhook
13818
+ # (Deprecated) Manually fire a Bank Transfer webhook
13620
13819
  # Use the &#x60;/sandbox/bank_transfer/fire_webhook&#x60; endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
13621
13820
  # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
13622
13821
  # @param [Hash] opts the optional parameters
@@ -13674,7 +13873,7 @@ module Plaid
13674
13873
  return data, status_code, headers
13675
13874
  end
13676
13875
 
13677
- # Simulate a bank transfer event in Sandbox
13876
+ # (Deprecated) Simulate a bank transfer event in Sandbox
13678
13877
  # Use the `/sandbox/bank_transfer/simulate` endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/bank_transfer/event/sync` or `/bank_transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
13679
13878
  # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
13680
13879
  # @param [Hash] opts the optional parameters
@@ -13684,7 +13883,7 @@ module Plaid
13684
13883
  data
13685
13884
  end
13686
13885
 
13687
- # Simulate a bank transfer event in Sandbox
13886
+ # (Deprecated) Simulate a bank transfer event in Sandbox
13688
13887
  # Use the &#x60;/sandbox/bank_transfer/simulate&#x60; endpoint to simulate a bank transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as &#x60;/bank_transfer/event/sync&#x60; or &#x60;/bank_transfer/event/list&#x60;, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
13689
13888
  # @param sandbox_bank_transfer_simulate_request [SandboxBankTransferSimulateRequest]
13690
13889
  # @param [Hash] opts the optional parameters
@@ -13810,6 +14009,74 @@ module Plaid
13810
14009
  return data, status_code, headers
13811
14010
  end
13812
14011
 
14012
+ # Seed an FDX consent grant for a sandbox data partner
14013
+ # `/sandbox/fdx/consent/seed` creates a test FDX consent grant (and a backing Item) for a data provider's customer in Sandbox, so the FDX Consent API endpoints can be exercised end-to-end without a live data provider connection. `customer_id` is the data provider's identifier for the end user and `application_id` identifies the data recipient application the consent is granted to; both are required. Optionally provide `consent_id` (a UUIDv4) to control the seeded grant's identifier; one is generated when omitted. The seeded grant is returned by `/fdx/consents` and `/fdx/consents/{consentId}`, and can be revoked via `/fdx/consents/{consentId}/revocation`.
14014
+ # @param sandbox_fdx_consent_seed_request [SandboxFdxConsentSeedRequest]
14015
+ # @param [Hash] opts the optional parameters
14016
+ # @return [SandboxFdxConsentSeedResponse]
14017
+ def sandbox_fdx_consent_seed(sandbox_fdx_consent_seed_request, opts = {})
14018
+ data, _status_code, _headers = sandbox_fdx_consent_seed_with_http_info(sandbox_fdx_consent_seed_request, opts)
14019
+ data
14020
+ end
14021
+
14022
+ # Seed an FDX consent grant for a sandbox data partner
14023
+ # &#x60;/sandbox/fdx/consent/seed&#x60; creates a test FDX consent grant (and a backing Item) for a data provider&#39;s customer in Sandbox, so the FDX Consent API endpoints can be exercised end-to-end without a live data provider connection. &#x60;customer_id&#x60; is the data provider&#39;s identifier for the end user and &#x60;application_id&#x60; identifies the data recipient application the consent is granted to; both are required. Optionally provide &#x60;consent_id&#x60; (a UUIDv4) to control the seeded grant&#39;s identifier; one is generated when omitted. The seeded grant is returned by &#x60;/fdx/consents&#x60; and &#x60;/fdx/consents/{consentId}&#x60;, and can be revoked via &#x60;/fdx/consents/{consentId}/revocation&#x60;.
14024
+ # @param sandbox_fdx_consent_seed_request [SandboxFdxConsentSeedRequest]
14025
+ # @param [Hash] opts the optional parameters
14026
+ # @return [Array<(SandboxFdxConsentSeedResponse, Integer, Hash)>] SandboxFdxConsentSeedResponse data, response status code and response headers
14027
+ def sandbox_fdx_consent_seed_with_http_info(sandbox_fdx_consent_seed_request, opts = {})
14028
+ if @api_client.config.debugging
14029
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_fdx_consent_seed ...'
14030
+ end
14031
+ # verify the required parameter 'sandbox_fdx_consent_seed_request' is set
14032
+ if @api_client.config.client_side_validation && sandbox_fdx_consent_seed_request.nil?
14033
+ fail ArgumentError, "Missing the required parameter 'sandbox_fdx_consent_seed_request' when calling PlaidApi.sandbox_fdx_consent_seed"
14034
+ end
14035
+ # resource path
14036
+ local_var_path = '/sandbox/fdx/consent/seed'
14037
+
14038
+ # query parameters
14039
+ query_params = opts[:query_params] || {}
14040
+
14041
+ # header parameters
14042
+ header_params = opts[:header_params] || {}
14043
+ # HTTP header 'Accept' (if needed)
14044
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14045
+ # HTTP header 'Content-Type'
14046
+ content_type = @api_client.select_header_content_type(['application/json'])
14047
+ if !content_type.nil?
14048
+ header_params['Content-Type'] = content_type
14049
+ end
14050
+
14051
+ # form parameters
14052
+ form_params = opts[:form_params] || {}
14053
+
14054
+ # http body (model)
14055
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_fdx_consent_seed_request)
14056
+
14057
+ # return_type
14058
+ return_type = opts[:debug_return_type] || 'SandboxFdxConsentSeedResponse'
14059
+
14060
+ # auth_names
14061
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
14062
+
14063
+ new_options = opts.merge(
14064
+ :operation => :"PlaidApi.sandbox_fdx_consent_seed",
14065
+ :header_params => header_params,
14066
+ :query_params => query_params,
14067
+ :form_params => form_params,
14068
+ :body => post_body,
14069
+ :auth_names => auth_names,
14070
+ :return_type => return_type
14071
+ )
14072
+
14073
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
14074
+ if @api_client.config.debugging
14075
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_fdx_consent_seed\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14076
+ end
14077
+ return data, status_code, headers
14078
+ end
14079
+
13813
14080
  # Manually fire an Income webhook
13814
14081
  # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
13815
14082
  # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
@@ -13947,7 +14214,7 @@ module Plaid
13947
14214
  end
13948
14215
 
13949
14216
  # Fire a test webhook
13950
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given same day micro-deposit item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
14217
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the `webhook_type` in the request body. Valid Sandbox `DEFAULT_UPDATE` webhook types include: `AUTH`, `IDENTITY`, `TRANSACTIONS`, `INVESTMENTS_TRANSACTIONS`, `LIABILITIES`, `HOLDINGS`. If the Item does not support the product, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. `SMS_MICRODEPOSITS_VERIFICATION`: Fired when a given Same-Day Micro-deposit Item is verified via SMS verification. `LOGIN_REPAIRED`: Fired when an Item recovers from the `ITEM_LOGIN_REQUIRED` without the user going through update mode in your app. `PENDING_DISCONNECT`: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `USER_PERMISSION_REVOKED`: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions' consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. `USER_ACCOUNT_REVOKED`: Fired when an end user has revoked access to their account on the Data Provider's portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
13951
14218
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
13952
14219
  # @param [Hash] opts the optional parameters
13953
14220
  # @return [SandboxItemFireWebhookResponse]
@@ -13957,7 +14224,7 @@ module Plaid
13957
14224
  end
13958
14225
 
13959
14226
  # Fire a test webhook
13960
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid Sandbox &#x60;DEFAULT_UPDATE&#x60; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;USER_PERMISSION_REVOKED&#x60;: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. &#x60;USER_ACCOUNT_REVOKED&#x60;: Fired when an end user has revoked access to their account on the Data Provider&#39;s portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type &#x60;TRANSFER&#x60;).
14227
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid Sandbox &#x60;DEFAULT_UPDATE&#x60; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given Same-Day Micro-deposit Item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;USER_PERMISSION_REVOKED&#x60;: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions&#39; consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. &#x60;USER_ACCOUNT_REVOKED&#x60;: Fired when an end user has revoked access to their account on the Data Provider&#39;s portal. This webhook is currently sent only for PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type &#x60;TRANSFER&#x60;).
13961
14228
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
13962
14229
  # @param [Hash] opts the optional parameters
13963
14230
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -14015,7 +14282,7 @@ module Plaid
14015
14282
  end
14016
14283
 
14017
14284
  # Force a Sandbox Item into an error state
14018
- # `/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.
14285
+ # `/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.
14019
14286
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
14020
14287
  # @param [Hash] opts the optional parameters
14021
14288
  # @return [SandboxItemResetLoginResponse]
@@ -14025,7 +14292,7 @@ module Plaid
14025
14292
  end
14026
14293
 
14027
14294
  # Force a Sandbox Item into an error state
14028
- # &#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.
14295
+ # &#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.
14029
14296
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
14030
14297
  # @param [Hash] opts the optional parameters
14031
14298
  # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
@@ -14083,7 +14350,7 @@ module Plaid
14083
14350
  end
14084
14351
 
14085
14352
  # Set verification status for Sandbox account
14086
- # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
14353
+ # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
14087
14354
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
14088
14355
  # @param [Hash] opts the optional parameters
14089
14356
  # @return [SandboxItemSetVerificationStatusResponse]
@@ -14093,7 +14360,7 @@ module Plaid
14093
14360
  end
14094
14361
 
14095
14362
  # Set verification status for Sandbox account
14096
- # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
14363
+ # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
14097
14364
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
14098
14365
  # @param [Hash] opts the optional parameters
14099
14366
  # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
@@ -14150,8 +14417,8 @@ module Plaid
14150
14417
  return data, status_code, headers
14151
14418
  end
14152
14419
 
14153
- # Save the selected accounts when connecting to the Platypus Oauth institution
14154
- # Save the selected accounts when connecting to the Platypus Oauth institution
14420
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14421
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14155
14422
  # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
14156
14423
  # @param [Hash] opts the optional parameters
14157
14424
  # @return [Hash<String, Object>]
@@ -14160,8 +14427,8 @@ module Plaid
14160
14427
  data
14161
14428
  end
14162
14429
 
14163
- # Save the selected accounts when connecting to the Platypus Oauth institution
14164
- # Save the selected accounts when connecting to the Platypus Oauth institution
14430
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14431
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14165
14432
  # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
14166
14433
  # @param [Hash] opts the optional parameters
14167
14434
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -14219,7 +14486,7 @@ module Plaid
14219
14486
  end
14220
14487
 
14221
14488
  # Reset the login of a Payment Profile
14222
- # `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
14489
+ # `/sandbox/payment_profile/reset_login` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
14223
14490
  # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
14224
14491
  # @param [Hash] opts the optional parameters
14225
14492
  # @return [SandboxPaymentProfileResetLoginResponse]
@@ -14229,7 +14496,7 @@ module Plaid
14229
14496
  end
14230
14497
 
14231
14498
  # Reset the login of a Payment Profile
14232
- # &#x60;/sandbox/payment_profile/reset_login/&#x60; forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling &#x60;/sandbox/payment_profile/reset_login&#x60;, calls to the &#x60;/transfer/authorization/create&#x60; with the Payment Profile will result in a &#x60;decision_rationale&#x60; &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
14499
+ # &#x60;/sandbox/payment_profile/reset_login&#x60; forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling &#x60;/sandbox/payment_profile/reset_login&#x60;, calls to the &#x60;/transfer/authorization/create&#x60; with the Payment Profile will result in a &#x60;decision_rationale&#x60; &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
14233
14500
  # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
14234
14501
  # @param [Hash] opts the optional parameters
14235
14502
  # @return [Array<(SandboxPaymentProfileResetLoginResponse, Integer, Hash)>] SandboxPaymentProfileResetLoginResponse data, response status code and response headers
@@ -14491,7 +14758,7 @@ module Plaid
14491
14758
  end
14492
14759
 
14493
14760
  # Create sandbox transactions
14494
- # Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints.
14761
+ # Use the `/sandbox/transactions/create` endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the `user_transactions_dynamic` test user. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints. Custom transactions are only applied to the depository account. Support for per-account targeting may be added in the future.
14495
14762
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
14496
14763
  # @param [Hash] opts the optional parameters
14497
14764
  # @return [SandboxTransactionsCreateResponse]
@@ -14501,7 +14768,7 @@ module Plaid
14501
14768
  end
14502
14769
 
14503
14770
  # Create sandbox transactions
14504
- # Use the &#x60;/sandbox/transactions/create&#x60; endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the &#x60;user_transactions_dynamic&#x60; test user. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints.
14771
+ # Use the &#x60;/sandbox/transactions/create&#x60; endpoint to create new transactions for an existing Item. This endpoint can be used to add up to 10 transactions to any Item at a time. This endpoint can only be used with Items that were created in the Sandbox environment using the &#x60;user_transactions_dynamic&#x60; test user. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints. Custom transactions are only applied to the depository account. Support for per-account targeting may be added in the future.
14505
14772
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
14506
14773
  # @param [Hash] opts the optional parameters
14507
14774
  # @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
@@ -14899,7 +15166,7 @@ module Plaid
14899
15166
  end
14900
15167
 
14901
15168
  # Trigger the creation of a repayment
14902
- # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
15169
+ # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, a 400 error is returned.
14903
15170
  # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
14904
15171
  # @param [Hash] opts the optional parameters
14905
15172
  # @return [SandboxTransferRepaymentSimulateResponse]
@@ -14909,7 +15176,7 @@ module Plaid
14909
15176
  end
14910
15177
 
14911
15178
  # Trigger the creation of a repayment
14912
- # Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
15179
+ # Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, a 400 error is returned.
14913
15180
  # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
14914
15181
  # @param [Hash] opts the optional parameters
14915
15182
  # @return [Array<(SandboxTransferRepaymentSimulateResponse, Integer, Hash)>] SandboxTransferRepaymentSimulateResponse data, response status code and response headers
@@ -15375,7 +15642,7 @@ module Plaid
15375
15642
  end
15376
15643
 
15377
15644
  # Force item(s) for a Sandbox User into an error state
15378
- # `/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.
15645
+ # `/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.
15379
15646
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15380
15647
  # @param [Hash] opts the optional parameters
15381
15648
  # @return [SandboxUserResetLoginResponse]
@@ -15385,7 +15652,7 @@ module Plaid
15385
15652
  end
15386
15653
 
15387
15654
  # Force item(s) for a Sandbox User into an error state
15388
- # &#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.
15655
+ # &#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.
15389
15656
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15390
15657
  # @param [Hash] opts the optional parameters
15391
15658
  # @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
@@ -15443,7 +15710,7 @@ module Plaid
15443
15710
  end
15444
15711
 
15445
15712
  # Create a Link token for Layer
15446
- # `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
15713
+ # `/session/token/create` is used to create a Link token for Layer. The returned Link token is used as a parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
15447
15714
  # @param session_token_create_request [SessionTokenCreateRequest]
15448
15715
  # @param [Hash] opts the optional parameters
15449
15716
  # @return [SessionTokenCreateResponse]
@@ -15453,7 +15720,7 @@ module Plaid
15453
15720
  end
15454
15721
 
15455
15722
  # Create a Link token for Layer
15456
- # &#x60;/session/token/create&#x60; is used to create a Link token for Layer. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
15723
+ # &#x60;/session/token/create&#x60; is used to create a Link token for Layer. The returned Link token is used as a parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
15457
15724
  # @param session_token_create_request [SessionTokenCreateRequest]
15458
15725
  # @param [Hash] opts the optional parameters
15459
15726
  # @return [Array<(SessionTokenCreateResponse, Integer, Hash)>] SessionTokenCreateResponse data, response status code and response headers
@@ -15882,7 +16149,7 @@ module Plaid
15882
16149
  # header parameters
15883
16150
  header_params = opts[:header_params] || {}
15884
16151
  # HTTP header 'Accept' (if needed)
15885
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16152
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
15886
16153
  # HTTP header 'Content-Type'
15887
16154
  content_type = @api_client.select_header_content_type(['application/json'])
15888
16155
  if !content_type.nil?
@@ -15918,8 +16185,8 @@ module Plaid
15918
16185
  return data, status_code, headers
15919
16186
  end
15920
16187
 
15921
- # Retrieve a list of all statements associated with an item.
15922
- # The `/statements/list` endpoint retrieves a list of all statements associated with an item.
16188
+ # Retrieve a list of all statements associated with an Item.
16189
+ # The `/statements/list` endpoint retrieves a list of all statements associated with an Item.
15923
16190
  # @param statements_list_request [StatementsListRequest]
15924
16191
  # @param [Hash] opts the optional parameters
15925
16192
  # @return [StatementsListResponse]
@@ -15928,8 +16195,8 @@ module Plaid
15928
16195
  data
15929
16196
  end
15930
16197
 
15931
- # Retrieve a list of all statements associated with an item.
15932
- # The &#x60;/statements/list&#x60; endpoint retrieves a list of all statements associated with an item.
16198
+ # Retrieve a list of all statements associated with an Item.
16199
+ # The &#x60;/statements/list&#x60; endpoint retrieves a list of all statements associated with an Item.
15933
16200
  # @param statements_list_request [StatementsListRequest]
15934
16201
  # @param [Hash] opts the optional parameters
15935
16202
  # @return [Array<(StatementsListResponse, Integer, Hash)>] StatementsListResponse data, response status code and response headers
@@ -16054,7 +16321,7 @@ module Plaid
16054
16321
  return data, status_code, headers
16055
16322
  end
16056
16323
 
16057
- # enhance locally-held transaction data
16324
+ # Enhance locally-held transaction data
16058
16325
  # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
16059
16326
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
16060
16327
  # @param [Hash] opts the optional parameters
@@ -16064,7 +16331,7 @@ module Plaid
16064
16331
  data
16065
16332
  end
16066
16333
 
16067
- # enhance locally-held transaction data
16334
+ # Enhance locally-held transaction data
16068
16335
  # The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
16069
16336
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
16070
16337
  # @param [Hash] opts the optional parameters
@@ -16191,7 +16458,7 @@ module Plaid
16191
16458
  end
16192
16459
 
16193
16460
  # Get transaction data
16194
- # 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.
16461
+ # 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` or `mortgage`; coverage may be limited). For transaction history from investment 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.
16195
16462
  # @param transactions_get_request [TransactionsGetRequest]
16196
16463
  # @param [Hash] opts the optional parameters
16197
16464
  # @return [TransactionsGetResponse]
@@ -16201,7 +16468,7 @@ module Plaid
16201
16468
  end
16202
16469
 
16203
16470
  # Get transaction data
16204
- # 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.
16471
+ # 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; or &#x60;mortgage&#x60;; coverage may be limited). For transaction history from investment 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.
16205
16472
  # @param transactions_get_request [TransactionsGetRequest]
16206
16473
  # @param [Hash] opts the optional parameters
16207
16474
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -16259,7 +16526,7 @@ module Plaid
16259
16526
  end
16260
16527
 
16261
16528
  # Fetch recurring transaction streams
16262
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a users checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
16529
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user's checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call the `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
16263
16530
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
16264
16531
  # @param [Hash] opts the optional parameters
16265
16532
  # @return [TransactionsRecurringGetResponse]
@@ -16269,7 +16536,7 @@ module Plaid
16269
16536
  end
16270
16537
 
16271
16538
  # Fetch recurring transaction streams
16272
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a users checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
16539
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user&#39;s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call the &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
16273
16540
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
16274
16541
  # @param [Hash] opts the optional parameters
16275
16542
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -16395,7 +16662,7 @@ module Plaid
16395
16662
  end
16396
16663
 
16397
16664
  # Create transaction category rule
16398
- # The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
16665
+ # The `/beta/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
16399
16666
  # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
16400
16667
  # @param [Hash] opts the optional parameters
16401
16668
  # @return [TransactionsRulesCreateResponse]
@@ -16405,7 +16672,7 @@ module Plaid
16405
16672
  end
16406
16673
 
16407
16674
  # Create transaction category rule
16408
- # The &#x60;/transactions/rules/v1/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
16675
+ # The &#x60;/beta/transactions/rules/v1/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
16409
16676
  # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
16410
16677
  # @param [Hash] opts the optional parameters
16411
16678
  # @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
@@ -16463,7 +16730,7 @@ module Plaid
16463
16730
  end
16464
16731
 
16465
16732
  # Return a list of rules created for the Item associated with the access token.
16466
- # The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
16733
+ # The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
16467
16734
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
16468
16735
  # @param [Hash] opts the optional parameters
16469
16736
  # @return [TransactionsRulesListResponse]
@@ -16473,7 +16740,7 @@ module Plaid
16473
16740
  end
16474
16741
 
16475
16742
  # Return a list of rules created for the Item associated with the access token.
16476
- # The &#x60;/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
16743
+ # The &#x60;/beta/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
16477
16744
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
16478
16745
  # @param [Hash] opts the optional parameters
16479
16746
  # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
@@ -16531,7 +16798,7 @@ module Plaid
16531
16798
  end
16532
16799
 
16533
16800
  # Remove transaction rule
16534
- # The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
16801
+ # The `/beta/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
16535
16802
  # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
16536
16803
  # @param [Hash] opts the optional parameters
16537
16804
  # @return [TransactionsRulesRemoveResponse]
@@ -16541,7 +16808,7 @@ module Plaid
16541
16808
  end
16542
16809
 
16543
16810
  # Remove transaction rule
16544
- # The &#x60;/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
16811
+ # The &#x60;/beta/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
16545
16812
  # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
16546
16813
  # @param [Hash] opts the optional parameters
16547
16814
  # @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
@@ -16599,7 +16866,7 @@ module Plaid
16599
16866
  end
16600
16867
 
16601
16868
  # Get incremental transaction updates on an Item
16602
- # The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the `/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
16869
+ # The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student` or `mortgage`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update (e.g. due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the `/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
16603
16870
  # @param transactions_sync_request [TransactionsSyncRequest]
16604
16871
  # @param [Hash] opts the optional parameters
16605
16872
  # @return [TransactionsSyncResponse]
@@ -16609,7 +16876,7 @@ module Plaid
16609
16876
  end
16610
16877
 
16611
16878
  # Get incremental transaction updates on an Item
16612
- # The &#x60;/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
16879
+ # The &#x60;/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g. due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, 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, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
16613
16880
  # @param transactions_sync_request [TransactionsSyncRequest]
16614
16881
  # @param [Hash] opts the optional parameters
16615
16882
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -16803,7 +17070,7 @@ module Plaid
16803
17070
  end
16804
17071
 
16805
17072
  # Create a transfer authorization
16806
- # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
17073
+ # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.decision_rationale.code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.decision_rationale.code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same-Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
16807
17074
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
16808
17075
  # @param [Hash] opts the optional parameters
16809
17076
  # @return [TransferAuthorizationCreateResponse]
@@ -16813,7 +17080,7 @@ module Plaid
16813
17080
  end
16814
17081
 
16815
17082
  # Create a transfer authorization
16816
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
17083
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.decision_rationale.code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.decision_rationale.code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same-Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
16817
17084
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
16818
17085
  # @param [Hash] opts the optional parameters
16819
17086
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -16871,7 +17138,7 @@ module Plaid
16871
17138
  end
16872
17139
 
16873
17140
  # (Deprecated) Retrieve a balance held with Plaid
16874
- # (Deprecated) Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
17141
+ # (Deprecated) Use the `/transfer/ledger/get` endpoint to view a balance held with Plaid.
16875
17142
  # @param transfer_balance_get_request [TransferBalanceGetRequest]
16876
17143
  # @param [Hash] opts the optional parameters
16877
17144
  # @return [TransferBalanceGetResponse]
@@ -16881,7 +17148,7 @@ module Plaid
16881
17148
  end
16882
17149
 
16883
17150
  # (Deprecated) Retrieve a balance held with Plaid
16884
- # (Deprecated) Use the &#x60;/transfer/balance/get&#x60; endpoint to view a balance held with Plaid.
17151
+ # (Deprecated) Use the &#x60;/transfer/ledger/get&#x60; endpoint to view a balance held with Plaid.
16885
17152
  # @param transfer_balance_get_request [TransferBalanceGetRequest]
16886
17153
  # @param [Hash] opts the optional parameters
16887
17154
  # @return [Array<(TransferBalanceGetResponse, Integer, Hash)>] TransferBalanceGetResponse data, response status code and response headers
@@ -17211,7 +17478,7 @@ module Plaid
17211
17478
  end
17212
17479
 
17213
17480
  # Upload transfer diligence document on behalf of the originator
17214
- # Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. Youll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
17481
+ # Third-party sender customers can use the `/transfer/diligence/document/upload` endpoint to upload a document on behalf of their end customer (i.e. originator) to Plaid. You'll need to send a request of type `multipart/form-data`. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
17215
17482
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
17216
17483
  # @param [Hash] opts the optional parameters
17217
17484
  # @return [TransferDiligenceDocumentUploadResponse]
@@ -17221,7 +17488,7 @@ module Plaid
17221
17488
  end
17222
17489
 
17223
17490
  # Upload transfer diligence document on behalf of the originator
17224
- # Third-party sender customers can use &#x60;/transfer/diligence/document/upload&#x60; endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. Youll need to send a request of type multipart/form-data. You must provide the &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.
17491
+ # Third-party sender customers can use the &#x60;/transfer/diligence/document/upload&#x60; endpoint to upload a document on behalf of their end customer (i.e. originator) to Plaid. You&#39;ll need to send a request of type &#x60;multipart/form-data&#x60;. You must provide the &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.
17225
17492
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
17226
17493
  # @param [Hash] opts the optional parameters
17227
17494
  # @return [Array<(TransferDiligenceDocumentUploadResponse, Integer, Hash)>] TransferDiligenceDocumentUploadResponse data, response status code and response headers
@@ -17755,7 +18022,7 @@ module Plaid
17755
18022
  end
17756
18023
 
17757
18024
  # Move available balance between ledgers
17758
- # Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If youre a platform, you can move funds between one of your ledgers and one of your customers ledger.
18025
+ # Use the `/transfer/ledger/distribute` endpoint to move available balance between ledgers, if you have multiple. If you're a platform, you can move funds between one of your ledgers and one of your customer's ledgers.
17759
18026
  # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
17760
18027
  # @param [Hash] opts the optional parameters
17761
18028
  # @return [TransferLedgerDistributeResponse]
@@ -17765,7 +18032,7 @@ module Plaid
17765
18032
  end
17766
18033
 
17767
18034
  # Move available balance between ledgers
17768
- # Use the &#x60;/transfer/ledger/distribute&#x60; endpoint to move available balance between ledgers, if you have multiple. If youre a platform, you can move funds between one of your ledgers and one of your customers ledger.
18035
+ # Use the &#x60;/transfer/ledger/distribute&#x60; endpoint to move available balance between ledgers, if you have multiple. If you&#39;re a platform, you can move funds between one of your ledgers and one of your customer&#39;s ledgers.
17769
18036
  # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
17770
18037
  # @param [Hash] opts the optional parameters
17771
18038
  # @return [Array<(TransferLedgerDistributeResponse, Integer, Hash)>] TransferLedgerDistributeResponse data, response status code and response headers
@@ -18163,7 +18430,7 @@ module Plaid
18163
18430
  end
18164
18431
 
18165
18432
  # Migrate account into Transfers
18166
- # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](https://dashboard.plaid.com/support).
18433
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid account manager or [support](https://dashboard.plaid.com/support).
18167
18434
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
18168
18435
  # @param [Hash] opts the optional parameters
18169
18436
  # @return [TransferMigrateAccountResponse]
@@ -18173,7 +18440,7 @@ module Plaid
18173
18440
  end
18174
18441
 
18175
18442
  # Migrate account into Transfers
18176
- # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](https://dashboard.plaid.com/support).
18443
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid account manager or [support](https://dashboard.plaid.com/support).
18177
18444
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
18178
18445
  # @param [Hash] opts the optional parameters
18179
18446
  # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
@@ -18775,7 +19042,7 @@ module Plaid
18775
19042
  end
18776
19043
 
18777
19044
  # Generate a Plaid-hosted onboarding UI URL.
18778
- # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaids terms for ACH money movement.
19045
+ # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid's terms for ACH money movement.
18779
19046
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
18780
19047
  # @param [Hash] opts the optional parameters
18781
19048
  # @return [TransferQuestionnaireCreateResponse]
@@ -18785,7 +19052,7 @@ module Plaid
18785
19052
  end
18786
19053
 
18787
19054
  # Generate a Plaid-hosted onboarding UI URL.
18788
- # The &#x60;/transfer/questionnaire/create&#x60; endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaids terms for ACH money movement.
19055
+ # The &#x60;/transfer/questionnaire/create&#x60; endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid&#39;s terms for ACH money movement.
18789
19056
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
18790
19057
  # @param [Hash] opts the optional parameters
18791
19058
  # @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
@@ -18843,7 +19110,7 @@ module Plaid
18843
19110
  end
18844
19111
 
18845
19112
  # Cancel a recurring transfer.
18846
- # Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
19113
+ # Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. A scheduled transfer that hasn't been submitted to the bank will be cancelled.
18847
19114
  # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
18848
19115
  # @param [Hash] opts the optional parameters
18849
19116
  # @return [TransferRecurringCancelResponse]
@@ -18853,7 +19120,7 @@ module Plaid
18853
19120
  end
18854
19121
 
18855
19122
  # Cancel a recurring transfer.
18856
- # Use the &#x60;/transfer/recurring/cancel&#x60; endpoint to cancel a recurring transfer. Scheduled transfer that hasn&#39;t been submitted to bank will be cancelled.
19123
+ # Use the &#x60;/transfer/recurring/cancel&#x60; endpoint to cancel a recurring transfer. A scheduled transfer that hasn&#39;t been submitted to the bank will be cancelled.
18857
19124
  # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
18858
19125
  # @param [Hash] opts the optional parameters
18859
19126
  # @return [Array<(TransferRecurringCancelResponse, Integer, Hash)>] TransferRecurringCancelResponse data, response status code and response headers
@@ -19454,6 +19721,74 @@ module Plaid
19454
19721
  return data, status_code, headers
19455
19722
  end
19456
19723
 
19724
+ # Report a return recovery
19725
+ # Use the `/transfer/return/recover` endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the original transfer's amount.
19726
+ # @param transfer_return_recover_request [TransferReturnRecoverRequest]
19727
+ # @param [Hash] opts the optional parameters
19728
+ # @return [TransferReturnRecoverResponse]
19729
+ def transfer_return_recover(transfer_return_recover_request, opts = {})
19730
+ data, _status_code, _headers = transfer_return_recover_with_http_info(transfer_return_recover_request, opts)
19731
+ data
19732
+ end
19733
+
19734
+ # Report a return recovery
19735
+ # Use the &#x60;/transfer/return/recover&#x60; endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the original transfer&#39;s amount.
19736
+ # @param transfer_return_recover_request [TransferReturnRecoverRequest]
19737
+ # @param [Hash] opts the optional parameters
19738
+ # @return [Array<(TransferReturnRecoverResponse, Integer, Hash)>] TransferReturnRecoverResponse data, response status code and response headers
19739
+ def transfer_return_recover_with_http_info(transfer_return_recover_request, opts = {})
19740
+ if @api_client.config.debugging
19741
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_return_recover ...'
19742
+ end
19743
+ # verify the required parameter 'transfer_return_recover_request' is set
19744
+ if @api_client.config.client_side_validation && transfer_return_recover_request.nil?
19745
+ fail ArgumentError, "Missing the required parameter 'transfer_return_recover_request' when calling PlaidApi.transfer_return_recover"
19746
+ end
19747
+ # resource path
19748
+ local_var_path = '/transfer/return/recover'
19749
+
19750
+ # query parameters
19751
+ query_params = opts[:query_params] || {}
19752
+
19753
+ # header parameters
19754
+ header_params = opts[:header_params] || {}
19755
+ # HTTP header 'Accept' (if needed)
19756
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
19757
+ # HTTP header 'Content-Type'
19758
+ content_type = @api_client.select_header_content_type(['application/json'])
19759
+ if !content_type.nil?
19760
+ header_params['Content-Type'] = content_type
19761
+ end
19762
+
19763
+ # form parameters
19764
+ form_params = opts[:form_params] || {}
19765
+
19766
+ # http body (model)
19767
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_return_recover_request)
19768
+
19769
+ # return_type
19770
+ return_type = opts[:debug_return_type] || 'TransferReturnRecoverResponse'
19771
+
19772
+ # auth_names
19773
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
19774
+
19775
+ new_options = opts.merge(
19776
+ :operation => :"PlaidApi.transfer_return_recover",
19777
+ :header_params => header_params,
19778
+ :query_params => query_params,
19779
+ :form_params => form_params,
19780
+ :body => post_body,
19781
+ :auth_names => auth_names,
19782
+ :return_type => return_type
19783
+ )
19784
+
19785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
19786
+ if @api_client.config.debugging
19787
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_return_recover\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
19788
+ end
19789
+ return data, status_code, headers
19790
+ end
19791
+
19457
19792
  # Retrieve a sweep
19458
19793
  # The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
19459
19794
  # @param transfer_sweep_get_request [TransferSweepGetRequest]
@@ -19727,7 +20062,7 @@ module Plaid
19727
20062
  end
19728
20063
 
19729
20064
  # Create user
19730
- # 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.
20065
+ # 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.
19731
20066
  # @param user_create_request [UserCreateRequest]
19732
20067
  # @param [Hash] opts the optional parameters
19733
20068
  # @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)
@@ -19738,7 +20073,7 @@ module Plaid
19738
20073
  end
19739
20074
 
19740
20075
  # Create user
19741
- # 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.
20076
+ # 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.
19742
20077
  # @param user_create_request [UserCreateRequest]
19743
20078
  # @param [Hash] opts the optional parameters
19744
20079
  # @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)
@@ -19778,7 +20113,7 @@ module Plaid
19778
20113
  return_type = opts[:debug_return_type] || 'UserCreateResponse'
19779
20114
 
19780
20115
  # auth_names
19781
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
20116
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
19782
20117
 
19783
20118
  new_options = opts.merge(
19784
20119
  :operation => :"PlaidApi.user_create",
@@ -19798,7 +20133,7 @@ module Plaid
19798
20133
  end
19799
20134
 
19800
20135
  # Refresh user items for Financial-Insights bundle
19801
- # `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead.
20136
+ # `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead.
19802
20137
  # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest]
19803
20138
  # @param [Hash] opts the optional parameters
19804
20139
  # @return [UserFinancialDataRefreshResponse]
@@ -19808,7 +20143,7 @@ module Plaid
19808
20143
  end
19809
20144
 
19810
20145
  # Refresh user items for Financial-Insights bundle
19811
- # &#x60;/user/financial_data/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Transactions Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.
20146
+ # &#x60;/user/financial_data/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.
19812
20147
  # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest]
19813
20148
  # @param [Hash] opts the optional parameters
19814
20149
  # @return [Array<(UserFinancialDataRefreshResponse, Integer, Hash)>] UserFinancialDataRefreshResponse data, response status code and response headers
@@ -20144,7 +20479,7 @@ module Plaid
20144
20479
  end
20145
20480
 
20146
20481
  # Remove Items from a User
20147
- # 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.
20482
+ # 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 and terminates billing on the Item's products. Once removed, Items cannot be reconnected without going through Link again. 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. If the user has any user-based recurring subscription products (Financial Management, Plaid Protect, or CRA Cash Flow Updates) and is deleting their account with your product, also call `/user/products/terminate` to end those subscriptions; per-Item billing is already terminated by this endpoint. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
20148
20483
  # @param user_items_remove_request [UserItemsRemoveRequest]
20149
20484
  # @param [Hash] opts the optional parameters
20150
20485
  # @return [UserItemsRemoveResponse]
@@ -20154,7 +20489,7 @@ module Plaid
20154
20489
  end
20155
20490
 
20156
20491
  # Remove Items from a User
20157
- # 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.
20492
+ # 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 and terminates billing on the Item&#39;s products. Once removed, Items cannot be reconnected without going through Link again. 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. If the user has any user-based recurring subscription products (Financial Management, Plaid Protect, or CRA Cash Flow Updates) and is deleting their account with your product, also call &#x60;/user/products/terminate&#x60; to end those subscriptions; per-Item billing is already terminated by this endpoint. For a user initiated data deletion request, see the [Consumer Service Center](https://plaid.com/check/consumer-service-center/) to revoke access to data.
20158
20493
  # @param user_items_remove_request [UserItemsRemoveRequest]
20159
20494
  # @param [Hash] opts the optional parameters
20160
20495
  # @return [Array<(UserItemsRemoveResponse, Integer, Hash)>] UserItemsRemoveResponse data, response status code and response headers
@@ -20212,7 +20547,7 @@ module Plaid
20212
20547
  end
20213
20548
 
20214
20549
  # Terminate user-based products
20215
- # `/user/products/terminate` terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA products) from all items associated with the user.
20550
+ # Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a `user_id`. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests.
20216
20551
  # @param user_products_terminate_request [UserProductsTerminateRequest]
20217
20552
  # @param [Hash] opts the optional parameters
20218
20553
  # @return [UserProductsTerminateResponse]
@@ -20222,7 +20557,7 @@ module Plaid
20222
20557
  end
20223
20558
 
20224
20559
  # Terminate user-based products
20225
- # &#x60;/user/products/terminate&#x60; terminates user-based recurring subscriptions for a given client user. This will remove user-based products (Financial Management, Protect, and CRA products) from all items associated with the user.
20560
+ # Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Cash Flow Updates) associated with a &#x60;user_id&#x60;. After you call this endpoint, the user will no longer be billed for these products. For CRA Monitoring, the subscription is canceled but historical data remains available for future report requests.
20226
20561
  # @param user_products_terminate_request [UserProductsTerminateRequest]
20227
20562
  # @param [Hash] opts the optional parameters
20228
20563
  # @return [Array<(UserProductsTerminateResponse, Integer, Hash)>] UserProductsTerminateResponse data, response status code and response headers
@@ -20280,7 +20615,7 @@ module Plaid
20280
20615
  end
20281
20616
 
20282
20617
  # Remove user
20283
- # `/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.
20618
+ # `/user/remove` deletes a `user_id` or `user_token` and associated information, including any Items associated with the user.
20284
20619
  # @param user_remove_request [UserRemoveRequest]
20285
20620
  # @param [Hash] opts the optional parameters
20286
20621
  # @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)
@@ -20291,7 +20626,7 @@ module Plaid
20291
20626
  end
20292
20627
 
20293
20628
  # Remove user
20294
- # &#x60;/user/remove&#x60; deletes a &#x60;user_id&#x60; or &#x60;user_token&#x60; and and associated information, including any Items associated with the user.
20629
+ # &#x60;/user/remove&#x60; deletes a &#x60;user_id&#x60; or &#x60;user_token&#x60; and associated information, including any Items associated with the user.
20295
20630
  # @param user_remove_request [UserRemoveRequest]
20296
20631
  # @param [Hash] opts the optional parameters
20297
20632
  # @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)
@@ -20419,7 +20754,7 @@ module Plaid
20419
20754
  end
20420
20755
 
20421
20756
  # Remove a third-party user token
20422
- # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
20757
+ # This endpoint is used to delete a third-party user token. Once removed, the token can no longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
20423
20758
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
20424
20759
  # @param [Hash] opts the optional parameters
20425
20760
  # @return [UserThirdPartyTokenRemoveResponse]
@@ -20429,7 +20764,7 @@ module Plaid
20429
20764
  end
20430
20765
 
20431
20766
  # Remove a third-party user token
20432
- # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
20767
+ # This endpoint is used to delete a third-party user token. Once removed, the token can no longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
20433
20768
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
20434
20769
  # @param [Hash] opts the optional parameters
20435
20770
  # @return [Array<(UserThirdPartyTokenRemoveResponse, Integer, Hash)>] UserThirdPartyTokenRemoveResponse data, response status code and response headers