plaid 46.2.0 → 47.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 (2079) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +138 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +362 -298
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/aamva_analysis.rb +1 -1
  10. data/lib/plaid/models/aamva_detailed_match_result.rb +1 -1
  11. data/lib/plaid/models/aamva_match_result.rb +1 -1
  12. data/lib/plaid/models/account_access.rb +2 -2
  13. data/lib/plaid/models/account_assets.rb +3 -3
  14. data/lib/plaid/models/account_balance.rb +3 -3
  15. data/lib/plaid/models/account_base.rb +5 -5
  16. data/lib/plaid/models/account_base_nullable.rb +5 -5
  17. data/lib/plaid/models/account_filter.rb +1 -1
  18. data/lib/plaid/models/account_filters_response.rb +1 -1
  19. data/lib/plaid/models/account_holder_category.rb +1 -1
  20. data/lib/plaid/models/account_identity.rb +4 -8
  21. data/lib/plaid/models/account_identity_all_of.rb +40 -2
  22. data/lib/plaid/models/account_identity_document_upload.rb +5 -5
  23. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  24. data/lib/plaid/models/account_identity_match_score.rb +4 -8
  25. data/lib/plaid/models/account_identity_match_score_all_of.rb +40 -2
  26. data/lib/plaid/models/account_insights.rb +1 -1
  27. data/lib/plaid/models/account_product_access.rb +1 -1
  28. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  29. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  30. data/lib/plaid/models/account_subtype.rb +1 -1
  31. data/lib/plaid/models/account_type.rb +1 -1
  32. data/lib/plaid/models/account_verification_insights.rb +1 -1
  33. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  34. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  35. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  36. data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
  37. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  38. data/lib/plaid/models/accounts_get_request.rb +2 -2
  39. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  40. data/lib/plaid/models/accounts_get_response.rb +1 -1
  41. data/lib/plaid/models/ach_class.rb +1 -1
  42. data/lib/plaid/models/action_state.rb +1 -1
  43. data/lib/plaid/models/activity.rb +2 -2
  44. data/lib/plaid/models/activity_type.rb +1 -1
  45. data/lib/plaid/models/address.rb +1 -1
  46. data/lib/plaid/models/address_data.rb +1 -1
  47. data/lib/plaid/models/address_data_not_required.rb +1 -1
  48. data/lib/plaid/models/address_data_nullable.rb +1 -1
  49. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  50. data/lib/plaid/models/address_match_score.rb +1 -1
  51. data/lib/plaid/models/address_nullable.rb +1 -1
  52. data/lib/plaid/models/address_purpose_label.rb +1 -1
  53. data/lib/plaid/models/affordability_insights.rb +2 -2
  54. data/lib/plaid/models/amount_with_currency.rb +1 -1
  55. data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +1 -1
  56. data/lib/plaid/models/application.rb +8 -8
  57. data/lib/plaid/models/application_get_request.rb +2 -2
  58. data/lib/plaid/models/application_get_response.rb +1 -1
  59. data/lib/plaid/models/apr.rb +1 -1
  60. data/lib/plaid/models/asset.rb +1 -1
  61. data/lib/plaid/models/asset_detail.rb +3 -3
  62. data/lib/plaid/models/asset_holder.rb +1 -1
  63. data/lib/plaid/models/asset_holder_name.rb +1 -1
  64. data/lib/plaid/models/asset_holding.rb +1 -1
  65. data/lib/plaid/models/asset_holdings.rb +1 -1
  66. data/lib/plaid/models/asset_investment_transaction_type.rb +1 -1
  67. data/lib/plaid/models/asset_owner.rb +1 -1
  68. data/lib/plaid/models/asset_owners.rb +2 -2
  69. data/lib/plaid/models/asset_report.rb +1 -1
  70. data/lib/plaid/models/asset_report_account_balance.rb +3 -3
  71. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  72. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  75. data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  78. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  80. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  81. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  84. data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
  85. data/lib/plaid/models/asset_report_freddie_get_response.rb +2 -2
  86. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  90. data/lib/plaid/models/asset_report_investment_security.rb +2 -2
  91. data/lib/plaid/models/asset_report_investment_transaction.rb +3 -3
  92. data/lib/plaid/models/asset_report_investments.rb +1 -1
  93. data/lib/plaid/models/asset_report_item.rb +2 -2
  94. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  95. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  96. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  97. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  98. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  99. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  100. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  101. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  102. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  103. data/lib/plaid/models/asset_report_type.rb +1 -1
  104. data/lib/plaid/models/asset_report_user.rb +2 -2
  105. data/lib/plaid/models/asset_transaction.rb +2 -2
  106. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  107. data/lib/plaid/models/asset_transaction_description.rb +2 -2
  108. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  109. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  110. data/lib/plaid/models/asset_transactions.rb +1 -1
  111. data/lib/plaid/models/asset_type.rb +1 -1
  112. data/lib/plaid/models/assets.rb +1 -1
  113. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  114. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  115. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  116. data/lib/plaid/models/auth_get_numbers.rb +3 -3
  117. data/lib/plaid/models/auth_get_request.rb +2 -2
  118. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  119. data/lib/plaid/models/auth_get_response.rb +1 -1
  120. data/lib/plaid/models/auth_metadata.rb +1 -1
  121. data/lib/plaid/models/auth_supported_methods.rb +3 -3
  122. data/lib/plaid/models/auth_update_types.rb +1 -1
  123. data/lib/plaid/models/auth_verify_numbers_ach.rb +1 -1
  124. data/lib/plaid/models/auth_verify_request.rb +1 -1
  125. data/lib/plaid/models/auth_verify_request_numbers.rb +1 -1
  126. data/lib/plaid/models/auth_verify_response.rb +2 -2
  127. data/lib/plaid/models/authorization_guarantee_details.rb +264 -0
  128. data/lib/plaid/models/authorization_guarantee_schedule_item.rb +241 -0
  129. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  130. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  131. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  132. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  133. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +2 -2
  134. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +2 -2
  135. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  136. data/lib/plaid/models/bank_penalties_indicators.rb +1 -1
  137. data/lib/plaid/models/bank_transfer.rb +3 -3
  138. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  142. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_create_request.rb +3 -3
  144. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_event.rb +3 -3
  147. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
  150. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  156. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  157. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  158. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  159. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  160. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  161. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  162. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  163. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  164. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  165. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  166. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  167. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  168. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  169. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  170. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  171. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +2 -2
  172. data/lib/plaid/models/base_report.rb +2 -2
  173. data/lib/plaid/models/base_report_account.rb +2 -2
  174. data/lib/plaid/models/base_report_account_balances.rb +3 -3
  175. data/lib/plaid/models/base_report_account_insights.rb +2 -2
  176. data/lib/plaid/models/base_report_account_metadata.rb +1 -1
  177. data/lib/plaid/models/base_report_attributes.rb +1 -1
  178. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  179. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  180. data/lib/plaid/models/base_report_historical_balance.rb +1 -1
  181. data/lib/plaid/models/base_report_investment_holding.rb +1 -1
  182. data/lib/plaid/models/base_report_investment_security.rb +2 -2
  183. data/lib/plaid/models/base_report_investment_transaction.rb +3 -3
  184. data/lib/plaid/models/base_report_investments.rb +1 -1
  185. data/lib/plaid/models/base_report_item.rb +2 -2
  186. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  187. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  188. data/lib/plaid/models/base_report_transaction.rb +1 -1
  189. data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +2 -2
  190. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  191. data/lib/plaid/models/base_report_user_attributes.rb +1 -1
  192. data/lib/plaid/models/base_report_warning.rb +1 -1
  193. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  194. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  195. data/lib/plaid/models/beacon_account_risk_attributes.rb +3 -3
  196. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  197. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +2 -2
  198. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  199. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +4 -4
  200. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  201. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  202. data/lib/plaid/models/beacon_audit_trail.rb +2 -2
  203. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  204. data/lib/plaid/models/beacon_bank_account_insights.rb +2 -2
  205. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  206. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  207. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  208. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  209. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  210. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  211. data/lib/plaid/models/beacon_report.rb +1 -1
  212. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  213. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  214. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  215. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  216. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  217. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  218. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  219. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  220. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  221. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  222. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  223. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  224. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  225. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  226. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  227. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  228. data/lib/plaid/models/beacon_report_type.rb +1 -1
  229. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  230. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +2 -2
  231. data/lib/plaid/models/beacon_user.rb +1 -1
  232. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +2 -2
  233. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +2 -2
  234. data/lib/plaid/models/beacon_user_address.rb +1 -1
  235. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  236. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  237. data/lib/plaid/models/beacon_user_data.rb +2 -2
  238. data/lib/plaid/models/beacon_user_depository_account.rb +2 -2
  239. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  240. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  241. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  242. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  243. data/lib/plaid/models/beacon_user_id_number.rb +2 -2
  244. data/lib/plaid/models/beacon_user_name.rb +1 -1
  245. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  246. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  247. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  248. data/lib/plaid/models/beacon_user_request_data.rb +2 -2
  249. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  250. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  251. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  252. data/lib/plaid/models/beacon_user_status.rb +1 -1
  253. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  254. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  255. data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
  256. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  257. data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +2 -2
  258. data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +1 -1
  259. data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +2 -2
  260. data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +1 -1
  261. data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +1 -1
  262. data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +1 -1
  263. data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +1 -1
  264. data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +1 -1
  265. data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +1 -1
  266. data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +1 -1
  267. data/lib/plaid/models/beta_partner_end_customer.rb +1 -1
  268. data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +1 -1
  269. data/lib/plaid/models/business_account.rb +4 -8
  270. data/lib/plaid/models/business_account_all_of.rb +40 -2
  271. data/lib/plaid/models/business_check_boolean_status.rb +1 -1
  272. data/lib/plaid/models/business_digital_presence_check.rb +1 -1
  273. data/lib/plaid/models/business_email_address.rb +1 -1
  274. data/lib/plaid/models/business_entity_type.rb +1 -1
  275. data/lib/plaid/models/business_field_match_summary.rb +1 -1
  276. data/lib/plaid/models/business_finance_category.rb +2 -2
  277. data/lib/plaid/models/business_industry_prediction.rb +1 -1
  278. data/lib/plaid/models/business_industry_prediction_nullable.rb +1 -1
  279. data/lib/plaid/models/business_kyb_check.rb +1 -1
  280. data/lib/plaid/models/business_kyb_match_details.rb +1 -1
  281. data/lib/plaid/models/business_phone_number.rb +1 -1
  282. data/lib/plaid/models/business_risk_check.rb +1 -1
  283. data/lib/plaid/models/business_search_terms.rb +1 -1
  284. data/lib/plaid/models/business_verification_create_request.rb +1 -1
  285. data/lib/plaid/models/business_verification_create_request_business.rb +1 -1
  286. data/lib/plaid/models/business_verification_create_response.rb +1 -1
  287. data/lib/plaid/models/business_verification_get_request.rb +1 -1
  288. data/lib/plaid/models/business_verification_get_response.rb +1 -1
  289. data/lib/plaid/models/business_verification_status_kyb_check.rb +1 -1
  290. data/lib/plaid/models/business_verification_status_overall.rb +1 -1
  291. data/lib/plaid/models/business_verification_status_risk_check.rb +1 -1
  292. data/lib/plaid/models/business_verification_status_web_presence_check.rb +1 -1
  293. data/lib/plaid/models/business_website.rb +1 -1
  294. data/lib/plaid/models/business_website_analysis.rb +1 -1
  295. data/lib/plaid/models/business_website_build_status.rb +1 -1
  296. data/lib/plaid/models/business_website_ssl.rb +1 -1
  297. data/lib/plaid/models/business_whois_record.rb +1 -1
  298. data/lib/plaid/models/cash_flow_insight.rb +1 -1
  299. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +1 -1
  300. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +2 -2
  301. data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +2 -2
  302. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +1 -1
  303. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +2 -2
  304. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +2 -2
  305. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +2 -2
  306. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +2 -2
  307. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +2 -2
  308. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  309. data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
  310. data/lib/plaid/models/cashflow_report_get_request.rb +2 -2
  311. data/lib/plaid/models/cashflow_report_get_request_options.rb +1 -1
  312. data/lib/plaid/models/cashflow_report_get_response.rb +1 -1
  313. data/lib/plaid/models/cashflow_report_historical_balance.rb +1 -1
  314. data/lib/plaid/models/cashflow_report_insights_get_request.rb +2 -2
  315. data/lib/plaid/models/cashflow_report_insights_get_response.rb +2 -2
  316. data/lib/plaid/models/cashflow_report_monthly_summary.rb +1 -1
  317. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +1 -1
  318. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +1 -1
  319. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +1 -1
  320. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +1 -1
  321. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +1 -1
  322. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +1 -1
  323. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +1 -1
  324. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +1 -1
  325. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +1 -1
  326. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +1 -1
  327. data/lib/plaid/models/cashflow_report_payment_meta.rb +1 -1
  328. data/lib/plaid/models/cashflow_report_refresh_request.rb +2 -2
  329. data/lib/plaid/models/cashflow_report_refresh_response.rb +2 -2
  330. data/lib/plaid/models/cashflow_report_transaction.rb +1 -1
  331. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +2 -2
  332. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +1 -1
  333. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +1 -1
  334. data/lib/plaid/models/categories_get_response.rb +1 -1
  335. data/lib/plaid/models/category.rb +1 -1
  336. data/lib/plaid/models/category_expenses.rb +1 -1
  337. data/lib/plaid/models/category_insight_details.rb +1 -1
  338. data/lib/plaid/models/category_insights.rb +1 -1
  339. data/lib/plaid/models/cause.rb +2 -2
  340. data/lib/plaid/models/cause_all_of.rb +1 -1
  341. data/lib/plaid/models/check_report_warning.rb +1 -1
  342. data/lib/plaid/models/check_report_warning_code.rb +1 -1
  343. data/lib/plaid/models/client_customization.rb +1 -1
  344. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  345. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  346. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  347. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  348. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  349. data/lib/plaid/models/client_user_identity.rb +1 -1
  350. data/lib/plaid/models/client_user_identity_address.rb +1 -1
  351. data/lib/plaid/models/client_user_identity_email.rb +1 -1
  352. data/lib/plaid/models/client_user_identity_name.rb +1 -1
  353. data/lib/plaid/models/client_user_identity_phone_number.rb +1 -1
  354. data/lib/plaid/models/connected_application.rb +2 -2
  355. data/lib/plaid/models/consent_event.rb +3 -3
  356. data/lib/plaid/models/consent_event_code.rb +1 -1
  357. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  358. data/lib/plaid/models/consent_event_type.rb +1 -1
  359. data/lib/plaid/models/consent_events_get_request.rb +2 -2
  360. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  361. data/lib/plaid/models/consented_account.rb +2 -2
  362. data/lib/plaid/models/consumer_dispute.rb +1 -1
  363. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  364. data/lib/plaid/models/consumer_report_pdf_get_request.rb +2 -2
  365. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  366. data/lib/plaid/models/consumer_report_user_identity.rb +4 -4
  367. data/lib/plaid/models/counterparty.rb +3 -3
  368. data/lib/plaid/models/counterparty_insights.rb +3 -3
  369. data/lib/plaid/models/counterparty_numbers.rb +1 -1
  370. data/lib/plaid/models/counterparty_numbers_bacs.rb +4 -4
  371. data/lib/plaid/models/counterparty_numbers_international.rb +2 -2
  372. data/lib/plaid/models/counterparty_type.rb +1 -1
  373. data/lib/plaid/models/country_code.rb +1 -1
  374. data/lib/plaid/models/cra_annual_income_values.rb +1 -1
  375. data/lib/plaid/models/cra_bank_income_account.rb +2 -2
  376. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  377. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  378. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  379. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  380. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +2 -2
  381. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  382. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  383. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  384. data/lib/plaid/models/cra_bank_income_income_provider.rb +1 -1
  385. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  386. data/lib/plaid/models/cra_bank_income_source.rb +4 -4
  387. data/lib/plaid/models/cra_bank_income_status.rb +1 -1
  388. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  389. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  390. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  391. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  392. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  393. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +4 -4
  394. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  395. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +1 -1
  396. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +3 -3
  397. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
  398. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +1 -1
  399. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +1 -1
  400. data/lib/plaid/models/cra_check_report_create_request.rb +3 -3
  401. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  402. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  403. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
  404. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
  405. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
  406. data/lib/plaid/models/cra_check_report_gse_options.rb +1 -1
  407. data/lib/plaid/models/cra_check_report_home_lending_report_options.rb +1 -1
  408. data/lib/plaid/models/cra_check_report_income_insights_get_options.rb +1 -1
  409. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +3 -3
  410. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  411. data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +1 -1
  412. data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +3 -3
  413. data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +1 -1
  414. data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +1 -1
  415. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +3 -3
  416. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +2 -2
  417. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  418. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +2 -2
  419. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +4 -4
  420. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +2 -2
  421. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +3 -3
  422. data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
  423. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +1 -1
  424. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +2 -1
  425. data/lib/plaid/models/cra_check_report_verification_get_request.rb +3 -3
  426. data/lib/plaid/models/cra_check_report_verification_get_response.rb +1 -1
  427. data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +31 -29
  428. data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +2 -1
  429. data/lib/plaid/models/cra_credit_profile_inquiry_type.rb +1 -1
  430. data/lib/plaid/models/cra_credit_profile_lend_score.rb +2 -2
  431. data/lib/plaid/models/cra_credit_profile_report.rb +1 -1
  432. data/lib/plaid/models/cra_credit_profile_report_get_request.rb +2 -2
  433. data/lib/plaid/models/cra_credit_profile_report_get_response.rb +12 -2
  434. data/lib/plaid/models/cra_credit_profile_report_metadata.rb +1 -1
  435. data/lib/plaid/models/cra_credit_profile_report_type.rb +1 -1
  436. data/lib/plaid/models/cra_credit_profile_report_version.rb +1 -1
  437. data/lib/plaid/models/cra_current_modeled_income.rb +1 -1
  438. data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
  439. data/lib/plaid/models/cra_employment_refresh_report_account.rb +2 -2
  440. data/lib/plaid/models/cra_employment_refresh_report_item.rb +2 -2
  441. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
  442. data/lib/plaid/models/cra_income_category.rb +1 -1
  443. data/lib/plaid/models/cra_income_insights.rb +6 -1
  444. data/lib/plaid/models/cra_income_insights_user_summary.rb +1 -1
  445. data/lib/plaid/models/cra_income_metrics.rb +1 -1
  446. data/lib/plaid/models/cra_income_next_payment.rb +1 -1
  447. data/lib/plaid/models/cra_income_stream.rb +1 -1
  448. data/lib/plaid/models/cra_income_stream_insights.rb +1 -1
  449. data/lib/plaid/models/cra_income_transaction.rb +1 -1
  450. data/lib/plaid/models/cra_income_transaction_outlier.rb +1 -1
  451. data/lib/plaid/models/cra_lend_score_report.rb +1 -1
  452. data/lib/plaid/models/cra_loan_application.rb +1 -1
  453. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  454. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  455. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  456. data/lib/plaid/models/cra_loan_payment_history.rb +2 -2
  457. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  458. data/lib/plaid/models/cra_loan_register.rb +1 -1
  459. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  460. data/lib/plaid/models/cra_loan_status.rb +1 -1
  461. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  462. data/lib/plaid/models/cra_loan_type.rb +1 -1
  463. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  464. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  465. data/lib/plaid/models/cra_loan_update.rb +1 -1
  466. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  467. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  468. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  469. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  470. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  471. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  472. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  473. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +3 -3
  474. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  475. data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
  476. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +4 -4
  477. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  478. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  479. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  480. data/lib/plaid/models/cra_monthly_income_values.rb +1 -1
  481. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  482. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  483. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  484. data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +29 -8
  485. data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +1 -1
  486. data/lib/plaid/models/cra_partner_insights_bureau.rb +1 -1
  487. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  488. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  489. data/lib/plaid/models/cra_partner_insights_fico_input.rb +5 -5
  490. data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +2 -2
  491. data/lib/plaid/models/cra_partner_insights_fico_results.rb +3 -3
  492. data/lib/plaid/models/cra_partner_insights_get_request.rb +2 -2
  493. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  494. data/lib/plaid/models/cra_partner_insights_item.rb +3 -3
  495. data/lib/plaid/models/cra_partner_insights_item_account.rb +2 -2
  496. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  497. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  498. data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +54 -12
  499. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +4 -4
  500. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +4 -4
  501. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +1 -1
  502. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  503. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  504. data/lib/plaid/models/cra_projected_modeled_income.rb +1 -1
  505. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  506. data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +3 -3
  507. data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +3 -3
  508. data/lib/plaid/models/cra_user_tier.rb +1 -1
  509. data/lib/plaid/models/cra_verification_income_account.rb +323 -0
  510. data/lib/plaid/models/cra_verification_income_category.rb +241 -0
  511. data/lib/plaid/models/{network_insights_item.rb → cra_verification_income_item.rb} +58 -26
  512. data/lib/plaid/models/cra_verification_income_metrics.rb +243 -0
  513. data/lib/plaid/models/{network_insights_report_get_response.rb → cra_verification_income_next_payment.rb} +16 -30
  514. data/lib/plaid/models/cra_verification_income_pay_frequency.rb +43 -0
  515. data/lib/plaid/models/{item_handle_fraud_report_response.rb → cra_verification_income_provider.rb} +26 -26
  516. data/lib/plaid/models/{network_insights_report.rb → cra_verification_income_report.rb} +46 -34
  517. data/lib/plaid/models/cra_verification_income_status.rb +40 -0
  518. data/lib/plaid/models/cra_verification_income_stream.rb +316 -0
  519. data/lib/plaid/models/cra_verification_income_stream_insights.rb +295 -0
  520. data/lib/plaid/models/cra_verification_income_transaction.rb +337 -0
  521. data/lib/plaid/models/cra_verification_income_transaction_outlier.rb +237 -0
  522. data/lib/plaid/models/cra_verification_income_user_summary.rb +228 -0
  523. data/lib/plaid/models/{link_session_protect_result.rb → cra_verification_income_values.rb} +28 -36
  524. data/lib/plaid/models/cra_verification_modeled_income.rb +239 -0
  525. data/lib/plaid/models/cra_verification_report.rb +16 -6
  526. data/lib/plaid/models/cra_voa_report.rb +1 -1
  527. data/lib/plaid/models/cra_voa_report_account.rb +2 -2
  528. data/lib/plaid/models/cra_voa_report_account_balances.rb +3 -3
  529. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
  530. data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
  531. data/lib/plaid/models/cra_voa_report_item.rb +2 -2
  532. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +1 -1
  533. data/lib/plaid/models/credit1099.rb +1 -1
  534. data/lib/plaid/models/credit1099_filer.rb +1 -1
  535. data/lib/plaid/models/credit1099_payer.rb +1 -1
  536. data/lib/plaid/models/credit1099_recipient.rb +3 -3
  537. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  538. data/lib/plaid/models/credit_ach_class.rb +1 -1
  539. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  540. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  541. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +2 -2
  542. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  543. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  544. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  545. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  546. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  547. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  548. data/lib/plaid/models/credit_bank_employment_get_request.rb +2 -2
  549. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  550. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  551. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  552. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  553. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  554. data/lib/plaid/models/credit_bank_income.rb +1 -1
  555. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  556. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  557. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  558. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  559. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  560. data/lib/plaid/models/credit_bank_income_get_request.rb +2 -2
  561. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  562. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  563. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  564. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  565. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  566. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +2 -2
  567. data/lib/plaid/models/credit_bank_income_refresh_request.rb +2 -2
  568. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  569. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  570. data/lib/plaid/models/credit_bank_income_source.rb +3 -3
  571. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  572. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  573. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  574. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  575. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  576. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +2 -2
  577. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  578. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  579. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  580. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  581. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  582. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  583. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  584. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  585. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +2 -2
  586. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  587. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  588. data/lib/plaid/models/credit_card_liability.rb +1 -1
  589. data/lib/plaid/models/credit_category.rb +1 -1
  590. data/lib/plaid/models/credit_document_metadata.rb +2 -2
  591. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  592. data/lib/plaid/models/credit_employment_get_request.rb +2 -2
  593. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  594. data/lib/plaid/models/credit_employment_item.rb +1 -1
  595. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  596. data/lib/plaid/models/credit_filter.rb +1 -1
  597. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  598. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  599. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  600. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  601. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  602. data/lib/plaid/models/credit_freddie_mac_loan.rb +2 -2
  603. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  604. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  605. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  606. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  607. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  608. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +3 -3
  609. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +2 -2
  610. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  611. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  612. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  613. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  614. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  615. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  616. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  617. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  618. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  619. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  620. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  621. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  622. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  623. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  624. data/lib/plaid/models/credit_payroll_income_get_request.rb +2 -2
  625. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  626. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  627. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +3 -3
  628. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +2 -2
  629. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +2 -2
  630. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  631. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +2 -2
  632. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  633. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  634. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
  635. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  636. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  637. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  638. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  639. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  640. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  641. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  642. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  643. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  644. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  645. data/lib/plaid/models/credit_session.rb +1 -1
  646. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  647. data/lib/plaid/models/credit_session_bank_employment_status.rb +3 -1
  648. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  649. data/lib/plaid/models/credit_session_bank_income_status.rb +3 -1
  650. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  651. data/lib/plaid/models/credit_session_error.rb +1 -1
  652. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  653. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  654. data/lib/plaid/models/credit_session_results.rb +1 -1
  655. data/lib/plaid/models/credit_sessions_get_request.rb +2 -2
  656. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  657. data/lib/plaid/models/credit_w2.rb +4 -4
  658. data/lib/plaid/models/custom_sandbox_transaction.rb +1 -1
  659. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  660. data/lib/plaid/models/dashboard_user.rb +2 -2
  661. data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
  662. data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
  663. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  664. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  665. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  666. data/lib/plaid/models/data_sources.rb +1 -1
  667. data/lib/plaid/models/date_range.rb +1 -1
  668. data/lib/plaid/models/deductions.rb +1 -1
  669. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  670. data/lib/plaid/models/deductions_total.rb +1 -1
  671. data/lib/plaid/models/default_update_webhook.rb +1 -1
  672. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  673. data/lib/plaid/models/depository_filter.rb +2 -2
  674. data/lib/plaid/models/detailed_originator.rb +2 -2
  675. data/lib/plaid/models/detected_account.rb +1 -1
  676. data/lib/plaid/models/device_id.rb +1 -1
  677. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  678. data/lib/plaid/models/doc_type.rb +1 -1
  679. data/lib/plaid/models/document_analysis.rb +1 -1
  680. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  681. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  682. data/lib/plaid/models/document_metadata.rb +1 -1
  683. data/lib/plaid/models/document_name_match_code.rb +1 -1
  684. data/lib/plaid/models/document_risk_signal.rb +1 -1
  685. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  686. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  687. data/lib/plaid/models/document_risk_summary.rb +1 -1
  688. data/lib/plaid/models/document_status.rb +1 -1
  689. data/lib/plaid/models/documentary_verification.rb +1 -1
  690. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  691. data/lib/plaid/models/earnings.rb +1 -1
  692. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  693. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  694. data/lib/plaid/models/earnings_total.rb +1 -1
  695. data/lib/plaid/models/email.rb +1 -1
  696. data/lib/plaid/models/email_address_match_score.rb +1 -1
  697. data/lib/plaid/models/employee.rb +1 -1
  698. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  699. data/lib/plaid/models/employer.rb +1 -1
  700. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  701. data/lib/plaid/models/employer_verification.rb +1 -1
  702. data/lib/plaid/models/employers_search_request.rb +1 -1
  703. data/lib/plaid/models/employers_search_response.rb +1 -1
  704. data/lib/plaid/models/employment_details.rb +1 -1
  705. data/lib/plaid/models/employment_source_type.rb +1 -1
  706. data/lib/plaid/models/employment_verification.rb +1 -1
  707. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  708. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  709. data/lib/plaid/models/employment_verification_status.rb +1 -1
  710. data/lib/plaid/models/enhancements.rb +1 -1
  711. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  712. data/lib/plaid/models/enrichments.rb +2 -2
  713. data/lib/plaid/models/entity_document.rb +1 -1
  714. data/lib/plaid/models/entity_document_type.rb +1 -1
  715. data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
  716. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  717. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  718. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  719. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  720. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  721. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  722. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  723. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  724. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  725. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  726. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  727. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  728. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  729. data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
  730. data/lib/plaid/models/entity_watchlist_screening_hit.rb +19 -2
  731. data/lib/plaid/models/entity_watchlist_screening_review.rb +2 -2
  732. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  733. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  734. data/lib/plaid/models/ewa_score.rb +1 -1
  735. data/lib/plaid/models/expenditure_insights.rb +1 -1
  736. data/lib/plaid/models/expenditure_insights_cash_flow.rb +1 -1
  737. data/lib/plaid/models/expenditure_summary.rb +2 -2
  738. data/lib/plaid/models/expiration_date.rb +1 -1
  739. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  740. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  741. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  742. data/lib/plaid/models/external_payment_options.rb +1 -1
  743. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  744. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  745. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  746. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  747. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  748. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  749. data/lib/plaid/models/fdx_consent_grant.rb +331 -0
  750. data/lib/plaid/models/fdx_consent_grant_resource.rb +279 -0
  751. data/lib/plaid/models/fdx_consent_grant_status.rb +40 -0
  752. data/lib/plaid/models/fdx_consent_resource_type.rb +40 -0
  753. data/lib/plaid/models/fdx_consent_revocation.rb +281 -0
  754. data/lib/plaid/models/fdx_consent_revocation_record.rb +290 -0
  755. data/lib/plaid/models/fdx_consent_revocations.rb +228 -0
  756. data/lib/plaid/models/fdx_content_types.rb +1 -1
  757. data/lib/plaid/models/fdx_data_cluster.rb +53 -0
  758. data/lib/plaid/models/fdx_event_status.rb +1 -1
  759. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  760. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  761. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  762. data/lib/plaid/models/fdx_lifecycle_event.rb +1 -1
  763. data/lib/plaid/models/fdx_notification.rb +2 -2
  764. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  765. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  766. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  767. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  768. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  769. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  770. data/lib/plaid/models/fdx_party.rb +1 -1
  771. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  772. data/lib/plaid/models/fdx_party_type.rb +1 -1
  773. data/lib/plaid/models/fdx_recipient_metadata.rb +2 -2
  774. data/lib/plaid/models/fdx_update_reason.rb +1 -1
  775. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  776. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  777. data/lib/plaid/models/fixed_income.rb +1 -1
  778. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  779. data/lib/plaid/models/form1099_type.rb +1 -1
  780. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  781. data/lib/plaid/models/fraud_amount.rb +1 -1
  782. data/lib/plaid/models/fraud_analysis_details.rb +8 -23
  783. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  784. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  785. data/lib/plaid/models/gambling_indicators.rb +1 -1
  786. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  787. data/lib/plaid/models/get_recipient_response.rb +1 -1
  788. data/lib/plaid/models/get_recipients_response.rb +1 -1
  789. data/lib/plaid/models/gse_report_type.rb +1 -1
  790. data/lib/plaid/models/health_incident.rb +1 -1
  791. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  792. data/lib/plaid/models/historical_annual_income.rb +1 -1
  793. data/lib/plaid/models/historical_balance.rb +1 -1
  794. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  795. data/lib/plaid/models/holding.rb +18 -6
  796. data/lib/plaid/models/holding_tax_lot.rb +309 -0
  797. data/lib/plaid/models/holding_tax_lot_position_type.rb +39 -0
  798. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  799. data/lib/plaid/models/holdings_override.rb +1 -1
  800. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  801. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +3 -3
  802. data/lib/plaid/models/human_review.rb +1 -1
  803. data/lib/plaid/models/human_review_status.rb +1 -1
  804. data/lib/plaid/models/id_number_type.rb +2 -1
  805. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  806. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  807. data/lib/plaid/models/identity_document_upload.rb +1 -1
  808. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  809. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  810. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  811. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  812. data/lib/plaid/models/identity_documents_uploads_get_request.rb +2 -2
  813. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  814. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  815. data/lib/plaid/models/identity_get_request.rb +2 -2
  816. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  817. data/lib/plaid/models/identity_get_response.rb +1 -1
  818. data/lib/plaid/models/identity_match_request.rb +2 -2
  819. data/lib/plaid/models/identity_match_request_options.rb +2 -2
  820. data/lib/plaid/models/identity_match_response.rb +1 -1
  821. data/lib/plaid/models/identity_match_user.rb +1 -1
  822. data/lib/plaid/models/identity_refresh_request.rb +2 -2
  823. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  824. data/lib/plaid/models/identity_update_types.rb +1 -1
  825. data/lib/plaid/models/identity_verification.rb +2 -2
  826. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  827. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  828. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  829. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  830. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  831. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  832. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  833. data/lib/plaid/models/identity_verification_create_response.rb +2 -2
  834. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  835. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  836. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  837. data/lib/plaid/models/identity_verification_get_response.rb +2 -2
  838. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  839. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  840. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  841. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  842. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  843. data/lib/plaid/models/identity_verification_retried_webhook.rb +2 -2
  844. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  845. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  846. data/lib/plaid/models/identity_verification_retry_response.rb +2 -2
  847. data/lib/plaid/models/identity_verification_status.rb +1 -1
  848. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  849. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  850. data/lib/plaid/models/identity_verification_step_summary.rb +2 -2
  851. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  852. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  853. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  854. data/lib/plaid/models/identity_verification_user_data.rb +2 -2
  855. data/lib/plaid/models/idv_protect_event.rb +2 -2
  856. data/lib/plaid/models/image_quality.rb +1 -1
  857. data/lib/plaid/models/image_quality_details.rb +4 -23
  858. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  859. data/lib/plaid/models/incident_update.rb +1 -1
  860. data/lib/plaid/models/income_breakdown.rb +1 -1
  861. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  862. data/lib/plaid/models/income_insights.rb +1 -1
  863. data/lib/plaid/models/income_insights_filter.rb +1 -1
  864. data/lib/plaid/models/income_insights_income_excluding_transfers.rb +1 -1
  865. data/lib/plaid/models/income_insights_total_income.rb +1 -1
  866. data/lib/plaid/models/income_insights_transfers_in.rb +1 -1
  867. data/lib/plaid/models/income_insights_version.rb +1 -1
  868. data/lib/plaid/models/income_override.rb +1 -1
  869. data/lib/plaid/models/income_sources_counts.rb +1 -1
  870. data/lib/plaid/models/income_summary.rb +1 -1
  871. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  872. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  873. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  874. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  875. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  876. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  877. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  878. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  879. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  880. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  881. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  882. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  883. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  884. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  885. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  886. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  887. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  888. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  889. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  890. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  891. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +6 -1
  892. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  893. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  894. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  895. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  896. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  897. data/lib/plaid/models/individual_name.rb +2 -2
  898. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  899. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  900. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  901. data/lib/plaid/models/inflow_model.rb +1 -1
  902. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  903. data/lib/plaid/models/institution.rb +1 -1
  904. data/lib/plaid/models/institution_status.rb +1 -1
  905. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  906. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  907. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  908. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  909. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  910. data/lib/plaid/models/institutions_get_request.rb +1 -1
  911. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  912. data/lib/plaid/models/institutions_get_response.rb +1 -1
  913. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  914. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  915. data/lib/plaid/models/institutions_search_request.rb +1 -1
  916. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  917. data/lib/plaid/models/institutions_search_response.rb +1 -1
  918. data/lib/plaid/models/investment_account.rb +4 -8
  919. data/lib/plaid/models/investment_account_all_of.rb +40 -2
  920. data/lib/plaid/models/investment_account_balance.rb +3 -3
  921. data/lib/plaid/models/investment_account_balance_all_of.rb +1 -1
  922. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  923. data/lib/plaid/models/investment_filter.rb +1 -1
  924. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  925. data/lib/plaid/models/investment_transaction.rb +3 -3
  926. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  927. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  928. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  929. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  930. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  931. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  932. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  933. data/lib/plaid/models/investments_auth_get_request.rb +2 -2
  934. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  935. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  936. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  937. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  938. data/lib/plaid/models/investments_historical_update_webhook.rb +2 -2
  939. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  940. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  941. data/lib/plaid/models/investments_refresh_request.rb +2 -2
  942. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  943. data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
  944. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  945. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  946. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  947. data/lib/plaid/models/iso_currency_code.rb +1 -1
  948. data/lib/plaid/models/issue.rb +1 -1
  949. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  950. data/lib/plaid/models/issues_get_request.rb +1 -1
  951. data/lib/plaid/models/issues_get_response.rb +1 -1
  952. data/lib/plaid/models/issues_search_request.rb +1 -1
  953. data/lib/plaid/models/issues_search_response.rb +1 -1
  954. data/lib/plaid/models/issues_status.rb +1 -1
  955. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  956. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  957. data/lib/plaid/models/issuing_country.rb +1 -1
  958. data/lib/plaid/models/item.rb +3 -3
  959. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  960. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  961. data/lib/plaid/models/item_activity_list_request.rb +2 -2
  962. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  963. data/lib/plaid/models/item_add_result_webhook.rb +3 -3
  964. data/lib/plaid/models/item_application_list_request.rb +2 -2
  965. data/lib/plaid/models/item_application_list_response.rb +1 -1
  966. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  967. data/lib/plaid/models/item_application_scopes_update_request.rb +3 -3
  968. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  969. data/lib/plaid/models/item_application_unlink_request.rb +3 -3
  970. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  971. data/lib/plaid/models/item_auth_method.rb +1 -1
  972. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  973. data/lib/plaid/models/item_create_authentication.rb +1 -1
  974. data/lib/plaid/models/item_error_webhook.rb +2 -2
  975. data/lib/plaid/models/item_get_request.rb +2 -2
  976. data/lib/plaid/models/item_get_response.rb +1 -1
  977. data/lib/plaid/models/item_import_request.rb +1 -1
  978. data/lib/plaid/models/item_import_request_options.rb +1 -1
  979. data/lib/plaid/models/item_import_request_user_auth.rb +3 -3
  980. data/lib/plaid/models/item_import_response.rb +2 -2
  981. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  982. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  983. data/lib/plaid/models/item_products_terminate_reason_code.rb +195 -15
  984. data/lib/plaid/models/item_products_terminate_request.rb +2 -24
  985. data/lib/plaid/models/item_products_terminate_response.rb +1 -1
  986. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  987. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  988. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  989. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  990. data/lib/plaid/models/item_remove_reason_code.rb +1 -1
  991. data/lib/plaid/models/item_remove_request.rb +3 -3
  992. data/lib/plaid/models/item_remove_response.rb +1 -1
  993. data/lib/plaid/models/item_status.rb +1 -1
  994. data/lib/plaid/models/item_status_investments.rb +1 -1
  995. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  996. data/lib/plaid/models/item_status_nullable.rb +1 -1
  997. data/lib/plaid/models/item_status_transactions.rb +2 -2
  998. data/lib/plaid/models/item_webhook_update_request.rb +2 -2
  999. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  1000. data/lib/plaid/models/item_with_consent_fields.rb +3 -3
  1001. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  1002. data/lib/plaid/models/jwk_public_key.rb +1 -1
  1003. data/lib/plaid/models/jwt_header.rb +1 -1
  1004. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  1005. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  1006. data/lib/plaid/models/kyc_check_details.rb +1 -1
  1007. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  1008. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  1009. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  1010. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  1011. data/lib/plaid/models/last_data_access_times.rb +1 -1
  1012. data/lib/plaid/models/latest_scored_event.rb +2 -2
  1013. data/lib/plaid/models/layer_authentication_passed_webhook.rb +1 -1
  1014. data/lib/plaid/models/ledger_event_source_type.rb +1 -1
  1015. data/lib/plaid/models/lend_score.rb +2 -2
  1016. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  1017. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  1018. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  1019. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  1020. data/lib/plaid/models/liabilities_object.rb +1 -1
  1021. data/lib/plaid/models/liability_override.rb +1 -1
  1022. data/lib/plaid/models/limited_purpose_type.rb +1 -1
  1023. data/lib/plaid/models/link_callback_metadata.rb +2 -2
  1024. data/lib/plaid/models/link_delivery_account.rb +1 -1
  1025. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  1026. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  1027. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  1028. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  1029. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  1030. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  1031. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  1032. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  1033. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  1034. data/lib/plaid/models/link_delivery_options.rb +1 -1
  1035. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  1036. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  1037. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  1038. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  1039. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  1040. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  1041. data/lib/plaid/models/link_event.rb +1 -1
  1042. data/lib/plaid/models/link_event_metadata.rb +2 -2
  1043. data/lib/plaid/models/link_event_name.rb +1 -1
  1044. data/lib/plaid/models/link_events_webhook.rb +2 -2
  1045. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  1046. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  1047. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  1048. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  1049. data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
  1050. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  1051. data/lib/plaid/models/link_session_cra_update_result.rb +2 -2
  1052. data/lib/plaid/models/link_session_exit.rb +2 -2
  1053. data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
  1054. data/lib/plaid/models/link_session_exit_metadata.rb +2 -2
  1055. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  1056. data/lib/plaid/models/link_session_finished_webhook.rb +3 -3
  1057. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  1058. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  1059. data/lib/plaid/models/link_session_results.rb +7 -17
  1060. data/lib/plaid/models/link_session_success.rb +2 -2
  1061. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  1062. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  1063. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  1064. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  1065. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  1066. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  1067. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  1068. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  1069. data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
  1070. data/lib/plaid/models/link_token_create_hosted_link.rb +2 -2
  1071. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  1072. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  1073. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  1074. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  1075. data/lib/plaid/models/link_token_create_request.rb +4 -4
  1076. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  1077. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
  1078. data/lib/plaid/models/link_token_create_request_auth.rb +3 -3
  1079. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  1080. data/lib/plaid/models/link_token_create_request_cra_options.rb +1 -1
  1081. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  1082. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +1 -1
  1083. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
  1084. data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +1 -1
  1085. data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +1 -1
  1086. data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +1 -1
  1087. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  1088. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  1089. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  1090. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  1091. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  1092. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  1093. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  1094. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  1095. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  1096. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  1097. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  1098. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  1099. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  1100. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  1101. data/lib/plaid/models/link_token_create_request_user.rb +3 -3
  1102. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  1103. data/lib/plaid/models/link_token_create_request_user_id_number.rb +2 -2
  1104. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  1105. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  1106. data/lib/plaid/models/link_token_create_response.rb +2 -2
  1107. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  1108. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  1109. data/lib/plaid/models/link_token_get_request.rb +1 -1
  1110. data/lib/plaid/models/link_token_get_response.rb +2 -2
  1111. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  1112. data/lib/plaid/models/link_token_investments.rb +1 -1
  1113. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  1114. data/lib/plaid/models/link_token_transactions.rb +1 -1
  1115. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  1116. data/lib/plaid/models/loan.rb +1 -1
  1117. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  1118. data/lib/plaid/models/loan_disbursements_indicators.rb +1 -1
  1119. data/lib/plaid/models/loan_filter.rb +1 -1
  1120. data/lib/plaid/models/loan_identifier.rb +1 -1
  1121. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  1122. data/lib/plaid/models/loan_identifiers.rb +1 -1
  1123. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  1124. data/lib/plaid/models/loan_payments_indicators.rb +2 -2
  1125. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  1126. data/lib/plaid/models/loans.rb +1 -1
  1127. data/lib/plaid/models/location.rb +1 -1
  1128. data/lib/plaid/models/match_summary.rb +1 -1
  1129. data/lib/plaid/models/match_summary_code.rb +1 -1
  1130. data/lib/plaid/models/merchant_insights.rb +2 -2
  1131. data/lib/plaid/models/meta.rb +1 -1
  1132. data/lib/plaid/models/mfa.rb +1 -1
  1133. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  1134. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  1135. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  1136. data/lib/plaid/models/monitoring_insights.rb +1 -1
  1137. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  1138. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  1139. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  1140. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  1141. data/lib/plaid/models/monthly_average.rb +1 -1
  1142. data/lib/plaid/models/monthly_summary.rb +1 -1
  1143. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  1144. data/lib/plaid/models/mortgage_liability.rb +1 -1
  1145. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  1146. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  1147. data/lib/plaid/models/name_match_score.rb +1 -1
  1148. data/lib/plaid/models/negative_balance_insights.rb +1 -1
  1149. data/lib/plaid/models/negative_balance_occurrence.rb +1 -1
  1150. data/lib/plaid/models/net_pay.rb +1 -1
  1151. data/lib/plaid/models/network_insights_version.rb +1 -1
  1152. data/lib/plaid/models/network_status_get_request.rb +1 -1
  1153. data/lib/plaid/models/network_status_get_response.rb +1 -1
  1154. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  1155. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  1156. data/lib/plaid/models/network_status_get_user.rb +1 -1
  1157. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  1158. data/lib/plaid/models/numbers.rb +4 -4
  1159. data/lib/plaid/models/numbers_acats.rb +1 -1
  1160. data/lib/plaid/models/numbers_ach.rb +2 -2
  1161. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  1162. data/lib/plaid/models/numbers_aton.rb +1 -1
  1163. data/lib/plaid/models/numbers_bacs.rb +4 -4
  1164. data/lib/plaid/models/numbers_bacs_nullable.rb +4 -4
  1165. data/lib/plaid/models/numbers_eft.rb +1 -1
  1166. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  1167. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  1168. data/lib/plaid/models/numbers_international.rb +2 -2
  1169. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  1170. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  1171. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  1172. data/lib/plaid/models/o_auth_error_code.rb +1 -1
  1173. data/lib/plaid/models/o_auth_error_response.rb +1 -1
  1174. data/lib/plaid/models/o_auth_grant_type.rb +1 -1
  1175. data/lib/plaid/models/o_auth_introspect_request.rb +1 -1
  1176. data/lib/plaid/models/o_auth_introspect_response.rb +1 -1
  1177. data/lib/plaid/models/o_auth_revoke_request.rb +1 -1
  1178. data/lib/plaid/models/o_auth_revoke_response.rb +1 -1
  1179. data/lib/plaid/models/o_auth_subject_token_type.rb +1 -1
  1180. data/lib/plaid/models/o_auth_token_request.rb +2 -2
  1181. data/lib/plaid/models/o_auth_token_response.rb +2 -2
  1182. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1183. data/lib/plaid/models/option_contract.rb +1 -1
  1184. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1185. data/lib/plaid/models/originator.rb +2 -2
  1186. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1187. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1188. data/lib/plaid/models/other_filter.rb +1 -1
  1189. data/lib/plaid/models/outlier_transactions_insights.rb +1 -1
  1190. data/lib/plaid/models/override_account_type.rb +1 -1
  1191. data/lib/plaid/models/override_accounts.rb +1 -1
  1192. data/lib/plaid/models/owner.rb +1 -1
  1193. data/lib/plaid/models/owner_override.rb +1 -1
  1194. data/lib/plaid/models/ownership_type.rb +1 -1
  1195. data/lib/plaid/models/parties.rb +1 -1
  1196. data/lib/plaid/models/partner_customer_create_request.rb +2 -2
  1197. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1198. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1199. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1200. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1201. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1202. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1203. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1204. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1205. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1206. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1207. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1208. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1209. data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +1 -1
  1210. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1211. data/lib/plaid/models/partner_end_customer_cra_purposes.rb +1 -1
  1212. data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +1 -1
  1213. data/lib/plaid/models/partner_end_customer_cra_use_case.rb +1 -1
  1214. data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +1 -1
  1215. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  1216. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1217. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  1218. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1219. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1220. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1221. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1222. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1223. data/lib/plaid/models/partner_end_customer_questionnaires.rb +1 -1
  1224. data/lib/plaid/models/partner_end_customer_requirement_due.rb +1 -1
  1225. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1226. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1227. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1228. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  1229. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1230. data/lib/plaid/models/party.rb +1 -1
  1231. data/lib/plaid/models/party_individual.rb +1 -1
  1232. data/lib/plaid/models/party_role_type.rb +1 -1
  1233. data/lib/plaid/models/pay.rb +1 -1
  1234. data/lib/plaid/models/pay_frequency.rb +1 -1
  1235. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1236. data/lib/plaid/models/pay_period_details.rb +1 -1
  1237. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1238. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  1239. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  1240. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  1241. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  1242. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  1243. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1244. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1245. data/lib/plaid/models/payment_amount.rb +1 -1
  1246. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1247. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1248. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1249. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1250. data/lib/plaid/models/payment_channel.rb +1 -1
  1251. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1252. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1253. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1254. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1255. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1256. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1257. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1258. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1259. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1260. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1261. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1262. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1263. data/lib/plaid/models/payment_initiation_consent_get_response.rb +2 -2
  1264. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1265. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +2 -2
  1266. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1267. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1268. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1269. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1270. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
  1271. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1272. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1273. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1274. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1275. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1276. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1277. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  1278. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1279. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1280. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1281. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1282. data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -2
  1283. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1284. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1285. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1286. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
  1287. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1288. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1289. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1290. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1291. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  1292. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  1293. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1294. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1295. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1296. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1297. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1298. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1299. data/lib/plaid/models/payment_meta.rb +1 -1
  1300. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1301. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1302. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1303. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1304. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1305. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1306. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1307. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1308. data/lib/plaid/models/payment_scheme.rb +1 -1
  1309. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1310. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1311. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1312. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1313. data/lib/plaid/models/payroll_item.rb +1 -1
  1314. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1315. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1316. data/lib/plaid/models/paystub.rb +1 -1
  1317. data/lib/plaid/models/paystub_address.rb +1 -1
  1318. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1319. data/lib/plaid/models/paystub_details.rb +1 -1
  1320. data/lib/plaid/models/paystub_employer.rb +1 -1
  1321. data/lib/plaid/models/paystub_override.rb +1 -1
  1322. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1323. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1324. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1325. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1326. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1327. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1328. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1329. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1330. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1331. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1332. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1333. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1334. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1335. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1336. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1337. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1338. data/lib/plaid/models/pending_disconnect_webhook.rb +2 -2
  1339. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1340. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  1341. data/lib/plaid/models/personal_finance_category.rb +2 -2
  1342. data/lib/plaid/models/personal_finance_category_version.rb +1 -1
  1343. data/lib/plaid/models/phone_number.rb +1 -1
  1344. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1345. data/lib/plaid/models/phone_type.rb +1 -1
  1346. data/lib/plaid/models/physical_document_category.rb +1 -1
  1347. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1348. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1349. data/lib/plaid/models/physical_document_images.rb +1 -1
  1350. data/lib/plaid/models/plaid_error.rb +2 -2
  1351. data/lib/plaid/models/plaid_error_type.rb +3 -1
  1352. data/lib/plaid/models/plaid_lend_score_version.rb +1 -1
  1353. data/lib/plaid/models/platform_ids.rb +1 -1
  1354. data/lib/plaid/models/po_box_status.rb +1 -1
  1355. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1356. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1357. data/lib/plaid/models/prism_cash_score_version.rb +1 -1
  1358. data/lib/plaid/models/prism_detect.rb +1 -1
  1359. data/lib/plaid/models/prism_detect_version.rb +1 -1
  1360. data/lib/plaid/models/prism_extend.rb +1 -1
  1361. data/lib/plaid/models/prism_extend_version.rb +1 -1
  1362. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1363. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1364. data/lib/plaid/models/prism_insights.rb +13 -3
  1365. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1366. data/lib/plaid/models/prism_versions.rb +1 -1
  1367. data/lib/plaid/models/prism_versions_deprecated.rb +1 -1
  1368. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1369. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1370. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  1371. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1372. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1373. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1374. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1375. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1376. data/lib/plaid/models/processor_bank_transfer_create_request.rb +3 -3
  1377. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1378. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1379. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1380. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1381. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1382. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1383. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1384. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1385. data/lib/plaid/models/processor_investments_auth_get_request.rb +1 -1
  1386. data/lib/plaid/models/processor_investments_auth_get_response.rb +1 -1
  1387. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1388. data/lib/plaid/models/processor_investments_holdings_get_response.rb +2 -2
  1389. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1390. data/lib/plaid/models/processor_investments_transactions_get_response.rb +1 -1
  1391. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1392. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1393. data/lib/plaid/models/processor_number.rb +2 -2
  1394. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1395. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1396. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1397. data/lib/plaid/models/processor_signal_evaluate_request.rb +3 -3
  1398. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1399. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1400. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1401. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1402. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1403. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +3 -3
  1404. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  1405. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1406. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  1407. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1408. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1409. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1410. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1411. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1412. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1413. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1414. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1415. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1416. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1417. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1418. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1419. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1420. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1421. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1422. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1423. data/lib/plaid/models/processor_transactions_sync_request.rb +2 -2
  1424. data/lib/plaid/models/processor_transactions_sync_response.rb +2 -2
  1425. data/lib/plaid/models/product_access.rb +1 -1
  1426. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1427. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1428. data/lib/plaid/models/product_status.rb +1 -1
  1429. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1430. data/lib/plaid/models/products.rb +2 -1
  1431. data/lib/plaid/models/products_terminate_reason_code.rb +50 -0
  1432. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1433. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1434. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1435. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1436. data/lib/plaid/models/protect_bank_account.rb +1 -1
  1437. data/lib/plaid/models/protect_compute_request.rb +2 -2
  1438. data/lib/plaid/models/protect_compute_response.rb +14 -4
  1439. data/lib/plaid/models/protect_compute_subscores.rb +288 -0
  1440. data/lib/plaid/models/protect_event.rb +1 -1
  1441. data/lib/plaid/models/protect_event_get_request.rb +1 -1
  1442. data/lib/plaid/models/protect_event_get_response.rb +2 -2
  1443. data/lib/plaid/models/protect_event_send_request.rb +1 -1
  1444. data/lib/plaid/models/protect_event_send_response.rb +2 -2
  1445. data/lib/plaid/models/protect_incident_amount.rb +1 -1
  1446. data/lib/plaid/models/protect_incident_event.rb +17 -6
  1447. data/lib/plaid/models/protect_incident_event_response.rb +1 -1
  1448. data/lib/plaid/models/protect_link_model_inputs.rb +1 -1
  1449. data/lib/plaid/models/protect_model_inputs.rb +2 -2
  1450. data/lib/plaid/models/protect_report.rb +1 -1
  1451. data/lib/plaid/models/protect_report_confidence.rb +1 -1
  1452. data/lib/plaid/models/protect_report_create_request.rb +2 -19
  1453. data/lib/plaid/models/protect_report_create_response.rb +1 -1
  1454. data/lib/plaid/models/protect_report_source.rb +1 -1
  1455. data/lib/plaid/models/protect_report_type.rb +1 -1
  1456. data/lib/plaid/models/protect_sdk_model_inputs.rb +1 -1
  1457. data/lib/plaid/models/protect_user.rb +3 -3
  1458. data/lib/plaid/models/protect_user_event_webhook.rb +2 -2
  1459. data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
  1460. data/lib/plaid/models/protect_user_insights_get_response.rb +1 -1
  1461. data/lib/plaid/models/provider_business_address.rb +1 -1
  1462. data/lib/plaid/models/provider_business_name.rb +1 -1
  1463. data/lib/plaid/models/proxy_type.rb +1 -1
  1464. data/lib/plaid/models/pslf_status.rb +1 -1
  1465. data/lib/plaid/models/reason_code.rb +1 -1
  1466. data/lib/plaid/models/recaptcha_required_error.rb +5 -24
  1467. data/lib/plaid/models/recipient_bacs.rb +2 -2
  1468. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  1469. data/lib/plaid/models/recommendation_string.rb +1 -1
  1470. data/lib/plaid/models/recurring_cancelled_webhook.rb +2 -2
  1471. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1472. data/lib/plaid/models/recurring_new_transfer_webhook.rb +3 -3
  1473. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1474. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1475. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1476. data/lib/plaid/models/recurring_transfer.rb +4 -4
  1477. data/lib/plaid/models/recurring_transfer_nullable.rb +4 -4
  1478. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +2 -2
  1479. data/lib/plaid/models/refresh_result.rb +1 -1
  1480. data/lib/plaid/models/removed_transaction.rb +1 -1
  1481. data/lib/plaid/models/report_type.rb +1 -1
  1482. data/lib/plaid/models/reporting_information.rb +2 -2
  1483. data/lib/plaid/models/request_business_address.rb +1 -1
  1484. data/lib/plaid/models/response_business_address.rb +1 -1
  1485. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1486. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1487. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1488. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1489. data/lib/plaid/models/risk_check_details.rb +1 -1
  1490. data/lib/plaid/models/risk_check_device.rb +1 -1
  1491. data/lib/plaid/models/risk_check_email.rb +44 -2
  1492. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1493. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1494. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1495. data/lib/plaid/models/risk_check_email_includes_date_of_birth.rb +40 -0
  1496. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1497. data/lib/plaid/models/risk_check_email_is_edu.rb +40 -0
  1498. data/lib/plaid/models/risk_check_email_name.rb +43 -0
  1499. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1500. data/lib/plaid/models/risk_check_facial_duplicate.rb +2 -2
  1501. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1502. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1503. data/lib/plaid/models/risk_check_network.rb +1 -1
  1504. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1505. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1506. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1507. data/lib/plaid/models/risk_indicators.rb +1 -1
  1508. data/lib/plaid/models/risk_level.rb +1 -1
  1509. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1510. data/lib/plaid/models/risk_profile.rb +2 -2
  1511. data/lib/plaid/models/risk_reason.rb +2 -2
  1512. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1513. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1514. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1515. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1516. data/lib/plaid/models/role.rb +2 -2
  1517. data/lib/plaid/models/role_detail.rb +1 -1
  1518. data/lib/plaid/models/roles.rb +1 -1
  1519. data/lib/plaid/models/rule_details.rb +2 -2
  1520. data/lib/plaid/models/rule_result.rb +1 -1
  1521. data/lib/plaid/models/ruleset.rb +1 -1
  1522. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1523. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1524. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1525. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1526. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1527. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1528. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  1529. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1530. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +4 -4
  1531. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
  1532. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1533. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1534. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1535. data/lib/plaid/models/sandbox_item_application_seed_request.rb +3 -3
  1536. data/lib/plaid/models/sandbox_item_application_seed_response.rb +1 -1
  1537. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
  1538. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1539. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  1540. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1541. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  1542. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1543. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1544. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1545. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1546. data/lib/plaid/models/sandbox_payment_simulate_request.rb +1 -1
  1547. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1548. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1549. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1550. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1551. data/lib/plaid/models/sandbox_public_token_create_request.rb +3 -3
  1552. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1553. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1554. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1555. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1556. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1557. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1558. data/lib/plaid/models/sandbox_transactions_create_request.rb +2 -2
  1559. data/lib/plaid/models/sandbox_transactions_create_response.rb +1 -1
  1560. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1561. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1562. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +2 -2
  1563. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1564. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +2 -2
  1565. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1566. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +2 -2
  1567. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1568. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +3 -3
  1569. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1570. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1571. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1572. data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +1 -1
  1573. data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +2 -2
  1574. data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +1 -1
  1575. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +3 -3
  1576. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1577. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  1578. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1579. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1580. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1581. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1582. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1583. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1584. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1585. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1586. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1587. data/lib/plaid/models/sandbox_user_reset_login_request.rb +3 -3
  1588. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1589. data/lib/plaid/models/scopes.rb +1 -1
  1590. data/lib/plaid/models/scopes_context.rb +1 -1
  1591. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1592. data/lib/plaid/models/screening_hit_analysis.rb +2 -2
  1593. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1594. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1595. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1596. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1597. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1598. data/lib/plaid/models/security.rb +2 -2
  1599. data/lib/plaid/models/security_override.rb +2 -2
  1600. data/lib/plaid/models/selfie_age_check.rb +288 -0
  1601. data/lib/plaid/models/selfie_age_check_status.rb +41 -0
  1602. data/lib/plaid/models/selfie_analysis.rb +12 -2
  1603. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1604. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1605. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1606. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1607. data/lib/plaid/models/selfie_capture.rb +4 -4
  1608. data/lib/plaid/models/selfie_check.rb +1 -1
  1609. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1610. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1611. data/lib/plaid/models/selfie_status.rb +1 -1
  1612. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  1613. data/lib/plaid/models/service.rb +1 -1
  1614. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1615. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1616. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1617. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1618. data/lib/plaid/models/services.rb +1 -1
  1619. data/lib/plaid/models/session_token_create_request.rb +2 -2
  1620. data/lib/plaid/models/session_token_create_request_user.rb +1 -1
  1621. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1622. data/lib/plaid/models/session_token_create_response_link.rb +2 -2
  1623. data/lib/plaid/models/signal_address_data.rb +1 -1
  1624. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1625. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1626. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1627. data/lib/plaid/models/signal_device.rb +1 -1
  1628. data/lib/plaid/models/signal_evaluate_core_attributes.rb +3 -3
  1629. data/lib/plaid/models/signal_evaluate_request.rb +2 -2
  1630. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1631. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1632. data/lib/plaid/models/signal_person_name.rb +1 -1
  1633. data/lib/plaid/models/signal_prepare_request.rb +2 -2
  1634. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1635. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1636. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1637. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -1
  1638. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1639. data/lib/plaid/models/signal_schedule_request.rb +2 -2
  1640. data/lib/plaid/models/signal_schedule_response.rb +1 -1
  1641. data/lib/plaid/models/signal_scores.rb +1 -1
  1642. data/lib/plaid/models/signal_user.rb +1 -1
  1643. data/lib/plaid/models/signal_warning.rb +2 -2
  1644. data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
  1645. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1646. data/lib/plaid/models/sms_verification.rb +1 -1
  1647. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1648. data/lib/plaid/models/source.rb +1 -1
  1649. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1650. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1651. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1652. data/lib/plaid/models/statements_account.rb +1 -1
  1653. data/lib/plaid/models/statements_download_request.rb +2 -2
  1654. data/lib/plaid/models/statements_list_request.rb +2 -2
  1655. data/lib/plaid/models/statements_list_response.rb +1 -1
  1656. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1657. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1658. data/lib/plaid/models/statements_refresh_request.rb +2 -2
  1659. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1660. data/lib/plaid/models/statements_statement.rb +2 -2
  1661. data/lib/plaid/models/status.rb +2 -2
  1662. data/lib/plaid/models/statuses.rb +1 -1
  1663. data/lib/plaid/models/strategy.rb +1 -1
  1664. data/lib/plaid/models/student_loan.rb +2 -2
  1665. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1666. data/lib/plaid/models/student_loan_status.rb +1 -1
  1667. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1668. data/lib/plaid/models/sweep_failure.rb +1 -1
  1669. data/lib/plaid/models/sweep_status.rb +1 -1
  1670. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1671. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1672. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1673. data/lib/plaid/models/taxform.rb +1 -1
  1674. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1675. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1676. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1677. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1678. data/lib/plaid/models/total.rb +1 -1
  1679. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1680. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1681. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1682. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1683. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1684. data/lib/plaid/models/total_monthly_income_insights.rb +2 -2
  1685. data/lib/plaid/models/total_outflow_amount.rb +1 -1
  1686. data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
  1687. data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
  1688. data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
  1689. data/lib/plaid/models/total_report_inflow_amount.rb +1 -1
  1690. data/lib/plaid/models/total_report_inflow_amount30d.rb +1 -1
  1691. data/lib/plaid/models/total_report_inflow_amount60d.rb +1 -1
  1692. data/lib/plaid/models/total_report_inflow_amount90d.rb +2 -2
  1693. data/lib/plaid/models/total_report_outflow_amount.rb +1 -1
  1694. data/lib/plaid/models/total_report_outflow_amount30d.rb +1 -1
  1695. data/lib/plaid/models/total_report_outflow_amount60d.rb +1 -1
  1696. data/lib/plaid/models/total_report_outflow_amount90d.rb +1 -1
  1697. data/lib/plaid/models/transaction.rb +1 -1
  1698. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1699. data/lib/plaid/models/transaction_base.rb +1 -1
  1700. data/lib/plaid/models/transaction_code.rb +3 -1
  1701. data/lib/plaid/models/transaction_counterparty.rb +2 -2
  1702. data/lib/plaid/models/transaction_data.rb +1 -1
  1703. data/lib/plaid/models/transaction_override.rb +1 -1
  1704. data/lib/plaid/models/transaction_stream.rb +1 -1
  1705. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1706. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1707. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1708. data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
  1709. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1710. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1711. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1712. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1713. data/lib/plaid/models/transactions_get_request.rb +2 -2
  1714. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1715. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1716. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1717. data/lib/plaid/models/transactions_recurring_create_request.rb +2 -2
  1718. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1719. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  1720. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1721. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1722. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1723. data/lib/plaid/models/transactions_recurring_merge_request.rb +2 -2
  1724. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1725. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1726. data/lib/plaid/models/transactions_recurring_update_request.rb +2 -2
  1727. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1728. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  1729. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1730. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1731. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1732. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1733. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1734. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1735. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1736. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1737. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1738. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1739. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1740. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  1741. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  1742. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  1743. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1744. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1745. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1746. data/lib/plaid/models/transfer.rb +22 -8
  1747. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1748. data/lib/plaid/models/transfer_authorization.rb +18 -4
  1749. data/lib/plaid/models/transfer_authorization_cancel_request.rb +2 -2
  1750. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1751. data/lib/plaid/models/transfer_authorization_create_request.rb +30 -8
  1752. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1753. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1754. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1755. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1756. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1757. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1758. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1759. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1760. data/lib/plaid/models/transfer_authorization_payment_risk.rb +2 -2
  1761. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +18 -3
  1762. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1763. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1764. data/lib/plaid/models/transfer_balance.rb +1 -1
  1765. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1766. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1767. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1768. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  1769. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1770. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1771. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1772. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1773. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1774. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1775. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1776. data/lib/plaid/models/transfer_create_request.rb +5 -5
  1777. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1778. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1779. data/lib/plaid/models/transfer_credit_usage_configuration.rb +5 -5
  1780. data/lib/plaid/models/transfer_debit_usage_configuration.rb +5 -5
  1781. data/lib/plaid/models/transfer_device.rb +1 -1
  1782. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1783. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1784. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1785. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1786. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1787. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1788. data/lib/plaid/models/transfer_event.rb +6 -6
  1789. data/lib/plaid/models/transfer_event_list_request.rb +3 -3
  1790. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1791. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1792. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1793. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1794. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1795. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1796. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1797. data/lib/plaid/models/transfer_failure.rb +1 -1
  1798. data/lib/plaid/models/transfer_funding_account.rb +2 -2
  1799. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +2 -2
  1800. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
  1801. data/lib/plaid/models/transfer_get_request.rb +3 -3
  1802. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1803. data/lib/plaid/models/transfer_guarantee_details.rb +243 -0
  1804. data/lib/plaid/models/transfer_guarantee_outcome.rb +41 -0
  1805. data/lib/plaid/models/transfer_guarantee_schedule_item.rb +260 -0
  1806. data/lib/plaid/models/transfer_guarantee_schedule_item_all_of.rb +221 -0
  1807. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1808. data/lib/plaid/models/transfer_intent_create.rb +2 -2
  1809. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1810. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1811. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  1812. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1813. data/lib/plaid/models/transfer_intent_get.rb +2 -2
  1814. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1815. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1816. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1817. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1818. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1819. data/lib/plaid/models/transfer_ledger_deposit_request.rb +2 -2
  1820. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1821. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1822. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1823. data/lib/plaid/models/transfer_ledger_event.rb +1 -1
  1824. data/lib/plaid/models/transfer_ledger_event_list_request.rb +1 -1
  1825. data/lib/plaid/models/transfer_ledger_event_list_response.rb +1 -1
  1826. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1827. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1828. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1829. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +2 -2
  1830. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1831. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1832. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1833. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1834. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1835. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1836. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1837. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1838. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1839. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1840. data/lib/plaid/models/transfer_network.rb +1 -1
  1841. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1842. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1843. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1844. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1845. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +1 -1
  1846. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +1 -1
  1847. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1848. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1849. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1850. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1851. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1852. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1853. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  1854. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1855. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1856. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1857. data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
  1858. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1859. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1860. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1861. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1862. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1863. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1864. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1865. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1866. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1867. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1868. data/lib/plaid/models/transfer_recurring_cancel_request.rb +2 -2
  1869. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1870. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
  1871. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1872. data/lib/plaid/models/transfer_recurring_get_request.rb +2 -2
  1873. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1874. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1875. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1876. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1877. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1878. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1879. data/lib/plaid/models/transfer_refund.rb +3 -3
  1880. data/lib/plaid/models/transfer_refund_cancel_request.rb +2 -2
  1881. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1882. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1883. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1884. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1885. data/lib/plaid/models/transfer_refund_get_request.rb +2 -2
  1886. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1887. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1888. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1889. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1890. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  1891. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1892. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1893. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  1894. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1895. data/lib/plaid/models/transfer_status.rb +1 -1
  1896. data/lib/plaid/models/transfer_sweep.rb +2 -2
  1897. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1898. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1899. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1900. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1901. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1902. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  1903. data/lib/plaid/models/transfer_type.rb +1 -1
  1904. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1905. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1906. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1907. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1908. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1909. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1910. data/lib/plaid/models/trust_index.rb +1 -1
  1911. data/lib/plaid/models/trust_index_subscore.rb +1 -1
  1912. data/lib/plaid/models/trust_index_subscores.rb +1 -1
  1913. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1914. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1915. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1916. data/lib/plaid/models/user_account_identity.rb +3 -3
  1917. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1918. data/lib/plaid/models/user_account_identity_edit_counts.rb +1 -1
  1919. data/lib/plaid/models/user_account_identity_edit_history.rb +1 -1
  1920. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1921. data/lib/plaid/models/user_account_identity_official_document.rb +1 -1
  1922. data/lib/plaid/models/user_account_item.rb +2 -2
  1923. data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
  1924. data/lib/plaid/models/user_account_session_event.rb +1 -1
  1925. data/lib/plaid/models/user_account_session_event_send_request.rb +1 -1
  1926. data/lib/plaid/models/user_account_session_event_send_response.rb +1 -1
  1927. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1928. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1929. data/lib/plaid/models/user_address.rb +1 -1
  1930. data/lib/plaid/models/user_based_products.rb +1 -1
  1931. data/lib/plaid/models/user_create_request.rb +2 -2
  1932. data/lib/plaid/models/user_create_response.rb +3 -3
  1933. data/lib/plaid/models/user_custom_password.rb +1 -1
  1934. data/lib/plaid/models/user_data_overview.rb +1 -1
  1935. data/lib/plaid/models/user_financial_data_refresh_request.rb +1 -1
  1936. data/lib/plaid/models/user_financial_data_refresh_response.rb +1 -1
  1937. data/lib/plaid/models/user_get_request.rb +2 -2
  1938. data/lib/plaid/models/user_get_response.rb +2 -2
  1939. data/lib/plaid/models/user_id_number.rb +2 -2
  1940. data/lib/plaid/models/user_identity_remove_request.rb +2 -2
  1941. data/lib/plaid/models/user_identity_remove_response.rb +1 -1
  1942. data/lib/plaid/models/user_items_associate_request.rb +2 -2
  1943. data/lib/plaid/models/user_items_associate_response.rb +1 -1
  1944. data/lib/plaid/models/user_items_get_request.rb +3 -3
  1945. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1946. data/lib/plaid/models/user_items_remove_request.rb +3 -3
  1947. data/lib/plaid/models/user_items_remove_response.rb +1 -1
  1948. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1949. data/lib/plaid/models/{network_insights_report_get_request.rb → user_products_terminate_reason_code.rb} +14 -44
  1950. data/lib/plaid/models/user_products_terminate_request.rb +42 -12
  1951. data/lib/plaid/models/user_products_terminate_response.rb +1 -1
  1952. data/lib/plaid/models/user_remove_request.rb +3 -3
  1953. data/lib/plaid/models/user_remove_response.rb +1 -1
  1954. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1955. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1956. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1957. data/lib/plaid/models/user_third_party_token_create_request.rb +3 -3
  1958. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1959. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  1960. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  1961. data/lib/plaid/models/user_transactions_refresh_request.rb +1 -1
  1962. data/lib/plaid/models/user_transactions_refresh_response.rb +1 -1
  1963. data/lib/plaid/models/user_update_request.rb +3 -3
  1964. data/lib/plaid/models/user_update_response.rb +1 -1
  1965. data/lib/plaid/models/validation_source.rb +1 -1
  1966. data/lib/plaid/models/validation_sources.rb +1 -1
  1967. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1968. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1969. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1970. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1971. data/lib/plaid/models/verification_status.rb +1 -1
  1972. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1973. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1974. data/lib/plaid/models/w2.rb +4 -4
  1975. data/lib/plaid/models/w2_box12.rb +1 -1
  1976. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1977. data/lib/plaid/models/w2_override.rb +4 -4
  1978. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1979. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1980. data/lib/plaid/models/wallet.rb +1 -1
  1981. data/lib/plaid/models/wallet_balance.rb +1 -1
  1982. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1983. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1984. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1985. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1986. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1987. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1988. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1989. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1990. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1991. data/lib/plaid/models/wallet_status.rb +1 -1
  1992. data/lib/plaid/models/wallet_transaction.rb +4 -4
  1993. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1994. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1995. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1996. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1997. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  1998. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1999. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  2000. data/lib/plaid/models/wallet_transaction_failure_reason.rb +3 -1
  2001. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  2002. data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
  2003. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  2004. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  2005. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  2006. data/lib/plaid/models/wallet_transaction_payee_verification_status.rb +1 -1
  2007. data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
  2008. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  2009. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +12 -2
  2010. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  2011. data/lib/plaid/models/warning.rb +1 -1
  2012. data/lib/plaid/models/watchlist_screening_audit_trail.rb +2 -2
  2013. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  2014. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  2015. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  2016. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
  2017. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  2018. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
  2019. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  2020. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  2021. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  2022. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  2023. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
  2024. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  2025. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  2026. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  2027. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  2028. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  2029. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +2 -2
  2030. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +2 -2
  2031. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  2032. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  2033. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
  2034. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  2035. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
  2036. data/lib/plaid/models/watchlist_screening_hit.rb +19 -2
  2037. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  2038. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  2039. data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
  2040. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  2041. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
  2042. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  2043. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
  2044. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  2045. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  2046. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  2047. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  2048. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +3 -3
  2049. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  2050. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  2051. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  2052. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  2053. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  2054. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +2 -2
  2055. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +2 -2
  2056. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  2057. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  2058. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
  2059. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  2060. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
  2061. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  2062. data/lib/plaid/models/watchlist_screening_review.rb +2 -2
  2063. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  2064. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  2065. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  2066. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  2067. data/lib/plaid/models/webhook_type.rb +1 -1
  2068. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  2069. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  2070. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  2071. data/lib/plaid/models/yield_rate.rb +1 -1
  2072. data/lib/plaid/models/yield_rate_type.rb +1 -1
  2073. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  2074. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  2075. data/lib/plaid/version.rb +2 -2
  2076. data/lib/plaid.rb +41 -8
  2077. data/plaid.gemspec +1 -1
  2078. metadata +42 -9
  2079. data/lib/plaid/models/item_handle_fraud_report_request.rb +0 -380
@@ -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.698.7
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
@@ -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
@@ -1516,7 +1516,7 @@ module Plaid
1516
1516
  end
1517
1517
 
1518
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.
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]
@@ -1526,7 +1526,7 @@ module Plaid
1526
1526
  end
1527
1527
 
1528
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.
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
@@ -1924,7 +1924,7 @@ module Plaid
1924
1924
  end
1925
1925
 
1926
1926
  # Get a Beacon Report
1927
- # Returns a Beacon report for a given Beacon report id.
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]
@@ -1934,7 +1934,7 @@ module Plaid
1934
1934
  end
1935
1935
 
1936
1936
  # Get a Beacon Report
1937
- # Returns a Beacon report for a given Beacon report id.
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
@@ -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 `/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.
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;/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.
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 `/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;/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
@@ -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 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.
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 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.
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
@@ -3760,7 +3760,7 @@ module Plaid
3760
3760
  end
3761
3761
 
3762
3762
  # Retrieve cash flow information from your user's banks
3763
- # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after 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).
3763
+ # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after you've received a `CHECK_REPORT_READY` or a `USER_CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn't have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \"II2\". Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#heading=h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.0#bookmark=id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab=t.36c85n2ircqk#heading=h.79dwr5c1iszl).
3764
3764
  # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3765
3765
  # @param [Hash] opts the optional parameters
3766
3766
  # @return [CraCheckReportIncomeInsightsGetResponse]
@@ -3770,7 +3770,7 @@ module Plaid
3770
3770
  end
3771
3771
 
3772
3772
  # Retrieve cash flow information from your user&#39;s banks
3773
- # This endpoint allows you to retrieve the Income Insights report for your user. You should call this endpoint after 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).
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 base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. NOTE: The following schema was updated in April 2026 to reflect the response when the provided version is \&quot;II2\&quot;. Please see [this document](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.0#heading&#x3D;h.rudamzinus2i) for guidance on migrating to II2 if you are currently using the II1 version, and [this section](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.0#bookmark&#x3D;id.tdcc2wpk0h60) for an example II1 response along with its [documentation](https://docs.google.com/document/d/1kQkQ7FOgFaC4n-sUGUk74hoXZNY_L_nJeCuMe7Keip4/edit?tab&#x3D;t.36c85n2ircqk#heading&#x3D;h.79dwr5c1iszl).
3774
3774
  # @param cra_check_report_income_insights_get_request [CraCheckReportIncomeInsightsGetRequest]
3775
3775
  # @param [Hash] opts the optional parameters
3776
3776
  # @return [Array<(CraCheckReportIncomeInsightsGetResponse, Integer, Hash)>] CraCheckReportIncomeInsightsGetResponse data, response status code and response headers
@@ -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 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.
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 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.
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
@@ -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 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 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`. If you did not initialize Link with the `cra_network_insights` product or have generated a report using `/cra/check_report/create`, Plaid will generate the attributes when you call this endpoint.
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 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 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;. If you did not initialize Link with the &#x60;cra_network_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, Plaid will generate the attributes when you call this endpoint.
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
@@ -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 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.
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 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.
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
@@ -4916,7 +4916,7 @@ module Plaid
4916
4916
  end
4917
4917
 
4918
4918
  # 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.
4919
+ # The `/credit/asset_report/freddie_mac/get` endpoint retrieves the Asset Report in Freddie Mac's JSON format.
4920
4920
  # @param request_body [Hash<String, Object>]
4921
4921
  # @param [Hash] opts the optional parameters
4922
4922
  # @return [AssetReportFreddieGetResponse]
@@ -4926,7 +4926,7 @@ module Plaid
4926
4926
  end
4927
4927
 
4928
4928
  # 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.
4929
+ # The &#x60;/credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Asset Report in Freddie Mac&#39;s JSON format.
4930
4930
  # @param request_body [Hash<String, Object>]
4931
4931
  # @param [Hash] opts the optional parameters
4932
4932
  # @return [Array<(AssetReportFreddieGetResponse, Integer, Hash)>] AssetReportFreddieGetResponse data, response status code and response headers
@@ -4984,7 +4984,7 @@ module Plaid
4984
4984
  end
4985
4985
 
4986
4986
  # 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.
4987
+ # 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
4988
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4989
4989
  # @param [Hash] opts the optional parameters
4990
4990
  # @return [CreditAuditCopyTokenCreateResponse]
@@ -4994,7 +4994,7 @@ module Plaid
4994
4994
  end
4995
4995
 
4996
4996
  # 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.
4997
+ # 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
4998
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
4999
4999
  # @param [Hash] opts the optional parameters
5000
5000
  # @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
@@ -5052,7 +5052,7 @@ module Plaid
5052
5052
  end
5053
5053
 
5054
5054
  # 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.
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.
5056
5056
  # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
5057
5057
  # @param [Hash] opts the optional parameters
5058
5058
  # @return [CreditAuditCopyTokenUpdateResponse]
@@ -5062,7 +5062,7 @@ module Plaid
5062
5062
  end
5063
5063
 
5064
5064
  # 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.
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.
5066
5066
  # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
5067
5067
  # @param [Hash] opts the optional parameters
5068
5068
  # @return [Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>] CreditAuditCopyTokenUpdateResponse data, response status code and response headers
@@ -5120,7 +5120,7 @@ module Plaid
5120
5120
  end
5121
5121
 
5122
5122
  # 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.
5123
+ # `/beta/credit/v1/bank_employment/get` returns the employment report(s) derived from bank transaction data for a specified user.
5124
5124
  # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
5125
5125
  # @param [Hash] opts the optional parameters
5126
5126
  # @return [CreditBankEmploymentGetResponse]
@@ -5130,7 +5130,7 @@ module Plaid
5130
5130
  end
5131
5131
 
5132
5132
  # 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.
5133
+ # &#x60;/beta/credit/v1/bank_employment/get&#x60; returns the employment report(s) derived from bank transaction data for a specified user.
5134
5134
  # @param credit_bank_employment_get_request [CreditBankEmploymentGetRequest]
5135
5135
  # @param [Hash] opts the optional parameters
5136
5136
  # @return [Array<(CreditBankEmploymentGetResponse, Integer, Hash)>] CreditBankEmploymentGetResponse data, response status code and response headers
@@ -5324,7 +5324,7 @@ module Plaid
5324
5324
  end
5325
5325
 
5326
5326
  # 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`.
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'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
5328
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
5329
5329
  # @param [Hash] opts the optional parameters
5330
5330
  # @return [CreditBankIncomeRefreshResponse]
@@ -5334,7 +5334,7 @@ module Plaid
5334
5334
  end
5335
5335
 
5336
5336
  # 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;.
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&#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
5338
  # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
5339
5339
  # @param [Hash] opts the optional parameters
5340
5340
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
@@ -5596,7 +5596,7 @@ module Plaid
5596
5596
  end
5597
5597
 
5598
5598
  # 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.
5599
+ # The `/credit/freddie_mac/reports/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
5600
5600
  # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
5601
5601
  # @param [Hash] opts the optional parameters
5602
5602
  # @return [CreditFreddieMacReportsGetResponse]
@@ -5606,7 +5606,7 @@ module Plaid
5606
5606
  end
5607
5607
 
5608
5608
  # 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.
5609
+ # The &#x60;/credit/freddie_mac/reports/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.
5610
5610
  # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
5611
5611
  # @param [Hash] opts the optional parameters
5612
5612
  # @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
@@ -6479,7 +6479,7 @@ module Plaid
6479
6479
  return data, status_code, headers
6480
6480
  end
6481
6481
 
6482
- # Retrieve a dashboard user
6482
+ # Retrieve a Dashboard user
6483
6483
  # 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
6484
  # @param dashboard_user_get_request [DashboardUserGetRequest]
6485
6485
  # @param [Hash] opts the optional parameters
@@ -6489,7 +6489,7 @@ module Plaid
6489
6489
  data
6490
6490
  end
6491
6491
 
6492
- # Retrieve a dashboard user
6492
+ # Retrieve a Dashboard user
6493
6493
  # 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
6494
  # @param dashboard_user_get_request [DashboardUserGetRequest]
6495
6495
  # @param [Hash] opts the optional parameters
@@ -6547,8 +6547,8 @@ module Plaid
6547
6547
  return data, status_code, headers
6548
6548
  end
6549
6549
 
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.
6550
+ # List Dashboard users
6551
+ # 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
6552
  # @param dashboard_user_list_request [DashboardUserListRequest]
6553
6553
  # @param [Hash] opts the optional parameters
6554
6554
  # @return [DashboardUserListResponse]
@@ -6557,8 +6557,8 @@ module Plaid
6557
6557
  data
6558
6558
  end
6559
6559
 
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.
6560
+ # List Dashboard users
6561
+ # 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
6562
  # @param dashboard_user_list_request [DashboardUserListRequest]
6563
6563
  # @param [Hash] opts the optional parameters
6564
6564
  # @return [Array<(DashboardUserListResponse, Integer, Hash)>] DashboardUserListResponse data, response status code and response headers
@@ -6616,7 +6616,7 @@ module Plaid
6616
6616
  end
6617
6617
 
6618
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.
6619
+ # `/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
6620
  # @param employers_search_request [EmployersSearchRequest]
6621
6621
  # @param [Hash] opts the optional parameters
6622
6622
  # @return [EmployersSearchResponse]
@@ -6626,7 +6626,7 @@ module Plaid
6626
6626
  end
6627
6627
 
6628
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.
6629
+ # &#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
6630
  # @param employers_search_request [EmployersSearchRequest]
6631
6631
  # @param [Hash] opts the optional parameters
6632
6632
  # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
@@ -6751,6 +6751,206 @@ module Plaid
6751
6751
  return data, status_code, headers
6752
6752
  end
6753
6753
 
6754
+ # Get FDX Consent Grant
6755
+ # Returns a consent grant by its identifier
6756
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6757
+ # @param [Hash] opts the optional parameters
6758
+ # @return [FDXConsentGrant]
6759
+ def fdx_consents_get(consent_id, opts = {})
6760
+ data, _status_code, _headers = fdx_consents_get_with_http_info(consent_id, opts)
6761
+ data
6762
+ end
6763
+
6764
+ # Get FDX Consent Grant
6765
+ # Returns a consent grant by its identifier
6766
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6767
+ # @param [Hash] opts the optional parameters
6768
+ # @return [Array<(FDXConsentGrant, Integer, Hash)>] FDXConsentGrant data, response status code and response headers
6769
+ def fdx_consents_get_with_http_info(consent_id, opts = {})
6770
+ if @api_client.config.debugging
6771
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_get ...'
6772
+ end
6773
+ # verify the required parameter 'consent_id' is set
6774
+ if @api_client.config.client_side_validation && consent_id.nil?
6775
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_get"
6776
+ end
6777
+ # resource path
6778
+ local_var_path = '/fdx/consents/{consentId}'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
6779
+
6780
+ # query parameters
6781
+ query_params = opts[:query_params] || {}
6782
+
6783
+ # header parameters
6784
+ header_params = opts[:header_params] || {}
6785
+ # HTTP header 'Accept' (if needed)
6786
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6787
+
6788
+ # form parameters
6789
+ form_params = opts[:form_params] || {}
6790
+
6791
+ # http body (model)
6792
+ post_body = opts[:debug_body]
6793
+
6794
+ # return_type
6795
+ return_type = opts[:debug_return_type] || 'FDXConsentGrant'
6796
+
6797
+ # auth_names
6798
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6799
+
6800
+ new_options = opts.merge(
6801
+ :operation => :"PlaidApi.fdx_consents_get",
6802
+ :header_params => header_params,
6803
+ :query_params => query_params,
6804
+ :form_params => form_params,
6805
+ :body => post_body,
6806
+ :auth_names => auth_names,
6807
+ :return_type => return_type
6808
+ )
6809
+
6810
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6811
+ if @api_client.config.debugging
6812
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6813
+ end
6814
+ return data, status_code, headers
6815
+ end
6816
+
6817
+ # Retrieve FDX Consent Grant revocation records
6818
+ # Returns the revocation history of a consent grant
6819
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6820
+ # @param [Hash] opts the optional parameters
6821
+ # @return [FDXConsentRevocations]
6822
+ def fdx_consents_revocation_get(consent_id, opts = {})
6823
+ data, _status_code, _headers = fdx_consents_revocation_get_with_http_info(consent_id, opts)
6824
+ data
6825
+ end
6826
+
6827
+ # Retrieve FDX Consent Grant revocation records
6828
+ # Returns the revocation history of a consent grant
6829
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6830
+ # @param [Hash] opts the optional parameters
6831
+ # @return [Array<(FDXConsentRevocations, Integer, Hash)>] FDXConsentRevocations data, response status code and response headers
6832
+ def fdx_consents_revocation_get_with_http_info(consent_id, opts = {})
6833
+ if @api_client.config.debugging
6834
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revocation_get ...'
6835
+ end
6836
+ # verify the required parameter 'consent_id' is set
6837
+ if @api_client.config.client_side_validation && consent_id.nil?
6838
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revocation_get"
6839
+ end
6840
+ # resource path
6841
+ local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
6842
+
6843
+ # query parameters
6844
+ query_params = opts[:query_params] || {}
6845
+
6846
+ # header parameters
6847
+ header_params = opts[:header_params] || {}
6848
+ # HTTP header 'Accept' (if needed)
6849
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6850
+
6851
+ # form parameters
6852
+ form_params = opts[:form_params] || {}
6853
+
6854
+ # http body (model)
6855
+ post_body = opts[:debug_body]
6856
+
6857
+ # return_type
6858
+ return_type = opts[:debug_return_type] || 'FDXConsentRevocations'
6859
+
6860
+ # auth_names
6861
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6862
+
6863
+ new_options = opts.merge(
6864
+ :operation => :"PlaidApi.fdx_consents_revocation_get",
6865
+ :header_params => header_params,
6866
+ :query_params => query_params,
6867
+ :form_params => form_params,
6868
+ :body => post_body,
6869
+ :auth_names => auth_names,
6870
+ :return_type => return_type
6871
+ )
6872
+
6873
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
6874
+ if @api_client.config.debugging
6875
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revocation_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6876
+ end
6877
+ return data, status_code, headers
6878
+ end
6879
+
6880
+ # Revoke FDX Consent Grant
6881
+ # Appends a REVOKED status record to the named consent grant
6882
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6883
+ # @param request_body [Hash<String, Object>]
6884
+ # @param [Hash] opts the optional parameters
6885
+ # @return [nil]
6886
+ def fdx_consents_revoke(consent_id, request_body, opts = {})
6887
+ fdx_consents_revoke_with_http_info(consent_id, request_body, opts)
6888
+ nil
6889
+ end
6890
+
6891
+ # Revoke FDX Consent Grant
6892
+ # Appends a REVOKED status record to the named consent grant
6893
+ # @param consent_id [String] Consent Grant Identifier. Uniquely identifies the consent grant
6894
+ # @param request_body [Hash<String, Object>]
6895
+ # @param [Hash] opts the optional parameters
6896
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
6897
+ def fdx_consents_revoke_with_http_info(consent_id, request_body, opts = {})
6898
+ if @api_client.config.debugging
6899
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_consents_revoke ...'
6900
+ end
6901
+ # verify the required parameter 'consent_id' is set
6902
+ if @api_client.config.client_side_validation && consent_id.nil?
6903
+ fail ArgumentError, "Missing the required parameter 'consent_id' when calling PlaidApi.fdx_consents_revoke"
6904
+ end
6905
+ # verify the required parameter 'request_body' is set
6906
+ if @api_client.config.client_side_validation && request_body.nil?
6907
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.fdx_consents_revoke"
6908
+ end
6909
+ # resource path
6910
+ local_var_path = '/fdx/consents/{consentId}/revocation'.sub('{' + 'consentId' + '}', CGI.escape(consent_id.to_s))
6911
+
6912
+ # query parameters
6913
+ query_params = opts[:query_params] || {}
6914
+
6915
+ # header parameters
6916
+ header_params = opts[:header_params] || {}
6917
+ # HTTP header 'Accept' (if needed)
6918
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6919
+ # HTTP header 'Content-Type'
6920
+ content_type = @api_client.select_header_content_type(['application/json'])
6921
+ if !content_type.nil?
6922
+ header_params['Content-Type'] = content_type
6923
+ end
6924
+
6925
+ # form parameters
6926
+ form_params = opts[:form_params] || {}
6927
+
6928
+ # http body (model)
6929
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
6930
+
6931
+ # return_type
6932
+ return_type = opts[:debug_return_type]
6933
+
6934
+ # auth_names
6935
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6936
+
6937
+ new_options = opts.merge(
6938
+ :operation => :"PlaidApi.fdx_consents_revoke",
6939
+ :header_params => header_params,
6940
+ :query_params => query_params,
6941
+ :form_params => form_params,
6942
+ :body => post_body,
6943
+ :auth_names => auth_names,
6944
+ :return_type => return_type
6945
+ )
6946
+
6947
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
6948
+ if @api_client.config.debugging
6949
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_consents_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6950
+ end
6951
+ return data, status_code, headers
6952
+ end
6953
+
6754
6954
  # Webhook receiver for fdx notifications
6755
6955
  # A generic webhook receiver endpoint for FDX Event Notifications
6756
6956
  # @param fdx_notification [FDXNotification]
@@ -7215,7 +7415,7 @@ module Plaid
7215
7415
  end
7216
7416
 
7217
7417
  # 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.
7418
+ # Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
7219
7419
  # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
7220
7420
  # @param [Hash] opts the optional parameters
7221
7421
  # @return [IdentityVerificationAutofillCreateResponse]
@@ -7225,7 +7425,7 @@ module Plaid
7225
7425
  end
7226
7426
 
7227
7427
  # 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.
7428
+ # Try to autofill an Identity Verification based on the provided phone number, date of birth and country of residence.
7229
7429
  # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
7230
7430
  # @param [Hash] opts the optional parameters
7231
7431
  # @return [Array<(IdentityVerificationAutofillCreateResponse, Integer, Hash)>] IdentityVerificationAutofillCreateResponse data, response status code and response headers
@@ -7895,7 +8095,7 @@ module Plaid
7895
8095
  end
7896
8096
 
7897
8097
  # 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.
8098
+ # 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
8099
  # @param institutions_get_request [InstitutionsGetRequest]
7900
8100
  # @param [Hash] opts the optional parameters
7901
8101
  # @return [InstitutionsGetResponse]
@@ -7905,7 +8105,7 @@ module Plaid
7905
8105
  end
7906
8106
 
7907
8107
  # 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.
8108
+ # 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
8109
  # @param institutions_get_request [InstitutionsGetRequest]
7910
8110
  # @param [Hash] opts the optional parameters
7911
8111
  # @return [Array<(InstitutionsGetResponse, Integer, Hash)>] InstitutionsGetResponse data, response status code and response headers
@@ -8710,8 +8910,8 @@ module Plaid
8710
8910
  return data, status_code, headers
8711
8911
  end
8712
8912
 
8713
- # List a users connected applications
8714
- # List a users connected applications
8913
+ # List a user's connected applications
8914
+ # List a user's connected applications
8715
8915
  # @param item_application_list_request [ItemApplicationListRequest]
8716
8916
  # @param [Hash] opts the optional parameters
8717
8917
  # @return [ItemApplicationListResponse]
@@ -8720,8 +8920,8 @@ module Plaid
8720
8920
  data
8721
8921
  end
8722
8922
 
8723
- # List a users connected applications
8724
- # List a users connected applications
8923
+ # List a user&#39;s connected applications
8924
+ # List a user&#39;s connected applications
8725
8925
  # @param item_application_list_request [ItemApplicationListRequest]
8726
8926
  # @param [Hash] opts the optional parameters
8727
8927
  # @return [Array<(ItemApplicationListResponse, Integer, Hash)>] ItemApplicationListResponse data, response status code and response headers
@@ -8846,8 +9046,8 @@ module Plaid
8846
9046
  return data, status_code, headers
8847
9047
  end
8848
9048
 
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.
9049
+ # Unlink a user's connected application
9050
+ # 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
9051
  # @param item_application_unlink_request [ItemApplicationUnlinkRequest]
8852
9052
  # @param [Hash] opts the optional parameters
8853
9053
  # @return [ItemApplicationUnlinkResponse]
@@ -8856,8 +9056,8 @@ module Plaid
8856
9056
  data
8857
9057
  end
8858
9058
 
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.
9059
+ # Unlink a user&#39;s connected application
9060
+ # 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
9061
  # @param item_application_unlink_request [ItemApplicationUnlinkRequest]
8862
9062
  # @param [Hash] opts the optional parameters
8863
9063
  # @return [Array<(ItemApplicationUnlinkResponse, Integer, Hash)>] ItemApplicationUnlinkResponse data, response status code and response headers
@@ -9050,74 +9250,6 @@ module Plaid
9050
9250
  return data, status_code, headers
9051
9251
  end
9052
9252
 
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
9253
  # Import Item
9122
9254
  # `/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
9255
  # @param item_import_request [ItemImportRequest]
@@ -9662,7 +9794,7 @@ module Plaid
9662
9794
  return data, status_code, headers
9663
9795
  end
9664
9796
 
9665
- # Exchange the Link Correlation Id for a Link Token
9797
+ # Exchange the Link Correlation ID for a Link Token
9666
9798
  # 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
9799
  # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
9668
9800
  # @param [Hash] opts the optional parameters
@@ -9672,7 +9804,7 @@ module Plaid
9672
9804
  data
9673
9805
  end
9674
9806
 
9675
- # Exchange the Link Correlation Id for a Link Token
9807
+ # Exchange the Link Correlation ID for a Link Token
9676
9808
  # 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
9809
  # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
9678
9810
  # @param [Hash] opts the optional parameters
@@ -9866,76 +9998,8 @@ module Plaid
9866
9998
  return data, status_code, headers
9867
9999
  end
9868
10000
 
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
10001
  # 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).
10002
+ # 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
10003
  # @param network_status_get_request [NetworkStatusGetRequest]
9940
10004
  # @param [Hash] opts the optional parameters
9941
10005
  # @return [NetworkStatusGetResponse]
@@ -9945,7 +10009,7 @@ module Plaid
9945
10009
  end
9946
10010
 
9947
10011
  # 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).
10012
+ # 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
10013
  # @param network_status_get_request [NetworkStatusGetRequest]
9950
10014
  # @param [Hash] opts the optional parameters
9951
10015
  # @return [Array<(NetworkStatusGetResponse, Integer, Hash)>] NetworkStatusGetResponse data, response status code and response headers
@@ -10819,7 +10883,7 @@ module Plaid
10819
10883
  end
10820
10884
 
10821
10885
  # 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.
10886
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with Bacs numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient's account, although at least 90% of standing order payments are sent by 6am.
10823
10887
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10824
10888
  # @param [Hash] opts the optional parameters
10825
10889
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -10829,7 +10893,7 @@ module Plaid
10829
10893
  end
10830
10894
 
10831
10895
  # 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.
10896
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with Bacs numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient&#39;s account, although at least 90% of standing order payments are sent by 6am.
10833
10897
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
10834
10898
  # @param [Hash] opts the optional parameters
10835
10899
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -11091,7 +11155,7 @@ module Plaid
11091
11155
  end
11092
11156
 
11093
11157
  # 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`.
11158
+ # 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
11159
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
11096
11160
  # @param [Hash] opts the optional parameters
11097
11161
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -11101,7 +11165,7 @@ module Plaid
11101
11165
  end
11102
11166
 
11103
11167
  # 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;.
11168
+ # 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
11169
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
11106
11170
  # @param [Hash] opts the optional parameters
11107
11171
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -11431,7 +11495,7 @@ module Plaid
11431
11495
  end
11432
11496
 
11433
11497
  # 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.
11498
+ # 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
11499
  # @param payment_profile_remove_request [PaymentProfileRemoveRequest]
11436
11500
  # @param [Hash] opts the optional parameters
11437
11501
  # @return [PaymentProfileRemoveResponse]
@@ -11441,7 +11505,7 @@ module Plaid
11441
11505
  end
11442
11506
 
11443
11507
  # 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.
11508
+ # 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
11509
  # @param payment_profile_remove_request [PaymentProfileRemoveRequest]
11446
11510
  # @param [Hash] opts the optional parameters
11447
11511
  # @return [Array<(PaymentProfileRemoveResponse, Integer, Hash)>] PaymentProfileRemoveResponse data, response status code and response headers
@@ -11499,7 +11563,7 @@ module Plaid
11499
11563
  end
11500
11564
 
11501
11565
  # 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.
11566
+ # 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
11567
  # @param processor_account_get_request [ProcessorAccountGetRequest]
11504
11568
  # @param [Hash] opts the optional parameters
11505
11569
  # @return [ProcessorAccountGetResponse]
@@ -11509,7 +11573,7 @@ module Plaid
11509
11573
  end
11510
11574
 
11511
11575
  # 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.
11576
+ # 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
11577
  # @param processor_account_get_request [ProcessorAccountGetRequest]
11514
11578
  # @param [Hash] opts the optional parameters
11515
11579
  # @return [Array<(ProcessorAccountGetResponse, Integer, Hash)>] ProcessorAccountGetResponse data, response status code and response headers
@@ -12927,7 +12991,7 @@ module Plaid
12927
12991
  end
12928
12992
 
12929
12993
  # 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.
12994
+ # 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 `/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
12995
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12932
12996
  # @param [Hash] opts the optional parameters
12933
12997
  # @return [ProcessorTransactionsRecurringGetResponse]
@@ -12937,7 +13001,7 @@ module Plaid
12937
13001
  end
12938
13002
 
12939
13003
  # 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.
13004
+ # 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 &#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
13005
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12942
13006
  # @param [Hash] opts the optional parameters
12943
13007
  # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
@@ -13063,7 +13127,7 @@ module Plaid
13063
13127
  end
13064
13128
 
13065
13129
  # 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.
13130
+ # 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.
13067
13131
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
13068
13132
  # @param [Hash] opts the optional parameters
13069
13133
  # @return [ProcessorTransactionsSyncResponse]
@@ -13073,7 +13137,7 @@ module Plaid
13073
13137
  end
13074
13138
 
13075
13139
  # 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.
13140
+ # 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.
13077
13141
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
13078
13142
  # @param [Hash] opts the optional parameters
13079
13143
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -13198,8 +13262,8 @@ module Plaid
13198
13262
  return data, status_code, headers
13199
13263
  end
13200
13264
 
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`.
13265
+ # Compute Protect Trust Index scores and subscores
13266
+ # 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
13267
  # @param protect_compute_request [ProtectComputeRequest]
13204
13268
  # @param [Hash] opts the optional parameters
13205
13269
  # @return [ProtectComputeResponse]
@@ -13208,8 +13272,8 @@ module Plaid
13208
13272
  data
13209
13273
  end
13210
13274
 
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;.
13275
+ # Compute Protect Trust Index scores and subscores
13276
+ # 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
13277
  # @param protect_compute_request [ProtectComputeRequest]
13214
13278
  # @param [Hash] opts the optional parameters
13215
13279
  # @return [Array<(ProtectComputeResponse, Integer, Hash)>] ProtectComputeResponse data, response status code and response headers
@@ -13403,7 +13467,7 @@ module Plaid
13403
13467
  end
13404
13468
 
13405
13469
  # 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.
13470
+ # 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
13471
  # @param protect_report_create_request [ProtectReportCreateRequest]
13408
13472
  # @param [Hash] opts the optional parameters
13409
13473
  # @return [ProtectReportCreateResponse]
@@ -13413,7 +13477,7 @@ module Plaid
13413
13477
  end
13414
13478
 
13415
13479
  # 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.
13480
+ # 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
13481
  # @param protect_report_create_request [ProtectReportCreateRequest]
13418
13482
  # @param [Hash] opts the optional parameters
13419
13483
  # @return [Array<(ProtectReportCreateResponse, Integer, Hash)>] ProtectReportCreateResponse data, response status code and response headers
@@ -13538,7 +13602,7 @@ module Plaid
13538
13602
  return data, status_code, headers
13539
13603
  end
13540
13604
 
13541
- # Manually fire a bank income webhook in sandbox
13605
+ # Manually fire a Bank Income webhook in Sandbox
13542
13606
  # Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
13543
13607
  # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
13544
13608
  # @param [Hash] opts the optional parameters
@@ -13548,7 +13612,7 @@ module Plaid
13548
13612
  data
13549
13613
  end
13550
13614
 
13551
- # Manually fire a bank income webhook in sandbox
13615
+ # Manually fire a Bank Income webhook in Sandbox
13552
13616
  # Use the &#x60;/sandbox/bank_income/fire_webhook&#x60; endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
13553
13617
  # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
13554
13618
  # @param [Hash] opts the optional parameters
@@ -13947,7 +14011,7 @@ module Plaid
13947
14011
  end
13948
14012
 
13949
14013
  # 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`).
14014
+ # 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
14015
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
13952
14016
  # @param [Hash] opts the optional parameters
13953
14017
  # @return [SandboxItemFireWebhookResponse]
@@ -13957,7 +14021,7 @@ module Plaid
13957
14021
  end
13958
14022
 
13959
14023
  # 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;).
14024
+ # 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
14025
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
13962
14026
  # @param [Hash] opts the optional parameters
13963
14027
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -14015,7 +14079,7 @@ module Plaid
14015
14079
  end
14016
14080
 
14017
14081
  # 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.
14082
+ # `/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
14083
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
14020
14084
  # @param [Hash] opts the optional parameters
14021
14085
  # @return [SandboxItemResetLoginResponse]
@@ -14025,7 +14089,7 @@ module Plaid
14025
14089
  end
14026
14090
 
14027
14091
  # 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.
14092
+ # &#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
14093
  # @param sandbox_item_reset_login_request [SandboxItemResetLoginRequest]
14030
14094
  # @param [Hash] opts the optional parameters
14031
14095
  # @return [Array<(SandboxItemResetLoginResponse, Integer, Hash)>] SandboxItemResetLoginResponse data, response status code and response headers
@@ -14083,7 +14147,7 @@ module Plaid
14083
14147
  end
14084
14148
 
14085
14149
  # 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#).
14150
+ # 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
14151
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
14088
14152
  # @param [Hash] opts the optional parameters
14089
14153
  # @return [SandboxItemSetVerificationStatusResponse]
@@ -14093,7 +14157,7 @@ module Plaid
14093
14157
  end
14094
14158
 
14095
14159
  # 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#).
14160
+ # 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
14161
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
14098
14162
  # @param [Hash] opts the optional parameters
14099
14163
  # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
@@ -14150,8 +14214,8 @@ module Plaid
14150
14214
  return data, status_code, headers
14151
14215
  end
14152
14216
 
14153
- # Save the selected accounts when connecting to the Platypus Oauth institution
14154
- # Save the selected accounts when connecting to the Platypus Oauth institution
14217
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14218
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14155
14219
  # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
14156
14220
  # @param [Hash] opts the optional parameters
14157
14221
  # @return [Hash<String, Object>]
@@ -14160,8 +14224,8 @@ module Plaid
14160
14224
  data
14161
14225
  end
14162
14226
 
14163
- # Save the selected accounts when connecting to the Platypus Oauth institution
14164
- # Save the selected accounts when connecting to the Platypus Oauth institution
14227
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14228
+ # Save the selected accounts when connecting to the Platypus OAuth institution
14165
14229
  # @param sandbox_oauth_select_accounts_request [SandboxOauthSelectAccountsRequest]
14166
14230
  # @param [Hash] opts the optional parameters
14167
14231
  # @return [Array<(Hash<String, Object>, Integer, Hash)>] Hash<String, Object> data, response status code and response headers
@@ -14491,7 +14555,7 @@ module Plaid
14491
14555
  end
14492
14556
 
14493
14557
  # 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.
14558
+ # 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
14559
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
14496
14560
  # @param [Hash] opts the optional parameters
14497
14561
  # @return [SandboxTransactionsCreateResponse]
@@ -14501,7 +14565,7 @@ module Plaid
14501
14565
  end
14502
14566
 
14503
14567
  # 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.
14568
+ # 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
14569
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
14506
14570
  # @param [Hash] opts the optional parameters
14507
14571
  # @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
@@ -15375,7 +15439,7 @@ module Plaid
15375
15439
  end
15376
15440
 
15377
15441
  # 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.
15442
+ # `/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
15443
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15380
15444
  # @param [Hash] opts the optional parameters
15381
15445
  # @return [SandboxUserResetLoginResponse]
@@ -15385,7 +15449,7 @@ module Plaid
15385
15449
  end
15386
15450
 
15387
15451
  # 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.
15452
+ # &#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
15453
  # @param sandbox_user_reset_login_request [SandboxUserResetLoginRequest]
15390
15454
  # @param [Hash] opts the optional parameters
15391
15455
  # @return [Array<(SandboxUserResetLoginResponse, Integer, Hash)>] SandboxUserResetLoginResponse data, response status code and response headers
@@ -15443,7 +15507,7 @@ module Plaid
15443
15507
  end
15444
15508
 
15445
15509
  # 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).
15510
+ # `/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
15511
  # @param session_token_create_request [SessionTokenCreateRequest]
15448
15512
  # @param [Hash] opts the optional parameters
15449
15513
  # @return [SessionTokenCreateResponse]
@@ -15453,7 +15517,7 @@ module Plaid
15453
15517
  end
15454
15518
 
15455
15519
  # 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).
15520
+ # &#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
15521
  # @param session_token_create_request [SessionTokenCreateRequest]
15458
15522
  # @param [Hash] opts the optional parameters
15459
15523
  # @return [Array<(SessionTokenCreateResponse, Integer, Hash)>] SessionTokenCreateResponse data, response status code and response headers
@@ -15882,7 +15946,7 @@ module Plaid
15882
15946
  # header parameters
15883
15947
  header_params = opts[:header_params] || {}
15884
15948
  # HTTP header 'Accept' (if needed)
15885
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
15949
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf', 'application/json'])
15886
15950
  # HTTP header 'Content-Type'
15887
15951
  content_type = @api_client.select_header_content_type(['application/json'])
15888
15952
  if !content_type.nil?
@@ -15918,8 +15982,8 @@ module Plaid
15918
15982
  return data, status_code, headers
15919
15983
  end
15920
15984
 
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.
15985
+ # Retrieve a list of all statements associated with an Item.
15986
+ # The `/statements/list` endpoint retrieves a list of all statements associated with an Item.
15923
15987
  # @param statements_list_request [StatementsListRequest]
15924
15988
  # @param [Hash] opts the optional parameters
15925
15989
  # @return [StatementsListResponse]
@@ -15928,8 +15992,8 @@ module Plaid
15928
15992
  data
15929
15993
  end
15930
15994
 
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.
15995
+ # Retrieve a list of all statements associated with an Item.
15996
+ # The &#x60;/statements/list&#x60; endpoint retrieves a list of all statements associated with an Item.
15933
15997
  # @param statements_list_request [StatementsListRequest]
15934
15998
  # @param [Hash] opts the optional parameters
15935
15999
  # @return [Array<(StatementsListResponse, Integer, Hash)>] StatementsListResponse data, response status code and response headers
@@ -16054,7 +16118,7 @@ module Plaid
16054
16118
  return data, status_code, headers
16055
16119
  end
16056
16120
 
16057
- # enhance locally-held transaction data
16121
+ # Enhance locally-held transaction data
16058
16122
  # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
16059
16123
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
16060
16124
  # @param [Hash] opts the optional parameters
@@ -16064,7 +16128,7 @@ module Plaid
16064
16128
  data
16065
16129
  end
16066
16130
 
16067
- # enhance locally-held transaction data
16131
+ # Enhance locally-held transaction data
16068
16132
  # The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
16069
16133
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
16070
16134
  # @param [Hash] opts the optional parameters
@@ -16259,7 +16323,7 @@ module Plaid
16259
16323
  end
16260
16324
 
16261
16325
  # 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.
16326
+ # 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 `/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
16327
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
16264
16328
  # @param [Hash] opts the optional parameters
16265
16329
  # @return [TransactionsRecurringGetResponse]
@@ -16269,7 +16333,7 @@ module Plaid
16269
16333
  end
16270
16334
 
16271
16335
  # 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.
16336
+ # 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 &#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
16337
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
16274
16338
  # @param [Hash] opts the optional parameters
16275
16339
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -16395,7 +16459,7 @@ module Plaid
16395
16459
  end
16396
16460
 
16397
16461
  # 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.
16462
+ # 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
16463
  # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
16400
16464
  # @param [Hash] opts the optional parameters
16401
16465
  # @return [TransactionsRulesCreateResponse]
@@ -16405,7 +16469,7 @@ module Plaid
16405
16469
  end
16406
16470
 
16407
16471
  # 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.
16472
+ # 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
16473
  # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
16410
16474
  # @param [Hash] opts the optional parameters
16411
16475
  # @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
@@ -16463,7 +16527,7 @@ module Plaid
16463
16527
  end
16464
16528
 
16465
16529
  # 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.
16530
+ # The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
16467
16531
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
16468
16532
  # @param [Hash] opts the optional parameters
16469
16533
  # @return [TransactionsRulesListResponse]
@@ -16473,7 +16537,7 @@ module Plaid
16473
16537
  end
16474
16538
 
16475
16539
  # 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.
16540
+ # The &#x60;/beta/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
16477
16541
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
16478
16542
  # @param [Hash] opts the optional parameters
16479
16543
  # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
@@ -16531,7 +16595,7 @@ module Plaid
16531
16595
  end
16532
16596
 
16533
16597
  # Remove transaction rule
16534
- # The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
16598
+ # The `/beta/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
16535
16599
  # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
16536
16600
  # @param [Hash] opts the optional parameters
16537
16601
  # @return [TransactionsRulesRemoveResponse]
@@ -16541,7 +16605,7 @@ module Plaid
16541
16605
  end
16542
16606
 
16543
16607
  # Remove transaction rule
16544
- # The &#x60;/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
16608
+ # The &#x60;/beta/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
16545
16609
  # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
16546
16610
  # @param [Hash] opts the optional parameters
16547
16611
  # @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
@@ -16599,7 +16663,7 @@ module Plaid
16599
16663
  end
16600
16664
 
16601
16665
  # 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.
16666
+ # 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.
16603
16667
  # @param transactions_sync_request [TransactionsSyncRequest]
16604
16668
  # @param [Hash] opts the optional parameters
16605
16669
  # @return [TransactionsSyncResponse]
@@ -16609,7 +16673,7 @@ module Plaid
16609
16673
  end
16610
16674
 
16611
16675
  # 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.
16676
+ # 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.
16613
16677
  # @param transactions_sync_request [TransactionsSyncRequest]
16614
16678
  # @param [Hash] opts the optional parameters
16615
16679
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -16803,7 +16867,7 @@ module Plaid
16803
16867
  end
16804
16868
 
16805
16869
  # 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.
16870
+ # 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
16871
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
16808
16872
  # @param [Hash] opts the optional parameters
16809
16873
  # @return [TransferAuthorizationCreateResponse]
@@ -16813,7 +16877,7 @@ module Plaid
16813
16877
  end
16814
16878
 
16815
16879
  # 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.
16880
+ # 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
16881
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
16818
16882
  # @param [Hash] opts the optional parameters
16819
16883
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -17211,7 +17275,7 @@ module Plaid
17211
17275
  end
17212
17276
 
17213
17277
  # 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.
17278
+ # 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. 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
17279
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
17216
17280
  # @param [Hash] opts the optional parameters
17217
17281
  # @return [TransferDiligenceDocumentUploadResponse]
@@ -17221,7 +17285,7 @@ module Plaid
17221
17285
  end
17222
17286
 
17223
17287
  # 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.
17288
+ # 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. 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
17289
  # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
17226
17290
  # @param [Hash] opts the optional parameters
17227
17291
  # @return [Array<(TransferDiligenceDocumentUploadResponse, Integer, Hash)>] TransferDiligenceDocumentUploadResponse data, response status code and response headers
@@ -17755,7 +17819,7 @@ module Plaid
17755
17819
  end
17756
17820
 
17757
17821
  # 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.
17822
+ # 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 ledger.
17759
17823
  # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
17760
17824
  # @param [Hash] opts the optional parameters
17761
17825
  # @return [TransferLedgerDistributeResponse]
@@ -17765,7 +17829,7 @@ module Plaid
17765
17829
  end
17766
17830
 
17767
17831
  # 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.
17832
+ # 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 ledger.
17769
17833
  # @param transfer_ledger_distribute_request [TransferLedgerDistributeRequest]
17770
17834
  # @param [Hash] opts the optional parameters
17771
17835
  # @return [Array<(TransferLedgerDistributeResponse, Integer, Hash)>] TransferLedgerDistributeResponse data, response status code and response headers
@@ -18163,7 +18227,7 @@ module Plaid
18163
18227
  end
18164
18228
 
18165
18229
  # 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).
18230
+ # 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
18231
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
18168
18232
  # @param [Hash] opts the optional parameters
18169
18233
  # @return [TransferMigrateAccountResponse]
@@ -18173,7 +18237,7 @@ module Plaid
18173
18237
  end
18174
18238
 
18175
18239
  # 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).
18240
+ # 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
18241
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
18178
18242
  # @param [Hash] opts the optional parameters
18179
18243
  # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
@@ -18775,7 +18839,7 @@ module Plaid
18775
18839
  end
18776
18840
 
18777
18841
  # 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.
18842
+ # 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
18843
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
18780
18844
  # @param [Hash] opts the optional parameters
18781
18845
  # @return [TransferQuestionnaireCreateResponse]
@@ -18785,7 +18849,7 @@ module Plaid
18785
18849
  end
18786
18850
 
18787
18851
  # 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.
18852
+ # 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
18853
  # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
18790
18854
  # @param [Hash] opts the optional parameters
18791
18855
  # @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
@@ -20144,7 +20208,7 @@ module Plaid
20144
20208
  end
20145
20209
 
20146
20210
  # 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.
20211
+ # 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
20212
  # @param user_items_remove_request [UserItemsRemoveRequest]
20149
20213
  # @param [Hash] opts the optional parameters
20150
20214
  # @return [UserItemsRemoveResponse]
@@ -20154,7 +20218,7 @@ module Plaid
20154
20218
  end
20155
20219
 
20156
20220
  # 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.
20221
+ # 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
20222
  # @param user_items_remove_request [UserItemsRemoveRequest]
20159
20223
  # @param [Hash] opts the optional parameters
20160
20224
  # @return [Array<(UserItemsRemoveResponse, Integer, Hash)>] UserItemsRemoveResponse data, response status code and response headers
@@ -20212,7 +20276,7 @@ module Plaid
20212
20276
  end
20213
20277
 
20214
20278
  # 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.
20279
+ # 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
20280
  # @param user_products_terminate_request [UserProductsTerminateRequest]
20217
20281
  # @param [Hash] opts the optional parameters
20218
20282
  # @return [UserProductsTerminateResponse]
@@ -20222,7 +20286,7 @@ module Plaid
20222
20286
  end
20223
20287
 
20224
20288
  # 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.
20289
+ # 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
20290
  # @param user_products_terminate_request [UserProductsTerminateRequest]
20227
20291
  # @param [Hash] opts the optional parameters
20228
20292
  # @return [Array<(UserProductsTerminateResponse, Integer, Hash)>] UserProductsTerminateResponse data, response status code and response headers
@@ -20280,7 +20344,7 @@ module Plaid
20280
20344
  end
20281
20345
 
20282
20346
  # Remove user
20283
- # `/user/remove` deletes a `user_id` or `user_token` and and associated information, including any Items associated with the user.
20347
+ # `/user/remove` deletes a `user_id` or `user_token` and associated information, including any Items associated with the user.
20284
20348
  # @param user_remove_request [UserRemoveRequest]
20285
20349
  # @param [Hash] opts the optional parameters
20286
20350
  # @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 +20355,7 @@ module Plaid
20291
20355
  end
20292
20356
 
20293
20357
  # 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.
20358
+ # &#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
20359
  # @param user_remove_request [UserRemoveRequest]
20296
20360
  # @param [Hash] opts the optional parameters
20297
20361
  # @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)