plaid 51.0.0 → 53.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 (2290) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +369 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/README.md +6 -0
  6. data/lib/plaid/api/plaid_api.rb +284 -352
  7. data/lib/plaid/api_client.rb +4 -7
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +1 -1
  10. data/lib/plaid/models/aamva_analysis.rb +1 -1
  11. data/lib/plaid/models/aamva_detailed_match_result.rb +1 -1
  12. data/lib/plaid/models/aamva_match_result.rb +1 -1
  13. data/lib/plaid/models/account_access.rb +1 -1
  14. data/lib/plaid/models/account_assets.rb +1 -1
  15. data/lib/plaid/models/account_balance.rb +2 -2
  16. data/lib/plaid/models/account_base.rb +18 -7
  17. data/lib/plaid/models/account_base_nullable.rb +18 -7
  18. data/lib/plaid/models/account_filter.rb +1 -1
  19. data/lib/plaid/models/account_filters_response.rb +1 -1
  20. data/lib/plaid/models/account_holder_category.rb +1 -1
  21. data/lib/plaid/models/account_identity.rb +14 -3
  22. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  23. data/lib/plaid/models/account_identity_document_upload.rb +14 -3
  24. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  25. data/lib/plaid/models/account_identity_match_score.rb +14 -3
  26. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  27. data/lib/plaid/models/account_insights.rb +1 -1
  28. data/lib/plaid/models/account_product_access.rb +1 -1
  29. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  30. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  31. data/lib/plaid/models/account_subtype.rb +1 -3
  32. data/lib/plaid/models/account_type.rb +1 -1
  33. data/lib/plaid/models/account_verification_insights.rb +2 -2
  34. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  35. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  36. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  37. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  38. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  39. data/lib/plaid/models/accounts_get_request.rb +1 -1
  40. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  41. data/lib/plaid/models/accounts_get_response.rb +1 -1
  42. data/lib/plaid/models/ach_class.rb +1 -1
  43. data/lib/plaid/models/action_state.rb +1 -1
  44. data/lib/plaid/models/activity.rb +1 -1
  45. data/lib/plaid/models/activity_type.rb +1 -1
  46. data/lib/plaid/models/address.rb +1 -1
  47. data/lib/plaid/models/address_data.rb +2 -6
  48. data/lib/plaid/models/address_data_not_required.rb +2 -1
  49. data/lib/plaid/models/address_data_nullable.rb +2 -6
  50. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +2 -1
  51. data/lib/plaid/models/address_data_override.rb +276 -0
  52. data/lib/plaid/models/address_match_score.rb +1 -1
  53. data/lib/plaid/models/address_nullable.rb +1 -1
  54. data/lib/plaid/models/address_override.rb +240 -0
  55. data/lib/plaid/models/address_purpose_label.rb +1 -1
  56. data/lib/plaid/models/affordability_insights.rb +1 -1
  57. data/lib/plaid/models/amount.rb +1 -1
  58. data/lib/plaid/models/amount_with_currency.rb +1 -1
  59. data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +1 -1
  60. data/lib/plaid/models/application.rb +1 -1
  61. data/lib/plaid/models/application_get_request.rb +1 -1
  62. data/lib/plaid/models/application_get_response.rb +1 -1
  63. data/lib/plaid/models/application_last_data_access_times.rb +1 -1
  64. data/lib/plaid/models/apr.rb +1 -1
  65. data/lib/plaid/models/asset.rb +1 -1
  66. data/lib/plaid/models/asset_detail.rb +1 -1
  67. data/lib/plaid/models/asset_holder.rb +1 -1
  68. data/lib/plaid/models/asset_holder_name.rb +1 -1
  69. data/lib/plaid/models/asset_holding.rb +1 -1
  70. data/lib/plaid/models/asset_holdings.rb +1 -1
  71. data/lib/plaid/models/asset_investment_transaction_type.rb +1 -1
  72. data/lib/plaid/models/asset_owner.rb +1 -1
  73. data/lib/plaid/models/asset_owners.rb +1 -1
  74. data/lib/plaid/models/asset_report.rb +2 -3
  75. data/lib/plaid/models/asset_report_account_balance.rb +2 -2
  76. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  77. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  79. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  80. data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  84. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  85. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  86. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  88. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  89. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  90. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  91. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  92. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  93. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  94. data/lib/plaid/models/asset_report_insights.rb +237 -0
  95. data/lib/plaid/models/asset_report_investment_holding.rb +24 -13
  96. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  97. data/lib/plaid/models/asset_report_investment_transaction.rb +2 -32
  98. data/lib/plaid/models/asset_report_investments.rb +1 -1
  99. data/lib/plaid/models/asset_report_item.rb +1 -1
  100. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  101. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  102. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  103. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  104. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  105. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  106. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  107. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  108. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  109. data/lib/plaid/models/asset_report_type.rb +1 -1
  110. data/lib/plaid/models/asset_report_user.rb +1 -1
  111. data/lib/plaid/models/asset_transaction.rb +1 -1
  112. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  113. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  114. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  115. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  116. data/lib/plaid/models/asset_transactions.rb +1 -1
  117. data/lib/plaid/models/asset_type.rb +1 -1
  118. data/lib/plaid/models/assets.rb +1 -1
  119. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  120. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  121. data/lib/plaid/models/auth_default_update_webhook.rb +2 -2
  122. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  123. data/lib/plaid/models/auth_get_request.rb +1 -1
  124. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  125. data/lib/plaid/models/auth_get_response.rb +2 -2
  126. data/lib/plaid/models/auth_metadata.rb +1 -1
  127. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  128. data/lib/plaid/models/auth_update_types.rb +4 -3
  129. data/lib/plaid/models/auth_verify_numbers_ach.rb +1 -1
  130. data/lib/plaid/models/auth_verify_request.rb +1 -1
  131. data/lib/plaid/models/auth_verify_request_numbers.rb +1 -1
  132. data/lib/plaid/models/auth_verify_response.rb +1 -1
  133. data/lib/plaid/models/authorization_guarantee_details.rb +1 -1
  134. data/lib/plaid/models/authorization_guarantee_schedule_item.rb +1 -1
  135. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  136. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  137. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  138. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  139. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  140. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  141. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  142. data/lib/plaid/models/bank_penalties_indicators.rb +1 -1
  143. data/lib/plaid/models/bank_transfer.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  156. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  157. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  158. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  159. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  160. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  161. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  162. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  163. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  164. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  165. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  166. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  167. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  168. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  169. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  170. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  171. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  172. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  173. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  174. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  175. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  176. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  177. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  178. data/lib/plaid/models/base_report.rb +1 -1
  179. data/lib/plaid/models/base_report_account.rb +1 -1
  180. data/lib/plaid/models/base_report_account_balances.rb +2 -2
  181. data/lib/plaid/models/base_report_account_insights.rb +4 -4
  182. data/lib/plaid/models/base_report_account_metadata.rb +1 -1
  183. data/lib/plaid/models/base_report_attributes.rb +1 -1
  184. data/lib/plaid/models/base_report_average_flow_insights.rb +2 -2
  185. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  186. data/lib/plaid/models/base_report_historical_balance.rb +2 -2
  187. data/lib/plaid/models/base_report_investment_holding.rb +1 -1
  188. data/lib/plaid/models/base_report_investment_security.rb +1 -1
  189. data/lib/plaid/models/base_report_investment_transaction.rb +1 -1
  190. data/lib/plaid/models/base_report_investments.rb +1 -1
  191. data/lib/plaid/models/base_report_item.rb +1 -1
  192. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  193. data/lib/plaid/models/base_report_number_flow_insights.rb +2 -2
  194. data/lib/plaid/models/base_report_transaction.rb +1 -1
  195. data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +1 -1
  196. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  197. data/lib/plaid/models/base_report_user_attributes.rb +1 -1
  198. data/lib/plaid/models/base_report_warning.rb +1 -1
  199. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  200. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  201. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  202. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  203. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  204. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  205. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  206. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  207. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  208. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  209. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  210. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  211. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  212. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  213. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  214. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  215. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  216. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  217. data/lib/plaid/models/beacon_report.rb +1 -1
  218. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  219. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  220. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  221. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  222. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  223. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  224. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  225. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  226. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  227. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  228. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  229. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  230. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  231. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  232. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  233. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  234. data/lib/plaid/models/beacon_report_type.rb +1 -1
  235. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  236. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  237. data/lib/plaid/models/beacon_user.rb +1 -1
  238. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  239. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  240. data/lib/plaid/models/beacon_user_address.rb +1 -1
  241. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  242. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  243. data/lib/plaid/models/beacon_user_data.rb +1 -1
  244. data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
  245. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  246. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  247. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  248. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  249. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  250. data/lib/plaid/models/beacon_user_name.rb +1 -1
  251. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  252. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  253. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  254. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  255. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  256. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  257. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  258. data/lib/plaid/models/beacon_user_status.rb +1 -1
  259. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  260. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  261. data/lib/plaid/models/beacon_user_update_request_data.rb +1 -1
  262. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  263. data/lib/plaid/models/{link_delivery_get_request.rb → beta_cash_advance_income_insights_v1_get_request.rb} +16 -16
  264. data/lib/plaid/models/beta_cash_advance_income_insights_v1_get_response.rb +289 -0
  265. data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +1 -1
  266. data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +1 -1
  267. data/lib/plaid/models/beta_issues_v1_get_request.rb +1 -1
  268. data/lib/plaid/models/beta_issues_v1_get_response.rb +1 -1
  269. data/lib/plaid/models/beta_issues_v1_issue.rb +1 -1
  270. data/lib/plaid/models/beta_issues_v1_issue_attribution.rb +1 -1
  271. data/lib/plaid/models/beta_issues_v1_issue_behavior.rb +1 -1
  272. data/lib/plaid/models/beta_issues_v1_issue_impact.rb +1 -1
  273. data/lib/plaid/models/beta_issues_v1_issue_resolution_event.rb +1 -1
  274. data/lib/plaid/models/beta_issues_v1_issue_resolution_type.rb +1 -1
  275. data/lib/plaid/models/beta_issues_v1_issue_severity.rb +1 -1
  276. data/lib/plaid/models/beta_issues_v1_issue_status.rb +1 -1
  277. data/lib/plaid/models/beta_issues_v1_issue_type.rb +1 -1
  278. data/lib/plaid/models/beta_issues_v1_list_request.rb +1 -1
  279. data/lib/plaid/models/beta_issues_v1_list_response.rb +1 -1
  280. data/lib/plaid/models/beta_issues_v1_match_identifier_type.rb +1 -1
  281. data/lib/plaid/models/beta_issues_v1_match_request.rb +1 -1
  282. data/lib/plaid/models/beta_issues_v1_match_response.rb +1 -1
  283. data/lib/plaid/models/beta_issues_v1_subscribe_request.rb +1 -1
  284. data/lib/plaid/models/beta_issues_v1_subscribe_response.rb +1 -1
  285. data/lib/plaid/models/beta_issues_v1_unsubscribe_request.rb +1 -1
  286. data/lib/plaid/models/beta_issues_v1_unsubscribe_response.rb +1 -1
  287. data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +1 -1
  288. data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +1 -1
  289. data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +1 -1
  290. data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +1 -1
  291. data/lib/plaid/models/beta_partner_customer_v1_get_request.rb +1 -1
  292. data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +1 -1
  293. data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +1 -1
  294. data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +1 -1
  295. data/lib/plaid/models/beta_partner_end_customer.rb +1 -1
  296. data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +1 -1
  297. data/lib/plaid/models/beta_webhook_events_list_request.rb +8 -8
  298. data/lib/plaid/models/beta_webhook_events_list_response.rb +3 -3
  299. data/lib/plaid/models/business_account.rb +14 -3
  300. data/lib/plaid/models/business_account_all_of.rb +1 -1
  301. data/lib/plaid/models/business_check_boolean_status.rb +1 -1
  302. data/lib/plaid/models/business_digital_presence_check.rb +1 -1
  303. data/lib/plaid/models/business_email_address.rb +1 -1
  304. data/lib/plaid/models/business_entity_type.rb +1 -1
  305. data/lib/plaid/models/business_field_match_summary.rb +1 -1
  306. data/lib/plaid/models/business_finance_category.rb +1 -1
  307. data/lib/plaid/models/business_industry_prediction.rb +1 -1
  308. data/lib/plaid/models/business_industry_prediction_nullable.rb +1 -1
  309. data/lib/plaid/models/business_kyb_check.rb +1 -1
  310. data/lib/plaid/models/business_kyb_match_details.rb +1 -1
  311. data/lib/plaid/models/business_phone_number.rb +1 -1
  312. data/lib/plaid/models/business_risk_check.rb +1 -1
  313. data/lib/plaid/models/business_search_terms.rb +1 -1
  314. data/lib/plaid/models/business_verification_create_request.rb +1 -1
  315. data/lib/plaid/models/business_verification_create_request_business.rb +1 -1
  316. data/lib/plaid/models/business_verification_create_response.rb +1 -1
  317. data/lib/plaid/models/business_verification_get_request.rb +1 -1
  318. data/lib/plaid/models/business_verification_get_response.rb +1 -1
  319. data/lib/plaid/models/business_verification_status_kyb_check.rb +1 -1
  320. data/lib/plaid/models/business_verification_status_overall.rb +1 -1
  321. data/lib/plaid/models/business_verification_status_risk_check.rb +1 -1
  322. data/lib/plaid/models/business_verification_status_web_presence_check.rb +1 -1
  323. data/lib/plaid/models/business_website.rb +1 -1
  324. data/lib/plaid/models/business_website_analysis.rb +1 -1
  325. data/lib/plaid/models/business_website_build_status.rb +1 -1
  326. data/lib/plaid/models/business_website_ssl.rb +1 -1
  327. data/lib/plaid/models/business_whois_record.rb +1 -1
  328. data/lib/plaid/models/cash_advance_decision_outcome.rb +1 -1
  329. data/lib/plaid/models/{link_delivery_delivery_method.rb → cash_advance_feedback_type.rb} +4 -4
  330. data/lib/plaid/models/{link_delivery_options.rb → cash_advance_income_category.rb} +14 -12
  331. data/lib/plaid/models/cash_advance_income_stream.rb +275 -0
  332. data/lib/plaid/models/cash_advance_info.rb +2 -2
  333. data/lib/plaid/models/cash_advance_info_amount_approved.rb +1 -1
  334. data/lib/plaid/models/cash_advance_info_amount_due.rb +2 -2
  335. data/lib/plaid/models/cash_advance_pay_frequency.rb +45 -0
  336. data/lib/plaid/models/cash_advance_repayment.rb +1 -1
  337. data/lib/plaid/models/cash_advance_repayment_amount_due.rb +1 -1
  338. data/lib/plaid/models/cash_advance_repayment_amount_paid.rb +1 -1
  339. data/lib/plaid/models/cash_advance_repayment_status.rb +1 -1
  340. data/lib/plaid/models/cash_advance_type.rb +1 -1
  341. data/lib/plaid/models/cash_flow_insight.rb +1 -1
  342. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +1 -1
  343. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +1 -1
  344. data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +1 -1
  345. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +1 -1
  346. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +1 -1
  347. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +1 -1
  348. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +1 -1
  349. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +1 -1
  350. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +1 -1
  351. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  352. data/lib/plaid/models/cashflow_report_account_insights.rb +1 -1
  353. data/lib/plaid/models/cashflow_report_get_request.rb +1 -1
  354. data/lib/plaid/models/cashflow_report_get_request_options.rb +1 -1
  355. data/lib/plaid/models/cashflow_report_get_response.rb +1 -1
  356. data/lib/plaid/models/cashflow_report_historical_balance.rb +1 -1
  357. data/lib/plaid/models/cashflow_report_insights_get_request.rb +1 -1
  358. data/lib/plaid/models/cashflow_report_insights_get_response.rb +1 -1
  359. data/lib/plaid/models/cashflow_report_monthly_summary.rb +1 -1
  360. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +1 -1
  361. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +1 -1
  362. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +1 -1
  363. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +1 -1
  364. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +1 -1
  365. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +1 -1
  366. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +1 -1
  367. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +1 -1
  368. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +1 -1
  369. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +1 -1
  370. data/lib/plaid/models/cashflow_report_payment_meta.rb +1 -1
  371. data/lib/plaid/models/cashflow_report_refresh_request.rb +1 -1
  372. data/lib/plaid/models/cashflow_report_refresh_response.rb +1 -1
  373. data/lib/plaid/models/cashflow_report_transaction.rb +1 -1
  374. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +1 -1
  375. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +1 -1
  376. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +1 -1
  377. data/lib/plaid/models/categories_get_response.rb +1 -1
  378. data/lib/plaid/models/category.rb +1 -1
  379. data/lib/plaid/models/category_expenses.rb +1 -1
  380. data/lib/plaid/models/category_insight_details.rb +1 -1
  381. data/lib/plaid/models/category_insights.rb +1 -1
  382. data/lib/plaid/models/cause.rb +3 -3
  383. data/lib/plaid/models/cause_all_of.rb +1 -1
  384. data/lib/plaid/models/check_report_repairable_item.rb +1 -1
  385. data/lib/plaid/models/check_report_warning.rb +1 -1
  386. data/lib/plaid/models/check_report_warning_code.rb +1 -1
  387. data/lib/plaid/models/client_customization.rb +1 -1
  388. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  389. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  390. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  391. data/lib/plaid/models/client_user_identity.rb +2 -2
  392. data/lib/plaid/models/client_user_identity_address.rb +1 -1
  393. data/lib/plaid/models/client_user_identity_email.rb +1 -1
  394. data/lib/plaid/models/client_user_identity_name.rb +1 -1
  395. data/lib/plaid/models/client_user_identity_phone_number.rb +1 -1
  396. data/lib/plaid/models/connected_application.rb +1 -1
  397. data/lib/plaid/models/consent_event.rb +4 -4
  398. data/lib/plaid/models/consent_event_code.rb +1 -1
  399. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  400. data/lib/plaid/models/consent_event_type.rb +1 -1
  401. data/lib/plaid/models/consent_events_get_request.rb +1 -1
  402. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  403. data/lib/plaid/models/consented_account.rb +1 -1
  404. data/lib/plaid/models/consumer_dispute.rb +1 -1
  405. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  406. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  407. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  408. data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
  409. data/lib/plaid/models/counterparty.rb +1 -1
  410. data/lib/plaid/models/counterparty_insights.rb +1 -1
  411. data/lib/plaid/models/counterparty_numbers.rb +1 -1
  412. data/lib/plaid/models/counterparty_numbers_bacs.rb +1 -1
  413. data/lib/plaid/models/counterparty_numbers_international.rb +1 -1
  414. data/lib/plaid/models/counterparty_type.rb +1 -1
  415. data/lib/plaid/models/country_code.rb +1 -1
  416. data/lib/plaid/models/cra_annual_income_values.rb +1 -1
  417. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  418. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  419. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  420. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  421. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  422. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  423. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  424. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  425. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  426. data/lib/plaid/models/cra_bank_income_income_provider.rb +1 -1
  427. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  428. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  429. data/lib/plaid/models/cra_bank_income_status.rb +1 -1
  430. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  431. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  432. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  433. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  434. data/lib/plaid/models/cra_base_report_product.rb +275 -0
  435. data/lib/plaid/models/cra_base_report_product_config.rb +1 -1
  436. data/lib/plaid/models/{link_delivery_create_response.rb → cra_cashflow_insights_product.rb} +60 -41
  437. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  438. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +1 -1
  439. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  440. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +1 -1
  441. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +1 -1
  442. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
  443. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +1 -1
  444. data/lib/plaid/models/cra_check_report_create_cashflow_insights_options.rb +1 -1
  445. data/lib/plaid/models/cra_check_report_create_employment_refresh_options.rb +1 -1
  446. data/lib/plaid/models/cra_check_report_create_income_insights_options.rb +1 -1
  447. data/lib/plaid/models/cra_check_report_create_lend_score_options.rb +1 -1
  448. data/lib/plaid/models/cra_check_report_create_network_insights_options.rb +1 -1
  449. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +1 -1
  450. data/lib/plaid/models/cra_check_report_create_request.rb +3 -3
  451. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  452. data/lib/plaid/models/cra_check_report_failed_webhook.rb +16 -2
  453. data/lib/plaid/models/cra_check_report_failed_webhook_error.rb +3 -3
  454. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
  455. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
  456. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
  457. data/lib/plaid/models/cra_check_report_gse_options.rb +1 -1
  458. data/lib/plaid/models/cra_check_report_home_lending_report_options.rb +1 -1
  459. data/lib/plaid/models/cra_check_report_income_insights_get_options.rb +1 -1
  460. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
  461. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  462. data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +1 -1
  463. data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +1 -1
  464. data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +1 -1
  465. data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +1 -1
  466. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +1 -1
  467. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +1 -1
  468. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  469. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +1 -1
  470. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +1 -1
  471. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
  472. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +2 -2
  473. data/lib/plaid/models/cra_check_report_permissible_purpose.rb +1 -1
  474. data/lib/plaid/models/cra_check_report_ready_webhook.rb +2 -2
  475. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +1 -1
  476. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +1 -1
  477. data/lib/plaid/models/cra_check_report_verification_get_request.rb +1 -1
  478. data/lib/plaid/models/cra_check_report_verification_get_response.rb +1 -1
  479. data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +1 -1
  480. data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +1 -1
  481. data/lib/plaid/models/cra_credit_profile_inquiry_type.rb +1 -1
  482. data/lib/plaid/models/cra_credit_profile_lend_score.rb +1 -1
  483. data/lib/plaid/models/cra_credit_profile_report.rb +1 -1
  484. data/lib/plaid/models/cra_credit_profile_report_get_request.rb +1 -1
  485. data/lib/plaid/models/cra_credit_profile_report_get_response.rb +1 -1
  486. data/lib/plaid/models/cra_credit_profile_report_metadata.rb +18 -3
  487. data/lib/plaid/models/cra_credit_profile_report_type.rb +1 -1
  488. data/lib/plaid/models/cra_credit_profile_report_version.rb +1 -1
  489. data/lib/plaid/models/cra_current_modeled_income.rb +1 -1
  490. data/lib/plaid/models/cra_employment_refresh_report.rb +1 -1
  491. data/lib/plaid/models/cra_employment_refresh_report_account.rb +1 -1
  492. data/lib/plaid/models/cra_employment_refresh_report_item.rb +1 -1
  493. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +1 -1
  494. data/lib/plaid/models/cra_home_lending_product.rb +1 -1
  495. data/lib/plaid/models/cra_income_category.rb +1 -1
  496. data/lib/plaid/models/cra_income_complete_bundle_product.rb +275 -0
  497. data/lib/plaid/models/cra_income_insights.rb +1 -1
  498. data/lib/plaid/models/cra_income_insights_product.rb +1 -1
  499. data/lib/plaid/models/cra_income_insights_product_config.rb +1 -1
  500. data/lib/plaid/models/cra_income_insights_user_summary.rb +1 -1
  501. data/lib/plaid/models/cra_income_metrics.rb +1 -1
  502. data/lib/plaid/models/cra_income_next_payment.rb +1 -1
  503. data/lib/plaid/models/cra_income_stream.rb +1 -1
  504. data/lib/plaid/models/cra_income_stream_insights.rb +1 -1
  505. data/lib/plaid/models/cra_income_transaction.rb +1 -1
  506. data/lib/plaid/models/cra_income_transaction_outlier.rb +1 -1
  507. data/lib/plaid/models/cra_lend_score_complete_bundle_product.rb +285 -0
  508. data/lib/plaid/models/cra_lend_score_product.rb +285 -0
  509. data/lib/plaid/models/cra_lend_score_report.rb +1 -1
  510. data/lib/plaid/models/cra_lend_score_variant.rb +42 -0
  511. data/lib/plaid/models/cra_loan_application.rb +1 -1
  512. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  513. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  514. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  515. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  516. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  517. data/lib/plaid/models/cra_loan_register.rb +1 -1
  518. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  519. data/lib/plaid/models/cra_loan_status.rb +1 -1
  520. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  521. data/lib/plaid/models/cra_loan_type.rb +1 -1
  522. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  523. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  524. data/lib/plaid/models/cra_loan_update.rb +1 -1
  525. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  526. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  527. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  528. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  529. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  530. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  531. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  532. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +1 -1
  533. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  534. data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
  535. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +1 -1
  536. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  537. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  538. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  539. data/lib/plaid/models/cra_monthly_income_values.rb +1 -1
  540. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  541. data/lib/plaid/models/cra_network_insights_product.rb +275 -0
  542. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  543. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  544. data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +1 -1
  545. data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +1 -1
  546. data/lib/plaid/models/cra_partner_insights_bureau.rb +1 -1
  547. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  548. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  549. data/lib/plaid/models/cra_partner_insights_fico_input.rb +1 -1
  550. data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +1 -1
  551. data/lib/plaid/models/cra_partner_insights_fico_results.rb +1 -1
  552. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  553. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  554. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  555. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  556. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  557. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  558. data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +1 -1
  559. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +1 -1
  560. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +1 -1
  561. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +1 -1
  562. data/lib/plaid/models/cra_pdf_add_ons.rb +2 -1
  563. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  564. data/lib/plaid/models/cra_projected_modeled_income.rb +1 -1
  565. data/lib/plaid/models/cra_qualify_product.rb +1 -1
  566. data/lib/plaid/models/cra_qualify_product_config.rb +1 -1
  567. data/lib/plaid/models/cra_report_create_base_report_options.rb +222 -0
  568. data/lib/plaid/models/cra_report_create_base_report_product_config.rb +285 -0
  569. data/lib/plaid/models/cra_report_create_cashflow_insights_product_config.rb +275 -0
  570. data/lib/plaid/models/cra_report_create_home_lending_product_config.rb +275 -0
  571. data/lib/plaid/models/cra_report_create_income_complete_bundle_product_config.rb +285 -0
  572. data/lib/plaid/models/cra_report_create_income_complete_options.rb +221 -0
  573. data/lib/plaid/models/cra_report_create_income_insights_options.rb +221 -0
  574. data/lib/plaid/models/cra_report_create_income_insights_product_config.rb +285 -0
  575. data/lib/plaid/models/cra_report_create_lend_score_complete_bundle_product_config.rb +285 -0
  576. data/lib/plaid/models/{sandbox_transfer_repayment_simulate_request.rb → cra_report_create_lend_score_complete_options.rb} +15 -23
  577. data/lib/plaid/models/{transactions_enhance_get_response.rb → cra_report_create_lend_score_options.rb} +14 -19
  578. data/lib/plaid/models/cra_report_create_lend_score_product_config.rb +285 -0
  579. data/lib/plaid/models/cra_report_create_network_insights_product_config.rb +275 -0
  580. data/lib/plaid/models/cra_report_create_qualify_product_config.rb +275 -0
  581. data/lib/plaid/models/cra_report_create_request.rb +465 -0
  582. data/lib/plaid/models/{sandbox_transfer_repayment_simulate_response.rb → cra_report_create_response.rb} +20 -6
  583. data/lib/plaid/models/cra_report_decision_stage.rb +1 -1
  584. data/lib/plaid/models/{link_delivery_session_status.rb → cra_report_error_code.rb} +5 -7
  585. data/lib/plaid/models/cra_report_get_account_identity_match.rb +267 -0
  586. data/lib/plaid/models/cra_report_get_account_primary_account.rb +241 -0
  587. data/lib/plaid/models/{link_delivery_get_response.rb → cra_report_get_base_account.rb} +58 -63
  588. data/lib/plaid/models/cra_report_get_base_item.rb +288 -0
  589. data/lib/plaid/models/cra_report_get_base_report_account.rb +454 -0
  590. data/lib/plaid/models/cra_report_get_base_report_account_account_insights.rb +350 -0
  591. data/lib/plaid/models/cra_report_get_base_report_account_attributes.rb +349 -0
  592. data/lib/plaid/models/{client_provided_raw_transaction.rb → cra_report_get_base_report_account_attributes_total_inflow_amount.rb} +29 -46
  593. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount30d.rb +254 -0
  594. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount60d.rb +254 -0
  595. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount90d.rb +254 -0
  596. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount.rb +254 -0
  597. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount30d.rb +254 -0
  598. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount60d.rb +254 -0
  599. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount90d.rb +254 -0
  600. data/lib/plaid/models/cra_report_get_base_report_account_balances.rb +305 -0
  601. data/lib/plaid/models/cra_report_get_base_report_account_identity_match.rb +267 -0
  602. data/lib/plaid/models/cra_report_get_base_report_account_insights.rb +344 -0
  603. data/lib/plaid/models/cra_report_get_base_report_attributes.rb +327 -0
  604. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount.rb +254 -0
  605. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount30d.rb +254 -0
  606. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount60d.rb +254 -0
  607. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount90d.rb +254 -0
  608. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount.rb +254 -0
  609. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount30d.rb +254 -0
  610. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount60d.rb +254 -0
  611. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount90d.rb +254 -0
  612. data/lib/plaid/models/{link_delivery_create_request.rb → cra_report_get_base_report_average_monthly_balance.rb} +39 -39
  613. data/lib/plaid/models/cra_report_get_base_report_item.rb +288 -0
  614. data/lib/plaid/models/cra_report_get_base_report_longest_gap_insight.rb +252 -0
  615. data/lib/plaid/models/cra_report_get_base_report_metadata.rb +404 -0
  616. data/lib/plaid/models/cra_report_get_base_report_metadata_all_of.rb +337 -0
  617. data/lib/plaid/models/cra_report_get_base_report_response_product.rb +328 -0
  618. data/lib/plaid/models/cra_report_get_base_report_response_product_attributes.rb +333 -0
  619. data/lib/plaid/models/cra_report_get_base_report_transaction.rb +430 -0
  620. data/lib/plaid/models/cra_report_get_cashflow_insights_metadata.rb +389 -0
  621. data/lib/plaid/models/cra_report_get_cashflow_insights_response_product.rb +315 -0
  622. data/lib/plaid/models/{enhancements.rb → cra_report_get_enriched_account.rb} +93 -104
  623. data/lib/plaid/models/cra_report_get_enriched_account_all_of.rb +279 -0
  624. data/lib/plaid/models/cra_report_get_enriched_item.rb +296 -0
  625. data/lib/plaid/models/cra_report_get_enriched_item_all_of.rb +237 -0
  626. data/lib/plaid/models/cra_report_get_home_lending_attributes.rb +1 -1
  627. data/lib/plaid/models/cra_report_get_home_lending_category_income.rb +1 -1
  628. data/lib/plaid/models/cra_report_get_home_lending_income_by_categories.rb +1 -1
  629. data/lib/plaid/models/cra_report_get_home_lending_income_metrics.rb +1 -1
  630. data/lib/plaid/models/cra_report_get_home_lending_income_sources.rb +1 -1
  631. data/lib/plaid/models/cra_report_get_home_lending_metadata.rb +1 -1
  632. data/lib/plaid/models/cra_report_get_home_lending_response_product.rb +19 -2
  633. data/lib/plaid/models/cra_report_get_income_complete_attributes.rb +221 -0
  634. data/lib/plaid/models/cra_report_get_income_complete_metadata.rb +389 -0
  635. data/lib/plaid/models/cra_report_get_income_complete_response_product.rb +329 -0
  636. data/lib/plaid/models/cra_report_get_income_insights_attributes.rb +1 -1
  637. data/lib/plaid/models/cra_report_get_income_insights_metadata.rb +21 -6
  638. data/lib/plaid/models/cra_report_get_income_insights_response_product.rb +19 -2
  639. data/lib/plaid/models/cra_report_get_income_insights_stream.rb +33 -5
  640. data/lib/plaid/models/cra_report_get_lend_score_complete_attributes.rb +254 -0
  641. data/lib/plaid/models/cra_report_get_lend_score_complete_metadata.rb +389 -0
  642. data/lib/plaid/models/{cra_report_get_income_insights_metadata_all_of.rb → cra_report_get_lend_score_complete_metadata_all_of.rb} +21 -6
  643. data/lib/plaid/models/cra_report_get_lend_score_complete_options.rb +223 -0
  644. data/lib/plaid/models/cra_report_get_lend_score_complete_response_product.rb +329 -0
  645. data/lib/plaid/models/cra_report_get_lend_score_metadata.rb +389 -0
  646. data/lib/plaid/models/cra_report_get_lend_score_metadata_all_of.rb +322 -0
  647. data/lib/plaid/models/cra_report_get_lend_score_options.rb +223 -0
  648. data/lib/plaid/models/cra_report_get_lend_score_response_product.rb +319 -0
  649. data/lib/plaid/models/{client_provided_enhanced_transaction.rb → cra_report_get_lend_score_variant_score.rb} +67 -66
  650. data/lib/plaid/models/cra_report_get_network_insights_metadata.rb +389 -0
  651. data/lib/plaid/models/cra_report_get_network_insights_response_product.rb +315 -0
  652. data/lib/plaid/models/cra_report_get_product_base_metadata.rb +1 -1
  653. data/lib/plaid/models/cra_report_get_qualify_response_product.rb +1 -1
  654. data/lib/plaid/models/cra_report_get_report.rb +24 -3
  655. data/lib/plaid/models/cra_report_get_request.rb +2 -2
  656. data/lib/plaid/models/cra_report_get_request_product.rb +13 -1
  657. data/lib/plaid/models/cra_report_get_response.rb +1 -1
  658. data/lib/plaid/models/cra_report_get_response_product.rb +13 -1
  659. data/lib/plaid/models/cra_report_product.rb +86 -0
  660. data/lib/plaid/models/cra_report_ready_webhook.rb +393 -0
  661. data/lib/plaid/models/cra_report_scope.rb +1 -1
  662. data/lib/plaid/models/cra_report_updated_webhook.rb +41 -5
  663. data/lib/plaid/models/cra_servicing_subscription.rb +1 -1
  664. data/lib/plaid/models/cra_servicing_subscription_create_request.rb +1 -1
  665. data/lib/plaid/models/cra_servicing_subscription_create_response.rb +1 -1
  666. data/lib/plaid/models/cra_servicing_subscription_delete_request.rb +1 -1
  667. data/lib/plaid/models/cra_servicing_subscription_delete_response.rb +1 -1
  668. data/lib/plaid/models/cra_servicing_subscription_get_request.rb +1 -1
  669. data/lib/plaid/models/cra_servicing_subscription_get_response.rb +1 -1
  670. data/lib/plaid/models/cra_servicing_subscription_list_request.rb +1 -1
  671. data/lib/plaid/models/cra_servicing_subscription_list_response.rb +1 -1
  672. data/lib/plaid/models/cra_servicing_subscription_update_request.rb +1 -1
  673. data/lib/plaid/models/cra_servicing_subscription_update_request_resettable_field.rb +1 -1
  674. data/lib/plaid/models/cra_servicing_subscription_update_response.rb +1 -1
  675. data/lib/plaid/models/cra_subscription_cadence.rb +1 -1
  676. data/lib/plaid/models/cra_subscription_product_config.rb +1 -1
  677. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  678. data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +16 -2
  679. data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +2 -2
  680. data/lib/plaid/models/cra_user_tier.rb +1 -1
  681. data/lib/plaid/models/cra_verification_income_account.rb +1 -1
  682. data/lib/plaid/models/cra_verification_income_category.rb +1 -1
  683. data/lib/plaid/models/cra_verification_income_item.rb +1 -1
  684. data/lib/plaid/models/cra_verification_income_metrics.rb +1 -1
  685. data/lib/plaid/models/cra_verification_income_next_payment.rb +1 -1
  686. data/lib/plaid/models/cra_verification_income_pay_frequency.rb +1 -1
  687. data/lib/plaid/models/cra_verification_income_provider.rb +1 -1
  688. data/lib/plaid/models/cra_verification_income_report.rb +1 -1
  689. data/lib/plaid/models/cra_verification_income_status.rb +1 -1
  690. data/lib/plaid/models/cra_verification_income_stream.rb +1 -1
  691. data/lib/plaid/models/cra_verification_income_stream_insights.rb +1 -1
  692. data/lib/plaid/models/cra_verification_income_transaction.rb +1 -1
  693. data/lib/plaid/models/cra_verification_income_transaction_outlier.rb +1 -1
  694. data/lib/plaid/models/cra_verification_income_user_summary.rb +1 -1
  695. data/lib/plaid/models/cra_verification_income_values.rb +1 -1
  696. data/lib/plaid/models/cra_verification_modeled_income.rb +1 -1
  697. data/lib/plaid/models/cra_verification_report.rb +1 -1
  698. data/lib/plaid/models/cra_voa_report.rb +1 -1
  699. data/lib/plaid/models/cra_voa_report_account.rb +1 -1
  700. data/lib/plaid/models/cra_voa_report_account_balances.rb +1 -1
  701. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
  702. data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
  703. data/lib/plaid/models/cra_voa_report_item.rb +1 -1
  704. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +1 -1
  705. data/lib/plaid/models/credit1099.rb +1 -1
  706. data/lib/plaid/models/credit1099_filer.rb +1 -1
  707. data/lib/plaid/models/credit1099_payer.rb +1 -1
  708. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  709. data/lib/plaid/models/credit_account_subtype.rb +1 -2
  710. data/lib/plaid/models/credit_ach_class.rb +1 -1
  711. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  712. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  713. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  714. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  715. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  716. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  717. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  718. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  719. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  720. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  721. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  722. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  723. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  724. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  725. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  726. data/lib/plaid/models/credit_bank_income.rb +1 -1
  727. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  728. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  729. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  730. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  731. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  732. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  733. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  734. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  735. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  736. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  737. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  738. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  739. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  740. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  741. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  742. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  743. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  744. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  745. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  746. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  747. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  748. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  749. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  750. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  751. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  752. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  753. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  754. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  755. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  756. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  757. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  758. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  759. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  760. data/lib/plaid/models/credit_card_liability.rb +17 -6
  761. data/lib/plaid/models/credit_category.rb +1 -1
  762. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  763. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  764. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  765. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  766. data/lib/plaid/models/credit_employment_item.rb +1 -1
  767. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  768. data/lib/plaid/models/credit_filter.rb +1 -1
  769. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  770. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  771. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  772. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  773. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  774. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  775. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  776. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  777. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  778. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  779. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  780. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  781. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  782. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  783. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  784. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  785. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  786. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  787. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  788. data/lib/plaid/models/credit_i20.rb +1 -1
  789. data/lib/plaid/models/credit_i20_student.rb +1 -1
  790. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  791. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  792. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  793. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  794. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  795. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  796. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  797. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  798. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  799. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  800. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  801. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  802. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  803. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  804. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  805. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  806. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  807. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +2 -2
  808. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  809. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  810. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  811. data/lib/plaid/models/credit_product.rb +3 -3
  812. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  813. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  814. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  815. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  816. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  817. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  818. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  819. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  820. data/lib/plaid/models/credit_session.rb +1 -1
  821. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  822. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  823. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  824. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  825. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  826. data/lib/plaid/models/credit_session_error.rb +1 -1
  827. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  828. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  829. data/lib/plaid/models/credit_session_results.rb +1 -1
  830. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  831. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  832. data/lib/plaid/models/credit_w2.rb +1 -1
  833. data/lib/plaid/models/custom_sandbox_transaction.rb +17 -7
  834. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  835. data/lib/plaid/models/dashboard_user.rb +1 -1
  836. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  837. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  838. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  839. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  840. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  841. data/lib/plaid/models/data_sources.rb +1 -1
  842. data/lib/plaid/models/date_range.rb +1 -1
  843. data/lib/plaid/models/deductions.rb +1 -1
  844. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  845. data/lib/plaid/models/deductions_total.rb +1 -1
  846. data/lib/plaid/models/default_update_webhook.rb +1 -1
  847. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  848. data/lib/plaid/models/depository_filter.rb +1 -1
  849. data/lib/plaid/models/detailed_originator.rb +1 -1
  850. data/lib/plaid/models/detected_account.rb +1 -1
  851. data/lib/plaid/models/device_id.rb +1 -1
  852. data/lib/plaid/models/disconnected_application.rb +1 -1
  853. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  854. data/lib/plaid/models/doc_type.rb +1 -1
  855. data/lib/plaid/models/document_analysis.rb +1 -1
  856. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  857. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  858. data/lib/plaid/models/document_metadata.rb +1 -1
  859. data/lib/plaid/models/document_name_match_code.rb +1 -1
  860. data/lib/plaid/models/document_risk_signal.rb +1 -1
  861. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  862. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  863. data/lib/plaid/models/document_risk_summary.rb +1 -1
  864. data/lib/plaid/models/document_status.rb +1 -1
  865. data/lib/plaid/models/documentary_verification.rb +3 -3
  866. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  867. data/lib/plaid/models/earnings.rb +1 -1
  868. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  869. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  870. data/lib/plaid/models/earnings_total.rb +1 -1
  871. data/lib/plaid/models/email.rb +1 -1
  872. data/lib/plaid/models/email_address_match_score.rb +1 -1
  873. data/lib/plaid/models/employee.rb +1 -1
  874. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  875. data/lib/plaid/models/employer.rb +1 -1
  876. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  877. data/lib/plaid/models/employer_verification.rb +1 -1
  878. data/lib/plaid/models/employers_search_request.rb +1 -1
  879. data/lib/plaid/models/employers_search_response.rb +1 -1
  880. data/lib/plaid/models/employment_details.rb +1 -1
  881. data/lib/plaid/models/employment_source_type.rb +1 -1
  882. data/lib/plaid/models/employment_verification.rb +1 -1
  883. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  884. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  885. data/lib/plaid/models/employment_verification_status.rb +1 -1
  886. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  887. data/lib/plaid/models/enrichments.rb +1 -1
  888. data/lib/plaid/models/entity_document.rb +1 -1
  889. data/lib/plaid/models/entity_document_type.rb +1 -1
  890. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  891. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  892. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  893. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  894. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  895. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  896. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  897. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  898. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  899. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  900. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  901. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  902. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  903. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  904. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  905. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  906. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  907. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  908. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  909. data/lib/plaid/models/ewa_score.rb +1 -1
  910. data/lib/plaid/models/expenditure_insights.rb +1 -1
  911. data/lib/plaid/models/expenditure_insights_cash_flow.rb +1 -1
  912. data/lib/plaid/models/expenditure_summary.rb +1 -1
  913. data/lib/plaid/models/expiration_date.rb +1 -1
  914. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  915. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  916. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  917. data/lib/plaid/models/external_payment_options.rb +1 -1
  918. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  919. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  920. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  921. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  922. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  923. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  924. data/lib/plaid/models/fdx_consent_grant.rb +1 -1
  925. data/lib/plaid/models/fdx_consent_grant_resource.rb +1 -1
  926. data/lib/plaid/models/fdx_consent_grant_status.rb +1 -1
  927. data/lib/plaid/models/fdx_consent_resource_type.rb +1 -1
  928. data/lib/plaid/models/fdx_consent_revocation.rb +1 -1
  929. data/lib/plaid/models/fdx_consent_revocation_record.rb +1 -1
  930. data/lib/plaid/models/fdx_consent_revocations.rb +1 -1
  931. data/lib/plaid/models/fdx_content_types.rb +1 -1
  932. data/lib/plaid/models/fdx_data_cluster.rb +1 -1
  933. data/lib/plaid/models/fdx_error.rb +1 -1
  934. data/lib/plaid/models/fdx_event_status.rb +1 -1
  935. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  936. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  937. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  938. data/lib/plaid/models/fdx_lifecycle_event.rb +1 -1
  939. data/lib/plaid/models/fdx_notification.rb +1 -1
  940. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  941. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  942. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  943. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  944. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  945. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  946. data/lib/plaid/models/fdx_party.rb +1 -1
  947. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  948. data/lib/plaid/models/fdx_party_type.rb +1 -1
  949. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  950. data/lib/plaid/models/fdx_update_reason.rb +1 -1
  951. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  952. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  953. data/lib/plaid/models/fixed_income.rb +1 -1
  954. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  955. data/lib/plaid/models/form1099_type.rb +1 -1
  956. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  957. data/lib/plaid/models/fraud_amount.rb +1 -1
  958. data/lib/plaid/models/fraud_analysis_details.rb +1 -1
  959. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  960. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  961. data/lib/plaid/models/gambling_indicators.rb +1 -1
  962. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  963. data/lib/plaid/models/get_consents_response.rb +1 -1
  964. data/lib/plaid/models/get_recipient_response.rb +1 -1
  965. data/lib/plaid/models/get_recipients_response.rb +1 -1
  966. data/lib/plaid/models/gse_report_type.rb +1 -1
  967. data/lib/plaid/models/health_incident.rb +1 -1
  968. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  969. data/lib/plaid/models/historical_annual_income.rb +1 -1
  970. data/lib/plaid/models/historical_balance.rb +1 -1
  971. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  972. data/lib/plaid/models/holding.rb +1 -1
  973. data/lib/plaid/models/holding_tax_lot.rb +1 -1
  974. data/lib/plaid/models/holding_tax_lot_position_type.rb +1 -1
  975. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  976. data/lib/plaid/models/holdings_override.rb +2 -2
  977. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  978. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  979. data/lib/plaid/models/human_review.rb +1 -1
  980. data/lib/plaid/models/human_review_status.rb +1 -1
  981. data/lib/plaid/models/id_number_type.rb +1 -1
  982. data/lib/plaid/models/identity_default_update_webhook.rb +2 -2
  983. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  984. data/lib/plaid/models/identity_document_upload.rb +1 -1
  985. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  986. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  987. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  988. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  989. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  990. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  991. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  992. data/lib/plaid/models/identity_get_request.rb +1 -1
  993. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  994. data/lib/plaid/models/identity_get_response.rb +1 -1
  995. data/lib/plaid/models/identity_match_list_attempt.rb +4 -8
  996. data/lib/plaid/models/identity_match_list_attempt_score.rb +4 -8
  997. data/lib/plaid/models/identity_match_list_outcome.rb +1 -1
  998. data/lib/plaid/models/identity_match_list_request.rb +4 -4
  999. data/lib/plaid/models/identity_match_list_response.rb +1 -1
  1000. data/lib/plaid/models/identity_match_request.rb +1 -1
  1001. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  1002. data/lib/plaid/models/identity_match_response.rb +1 -1
  1003. data/lib/plaid/models/identity_match_user.rb +1 -1
  1004. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  1005. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  1006. data/lib/plaid/models/identity_update_types.rb +5 -5
  1007. data/lib/plaid/models/identity_verification.rb +1 -1
  1008. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  1009. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  1010. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  1011. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  1012. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  1013. data/lib/plaid/models/identity_verification_create_request.rb +34 -2
  1014. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  1015. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  1016. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  1017. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  1018. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  1019. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  1020. data/lib/plaid/models/identity_verification_language.rb +45 -0
  1021. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  1022. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  1023. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  1024. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  1025. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  1026. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  1027. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  1028. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  1029. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  1030. data/lib/plaid/models/identity_verification_status.rb +1 -1
  1031. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  1032. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  1033. data/lib/plaid/models/identity_verification_step_summary.rb +2 -2
  1034. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  1035. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  1036. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  1037. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  1038. data/lib/plaid/models/idv_protect_event.rb +1 -1
  1039. data/lib/plaid/models/image_quality.rb +1 -1
  1040. data/lib/plaid/models/image_quality_details.rb +1 -1
  1041. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  1042. data/lib/plaid/models/incident_update.rb +1 -1
  1043. data/lib/plaid/models/income_breakdown.rb +1 -1
  1044. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  1045. data/lib/plaid/models/income_insights.rb +1 -1
  1046. data/lib/plaid/models/income_insights_filter.rb +1 -1
  1047. data/lib/plaid/models/income_insights_income_excluding_transfers.rb +1 -1
  1048. data/lib/plaid/models/income_insights_total_income.rb +1 -1
  1049. data/lib/plaid/models/income_insights_transfers_in.rb +1 -1
  1050. data/lib/plaid/models/income_insights_version.rb +1 -1
  1051. data/lib/plaid/models/income_override.rb +1 -1
  1052. data/lib/plaid/models/income_sources_counts.rb +1 -1
  1053. data/lib/plaid/models/income_summary.rb +1 -1
  1054. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  1055. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  1056. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  1057. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  1058. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  1059. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  1060. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  1061. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  1062. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  1063. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  1064. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  1065. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  1066. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  1067. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  1068. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  1069. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  1070. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  1071. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  1072. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  1073. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  1074. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  1075. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  1076. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  1077. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  1078. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  1079. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  1080. data/lib/plaid/models/individual_name.rb +1 -1
  1081. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  1082. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  1083. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  1084. data/lib/plaid/models/inflow_model.rb +8 -26
  1085. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  1086. data/lib/plaid/models/institution.rb +38 -2
  1087. data/lib/plaid/models/institution_connection_availability.rb +39 -0
  1088. data/lib/plaid/models/institution_status.rb +2 -2
  1089. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  1090. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  1091. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  1092. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  1093. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  1094. data/lib/plaid/models/institutions_get_request.rb +1 -1
  1095. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  1096. data/lib/plaid/models/institutions_get_response.rb +1 -1
  1097. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  1098. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  1099. data/lib/plaid/models/institutions_search_request.rb +1 -1
  1100. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  1101. data/lib/plaid/models/institutions_search_response.rb +1 -1
  1102. data/lib/plaid/models/investment_account.rb +18 -7
  1103. data/lib/plaid/models/investment_account_all_of.rb +1 -1
  1104. data/lib/plaid/models/investment_account_balance.rb +2 -2
  1105. data/lib/plaid/models/investment_account_balance_all_of.rb +1 -1
  1106. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  1107. data/lib/plaid/models/investment_filter.rb +1 -1
  1108. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  1109. data/lib/plaid/models/investment_transaction.rb +1 -1
  1110. data/lib/plaid/models/investment_transaction_subtype.rb +1 -4
  1111. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  1112. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  1113. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  1114. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  1115. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  1116. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  1117. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  1118. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  1119. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  1120. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  1121. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  1122. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  1123. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  1124. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  1125. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  1126. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  1127. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  1128. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  1129. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  1130. data/lib/plaid/models/investments_transactions_override.rb +2 -2
  1131. data/lib/plaid/models/iso_currency_code.rb +1 -1
  1132. data/lib/plaid/models/issue.rb +1 -1
  1133. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  1134. data/lib/plaid/models/issues_get_request.rb +1 -1
  1135. data/lib/plaid/models/issues_get_response.rb +1 -1
  1136. data/lib/plaid/models/issues_search_request.rb +1 -1
  1137. data/lib/plaid/models/issues_search_response.rb +2 -2
  1138. data/lib/plaid/models/issues_status.rb +1 -1
  1139. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  1140. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  1141. data/lib/plaid/models/issuing_country.rb +1 -1
  1142. data/lib/plaid/models/item.rb +19 -8
  1143. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  1144. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  1145. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  1146. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  1147. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  1148. data/lib/plaid/models/item_application_list_request.rb +1 -1
  1149. data/lib/plaid/models/item_application_list_response.rb +1 -1
  1150. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  1151. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  1152. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  1153. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  1154. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  1155. data/lib/plaid/models/item_auth_method.rb +1 -1
  1156. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  1157. data/lib/plaid/models/item_create_authentication.rb +1 -1
  1158. data/lib/plaid/models/item_error_webhook.rb +1 -1
  1159. data/lib/plaid/models/item_get_request.rb +1 -1
  1160. data/lib/plaid/models/item_get_response.rb +1 -1
  1161. data/lib/plaid/models/item_import_request.rb +1 -1
  1162. data/lib/plaid/models/item_import_request_options.rb +1 -1
  1163. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  1164. data/lib/plaid/models/item_import_response.rb +1 -1
  1165. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  1166. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  1167. data/lib/plaid/models/item_products_terminate_request.rb +1 -1
  1168. data/lib/plaid/models/item_products_terminate_response.rb +1 -1
  1169. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  1170. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  1171. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  1172. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  1173. data/lib/plaid/models/item_remove_reason_code.rb +1 -1
  1174. data/lib/plaid/models/item_remove_request.rb +1 -1
  1175. data/lib/plaid/models/item_remove_response.rb +1 -1
  1176. data/lib/plaid/models/item_status.rb +1 -1
  1177. data/lib/plaid/models/item_status_investments.rb +1 -1
  1178. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  1179. data/lib/plaid/models/item_status_nullable.rb +1 -1
  1180. data/lib/plaid/models/item_status_transactions.rb +1 -1
  1181. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  1182. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  1183. data/lib/plaid/models/item_with_consent_fields.rb +16 -5
  1184. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  1185. data/lib/plaid/models/jwk_public_key.rb +1 -1
  1186. data/lib/plaid/models/jwt_header.rb +1 -1
  1187. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  1188. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  1189. data/lib/plaid/models/kyc_check_details.rb +3 -3
  1190. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  1191. data/lib/plaid/models/kyc_check_id_number_summary.rb +15 -5
  1192. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  1193. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  1194. data/lib/plaid/models/kyc_check_ssa_analysis.rb +258 -0
  1195. data/lib/plaid/models/kyc_check_ssa_match_status.rb +40 -0
  1196. data/lib/plaid/models/latest_scored_event.rb +2 -2
  1197. data/lib/plaid/models/layer_authentication_passed_webhook.rb +1 -1
  1198. data/lib/plaid/models/ledger_event_source_type.rb +1 -1
  1199. data/lib/plaid/models/lend_score.rb +1 -1
  1200. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  1201. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  1202. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  1203. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  1204. data/lib/plaid/models/liabilities_object.rb +3 -3
  1205. data/lib/plaid/models/liability_override.rb +379 -92
  1206. data/lib/plaid/models/liability_override_apr.rb +303 -0
  1207. data/lib/plaid/models/liability_override_apr_type.rb +42 -0
  1208. data/lib/plaid/models/{transactions_enhance_get_request.rb → liability_override_interest_rate.rb} +63 -48
  1209. data/lib/plaid/models/liability_override_interest_rate_type.rb +39 -0
  1210. data/lib/plaid/models/limited_purpose_type.rb +1 -1
  1211. data/lib/plaid/models/line_of_credit_liability.rb +1 -1
  1212. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  1213. data/lib/plaid/models/link_delivery_account.rb +1 -1
  1214. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  1215. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  1216. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  1217. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  1218. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  1219. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  1220. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  1221. data/lib/plaid/models/link_event.rb +1 -1
  1222. data/lib/plaid/models/link_event_metadata.rb +1 -1
  1223. data/lib/plaid/models/link_event_name.rb +1 -1
  1224. data/lib/plaid/models/link_events_webhook.rb +2 -2
  1225. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  1226. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  1227. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  1228. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  1229. data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
  1230. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  1231. data/lib/plaid/models/link_session_cra_update_result.rb +1 -1
  1232. data/lib/plaid/models/link_session_exit.rb +1 -1
  1233. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  1234. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  1235. data/lib/plaid/models/link_session_exit_metadata_institution.rb +2 -2
  1236. data/lib/plaid/models/link_session_finished_webhook.rb +2 -2
  1237. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  1238. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  1239. data/lib/plaid/models/link_session_results.rb +1 -1
  1240. data/lib/plaid/models/link_session_success.rb +1 -1
  1241. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  1242. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  1243. data/lib/plaid/models/link_session_success_metadata_institution.rb +2 -2
  1244. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  1245. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  1246. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  1247. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  1248. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  1249. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  1250. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  1251. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  1252. data/lib/plaid/models/link_token_create_institution_data.rb +15 -5
  1253. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  1254. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  1255. data/lib/plaid/models/link_token_create_request.rb +14 -5
  1256. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  1257. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
  1258. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  1259. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  1260. data/lib/plaid/models/link_token_create_request_cra_options.rb +1 -1
  1261. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  1262. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +1 -1
  1263. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
  1264. data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +1 -1
  1265. data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +1 -1
  1266. data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +1 -1
  1267. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  1268. data/lib/plaid/models/link_token_create_request_cra_report_parameter.rb +380 -0
  1269. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  1270. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  1271. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  1272. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  1273. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  1274. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  1275. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  1276. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  1277. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  1278. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  1279. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  1280. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  1281. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  1282. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  1283. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  1284. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  1285. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  1286. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  1287. data/lib/plaid/models/link_token_create_response.rb +1 -1
  1288. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  1289. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  1290. data/lib/plaid/models/link_token_get_request.rb +1 -1
  1291. data/lib/plaid/models/link_token_get_response.rb +1 -1
  1292. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  1293. data/lib/plaid/models/link_token_investments.rb +1 -1
  1294. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  1295. data/lib/plaid/models/link_token_transactions.rb +1 -1
  1296. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  1297. data/lib/plaid/models/loan.rb +1 -1
  1298. data/lib/plaid/models/loan_account_subtype.rb +1 -2
  1299. data/lib/plaid/models/loan_compounding_period.rb +1 -1
  1300. data/lib/plaid/models/loan_disbursements_indicators.rb +1 -1
  1301. data/lib/plaid/models/loan_filter.rb +1 -1
  1302. data/lib/plaid/models/loan_identifier.rb +1 -1
  1303. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  1304. data/lib/plaid/models/loan_identifiers.rb +1 -1
  1305. data/lib/plaid/models/loan_interest_rate.rb +1 -1
  1306. data/lib/plaid/models/loan_interest_rate_type.rb +1 -1
  1307. data/lib/plaid/models/loan_liability.rb +1 -1
  1308. data/lib/plaid/models/loan_payment_frequency.rb +1 -1
  1309. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  1310. data/lib/plaid/models/loan_payments_indicators.rb +1 -1
  1311. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  1312. data/lib/plaid/models/loans.rb +1 -1
  1313. data/lib/plaid/models/location.rb +1 -1
  1314. data/lib/plaid/models/match_summary.rb +1 -1
  1315. data/lib/plaid/models/match_summary_code.rb +1 -1
  1316. data/lib/plaid/models/merchant_insights.rb +1 -1
  1317. data/lib/plaid/models/meta.rb +4 -28
  1318. data/lib/plaid/models/mfa.rb +1 -21
  1319. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  1320. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  1321. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  1322. data/lib/plaid/models/monitoring_insights.rb +1 -1
  1323. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  1324. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  1325. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  1326. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  1327. data/lib/plaid/models/monthly_average.rb +1 -1
  1328. data/lib/plaid/models/monthly_summary.rb +1 -1
  1329. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  1330. data/lib/plaid/models/mortgage_liability.rb +1 -1
  1331. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  1332. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  1333. data/lib/plaid/models/name_match_score.rb +1 -1
  1334. data/lib/plaid/models/negative_balance_insights.rb +1 -1
  1335. data/lib/plaid/models/negative_balance_occurrence.rb +1 -1
  1336. data/lib/plaid/models/net_pay.rb +1 -1
  1337. data/lib/plaid/models/network_insights_version.rb +1 -1
  1338. data/lib/plaid/models/network_status_get_request.rb +1 -1
  1339. data/lib/plaid/models/network_status_get_response.rb +1 -1
  1340. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  1341. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  1342. data/lib/plaid/models/network_status_get_user.rb +1 -1
  1343. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  1344. data/lib/plaid/models/numbers.rb +1 -1
  1345. data/lib/plaid/models/numbers_acats.rb +1 -1
  1346. data/lib/plaid/models/numbers_ach.rb +1 -1
  1347. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  1348. data/lib/plaid/models/numbers_aton.rb +1 -1
  1349. data/lib/plaid/models/numbers_bacs.rb +1 -1
  1350. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  1351. data/lib/plaid/models/numbers_eft.rb +1 -1
  1352. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  1353. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  1354. data/lib/plaid/models/numbers_international.rb +1 -1
  1355. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  1356. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  1357. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  1358. data/lib/plaid/models/o_auth_error_code.rb +1 -1
  1359. data/lib/plaid/models/o_auth_error_response.rb +1 -1
  1360. data/lib/plaid/models/o_auth_grant_type.rb +1 -1
  1361. data/lib/plaid/models/o_auth_introspect_request.rb +1 -1
  1362. data/lib/plaid/models/o_auth_introspect_response.rb +1 -1
  1363. data/lib/plaid/models/o_auth_revoke_request.rb +1 -1
  1364. data/lib/plaid/models/o_auth_revoke_response.rb +1 -1
  1365. data/lib/plaid/models/o_auth_subject_token_type.rb +1 -1
  1366. data/lib/plaid/models/o_auth_token_request.rb +1 -1
  1367. data/lib/plaid/models/o_auth_token_response.rb +1 -1
  1368. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1369. data/lib/plaid/models/option_contract.rb +2 -2
  1370. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1371. data/lib/plaid/models/originator.rb +1 -1
  1372. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1373. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1374. data/lib/plaid/models/other_filter.rb +1 -1
  1375. data/lib/plaid/models/outlier_transactions_insights.rb +1 -1
  1376. data/lib/plaid/models/override_account_type.rb +1 -1
  1377. data/lib/plaid/models/override_accounts.rb +11 -55
  1378. data/lib/plaid/models/owner.rb +1 -1
  1379. data/lib/plaid/models/owner_override.rb +2 -17
  1380. data/lib/plaid/models/ownership_type.rb +1 -1
  1381. data/lib/plaid/models/parties.rb +1 -1
  1382. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  1383. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1384. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1385. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1386. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1387. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1388. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1389. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1390. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1391. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1392. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1393. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1394. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1395. data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +1 -1
  1396. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1397. data/lib/plaid/models/partner_end_customer_cra_purposes.rb +1 -1
  1398. data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +1 -1
  1399. data/lib/plaid/models/partner_end_customer_cra_use_case.rb +1 -1
  1400. data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +1 -1
  1401. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  1402. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1403. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +3 -3
  1404. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1405. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1406. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1407. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1408. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1409. data/lib/plaid/models/partner_end_customer_questionnaires.rb +1 -1
  1410. data/lib/plaid/models/partner_end_customer_requirement_due.rb +1 -1
  1411. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1412. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1413. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1414. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  1415. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1416. data/lib/plaid/models/party.rb +1 -1
  1417. data/lib/plaid/models/party_individual.rb +1 -1
  1418. data/lib/plaid/models/party_role_type.rb +1 -1
  1419. data/lib/plaid/models/pay.rb +1 -1
  1420. data/lib/plaid/models/pay_frequency.rb +1 -1
  1421. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1422. data/lib/plaid/models/pay_period_details.rb +1 -1
  1423. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1424. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  1425. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  1426. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  1427. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  1428. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  1429. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1430. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1431. data/lib/plaid/models/payment_amount.rb +1 -1
  1432. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1433. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1434. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1435. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1436. data/lib/plaid/models/payment_channel.rb +1 -1
  1437. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1438. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1439. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1440. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1441. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1442. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1443. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1444. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1445. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1446. data/lib/plaid/models/payment_initiation_consent_create_request.rb +2 -2
  1447. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1448. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1449. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  1450. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1451. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
  1452. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
  1453. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1454. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1455. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1456. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1457. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1458. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1459. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1460. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1461. data/lib/plaid/models/payment_initiation_metadata.rb +20 -10
  1462. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1463. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  1464. data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
  1465. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1466. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1467. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1468. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  1469. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1470. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1471. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +3 -3
  1472. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1473. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1474. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1475. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  1476. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1477. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1478. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1479. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1480. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1481. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1482. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1483. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1484. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -6
  1485. data/lib/plaid/models/payment_meta.rb +1 -1
  1486. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1487. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1488. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1489. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1490. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1491. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1492. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1493. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1494. data/lib/plaid/models/payment_scheme.rb +1 -1
  1495. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  1496. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1497. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1498. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1499. data/lib/plaid/models/payroll_item.rb +1 -1
  1500. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1501. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1502. data/lib/plaid/models/paystub.rb +1 -1
  1503. data/lib/plaid/models/paystub_address.rb +1 -1
  1504. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1505. data/lib/plaid/models/paystub_details.rb +1 -1
  1506. data/lib/plaid/models/paystub_employer.rb +1 -1
  1507. data/lib/plaid/models/paystub_override.rb +1 -1
  1508. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1509. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1510. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1511. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1512. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1513. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1514. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1515. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1516. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1517. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1518. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1519. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1520. data/lib/plaid/models/paystub_override_pay_period_details.rb +2 -34
  1521. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1522. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1523. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1524. data/lib/plaid/models/pending_disconnect_webhook.rb +1 -1
  1525. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1526. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1527. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1528. data/lib/plaid/models/personal_finance_category_version.rb +1 -1
  1529. data/lib/plaid/models/phone_number.rb +1 -1
  1530. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1531. data/lib/plaid/models/phone_type.rb +1 -1
  1532. data/lib/plaid/models/physical_document_category.rb +1 -1
  1533. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1534. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1535. data/lib/plaid/models/physical_document_images.rb +1 -1
  1536. data/lib/plaid/models/plaid_error.rb +3 -3
  1537. data/lib/plaid/models/plaid_error_type.rb +3 -1
  1538. data/lib/plaid/models/plaid_lend_score_version.rb +1 -1
  1539. data/lib/plaid/models/platform_ids.rb +1 -1
  1540. data/lib/plaid/models/po_box_status.rb +1 -1
  1541. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1542. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1543. data/lib/plaid/models/prism_cash_score_version.rb +1 -1
  1544. data/lib/plaid/models/prism_detect.rb +1 -1
  1545. data/lib/plaid/models/prism_detect_version.rb +1 -1
  1546. data/lib/plaid/models/prism_extend.rb +1 -1
  1547. data/lib/plaid/models/prism_extend_version.rb +1 -1
  1548. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1549. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1550. data/lib/plaid/models/prism_insights.rb +1 -1
  1551. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1552. data/lib/plaid/models/prism_versions.rb +1 -1
  1553. data/lib/plaid/models/prism_versions_deprecated.rb +1 -1
  1554. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1555. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1556. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1557. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1558. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1559. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1560. data/lib/plaid/models/processor_balance_get_request_options.rb +2 -2
  1561. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1562. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1563. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1564. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1565. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1566. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1567. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1568. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1569. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1570. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1571. data/lib/plaid/models/processor_investments_auth_get_request.rb +1 -1
  1572. data/lib/plaid/models/processor_investments_auth_get_response.rb +1 -1
  1573. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1574. data/lib/plaid/models/processor_investments_holdings_get_response.rb +1 -1
  1575. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1576. data/lib/plaid/models/processor_investments_transactions_get_response.rb +1 -1
  1577. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1578. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1579. data/lib/plaid/models/processor_number.rb +1 -1
  1580. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1581. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1582. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1583. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1584. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1585. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1586. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1587. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1588. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1589. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1590. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1591. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +2 -2
  1592. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1593. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1594. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1595. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1596. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1597. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1598. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1599. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1600. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1601. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1602. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1603. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1604. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1605. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1606. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1607. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1608. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1609. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1610. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1611. data/lib/plaid/models/product_access.rb +1 -1
  1612. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1613. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1614. data/lib/plaid/models/product_status.rb +2 -2
  1615. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  1616. data/lib/plaid/models/products.rb +1 -1
  1617. data/lib/plaid/models/products_terminate_reason_code.rb +1 -1
  1618. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1619. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1620. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1621. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1622. data/lib/plaid/models/protect_bank_account.rb +1 -1
  1623. data/lib/plaid/models/protect_cash_advance_decision_create_request.rb +1 -1
  1624. data/lib/plaid/models/protect_cash_advance_decision_create_response.rb +1 -1
  1625. data/lib/plaid/models/{link_delivery_communication_method.rb → protect_cash_advance_feedback_upload_request.rb} +29 -19
  1626. data/lib/plaid/models/{link_delivery_recipient.rb → protect_cash_advance_feedback_upload_response.rb} +30 -22
  1627. data/lib/plaid/models/protect_cash_advance_repayment_create_request.rb +1 -1
  1628. data/lib/plaid/models/protect_cash_advance_repayment_create_response.rb +1 -1
  1629. data/lib/plaid/models/protect_compute_request.rb +2 -2
  1630. data/lib/plaid/models/protect_compute_response.rb +1 -1
  1631. data/lib/plaid/models/protect_compute_subscores.rb +1 -1
  1632. data/lib/plaid/models/protect_device_model_inputs.rb +1 -1
  1633. data/lib/plaid/models/protect_event.rb +1 -1
  1634. data/lib/plaid/models/protect_event_get_request.rb +1 -1
  1635. data/lib/plaid/models/protect_event_get_response.rb +12 -2
  1636. data/lib/plaid/models/protect_event_send_request.rb +1 -1
  1637. data/lib/plaid/models/protect_event_send_response.rb +1 -1
  1638. data/lib/plaid/models/protect_incident_amount.rb +1 -1
  1639. data/lib/plaid/models/protect_incident_event.rb +1 -1
  1640. data/lib/plaid/models/protect_incident_event_response.rb +1 -1
  1641. data/lib/plaid/models/protect_link_model_inputs.rb +1 -1
  1642. data/lib/plaid/models/protect_model_inputs.rb +1 -1
  1643. data/lib/plaid/models/protect_report.rb +1 -1
  1644. data/lib/plaid/models/protect_report_confidence.rb +1 -1
  1645. data/lib/plaid/models/protect_report_create_request.rb +1 -1
  1646. data/lib/plaid/models/protect_report_create_response.rb +1 -1
  1647. data/lib/plaid/models/protect_report_source.rb +1 -1
  1648. data/lib/plaid/models/protect_report_type.rb +1 -1
  1649. data/lib/plaid/models/protect_user.rb +1 -1
  1650. data/lib/plaid/models/protect_user_event_webhook.rb +1 -1
  1651. data/lib/plaid/models/protect_user_insights_get_request.rb +1 -1
  1652. data/lib/plaid/models/protect_user_insights_get_response.rb +1 -1
  1653. data/lib/plaid/models/provider_business_address.rb +1 -1
  1654. data/lib/plaid/models/provider_business_name.rb +1 -1
  1655. data/lib/plaid/models/proxy_type.rb +1 -1
  1656. data/lib/plaid/models/pslf_status.rb +1 -1
  1657. data/lib/plaid/models/reason_code.rb +1 -1
  1658. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1659. data/lib/plaid/models/receiver_details.rb +1 -1
  1660. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1661. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1662. data/lib/plaid/models/recommendation_string.rb +1 -1
  1663. data/lib/plaid/models/recurring_cancelled_webhook.rb +2 -2
  1664. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1665. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1666. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1667. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1668. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1669. data/lib/plaid/models/recurring_transfer.rb +2 -2
  1670. data/lib/plaid/models/recurring_transfer_nullable.rb +2 -2
  1671. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1672. data/lib/plaid/models/refresh_result.rb +1 -1
  1673. data/lib/plaid/models/removed_transaction.rb +1 -1
  1674. data/lib/plaid/models/report_type.rb +1 -1
  1675. data/lib/plaid/models/reporting_information.rb +1 -1
  1676. data/lib/plaid/models/request_business_address.rb +1 -1
  1677. data/lib/plaid/models/response_business_address.rb +1 -1
  1678. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1679. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1680. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1681. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1682. data/lib/plaid/models/risk_check_details.rb +1 -1
  1683. data/lib/plaid/models/risk_check_device.rb +1 -1
  1684. data/lib/plaid/models/risk_check_email.rb +1 -1
  1685. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1686. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1687. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1688. data/lib/plaid/models/risk_check_email_includes_date_of_birth.rb +1 -1
  1689. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1690. data/lib/plaid/models/risk_check_email_is_edu.rb +1 -1
  1691. data/lib/plaid/models/risk_check_email_name.rb +1 -1
  1692. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1693. data/lib/plaid/models/risk_check_facial_duplicate.rb +1 -1
  1694. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1695. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1696. data/lib/plaid/models/risk_check_network.rb +1 -1
  1697. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1698. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1699. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1700. data/lib/plaid/models/risk_indicators.rb +1 -1
  1701. data/lib/plaid/models/risk_level.rb +1 -1
  1702. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1703. data/lib/plaid/models/risk_profile.rb +1 -1
  1704. data/lib/plaid/models/risk_reason.rb +1 -1
  1705. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1706. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1707. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1708. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1709. data/lib/plaid/models/role.rb +1 -1
  1710. data/lib/plaid/models/role_detail.rb +1 -1
  1711. data/lib/plaid/models/roles.rb +1 -1
  1712. data/lib/plaid/models/rule_details.rb +1 -1
  1713. data/lib/plaid/models/rule_result.rb +1 -1
  1714. data/lib/plaid/models/ruleset.rb +1 -1
  1715. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1716. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1717. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1718. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1719. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1720. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1721. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1722. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1723. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +1 -1
  1724. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
  1725. data/lib/plaid/models/sandbox_cra_servicing_simulate_error_webhook_code.rb +1 -2
  1726. data/lib/plaid/models/sandbox_cra_servicing_simulate_request.rb +1 -1
  1727. data/lib/plaid/models/sandbox_cra_servicing_simulate_request_options.rb +1 -1
  1728. data/lib/plaid/models/sandbox_cra_servicing_simulate_response.rb +1 -1
  1729. data/lib/plaid/models/sandbox_fdx_consent_seed_request.rb +1 -1
  1730. data/lib/plaid/models/sandbox_fdx_consent_seed_response.rb +1 -1
  1731. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +4 -4
  1732. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1733. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1734. data/lib/plaid/models/sandbox_item_application_seed_request.rb +1 -1
  1735. data/lib/plaid/models/sandbox_item_application_seed_response.rb +1 -1
  1736. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +14 -5
  1737. data/lib/plaid/models/sandbox_item_fire_webhook_request_options.rb +238 -0
  1738. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1739. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1740. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1741. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1742. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1743. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1744. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1745. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1746. data/lib/plaid/models/sandbox_payment_simulate_request.rb +2 -2
  1747. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1748. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1749. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1750. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1751. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1752. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1753. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1754. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1755. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1756. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1757. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1758. data/lib/plaid/models/sandbox_transactions_create_request.rb +1 -1
  1759. data/lib/plaid/models/sandbox_transactions_create_response.rb +1 -1
  1760. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1761. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1762. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1763. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1764. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +2 -2
  1765. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1766. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1767. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1768. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1769. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1770. data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +1 -1
  1771. data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +1 -1
  1772. data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +1 -1
  1773. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1774. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1775. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1776. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1777. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1778. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1779. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1780. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1781. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1782. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1783. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1784. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1785. data/lib/plaid/models/sandbox_user_fire_webhook_code.rb +1 -1
  1786. data/lib/plaid/models/sandbox_user_fire_webhook_request.rb +1 -1
  1787. data/lib/plaid/models/sandbox_user_fire_webhook_response.rb +1 -1
  1788. data/lib/plaid/models/sandbox_user_fire_webhook_type.rb +1 -1
  1789. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1790. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1791. data/lib/plaid/models/scopes.rb +1 -1
  1792. data/lib/plaid/models/scopes_context.rb +1 -1
  1793. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1794. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1795. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1796. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1797. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1798. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1799. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1800. data/lib/plaid/models/security.rb +1 -1
  1801. data/lib/plaid/models/security_override.rb +6 -1
  1802. data/lib/plaid/models/selfie_age_check.rb +1 -1
  1803. data/lib/plaid/models/selfie_age_check_status.rb +1 -1
  1804. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1805. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1806. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1807. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1808. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1809. data/lib/plaid/models/selfie_capture.rb +1 -1
  1810. data/lib/plaid/models/selfie_check.rb +2 -2
  1811. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1812. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1813. data/lib/plaid/models/selfie_status.rb +1 -1
  1814. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1815. data/lib/plaid/models/service.rb +1 -1
  1816. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1817. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1818. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1819. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1820. data/lib/plaid/models/services.rb +1 -1
  1821. data/lib/plaid/models/session_token_create_request.rb +1 -1
  1822. data/lib/plaid/models/session_token_create_request_user.rb +1 -1
  1823. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1824. data/lib/plaid/models/session_token_create_response_link.rb +1 -1
  1825. data/lib/plaid/models/signal_address_data.rb +1 -1
  1826. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1827. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1828. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1829. data/lib/plaid/models/signal_device.rb +1 -1
  1830. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1831. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1832. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1833. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1834. data/lib/plaid/models/signal_person_name.rb +1 -1
  1835. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1836. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1837. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1838. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1839. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -1
  1840. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1841. data/lib/plaid/models/signal_schedule_request.rb +1 -1
  1842. data/lib/plaid/models/signal_schedule_response.rb +3 -3
  1843. data/lib/plaid/models/signal_scores.rb +1 -1
  1844. data/lib/plaid/models/signal_user.rb +1 -1
  1845. data/lib/plaid/models/signal_warning.rb +1 -1
  1846. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1847. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1848. data/lib/plaid/models/sms_verification.rb +1 -1
  1849. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1850. data/lib/plaid/models/source.rb +1 -1
  1851. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1852. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1853. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1854. data/lib/plaid/models/statements_account.rb +1 -1
  1855. data/lib/plaid/models/statements_download_request.rb +1 -1
  1856. data/lib/plaid/models/statements_list_request.rb +1 -1
  1857. data/lib/plaid/models/statements_list_response.rb +1 -1
  1858. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1859. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1860. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1861. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1862. data/lib/plaid/models/statements_statement.rb +1 -1
  1863. data/lib/plaid/models/status.rb +1 -1
  1864. data/lib/plaid/models/statuses.rb +1 -1
  1865. data/lib/plaid/models/strategy.rb +1 -1
  1866. data/lib/plaid/models/student_loan.rb +1 -1
  1867. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1868. data/lib/plaid/models/student_loan_status.rb +1 -1
  1869. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1870. data/lib/plaid/models/sweep_failure.rb +1 -1
  1871. data/lib/plaid/models/sweep_status.rb +1 -1
  1872. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1873. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1874. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1875. data/lib/plaid/models/taxform.rb +1 -1
  1876. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1877. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1878. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1879. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1880. data/lib/plaid/models/total.rb +1 -1
  1881. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1882. data/lib/plaid/models/total_inflow_amount.rb +2 -2
  1883. data/lib/plaid/models/total_inflow_amount30d.rb +2 -2
  1884. data/lib/plaid/models/total_inflow_amount60d.rb +2 -2
  1885. data/lib/plaid/models/total_inflow_amount90d.rb +2 -2
  1886. data/lib/plaid/models/total_monthly_income_insights.rb +2 -2
  1887. data/lib/plaid/models/total_outflow_amount.rb +2 -2
  1888. data/lib/plaid/models/total_outflow_amount30d.rb +2 -2
  1889. data/lib/plaid/models/total_outflow_amount60d.rb +2 -2
  1890. data/lib/plaid/models/total_outflow_amount90d.rb +2 -2
  1891. data/lib/plaid/models/total_report_inflow_amount.rb +2 -2
  1892. data/lib/plaid/models/total_report_inflow_amount30d.rb +2 -2
  1893. data/lib/plaid/models/total_report_inflow_amount60d.rb +2 -2
  1894. data/lib/plaid/models/total_report_inflow_amount90d.rb +2 -2
  1895. data/lib/plaid/models/total_report_outflow_amount.rb +2 -2
  1896. data/lib/plaid/models/total_report_outflow_amount30d.rb +2 -2
  1897. data/lib/plaid/models/total_report_outflow_amount60d.rb +2 -2
  1898. data/lib/plaid/models/total_report_outflow_amount90d.rb +2 -2
  1899. data/lib/plaid/models/transaction.rb +1 -1
  1900. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1901. data/lib/plaid/models/transaction_base.rb +1 -1
  1902. data/lib/plaid/models/transaction_code.rb +1 -1
  1903. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1904. data/lib/plaid/models/transaction_data.rb +1 -1
  1905. data/lib/plaid/models/transaction_override.rb +2 -2
  1906. data/lib/plaid/models/transaction_stream.rb +1 -1
  1907. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1908. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1909. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1910. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1911. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1912. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1913. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1914. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  1915. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1916. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1917. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1918. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1919. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1920. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1921. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1922. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1923. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1924. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1925. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1926. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1927. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1928. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1929. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1930. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1931. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1932. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1933. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1934. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1935. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1936. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1937. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1938. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1939. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1940. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1941. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  1942. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1943. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1944. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1945. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1946. data/lib/plaid/models/transfer.rb +3 -3
  1947. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1948. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1949. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1950. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1951. data/lib/plaid/models/transfer_authorization_create_request.rb +16 -7
  1952. data/lib/plaid/models/transfer_authorization_create_request_user_attributes.rb +256 -0
  1953. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1954. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1955. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1956. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1957. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1958. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1959. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1960. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1961. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1962. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
  1963. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1964. data/lib/plaid/models/transfer_authorization_user_attributes.rb +250 -0
  1965. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1966. data/lib/plaid/models/transfer_balance.rb +1 -1
  1967. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1968. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1969. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1970. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1971. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1972. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1973. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1974. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1975. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1976. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1977. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1978. data/lib/plaid/models/transfer_create_request.rb +4 -4
  1979. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1980. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1981. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1982. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1983. data/lib/plaid/models/transfer_device.rb +1 -1
  1984. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1985. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1986. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1987. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1988. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1989. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1990. data/lib/plaid/models/transfer_event.rb +2 -2
  1991. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1992. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1993. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1994. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1995. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1996. data/lib/plaid/models/transfer_event_type.rb +2 -1
  1997. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1998. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1999. data/lib/plaid/models/transfer_failure.rb +5 -5
  2000. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  2001. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +1 -1
  2002. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
  2003. data/lib/plaid/models/transfer_get_request.rb +1 -1
  2004. data/lib/plaid/models/transfer_get_response.rb +1 -1
  2005. data/lib/plaid/models/transfer_guarantee_details.rb +1 -1
  2006. data/lib/plaid/models/transfer_guarantee_outcome.rb +1 -1
  2007. data/lib/plaid/models/transfer_guarantee_schedule_item.rb +1 -1
  2008. data/lib/plaid/models/transfer_guarantee_schedule_item_all_of.rb +1 -1
  2009. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  2010. data/lib/plaid/models/transfer_intent_create.rb +2 -2
  2011. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  2012. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  2013. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  2014. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  2015. data/lib/plaid/models/transfer_intent_get.rb +2 -2
  2016. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  2017. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  2018. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  2019. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  2020. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  2021. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  2022. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  2023. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  2024. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  2025. data/lib/plaid/models/transfer_ledger_event.rb +2 -2
  2026. data/lib/plaid/models/transfer_ledger_event_list_request.rb +1 -1
  2027. data/lib/plaid/models/transfer_ledger_event_list_response.rb +1 -1
  2028. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  2029. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  2030. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +2 -1
  2031. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  2032. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  2033. data/lib/plaid/models/transfer_list_request.rb +1 -1
  2034. data/lib/plaid/models/transfer_list_response.rb +1 -1
  2035. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  2036. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  2037. data/lib/plaid/models/transfer_metrics_get_response.rb +3 -3
  2038. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  2039. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  2040. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  2041. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  2042. data/lib/plaid/models/transfer_network.rb +1 -1
  2043. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  2044. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  2045. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  2046. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  2047. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +1 -1
  2048. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +1 -1
  2049. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  2050. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  2051. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  2052. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  2053. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  2054. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  2055. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  2056. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  2057. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  2058. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  2059. data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
  2060. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  2061. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  2062. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  2063. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  2064. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  2065. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  2066. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  2067. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  2068. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  2069. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  2070. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  2071. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  2072. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
  2073. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  2074. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  2075. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  2076. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  2077. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  2078. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  2079. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  2080. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  2081. data/lib/plaid/models/transfer_refund.rb +1 -1
  2082. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  2083. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  2084. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  2085. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  2086. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  2087. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  2088. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  2089. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  2090. data/lib/plaid/models/transfer_repayment.rb +1 -1
  2091. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  2092. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  2093. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  2094. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  2095. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  2096. data/lib/plaid/models/transfer_return_recover_request.rb +2 -2
  2097. data/lib/plaid/models/transfer_return_recover_response.rb +1 -1
  2098. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  2099. data/lib/plaid/models/transfer_status.rb +1 -1
  2100. data/lib/plaid/models/transfer_sweep.rb +1 -1
  2101. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  2102. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  2103. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  2104. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  2105. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  2106. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  2107. data/lib/plaid/models/transfer_type.rb +1 -1
  2108. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  2109. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  2110. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  2111. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  2112. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  2113. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  2114. data/lib/plaid/models/trust_index.rb +1 -1
  2115. data/lib/plaid/models/trust_index_subscore.rb +1 -1
  2116. data/lib/plaid/models/trust_index_subscores.rb +1 -1
  2117. data/lib/plaid/models/trusted_device_data.rb +1 -1
  2118. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  2119. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  2120. data/lib/plaid/models/user_account_identity.rb +2 -2
  2121. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  2122. data/lib/plaid/models/user_account_identity_edit_counts.rb +1 -1
  2123. data/lib/plaid/models/user_account_identity_edit_history.rb +1 -1
  2124. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  2125. data/lib/plaid/models/user_account_identity_official_document.rb +1 -1
  2126. data/lib/plaid/models/user_account_item.rb +1 -1
  2127. data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
  2128. data/lib/plaid/models/user_account_session_event.rb +1 -1
  2129. data/lib/plaid/models/user_account_session_event_send_request.rb +1 -1
  2130. data/lib/plaid/models/user_account_session_event_send_response.rb +1 -1
  2131. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  2132. data/lib/plaid/models/user_account_session_get_response.rb +23 -2
  2133. data/lib/plaid/models/user_address.rb +1 -1
  2134. data/lib/plaid/models/user_based_products.rb +1 -1
  2135. data/lib/plaid/models/user_create_request.rb +1 -1
  2136. data/lib/plaid/models/user_create_response.rb +1 -1
  2137. data/lib/plaid/models/user_custom_password.rb +37 -24
  2138. data/lib/plaid/models/user_data_overview.rb +1 -1
  2139. data/lib/plaid/models/user_financial_data_refresh_request.rb +1 -1
  2140. data/lib/plaid/models/user_financial_data_refresh_response.rb +1 -1
  2141. data/lib/plaid/models/user_get_request.rb +1 -1
  2142. data/lib/plaid/models/user_get_response.rb +1 -1
  2143. data/lib/plaid/models/user_id_number.rb +2 -2
  2144. data/lib/plaid/models/user_identity_remove_request.rb +1 -1
  2145. data/lib/plaid/models/user_identity_remove_response.rb +1 -1
  2146. data/lib/plaid/models/user_income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  2147. data/lib/plaid/models/user_income_verification_risk_signals_status_webhook.rb +1 -1
  2148. data/lib/plaid/models/user_income_verification_status_webhook.rb +1 -1
  2149. data/lib/plaid/models/user_items_associate_request.rb +1 -1
  2150. data/lib/plaid/models/user_items_associate_response.rb +1 -1
  2151. data/lib/plaid/models/user_items_get_request.rb +1 -1
  2152. data/lib/plaid/models/user_items_get_response.rb +1 -1
  2153. data/lib/plaid/models/user_items_remove_request.rb +1 -1
  2154. data/lib/plaid/models/user_items_remove_response.rb +1 -1
  2155. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  2156. data/lib/plaid/models/user_products_terminate_request.rb +1 -1
  2157. data/lib/plaid/models/user_products_terminate_response.rb +1 -1
  2158. data/lib/plaid/models/user_remove_request.rb +1 -1
  2159. data/lib/plaid/models/user_remove_response.rb +1 -1
  2160. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  2161. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  2162. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  2163. data/lib/plaid/models/user_third_party_token_create_request.rb +1 -1
  2164. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  2165. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  2166. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  2167. data/lib/plaid/models/user_transactions_refresh_request.rb +1 -1
  2168. data/lib/plaid/models/user_transactions_refresh_response.rb +1 -1
  2169. data/lib/plaid/models/user_update_request.rb +1 -1
  2170. data/lib/plaid/models/user_update_response.rb +1 -1
  2171. data/lib/plaid/models/validation_source.rb +1 -1
  2172. data/lib/plaid/models/validation_sources.rb +1 -1
  2173. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  2174. data/lib/plaid/models/verification_of_asset.rb +1 -1
  2175. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  2176. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  2177. data/lib/plaid/models/verification_status.rb +1 -1
  2178. data/lib/plaid/models/verify_sms_details.rb +1 -1
  2179. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  2180. data/lib/plaid/models/w2.rb +1 -1
  2181. data/lib/plaid/models/w2_box12.rb +1 -1
  2182. data/lib/plaid/models/w2_box12_override.rb +2 -2
  2183. data/lib/plaid/models/w2_override.rb +15 -15
  2184. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  2185. data/lib/plaid/models/w2_state_and_local_wages_override.rb +5 -5
  2186. data/lib/plaid/models/wallet.rb +1 -1
  2187. data/lib/plaid/models/wallet_balance.rb +1 -1
  2188. data/lib/plaid/models/wallet_create_request.rb +1 -1
  2189. data/lib/plaid/models/wallet_create_response.rb +1 -1
  2190. data/lib/plaid/models/wallet_get_request.rb +1 -1
  2191. data/lib/plaid/models/wallet_get_response.rb +1 -1
  2192. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  2193. data/lib/plaid/models/wallet_list_request.rb +1 -1
  2194. data/lib/plaid/models/wallet_list_response.rb +1 -1
  2195. data/lib/plaid/models/wallet_numbers.rb +1 -1
  2196. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  2197. data/lib/plaid/models/wallet_status.rb +2 -1
  2198. data/lib/plaid/models/wallet_transaction.rb +1 -1
  2199. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  2200. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  2201. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
  2202. data/lib/plaid/models/wallet_transaction_counterparty_holder_category.rb +1 -1
  2203. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  2204. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  2205. data/lib/plaid/models/wallet_transaction_execute_request.rb +3 -3
  2206. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  2207. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  2208. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  2209. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  2210. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  2211. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  2212. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  2213. data/lib/plaid/models/wallet_transaction_payee_verification_status.rb +1 -1
  2214. data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
  2215. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  2216. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  2217. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  2218. data/lib/plaid/models/warning.rb +1 -1
  2219. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  2220. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  2221. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  2222. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  2223. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  2224. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  2225. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  2226. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  2227. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  2228. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  2229. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  2230. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  2231. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  2232. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  2233. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  2234. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  2235. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  2236. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  2237. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  2238. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  2239. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  2240. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  2241. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  2242. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  2243. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  2244. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  2245. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  2246. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  2247. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  2248. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  2249. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  2250. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  2251. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  2252. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  2253. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  2254. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  2255. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  2256. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  2257. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  2258. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  2259. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  2260. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  2261. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  2262. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  2263. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  2264. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  2265. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  2266. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  2267. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  2268. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  2269. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  2270. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  2271. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  2272. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  2273. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  2274. data/lib/plaid/models/webhook_event.rb +4 -4
  2275. data/lib/plaid/models/webhook_event_delivery_status.rb +1 -1
  2276. data/lib/plaid/models/webhook_type.rb +2 -1
  2277. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  2278. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  2279. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  2280. data/lib/plaid/models/yield_rate.rb +1 -1
  2281. data/lib/plaid/models/yield_rate_type.rb +1 -1
  2282. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  2283. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  2284. data/lib/plaid/version.rb +2 -2
  2285. data/lib/plaid.rb +106 -18
  2286. data/plaid.gemspec +1 -1
  2287. data/templates/ruby/api_client.mustache +2 -4
  2288. data/templates/ruby/api_client_faraday_partial.mustache +0 -1
  2289. data/test/test_api_client.rb +135 -0
  2290. metadata +107 -19
@@ -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.740.1
6
+ The version of the OpenAPI document: 2020-09-14_1.778.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -68,7 +68,7 @@ module Plaid
68
68
  return_type = opts[:debug_return_type] || 'AccountsGetResponse'
69
69
 
70
70
  # auth_names
71
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
71
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
72
72
 
73
73
  new_options = opts.merge(
74
74
  :operation => :"PlaidApi.accounts_balance_get",
@@ -952,7 +952,7 @@ module Plaid
952
952
  return_type = opts[:debug_return_type] || 'AuthGetResponse'
953
953
 
954
954
  # auth_names
955
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
955
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
956
956
 
957
957
  new_options = opts.merge(
958
958
  :operation => :"PlaidApi.auth_get",
@@ -2603,6 +2603,74 @@ module Plaid
2603
2603
  return data, status_code, headers
2604
2604
  end
2605
2605
 
2606
+ # Get Cash Advance income insights
2607
+ # The `/beta/cash_advance/income_insights/v1/get` endpoint returns a user's top income streams across all of the user's active Items, ranked by historical net monthly income and capped at three, along with the next payment date and amount of the highest-ranked stream. Only USD income streams are returned. If some, but not all, of the user's Items could not be evaluated, the response is based on the remaining Items.
2608
+ # @param beta_cash_advance_income_insights_v1_get_request [BetaCashAdvanceIncomeInsightsV1GetRequest]
2609
+ # @param [Hash] opts the optional parameters
2610
+ # @return [BetaCashAdvanceIncomeInsightsV1GetResponse]
2611
+ def beta_cash_advance_income_insights_v1_get(beta_cash_advance_income_insights_v1_get_request, opts = {})
2612
+ data, _status_code, _headers = beta_cash_advance_income_insights_v1_get_with_http_info(beta_cash_advance_income_insights_v1_get_request, opts)
2613
+ data
2614
+ end
2615
+
2616
+ # Get Cash Advance income insights
2617
+ # The `/beta/cash_advance/income_insights/v1/get` endpoint returns a user's top income streams across all of the user's active Items, ranked by historical net monthly income and capped at three, along with the next payment date and amount of the highest-ranked stream. Only USD income streams are returned. If some, but not all, of the user's Items could not be evaluated, the response is based on the remaining Items.
2618
+ # @param beta_cash_advance_income_insights_v1_get_request [BetaCashAdvanceIncomeInsightsV1GetRequest]
2619
+ # @param [Hash] opts the optional parameters
2620
+ # @return [Array<(BetaCashAdvanceIncomeInsightsV1GetResponse, Integer, Hash)>] BetaCashAdvanceIncomeInsightsV1GetResponse data, response status code and response headers
2621
+ def beta_cash_advance_income_insights_v1_get_with_http_info(beta_cash_advance_income_insights_v1_get_request, opts = {})
2622
+ if @api_client.config.debugging
2623
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beta_cash_advance_income_insights_v1_get ...'
2624
+ end
2625
+ # verify the required parameter 'beta_cash_advance_income_insights_v1_get_request' is set
2626
+ if @api_client.config.client_side_validation && beta_cash_advance_income_insights_v1_get_request.nil?
2627
+ fail ArgumentError, "Missing the required parameter 'beta_cash_advance_income_insights_v1_get_request' when calling PlaidApi.beta_cash_advance_income_insights_v1_get"
2628
+ end
2629
+ # resource path
2630
+ local_var_path = '/beta/cash_advance/income_insights/v1/get'
2631
+
2632
+ # query parameters
2633
+ query_params = opts[:query_params] || {}
2634
+
2635
+ # header parameters
2636
+ header_params = opts[:header_params] || {}
2637
+ # HTTP header 'Accept' (if needed)
2638
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2639
+ # HTTP header 'Content-Type'
2640
+ content_type = @api_client.select_header_content_type(['application/json'])
2641
+ if !content_type.nil?
2642
+ header_params['Content-Type'] = content_type
2643
+ end
2644
+
2645
+ # form parameters
2646
+ form_params = opts[:form_params] || {}
2647
+
2648
+ # http body (model)
2649
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beta_cash_advance_income_insights_v1_get_request)
2650
+
2651
+ # return_type
2652
+ return_type = opts[:debug_return_type] || 'BetaCashAdvanceIncomeInsightsV1GetResponse'
2653
+
2654
+ # auth_names
2655
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2656
+
2657
+ new_options = opts.merge(
2658
+ :operation => :"PlaidApi.beta_cash_advance_income_insights_v1_get",
2659
+ :header_params => header_params,
2660
+ :query_params => query_params,
2661
+ :form_params => form_params,
2662
+ :body => post_body,
2663
+ :auth_names => auth_names,
2664
+ :return_type => return_type
2665
+ )
2666
+
2667
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2668
+ if @api_client.config.debugging
2669
+ @api_client.config.logger.debug "API called: PlaidApi#beta_cash_advance_income_insights_v1_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2670
+ end
2671
+ return data, status_code, headers
2672
+ end
2673
+
2606
2674
  # Get EWA Score Report
2607
2675
  # 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
2676
  # @param beta_ewa_report_v1_get_request [BetaEwaReportV1GetRequest]
@@ -2720,7 +2788,7 @@ module Plaid
2720
2788
  return_type = opts[:debug_return_type] || 'BetaIssuesV1GetResponse'
2721
2789
 
2722
2790
  # auth_names
2723
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2791
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
2724
2792
 
2725
2793
  new_options = opts.merge(
2726
2794
  :operation => :"PlaidApi.beta_issues_v1_get",
@@ -2856,7 +2924,7 @@ module Plaid
2856
2924
  return_type = opts[:debug_return_type] || 'BetaIssuesV1MatchResponse'
2857
2925
 
2858
2926
  # auth_names
2859
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2927
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
2860
2928
 
2861
2929
  new_options = opts.merge(
2862
2930
  :operation => :"PlaidApi.beta_issues_v1_match",
@@ -2876,7 +2944,7 @@ module Plaid
2876
2944
  end
2877
2945
 
2878
2946
  # Subscribe to an issue
2879
- # Subscribe a webhook URL to resolution notifications for an institution issue.
2947
+ # Subscribe a webhook URL to resolution notifications for an institution issue. A client has a single subscription per issue, so subscribing again for the same issue overwrites the previously registered webhook URL.
2880
2948
  # @param beta_issues_v1_subscribe_request [BetaIssuesV1SubscribeRequest]
2881
2949
  # @param [Hash] opts the optional parameters
2882
2950
  # @return [BetaIssuesV1SubscribeResponse]
@@ -2886,7 +2954,7 @@ module Plaid
2886
2954
  end
2887
2955
 
2888
2956
  # Subscribe to an issue
2889
- # Subscribe a webhook URL to resolution notifications for an institution issue.
2957
+ # Subscribe a webhook URL to resolution notifications for an institution issue. A client has a single subscription per issue, so subscribing again for the same issue overwrites the previously registered webhook URL.
2890
2958
  # @param beta_issues_v1_subscribe_request [BetaIssuesV1SubscribeRequest]
2891
2959
  # @param [Hash] opts the optional parameters
2892
2960
  # @return [Array<(BetaIssuesV1SubscribeResponse, Integer, Hash)>] BetaIssuesV1SubscribeResponse data, response status code and response headers
@@ -2924,7 +2992,7 @@ module Plaid
2924
2992
  return_type = opts[:debug_return_type] || 'BetaIssuesV1SubscribeResponse'
2925
2993
 
2926
2994
  # auth_names
2927
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2995
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
2928
2996
 
2929
2997
  new_options = opts.merge(
2930
2998
  :operation => :"PlaidApi.beta_issues_v1_subscribe",
@@ -2944,7 +3012,7 @@ module Plaid
2944
3012
  end
2945
3013
 
2946
3014
  # Unsubscribe from an issue
2947
- # Remove the client's subscription to resolution notifications for an institution issue.
3015
+ # Remove the client's subscription to resolution notifications for an institution issue. This removes the client's single subscription for that issue, identified by the issue alone.
2948
3016
  # @param beta_issues_v1_unsubscribe_request [BetaIssuesV1UnsubscribeRequest]
2949
3017
  # @param [Hash] opts the optional parameters
2950
3018
  # @return [BetaIssuesV1UnsubscribeResponse]
@@ -2954,7 +3022,7 @@ module Plaid
2954
3022
  end
2955
3023
 
2956
3024
  # Unsubscribe from an issue
2957
- # Remove the client&#39;s subscription to resolution notifications for an institution issue.
3025
+ # Remove the client&#39;s subscription to resolution notifications for an institution issue. This removes the client&#39;s single subscription for that issue, identified by the issue alone.
2958
3026
  # @param beta_issues_v1_unsubscribe_request [BetaIssuesV1UnsubscribeRequest]
2959
3027
  # @param [Hash] opts the optional parameters
2960
3028
  # @return [Array<(BetaIssuesV1UnsubscribeResponse, Integer, Hash)>] BetaIssuesV1UnsubscribeResponse data, response status code and response headers
@@ -2992,7 +3060,7 @@ module Plaid
2992
3060
  return_type = opts[:debug_return_type] || 'BetaIssuesV1UnsubscribeResponse'
2993
3061
 
2994
3062
  # auth_names
2995
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3063
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
2996
3064
 
2997
3065
  new_options = opts.merge(
2998
3066
  :operation => :"PlaidApi.beta_issues_v1_unsubscribe",
@@ -3284,7 +3352,7 @@ module Plaid
3284
3352
  end
3285
3353
 
3286
3354
  # List webhook events
3287
- # The `/beta/webhook_events/list` endpoint returns webhook events Plaid sent to the calling client within the last 7 days. Results are ordered by `sent_time` ascending and cursor paginated so clients can recover missed webhook deliveries and deduplicate on `webhook_message_id`. Filtering is optional. When multiple filter fields are set (`webhook_types`, `webhook_codes`, `item_ids`, `delivery_statuses`), they are combined with AND across fields and OR within each array (for example, `webhook_types: [\"ITEM\", \"AUTH\"]` matches either type). Recommended pagination workflow: 1. First call: omit `cursor`, and optionally set `start_time` within the last 7 days (or omit `start_time` to begin at the oldest retained event). 2. Subsequent calls: pass `next_cursor` as `cursor`. Do not send `start_time` with `cursor` — the two fields are mutually exclusive. Sending both returns `INVALID_FIELD`. 3. Persist `next_cursor` even when `has_more` is `false`, then reuse it on the next poll so you only receive events newer than what you have already seen. 4. If a stored cursor is older than the 7-day retention window, the API returns `WEBHOOK_EVENTS_CURSOR_EXPIRED`; restart with a `start_time` within the last 7 days. Events older than the retention window are no longer available. Errors: `WEBHOOK_EVENTS_START_TIME_OUT_OF_RANGE` (400) is returned when `start_time` is earlier than the 7-day retention window. Retry with a `start_time` within the last 7 days, or omit it. `WEBHOOK_EVENTS_CURSOR_EXPIRED` (400) is returned when the cursor's position is older than the 7-day retention window and can no longer be resolved. Restart pagination with a `start_time` within the last 7 days. `INVALID_FIELD` (400) is returned when `cursor` is not a properly formatted string, when both `cursor` and `start_time` are provided, or when the request is otherwise invalid.
3355
+ # `/beta/webhook_events/list` returns the webhooks Plaid sent to your account in the last 7 days, including webhooks that weren't delivered. Use it to recover webhooks your endpoint missed. Events are returned oldest first. `TRANSACTIONS` webhooks are not included. To recover Transactions updates, use [`/transactions/sync`](https://plaid.com/docs/api/products/transactions/#transactionssync). To page through events, omit `cursor` on your first request, then pass the previous response's `next_cursor` on each later request. Store `next_cursor` even when `has_more` is `false`, so your next poll returns only newer events. Filters are optional. An event matches a filter if it matches any of the filter's values, and must match every filter you provide. Events older than 7 days are not retained. If your cursor or `start_time` is older than that, the request fails with `WEBHOOK_EVENTS_CURSOR_EXPIRED` or `WEBHOOK_EVENTS_START_TIME_OUT_OF_RANGE`. This endpoint is in beta and may change in backwards-incompatible ways. Send feedback to building@plaid.com.
3288
3356
  # @param beta_webhook_events_list_request [BetaWebhookEventsListRequest]
3289
3357
  # @param [Hash] opts the optional parameters
3290
3358
  # @return [BetaWebhookEventsListResponse]
@@ -3294,7 +3362,7 @@ module Plaid
3294
3362
  end
3295
3363
 
3296
3364
  # List webhook events
3297
- # The &#x60;/beta/webhook_events/list&#x60; endpoint returns webhook events Plaid sent to the calling client within the last 7 days. Results are ordered by &#x60;sent_time&#x60; ascending and cursor paginated so clients can recover missed webhook deliveries and deduplicate on &#x60;webhook_message_id&#x60;. Filtering is optional. When multiple filter fields are set (&#x60;webhook_types&#x60;, &#x60;webhook_codes&#x60;, &#x60;item_ids&#x60;, &#x60;delivery_statuses&#x60;), they are combined with AND across fields and OR within each array (for example, &#x60;webhook_types: [\&quot;ITEM\&quot;, \&quot;AUTH\&quot;]&#x60; matches either type). Recommended pagination workflow: 1. First call: omit &#x60;cursor&#x60;, and optionally set &#x60;start_time&#x60; within the last 7 days (or omit &#x60;start_time&#x60; to begin at the oldest retained event). 2. Subsequent calls: pass &#x60;next_cursor&#x60; as &#x60;cursor&#x60;. Do not send &#x60;start_time&#x60; with &#x60;cursor&#x60; — the two fields are mutually exclusive. Sending both returns &#x60;INVALID_FIELD&#x60;. 3. Persist &#x60;next_cursor&#x60; even when &#x60;has_more&#x60; is &#x60;false&#x60;, then reuse it on the next poll so you only receive events newer than what you have already seen. 4. If a stored cursor is older than the 7-day retention window, the API returns &#x60;WEBHOOK_EVENTS_CURSOR_EXPIRED&#x60;; restart with a &#x60;start_time&#x60; within the last 7 days. Events older than the retention window are no longer available. Errors: &#x60;WEBHOOK_EVENTS_START_TIME_OUT_OF_RANGE&#x60; (400) is returned when &#x60;start_time&#x60; is earlier than the 7-day retention window. Retry with a &#x60;start_time&#x60; within the last 7 days, or omit it. &#x60;WEBHOOK_EVENTS_CURSOR_EXPIRED&#x60; (400) is returned when the cursor&#39;s position is older than the 7-day retention window and can no longer be resolved. Restart pagination with a &#x60;start_time&#x60; within the last 7 days. &#x60;INVALID_FIELD&#x60; (400) is returned when &#x60;cursor&#x60; is not a properly formatted string, when both &#x60;cursor&#x60; and &#x60;start_time&#x60; are provided, or when the request is otherwise invalid.
3365
+ # &#x60;/beta/webhook_events/list&#x60; returns the webhooks Plaid sent to your account in the last 7 days, including webhooks that weren&#39;t delivered. Use it to recover webhooks your endpoint missed. Events are returned oldest first. &#x60;TRANSACTIONS&#x60; webhooks are not included. To recover Transactions updates, use [&#x60;/transactions/sync&#x60;](https://plaid.com/docs/api/products/transactions/#transactionssync). To page through events, omit &#x60;cursor&#x60; on your first request, then pass the previous response&#39;s &#x60;next_cursor&#x60; on each later request. Store &#x60;next_cursor&#x60; even when &#x60;has_more&#x60; is &#x60;false&#x60;, so your next poll returns only newer events. Filters are optional. An event matches a filter if it matches any of the filter&#39;s values, and must match every filter you provide. Events older than 7 days are not retained. If your cursor or &#x60;start_time&#x60; is older than that, the request fails with &#x60;WEBHOOK_EVENTS_CURSOR_EXPIRED&#x60; or &#x60;WEBHOOK_EVENTS_START_TIME_OUT_OF_RANGE&#x60;. This endpoint is in beta and may change in backwards-incompatible ways. Send feedback to building@plaid.com.
3298
3366
  # @param beta_webhook_events_list_request [BetaWebhookEventsListRequest]
3299
3367
  # @param [Hash] opts the optional parameters
3300
3368
  # @return [Array<(BetaWebhookEventsListResponse, Integer, Hash)>] BetaWebhookEventsListResponse data, response status code and response headers
@@ -4440,7 +4508,7 @@ module Plaid
4440
4508
  end
4441
4509
 
4442
4510
  # Retrieve a Consumer Report as a PDF
4443
- # `/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.
4511
+ # `/cra/check_report/pdf/get` retrieves the most recent Consumer Report in PDF format. The most recent Base Report for the user is always included. Use the `add_ons` field to also include the most recent Income Insights, Partner Insights or LendScore report in the PDF.
4444
4512
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
4445
4513
  # @param [Hash] opts the optional parameters
4446
4514
  # @return [File]
@@ -4450,7 +4518,7 @@ module Plaid
4450
4518
  end
4451
4519
 
4452
4520
  # Retrieve a Consumer Report as a PDF
4453
- # &#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.
4521
+ # &#x60;/cra/check_report/pdf/get&#x60; retrieves the most recent Consumer Report in PDF format. The most recent Base Report for the user is always included. Use the &#x60;add_ons&#x60; field to also include the most recent Income Insights, Partner Insights or LendScore report in the PDF.
4454
4522
  # @param cra_check_report_pdf_get_request [CraCheckReportPDFGetRequest]
4455
4523
  # @param [Hash] opts the optional parameters
4456
4524
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -4556,7 +4624,7 @@ module Plaid
4556
4624
  return_type = opts[:debug_return_type] || 'CraCheckReportVerificationGetResponse'
4557
4625
 
4558
4626
  # auth_names
4559
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4627
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
4560
4628
 
4561
4629
  new_options = opts.merge(
4562
4630
  :operation => :"PlaidApi.cra_check_report_verification_get",
@@ -4624,7 +4692,7 @@ module Plaid
4624
4692
  return_type = opts[:debug_return_type] || 'File'
4625
4693
 
4626
4694
  # auth_names
4627
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4695
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
4628
4696
 
4629
4697
  new_options = opts.merge(
4630
4698
  :operation => :"PlaidApi.cra_check_report_verification_pdf_get",
@@ -5255,8 +5323,76 @@ module Plaid
5255
5323
  return data, status_code, headers
5256
5324
  end
5257
5325
 
5258
- # Retrieve a CRA Report for provided user
5259
- # `/cra/report/get` retrieves a CRA Report for a user.
5326
+ # Generate an updated Consumer Report for your user
5327
+ # `/cra/report/create` generates a Consumer Report for a user. With `scope` set to `PLAID_NETWORK`, the report is generated from the Plaid Network view of the user's profile. With `CLIENT_USER`, the report is generated from only the Items the user linked to your client. Each requested product is generated asynchronously. Use the returned `report_id` to retrieve the report once its products are ready.
5328
+ # @param cra_report_create_request [CraReportCreateRequest]
5329
+ # @param [Hash] opts the optional parameters
5330
+ # @return [CraReportCreateResponse]
5331
+ def cra_report_create(cra_report_create_request, opts = {})
5332
+ data, _status_code, _headers = cra_report_create_with_http_info(cra_report_create_request, opts)
5333
+ data
5334
+ end
5335
+
5336
+ # Generate an updated Consumer Report for your user
5337
+ # &#x60;/cra/report/create&#x60; generates a Consumer Report for a user. With &#x60;scope&#x60; set to &#x60;PLAID_NETWORK&#x60;, the report is generated from the Plaid Network view of the user&#39;s profile. With &#x60;CLIENT_USER&#x60;, the report is generated from only the Items the user linked to your client. Each requested product is generated asynchronously. Use the returned &#x60;report_id&#x60; to retrieve the report once its products are ready.
5338
+ # @param cra_report_create_request [CraReportCreateRequest]
5339
+ # @param [Hash] opts the optional parameters
5340
+ # @return [Array<(CraReportCreateResponse, Integer, Hash)>] CraReportCreateResponse data, response status code and response headers
5341
+ def cra_report_create_with_http_info(cra_report_create_request, opts = {})
5342
+ if @api_client.config.debugging
5343
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_report_create ...'
5344
+ end
5345
+ # verify the required parameter 'cra_report_create_request' is set
5346
+ if @api_client.config.client_side_validation && cra_report_create_request.nil?
5347
+ fail ArgumentError, "Missing the required parameter 'cra_report_create_request' when calling PlaidApi.cra_report_create"
5348
+ end
5349
+ # resource path
5350
+ local_var_path = '/cra/report/create'
5351
+
5352
+ # query parameters
5353
+ query_params = opts[:query_params] || {}
5354
+
5355
+ # header parameters
5356
+ header_params = opts[:header_params] || {}
5357
+ # HTTP header 'Accept' (if needed)
5358
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5359
+ # HTTP header 'Content-Type'
5360
+ content_type = @api_client.select_header_content_type(['application/json'])
5361
+ if !content_type.nil?
5362
+ header_params['Content-Type'] = content_type
5363
+ end
5364
+
5365
+ # form parameters
5366
+ form_params = opts[:form_params] || {}
5367
+
5368
+ # http body (model)
5369
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_report_create_request)
5370
+
5371
+ # return_type
5372
+ return_type = opts[:debug_return_type] || 'CraReportCreateResponse'
5373
+
5374
+ # auth_names
5375
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5376
+
5377
+ new_options = opts.merge(
5378
+ :operation => :"PlaidApi.cra_report_create",
5379
+ :header_params => header_params,
5380
+ :query_params => query_params,
5381
+ :form_params => form_params,
5382
+ :body => post_body,
5383
+ :auth_names => auth_names,
5384
+ :return_type => return_type
5385
+ )
5386
+
5387
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5388
+ if @api_client.config.debugging
5389
+ @api_client.config.logger.debug "API called: PlaidApi#cra_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5390
+ end
5391
+ return data, status_code, headers
5392
+ end
5393
+
5394
+ # Retrieve a Consumer Report for your user
5395
+ # `/cra/report/get` retrieves a Consumer Report for a user.
5260
5396
  # @param cra_report_get_request [CraReportGetRequest]
5261
5397
  # @param [Hash] opts the optional parameters
5262
5398
  # @return [CraReportGetResponse]
@@ -5265,8 +5401,8 @@ module Plaid
5265
5401
  data
5266
5402
  end
5267
5403
 
5268
- # Retrieve a CRA Report for provided user
5269
- # &#x60;/cra/report/get&#x60; retrieves a CRA Report for a user.
5404
+ # Retrieve a Consumer Report for your user
5405
+ # &#x60;/cra/report/get&#x60; retrieves a Consumer Report for a user.
5270
5406
  # @param cra_report_get_request [CraReportGetRequest]
5271
5407
  # @param [Hash] opts the optional parameters
5272
5408
  # @return [Array<(CraReportGetResponse, Integer, Hash)>] CraReportGetResponse data, response status code and response headers
@@ -5304,7 +5440,7 @@ module Plaid
5304
5440
  return_type = opts[:debug_return_type] || 'CraReportGetResponse'
5305
5441
 
5306
5442
  # auth_names
5307
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5443
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
5308
5444
 
5309
5445
  new_options = opts.merge(
5310
5446
  :operation => :"PlaidApi.cra_report_get",
@@ -6208,7 +6344,7 @@ module Plaid
6208
6344
  end
6209
6345
 
6210
6346
  # Subscribe and unsubscribe to proactive notifications for a user's income profile
6211
- # `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
6347
+ # `/credit/bank_income/webhook/update` is deprecated and no longer available; requests return an `INVALID_REQUEST` error with code `NOT_FOUND`.
6212
6348
  # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
6213
6349
  # @param [Hash] opts the optional parameters
6214
6350
  # @return [CreditBankIncomeWebhookUpdateResponse]
@@ -6218,7 +6354,7 @@ module Plaid
6218
6354
  end
6219
6355
 
6220
6356
  # Subscribe and unsubscribe to proactive notifications for a user&#39;s income profile
6221
- # &#x60;/credit/bank_income/webhook/update&#x60; allows you to subscribe or unsubscribe a user for income webhook notifications. By default, all users start out unsubscribed. If a user is subscribed, on significant changes to the user&#39;s income profile, you will receive a &#x60;BANK_INCOME_REFRESH_UPDATE&#x60; webhook, prompting you to refresh bank income data for the user.
6357
+ # &#x60;/credit/bank_income/webhook/update&#x60; is deprecated and no longer available; requests return an &#x60;INVALID_REQUEST&#x60; error with code &#x60;NOT_FOUND&#x60;.
6222
6358
  # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
6223
6359
  # @param [Hash] opts the optional parameters
6224
6360
  # @return [Array<(CreditBankIncomeWebhookUpdateResponse, Integer, Hash)>] CreditBankIncomeWebhookUpdateResponse data, response status code and response headers
@@ -6616,7 +6752,7 @@ module Plaid
6616
6752
  end
6617
6753
 
6618
6754
  # Check income verification eligibility and optimize conversion
6619
- # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `employer` and `access_tokens` fields. `employer_good` and `employer_bad` will result in `HIGH` and `LOW` confidence values, respectively. `employer_multi` will result in a `HIGH` confidence with multiple payroll options. Likewise, `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other value for `employer` and `access_tokens` in Sandbox will result in `UNKNOWN` confidence.
6755
+ # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the `access_tokens` field. `access_good` and `access_bad` will result in `HIGH` and `LOW` confidence values, respectively. Any other valid Sandbox access token will result in `UNKNOWN` confidence; other strings return an `INVALID_ACCESS_TOKEN` error.
6620
6756
  # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
6621
6757
  # @param [Hash] opts the optional parameters
6622
6758
  # @return [CreditPayrollIncomePrecheckResponse]
@@ -6626,7 +6762,7 @@ module Plaid
6626
6762
  end
6627
6763
 
6628
6764
  # Check income verification eligibility and optimize conversion
6629
- # &#x60;/credit/payroll_income/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing &#x60;employer&#x60; data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the &#x60;employer&#x60; and &#x60;access_tokens&#x60; fields. &#x60;employer_good&#x60; and &#x60;employer_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. &#x60;employer_multi&#x60; will result in a &#x60;HIGH&#x60; confidence with multiple payroll options. Likewise, &#x60;access_good&#x60; and &#x60;access_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. Any other value for &#x60;employer&#x60; and &#x60;access_tokens&#x60; in Sandbox will result in &#x60;UNKNOWN&#x60; confidence.
6765
+ # &#x60;/credit/payroll_income/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing &#x60;employer&#x60; data will increase the chance of receiving a useful result. When testing in Sandbox, you can control the results by providing special test values in the &#x60;access_tokens&#x60; field. &#x60;access_good&#x60; and &#x60;access_bad&#x60; will result in &#x60;HIGH&#x60; and &#x60;LOW&#x60; confidence values, respectively. Any other valid Sandbox access token will result in &#x60;UNKNOWN&#x60; confidence; other strings return an &#x60;INVALID_ACCESS_TOKEN&#x60; error.
6630
6766
  # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
6631
6767
  # @param [Hash] opts the optional parameters
6632
6768
  # @return [Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>] CreditPayrollIncomePrecheckResponse data, response status code and response headers
@@ -8142,7 +8278,7 @@ module Plaid
8142
8278
  return_type = opts[:debug_return_type] || 'IdentityGetResponse'
8143
8279
 
8144
8280
  # auth_names
8145
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8281
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
8146
8282
 
8147
8283
  new_options = opts.merge(
8148
8284
  :operation => :"PlaidApi.identity_get",
@@ -8230,7 +8366,7 @@ module Plaid
8230
8366
  end
8231
8367
 
8232
8368
  # List Link Identity Match attempts
8233
- # Returns a chronological history of Link-originated Identity Match attempts for a client, ordered by creation time with the oldest attempt first. Results are retained for up to one year. Attempts for deleted Items are omitted.
8369
+ # Returns a chronological history of Link-originated Identity Match attempts for a client, ordered by creation time with the oldest attempt first. This endpoint requires separate enablement in addition to access to Identity Match. To request endpoint access, contact your account manager or [submit a product access support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). Results are retained for up to one year. Attempts marked as deleted are omitted.
8234
8370
  # @param identity_match_list_request [IdentityMatchListRequest]
8235
8371
  # @param [Hash] opts the optional parameters
8236
8372
  # @return [IdentityMatchListResponse]
@@ -8240,7 +8376,7 @@ module Plaid
8240
8376
  end
8241
8377
 
8242
8378
  # List Link Identity Match attempts
8243
- # Returns a chronological history of Link-originated Identity Match attempts for a client, ordered by creation time with the oldest attempt first. Results are retained for up to one year. Attempts for deleted Items are omitted.
8379
+ # Returns a chronological history of Link-originated Identity Match attempts for a client, ordered by creation time with the oldest attempt first. This endpoint requires separate enablement in addition to access to Identity Match. To request endpoint access, contact your account manager or [submit a product access support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). Results are retained for up to one year. Attempts marked as deleted are omitted.
8244
8380
  # @param identity_match_list_request [IdentityMatchListRequest]
8245
8381
  # @param [Hash] opts the optional parameters
8246
8382
  # @return [Array<(IdentityMatchListResponse, Integer, Hash)>] IdentityMatchListResponse data, response status code and response headers
@@ -9114,7 +9250,7 @@ module Plaid
9114
9250
  end
9115
9251
 
9116
9252
  # Get details of an institution
9117
- # Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
9253
+ # Returns a JSON response containing details on a specified financial institution. Institutions that Plaid does not support for new connections are still returned by this endpoint, so that an `institution_id` stored on an existing Item can still be looked up. These institutions are not returned by `/institutions/get` or `/institutions/search`, and attempting to create a new Item for one of them returns an `INSTITUTION_NO_LONGER_SUPPORTED` error. Use `connection_availability` to tell the two cases apart. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
9118
9254
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
9119
9255
  # @param [Hash] opts the optional parameters
9120
9256
  # @return [InstitutionsGetByIdResponse]
@@ -9124,7 +9260,7 @@ module Plaid
9124
9260
  end
9125
9261
 
9126
9262
  # Get details of an institution
9127
- # Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; to authenticate to this endpoint. The &#x60;public_key&#x60; has been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
9263
+ # Returns a JSON response containing details on a specified financial institution. Institutions that Plaid does not support for new connections are still returned by this endpoint, so that an &#x60;institution_id&#x60; stored on an existing Item can still be looked up. These institutions are not returned by &#x60;/institutions/get&#x60; or &#x60;/institutions/search&#x60;, and attempting to create a new Item for one of them returns an &#x60;INSTITUTION_NO_LONGER_SUPPORTED&#x60; error. Use &#x60;connection_availability&#x60; to tell the two cases apart. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; to authenticate to this endpoint. The &#x60;public_key&#x60; has been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
9128
9264
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
9129
9265
  # @param [Hash] opts the optional parameters
9130
9266
  # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
@@ -9182,7 +9318,7 @@ module Plaid
9182
9318
  end
9183
9319
 
9184
9320
  # Search institutions
9185
- # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
9321
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Institutions that Plaid does not support for new connections are not included in search results, but can still be retrieved by ID with `/institutions/get_by_id`. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
9186
9322
  # @param institutions_search_request [InstitutionsSearchRequest]
9187
9323
  # @param [Hash] opts the optional parameters
9188
9324
  # @return [InstitutionsSearchResponse]
@@ -9192,7 +9328,7 @@ module Plaid
9192
9328
  end
9193
9329
 
9194
9330
  # Search institutions
9195
- # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; parameters to authenticate to this endpoint. The &#x60;public_key&#x60; parameter has since been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
9331
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Institutions that Plaid does not support for new connections are not included in search results, but can still be retrieved by ID with &#x60;/institutions/get_by_id&#x60;. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; parameters to authenticate to this endpoint. The &#x60;public_key&#x60; parameter has since been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
9196
9332
  # @param institutions_search_request [InstitutionsSearchRequest]
9197
9333
  # @param [Hash] opts the optional parameters
9198
9334
  # @return [Array<(InstitutionsSearchResponse, Integer, Hash)>] InstitutionsSearchResponse data, response status code and response headers
@@ -9386,7 +9522,7 @@ module Plaid
9386
9522
  end
9387
9523
 
9388
9524
  # Refresh investment data
9389
- # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call `/sandbox/item/fire_webhook`. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. 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. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9525
+ # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call `/sandbox/item/fire_webhook`. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCTS_NOT_SUPPORTED` error. 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. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9390
9526
  # @param investments_refresh_request [InvestmentsRefreshRequest]
9391
9527
  # @param [Hash] opts the optional parameters
9392
9528
  # @return [InvestmentsRefreshResponse]
@@ -9396,7 +9532,7 @@ module Plaid
9396
9532
  end
9397
9533
 
9398
9534
  # Refresh investment data
9399
- # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call &#x60;/sandbox/item/fire_webhook&#x60;. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9535
+ # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call &#x60;/sandbox/item/fire_webhook&#x60;. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](https://plaid.com/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9400
9536
  # @param investments_refresh_request [InvestmentsRefreshRequest]
9401
9537
  # @param [Hash] opts the optional parameters
9402
9538
  # @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
@@ -9590,7 +9726,7 @@ module Plaid
9590
9726
  end
9591
9727
 
9592
9728
  # Search for an Issue
9593
- # Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list of `Issue` objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
9729
+ # Search for an issue associated with one of the following identifiers: `item_id`, `link_session_id` or Link session `request_id`. This endpoint returns a list containing at most one issue. If no issues are associated with the provided identifier, `issues` is omitted. At least one of the identifiers must be provided to perform the search.
9594
9730
  # @param issues_search_request [IssuesSearchRequest]
9595
9731
  # @param [Hash] opts the optional parameters
9596
9732
  # @return [IssuesSearchResponse]
@@ -9600,7 +9736,7 @@ module Plaid
9600
9736
  end
9601
9737
 
9602
9738
  # Search for an Issue
9603
- # Search for an issue associated with one of the following identifiers: &#x60;item_id&#x60;, &#x60;link_session_id&#x60; or Link session &#x60;request_id&#x60;. This endpoint returns a list of &#x60;Issue&#x60; objects, with an empty list indicating that no issues are associated with the provided identifier. At least one of the identifiers must be provided to perform the search.
9739
+ # Search for an issue associated with one of the following identifiers: &#x60;item_id&#x60;, &#x60;link_session_id&#x60; or Link session &#x60;request_id&#x60;. This endpoint returns a list containing at most one issue. If no issues are associated with the provided identifier, &#x60;issues&#x60; is omitted. At least one of the identifiers must be provided to perform the search.
9604
9740
  # @param issues_search_request [IssuesSearchRequest]
9605
9741
  # @param [Hash] opts the optional parameters
9606
9742
  # @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
@@ -10182,7 +10318,7 @@ module Plaid
10182
10318
  return_type = opts[:debug_return_type] || 'ItemGetResponse'
10183
10319
 
10184
10320
  # auth_names
10185
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10321
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
10186
10322
 
10187
10323
  new_options = opts.merge(
10188
10324
  :operation => :"PlaidApi.item_get",
@@ -10386,7 +10522,7 @@ module Plaid
10386
10522
  return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
10387
10523
 
10388
10524
  # auth_names
10389
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10525
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
10390
10526
 
10391
10527
  new_options = opts.merge(
10392
10528
  :operation => :"PlaidApi.item_public_token_exchange",
@@ -10542,7 +10678,7 @@ module Plaid
10542
10678
  end
10543
10679
 
10544
10680
  # Retrieve Liabilities data
10545
- # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
10681
+ # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Supported account types are account type `credit` with account subtype `credit card` or `paypal`; and account type `loan` with account subtype `auto`, `commercial`, `commercial line of credit`, `consumer`, `home equity`, `home equity loan`, `line of credit`, `loan`, `mortgage`, or `student`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). To receive the expanded loan subtype values, use plaid-go 10.1.0 or later, plaid-java 44.0.0 or later, plaid-python 8.3.0 or later, or plaid-ruby 14.4.0 or later. Earlier client library versions may receive `loan` instead of `home equity loan` and `line of credit` instead of `commercial line of credit`. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`.
10546
10682
  # @param liabilities_get_request [LiabilitiesGetRequest]
10547
10683
  # @param [Hash] opts the optional parameters
10548
10684
  # @return [LiabilitiesGetResponse]
@@ -10552,7 +10688,7 @@ module Plaid
10552
10688
  end
10553
10689
 
10554
10690
  # Retrieve Liabilities data
10555
- # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;.
10691
+ # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;; and account type &#x60;loan&#x60; with account subtype &#x60;auto&#x60;, &#x60;commercial&#x60;, &#x60;commercial line of credit&#x60;, &#x60;consumer&#x60;, &#x60;home equity&#x60;, &#x60;home equity loan&#x60;, &#x60;line of credit&#x60;, &#x60;loan&#x60;, &#x60;mortgage&#x60;, or &#x60;student&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/link/#linktokencreate). To receive the expanded loan subtype values, use plaid-go 10.1.0 or later, plaid-java 44.0.0 or later, plaid-python 8.3.0 or later, or plaid-ruby 14.4.0 or later. Earlier client library versions may receive &#x60;loan&#x60; instead of &#x60;home equity loan&#x60; and &#x60;line of credit&#x60; instead of &#x60;commercial line of credit&#x60;. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;.
10556
10692
  # @param liabilities_get_request [LiabilitiesGetRequest]
10557
10693
  # @param [Hash] opts the optional parameters
10558
10694
  # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
@@ -10609,142 +10745,6 @@ module Plaid
10609
10745
  return data, status_code, headers
10610
10746
  end
10611
10747
 
10612
- # Create Hosted Link session
10613
- # Use the `/link_delivery/create` endpoint to create a Hosted Link session.
10614
- # @param link_delivery_create_request [LinkDeliveryCreateRequest]
10615
- # @param [Hash] opts the optional parameters
10616
- # @return [LinkDeliveryCreateResponse]
10617
- def link_delivery_create(link_delivery_create_request, opts = {})
10618
- data, _status_code, _headers = link_delivery_create_with_http_info(link_delivery_create_request, opts)
10619
- data
10620
- end
10621
-
10622
- # Create Hosted Link session
10623
- # Use the &#x60;/link_delivery/create&#x60; endpoint to create a Hosted Link session.
10624
- # @param link_delivery_create_request [LinkDeliveryCreateRequest]
10625
- # @param [Hash] opts the optional parameters
10626
- # @return [Array<(LinkDeliveryCreateResponse, Integer, Hash)>] LinkDeliveryCreateResponse data, response status code and response headers
10627
- def link_delivery_create_with_http_info(link_delivery_create_request, opts = {})
10628
- if @api_client.config.debugging
10629
- @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_create ...'
10630
- end
10631
- # verify the required parameter 'link_delivery_create_request' is set
10632
- if @api_client.config.client_side_validation && link_delivery_create_request.nil?
10633
- fail ArgumentError, "Missing the required parameter 'link_delivery_create_request' when calling PlaidApi.link_delivery_create"
10634
- end
10635
- # resource path
10636
- local_var_path = '/link_delivery/create'
10637
-
10638
- # query parameters
10639
- query_params = opts[:query_params] || {}
10640
-
10641
- # header parameters
10642
- header_params = opts[:header_params] || {}
10643
- # HTTP header 'Accept' (if needed)
10644
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10645
- # HTTP header 'Content-Type'
10646
- content_type = @api_client.select_header_content_type(['application/json'])
10647
- if !content_type.nil?
10648
- header_params['Content-Type'] = content_type
10649
- end
10650
-
10651
- # form parameters
10652
- form_params = opts[:form_params] || {}
10653
-
10654
- # http body (model)
10655
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_create_request)
10656
-
10657
- # return_type
10658
- return_type = opts[:debug_return_type] || 'LinkDeliveryCreateResponse'
10659
-
10660
- # auth_names
10661
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10662
-
10663
- new_options = opts.merge(
10664
- :operation => :"PlaidApi.link_delivery_create",
10665
- :header_params => header_params,
10666
- :query_params => query_params,
10667
- :form_params => form_params,
10668
- :body => post_body,
10669
- :auth_names => auth_names,
10670
- :return_type => return_type
10671
- )
10672
-
10673
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10674
- if @api_client.config.debugging
10675
- @api_client.config.logger.debug "API called: PlaidApi#link_delivery_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10676
- end
10677
- return data, status_code, headers
10678
- end
10679
-
10680
- # Get Hosted Link session
10681
- # Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.
10682
- # @param link_delivery_get_request [LinkDeliveryGetRequest]
10683
- # @param [Hash] opts the optional parameters
10684
- # @return [LinkDeliveryGetResponse]
10685
- def link_delivery_get(link_delivery_get_request, opts = {})
10686
- data, _status_code, _headers = link_delivery_get_with_http_info(link_delivery_get_request, opts)
10687
- data
10688
- end
10689
-
10690
- # Get Hosted Link session
10691
- # Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Hosted Link session.
10692
- # @param link_delivery_get_request [LinkDeliveryGetRequest]
10693
- # @param [Hash] opts the optional parameters
10694
- # @return [Array<(LinkDeliveryGetResponse, Integer, Hash)>] LinkDeliveryGetResponse data, response status code and response headers
10695
- def link_delivery_get_with_http_info(link_delivery_get_request, opts = {})
10696
- if @api_client.config.debugging
10697
- @api_client.config.logger.debug 'Calling API: PlaidApi.link_delivery_get ...'
10698
- end
10699
- # verify the required parameter 'link_delivery_get_request' is set
10700
- if @api_client.config.client_side_validation && link_delivery_get_request.nil?
10701
- fail ArgumentError, "Missing the required parameter 'link_delivery_get_request' when calling PlaidApi.link_delivery_get"
10702
- end
10703
- # resource path
10704
- local_var_path = '/link_delivery/get'
10705
-
10706
- # query parameters
10707
- query_params = opts[:query_params] || {}
10708
-
10709
- # header parameters
10710
- header_params = opts[:header_params] || {}
10711
- # HTTP header 'Accept' (if needed)
10712
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10713
- # HTTP header 'Content-Type'
10714
- content_type = @api_client.select_header_content_type(['application/json'])
10715
- if !content_type.nil?
10716
- header_params['Content-Type'] = content_type
10717
- end
10718
-
10719
- # form parameters
10720
- form_params = opts[:form_params] || {}
10721
-
10722
- # http body (model)
10723
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_delivery_get_request)
10724
-
10725
- # return_type
10726
- return_type = opts[:debug_return_type] || 'LinkDeliveryGetResponse'
10727
-
10728
- # auth_names
10729
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10730
-
10731
- new_options = opts.merge(
10732
- :operation => :"PlaidApi.link_delivery_get",
10733
- :header_params => header_params,
10734
- :query_params => query_params,
10735
- :form_params => form_params,
10736
- :body => post_body,
10737
- :auth_names => auth_names,
10738
- :return_type => return_type
10739
- )
10740
-
10741
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10742
- if @api_client.config.debugging
10743
- @api_client.config.logger.debug "API called: PlaidApi#link_delivery_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10744
- end
10745
- return data, status_code, headers
10746
- end
10747
-
10748
10748
  # Exchange the Link Correlation ID for a Link Token
10749
10749
  # 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`.
10750
10750
  # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
@@ -10862,7 +10862,7 @@ module Plaid
10862
10862
  return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
10863
10863
 
10864
10864
  # auth_names
10865
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10865
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
10866
10866
 
10867
10867
  new_options = opts.merge(
10868
10868
  :operation => :"PlaidApi.link_token_create",
@@ -11902,7 +11902,7 @@ module Plaid
11902
11902
  end
11903
11903
 
11904
11904
  # Get payment details
11905
- # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment's status is unreliable and may trigger API rate limits. Only the `payment_status_update` webhook should be used to receive real-time status updates in Production.
11905
+ # The `/payment_initiation/payment/get` endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the `/payment_initiation/payment/get` endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling `/payment_initiation/payment/get` to check a payment's status is unreliable and may trigger API rate limits. Only the `PAYMENT_STATUS_UPDATE` webhook should be used to receive real-time status updates in Production.
11906
11906
  # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
11907
11907
  # @param [Hash] opts the optional parameters
11908
11908
  # @return [PaymentInitiationPaymentGetResponse]
@@ -11912,7 +11912,7 @@ module Plaid
11912
11912
  end
11913
11913
 
11914
11914
  # Get payment details
11915
- # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;payment_status_update&#x60; webhook should be used to receive real-time status updates in Production.
11915
+ # The &#x60;/payment_initiation/payment/get&#x60; endpoint can be used to check the status of a payment, as well as to receive basic information such as recipient and payment amount. In the case of standing orders, the &#x60;/payment_initiation/payment/get&#x60; endpoint will provide information about the status of the overall standing order itself; the API cannot be used to retrieve payment status for individual payments within a standing order. Polling for status updates in Production is highly discouraged. Repeatedly calling &#x60;/payment_initiation/payment/get&#x60; to check a payment&#39;s status is unreliable and may trigger API rate limits. Only the &#x60;PAYMENT_STATUS_UPDATE&#x60; webhook should be used to receive real-time status updates in Production.
11916
11916
  # @param payment_initiation_payment_get_request [PaymentInitiationPaymentGetRequest]
11917
11917
  # @param [Hash] opts the optional parameters
11918
11918
  # @return [Array<(PaymentInitiationPaymentGetResponse, Integer, Hash)>] PaymentInitiationPaymentGetResponse data, response status code and response headers
@@ -12718,7 +12718,7 @@ module Plaid
12718
12718
  end
12719
12719
 
12720
12720
  # Retrieve Balance data
12721
- # The `/processor/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
12721
+ # The `/processor/balance/get` endpoint returns the real-time balance for the account associated with the processor token. While other endpoints may return a balance object, only `/processor/balance/get` forces the available and current balance fields to be refreshed rather than cached.
12722
12722
  # @param processor_balance_get_request [ProcessorBalanceGetRequest] The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of &#x60;null&#x60;.
12723
12723
  # @param [Hash] opts the optional parameters
12724
12724
  # @return [ProcessorBalanceGetResponse]
@@ -12728,7 +12728,7 @@ module Plaid
12728
12728
  end
12729
12729
 
12730
12730
  # Retrieve Balance data
12731
- # The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for each of an Item&#39;s accounts. While other endpoints may return a balance object, only &#x60;/processor/balance/get&#x60; forces the available and current balance fields to be refreshed rather than cached.
12731
+ # The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with the processor token. While other endpoints may return a balance object, only &#x60;/processor/balance/get&#x60; forces the available and current balance fields to be refreshed rather than cached.
12732
12732
  # @param processor_balance_get_request [ProcessorBalanceGetRequest] The &#x60;/processor/balance/get&#x60; endpoint returns the real-time balance for the account associated with a given &#x60;processor_token&#x60;. The current balance is the total amount of funds in the account. The available balance is the current balance less any outstanding holds or debits that have not yet posted to the account. Note that not all institutions calculate the available balance. In the event that available balance is unavailable from the institution, Plaid will return an available balance value of &#x60;null&#x60;.
12733
12733
  # @param [Hash] opts the optional parameters
12734
12734
  # @return [Array<(ProcessorBalanceGetResponse, Integer, Hash)>] ProcessorBalanceGetResponse data, response status code and response headers
@@ -13874,7 +13874,7 @@ module Plaid
13874
13874
  end
13875
13875
 
13876
13876
  # Get transaction data
13877
- # The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student` or `mortgage`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13877
+ # The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and loan-type accounts (coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13878
13878
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
13879
13879
  # @param [Hash] opts the optional parameters
13880
13880
  # @return [ProcessorTransactionsGetResponse]
@@ -13884,7 +13884,7 @@ module Plaid
13884
13884
  end
13885
13885
 
13886
13886
  # Get transaction data
13887
- # The &#x60;/processor/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/processor/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/processor/transactions/get&#x60; will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13887
+ # The &#x60;/processor/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and loan-type accounts (coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/processor/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/processor/transactions/get&#x60; will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
13888
13888
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
13889
13889
  # @param [Hash] opts the optional parameters
13890
13890
  # @return [Array<(ProcessorTransactionsGetResponse, Integer, Hash)>] ProcessorTransactionsGetResponse data, response status code and response headers
@@ -14078,7 +14078,7 @@ module Plaid
14078
14078
  end
14079
14079
 
14080
14080
  # Get incremental transaction updates on a processor token
14081
- # The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student` or `mortgage`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g. due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
14081
+ # 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 `loan`-type accounts. For `investments` accounts, use `/processor/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.
14082
14082
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
14083
14083
  # @param [Hash] opts the optional parameters
14084
14084
  # @return [ProcessorTransactionsSyncResponse]
@@ -14088,7 +14088,7 @@ module Plaid
14088
14088
  end
14089
14089
 
14090
14090
  # Get incremental transaction updates on a processor token
14091
- # The &#x60;/processor/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g. due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
14091
+ # 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 &#x60;loan&#x60;-type accounts. For &#x60;investments&#x60; accounts, use &#x60;/processor/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.
14092
14092
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
14093
14093
  # @param [Hash] opts the optional parameters
14094
14094
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -14281,6 +14281,74 @@ module Plaid
14281
14281
  return data, status_code, headers
14282
14282
  end
14283
14283
 
14284
+ # Upload a file of cash advance feedback
14285
+ # Upload a CSV file of cash advance decision or repayment feedback. Each row is equivalent to one call to `/protect/cash_advance/decision/create` or `/protect/cash_advance/repayment/create`. Send the request as `multipart/form-data` with `client_id` and `secret` in the `PLAID-CLIENT-ID` and `PLAID-SECRET` headers. The file is accepted for asynchronous processing; the response contains a `request_id` and an `upload_id` that identifies the upload.
14286
+ # @param protect_cash_advance_feedback_upload_request [ProtectCashAdvanceFeedbackUploadRequest]
14287
+ # @param [Hash] opts the optional parameters
14288
+ # @return [ProtectCashAdvanceFeedbackUploadResponse]
14289
+ def protect_cash_advance_feedback_upload(protect_cash_advance_feedback_upload_request, opts = {})
14290
+ data, _status_code, _headers = protect_cash_advance_feedback_upload_with_http_info(protect_cash_advance_feedback_upload_request, opts)
14291
+ data
14292
+ end
14293
+
14294
+ # Upload a file of cash advance feedback
14295
+ # Upload a CSV file of cash advance decision or repayment feedback. Each row is equivalent to one call to &#x60;/protect/cash_advance/decision/create&#x60; or &#x60;/protect/cash_advance/repayment/create&#x60;. Send the request as &#x60;multipart/form-data&#x60; with &#x60;client_id&#x60; and &#x60;secret&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; and &#x60;PLAID-SECRET&#x60; headers. The file is accepted for asynchronous processing; the response contains a &#x60;request_id&#x60; and an &#x60;upload_id&#x60; that identifies the upload.
14296
+ # @param protect_cash_advance_feedback_upload_request [ProtectCashAdvanceFeedbackUploadRequest]
14297
+ # @param [Hash] opts the optional parameters
14298
+ # @return [Array<(ProtectCashAdvanceFeedbackUploadResponse, Integer, Hash)>] ProtectCashAdvanceFeedbackUploadResponse data, response status code and response headers
14299
+ def protect_cash_advance_feedback_upload_with_http_info(protect_cash_advance_feedback_upload_request, opts = {})
14300
+ if @api_client.config.debugging
14301
+ @api_client.config.logger.debug 'Calling API: PlaidApi.protect_cash_advance_feedback_upload ...'
14302
+ end
14303
+ # verify the required parameter 'protect_cash_advance_feedback_upload_request' is set
14304
+ if @api_client.config.client_side_validation && protect_cash_advance_feedback_upload_request.nil?
14305
+ fail ArgumentError, "Missing the required parameter 'protect_cash_advance_feedback_upload_request' when calling PlaidApi.protect_cash_advance_feedback_upload"
14306
+ end
14307
+ # resource path
14308
+ local_var_path = '/protect/cash_advance/feedback/upload'
14309
+
14310
+ # query parameters
14311
+ query_params = opts[:query_params] || {}
14312
+
14313
+ # header parameters
14314
+ header_params = opts[:header_params] || {}
14315
+ # HTTP header 'Accept' (if needed)
14316
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14317
+ # HTTP header 'Content-Type'
14318
+ content_type = @api_client.select_header_content_type(['application/json'])
14319
+ if !content_type.nil?
14320
+ header_params['Content-Type'] = content_type
14321
+ end
14322
+
14323
+ # form parameters
14324
+ form_params = opts[:form_params] || {}
14325
+
14326
+ # http body (model)
14327
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_cash_advance_feedback_upload_request)
14328
+
14329
+ # return_type
14330
+ return_type = opts[:debug_return_type] || 'ProtectCashAdvanceFeedbackUploadResponse'
14331
+
14332
+ # auth_names
14333
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
14334
+
14335
+ new_options = opts.merge(
14336
+ :operation => :"PlaidApi.protect_cash_advance_feedback_upload",
14337
+ :header_params => header_params,
14338
+ :query_params => query_params,
14339
+ :form_params => form_params,
14340
+ :body => post_body,
14341
+ :auth_names => auth_names,
14342
+ :return_type => return_type
14343
+ )
14344
+
14345
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
14346
+ if @api_client.config.debugging
14347
+ @api_client.config.logger.debug "API called: PlaidApi#protect_cash_advance_feedback_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14348
+ end
14349
+ return data, status_code, headers
14350
+ end
14351
+
14284
14352
  # Record a cash advance repayment
14285
14353
  # Use this endpoint to record a cash-advance repayment as feedback. A repayment is a record paying back all or some of a previously-taken cash-advance.
14286
14354
  # @param protect_cash_advance_repayment_create_request [ProtectCashAdvanceRepaymentCreateRequest]
@@ -14350,7 +14418,7 @@ module Plaid
14350
14418
  end
14351
14419
 
14352
14420
  # Compute Protect Trust Index scores and subscores
14353
- # 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-3-<client>` scores a completed Link session for fraud risk; `cash-advance-onboarding-<client>-1.0` scores repayment risk for a first-time cash advance and `cash-advance-ongoing-<client>-1.0` scores subsequent advances, both additionally populating 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.
14421
+ # 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-3-<client>` scores a completed Link session for fraud risk; `cash-advance-ongoing-<client>-1.0` scores repayment risk for a cash advance, additionally populating 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. For device-session models, the endpoint may return retryable `error_code` = `SESSION_NOT_READY` until the Protect SDK has delivered device data for the session.
14354
14422
  # @param protect_compute_request [ProtectComputeRequest]
14355
14423
  # @param [Hash] opts the optional parameters
14356
14424
  # @return [ProtectComputeResponse]
@@ -14360,7 +14428,7 @@ module Plaid
14360
14428
  end
14361
14429
 
14362
14430
  # Compute Protect Trust Index scores and subscores
14363
- # 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-3-&lt;client&gt;&#x60; scores a completed Link session for fraud risk; &#x60;cash-advance-onboarding-&lt;client&gt;-1.0&#x60; scores repayment risk for a first-time cash advance and &#x60;cash-advance-ongoing-&lt;client&gt;-1.0&#x60; scores subsequent advances, both additionally populating 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.
14431
+ # 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-3-&lt;client&gt;&#x60; scores a completed Link session for fraud risk; &#x60;cash-advance-ongoing-&lt;client&gt;-1.0&#x60; scores repayment risk for a cash advance, additionally populating 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. For device-session models, the endpoint may return retryable &#x60;error_code&#x60; &#x3D; &#x60;SESSION_NOT_READY&#x60; until the Protect SDK has delivered device data for the session.
14364
14432
  # @param protect_compute_request [ProtectComputeRequest]
14365
14433
  # @param [Hash] opts the optional parameters
14366
14434
  # @return [Array<(ProtectComputeResponse, Integer, Hash)>] ProtectComputeResponse data, response status code and response headers
@@ -15234,7 +15302,7 @@ module Plaid
15234
15302
  end
15235
15303
 
15236
15304
  # Fire a test webhook
15237
- # 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 Chase, PNC, and Truist 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`).
15305
+ # 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 your client is not enabled for Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If your client is not enabled for 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 Chase, PNC, and Truist 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`).
15238
15306
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
15239
15307
  # @param [Hash] opts the optional parameters
15240
15308
  # @return [SandboxItemFireWebhookResponse]
@@ -15244,7 +15312,7 @@ module Plaid
15244
15312
  end
15245
15313
 
15246
15314
  # Fire a test webhook
15247
- # 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 Chase, PNC, and Truist 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;).
15315
+ # 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 your client is not enabled for 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 your client is not enabled for 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 Chase, PNC, and Truist 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;).
15248
15316
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
15249
15317
  # @param [Hash] opts the optional parameters
15250
15318
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -15778,7 +15846,7 @@ module Plaid
15778
15846
  end
15779
15847
 
15780
15848
  # Create sandbox transactions
15781
- # 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.
15849
+ # 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 be used with any Item created in the Sandbox environment. Added transactions persist across subsequent calls to `/transactions/get` and `/transactions/sync`. Each transaction is added to the account named by its `account_id`. When `account_id` is omitted, the transaction is added to the Item's checking account, or, for a custom Sandbox user, to the first depository account listed in its `override_accounts`, or its first account if it has no depository account.
15782
15850
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
15783
15851
  # @param [Hash] opts the optional parameters
15784
15852
  # @return [SandboxTransactionsCreateResponse]
@@ -15788,7 +15856,7 @@ module Plaid
15788
15856
  end
15789
15857
 
15790
15858
  # Create sandbox transactions
15791
- # 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.
15859
+ # 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 be used with any Item created in the Sandbox environment. Added transactions persist across subsequent calls to &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60;. Each transaction is added to the account named by its &#x60;account_id&#x60;. When &#x60;account_id&#x60; is omitted, the transaction is added to the Item&#39;s checking account, or, for a custom Sandbox user, to the first depository account listed in its &#x60;override_accounts&#x60;, or its first account if it has no depository account.
15792
15860
  # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
15793
15861
  # @param [Hash] opts the optional parameters
15794
15862
  # @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
@@ -16185,74 +16253,6 @@ module Plaid
16185
16253
  return data, status_code, headers
16186
16254
  end
16187
16255
 
16188
- # Trigger the creation of a repayment
16189
- # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, a 400 error is returned.
16190
- # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
16191
- # @param [Hash] opts the optional parameters
16192
- # @return [SandboxTransferRepaymentSimulateResponse]
16193
- def sandbox_transfer_repayment_simulate(sandbox_transfer_repayment_simulate_request, opts = {})
16194
- data, _status_code, _headers = sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts)
16195
- data
16196
- end
16197
-
16198
- # Trigger the creation of a repayment
16199
- # Use the &#x60;/sandbox/transfer/repayment/simulate&#x60; endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, a 400 error is returned.
16200
- # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
16201
- # @param [Hash] opts the optional parameters
16202
- # @return [Array<(SandboxTransferRepaymentSimulateResponse, Integer, Hash)>] SandboxTransferRepaymentSimulateResponse data, response status code and response headers
16203
- def sandbox_transfer_repayment_simulate_with_http_info(sandbox_transfer_repayment_simulate_request, opts = {})
16204
- if @api_client.config.debugging
16205
- @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_repayment_simulate ...'
16206
- end
16207
- # verify the required parameter 'sandbox_transfer_repayment_simulate_request' is set
16208
- if @api_client.config.client_side_validation && sandbox_transfer_repayment_simulate_request.nil?
16209
- fail ArgumentError, "Missing the required parameter 'sandbox_transfer_repayment_simulate_request' when calling PlaidApi.sandbox_transfer_repayment_simulate"
16210
- end
16211
- # resource path
16212
- local_var_path = '/sandbox/transfer/repayment/simulate'
16213
-
16214
- # query parameters
16215
- query_params = opts[:query_params] || {}
16216
-
16217
- # header parameters
16218
- header_params = opts[:header_params] || {}
16219
- # HTTP header 'Accept' (if needed)
16220
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16221
- # HTTP header 'Content-Type'
16222
- content_type = @api_client.select_header_content_type(['application/json'])
16223
- if !content_type.nil?
16224
- header_params['Content-Type'] = content_type
16225
- end
16226
-
16227
- # form parameters
16228
- form_params = opts[:form_params] || {}
16229
-
16230
- # http body (model)
16231
- post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_repayment_simulate_request)
16232
-
16233
- # return_type
16234
- return_type = opts[:debug_return_type] || 'SandboxTransferRepaymentSimulateResponse'
16235
-
16236
- # auth_names
16237
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16238
-
16239
- new_options = opts.merge(
16240
- :operation => :"PlaidApi.sandbox_transfer_repayment_simulate",
16241
- :header_params => header_params,
16242
- :query_params => query_params,
16243
- :form_params => form_params,
16244
- :body => post_body,
16245
- :auth_names => auth_names,
16246
- :return_type => return_type
16247
- )
16248
-
16249
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16250
- if @api_client.config.debugging
16251
- @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_repayment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16252
- end
16253
- return data, status_code, headers
16254
- end
16255
-
16256
16256
  # Simulate a transfer event in Sandbox
16257
16257
  # Use the `/sandbox/transfer/simulate` endpoint to simulate a transfer event in the Sandbox environment. Note that while an event will be simulated and will appear when using endpoints such as `/transfer/event/sync` or `/transfer/event/list`, no transactions will actually take place and funds will not move between accounts, even within the Sandbox.
16258
16258
  # @param sandbox_transfer_simulate_request [SandboxTransferSimulateRequest]
@@ -16594,7 +16594,7 @@ module Plaid
16594
16594
  end
16595
16595
 
16596
16596
  # List test clocks
16597
- # Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
16597
+ # Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by descending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
16598
16598
  # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
16599
16599
  # @param [Hash] opts the optional parameters
16600
16600
  # @return [SandboxTransferTestClockListResponse]
@@ -16604,7 +16604,7 @@ module Plaid
16604
16604
  end
16605
16605
 
16606
16606
  # List test clocks
16607
- # Use the &#x60;/sandbox/transfer/test_clock/list&#x60; endpoint to see a list of all your test clocks in the Sandbox environment, by ascending &#x60;virtual_time&#x60;. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired test clocks.
16607
+ # Use the &#x60;/sandbox/transfer/test_clock/list&#x60; endpoint to see a list of all your test clocks in the Sandbox environment, by descending &#x60;virtual_time&#x60;. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired test clocks.
16608
16608
  # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
16609
16609
  # @param [Hash] opts the optional parameters
16610
16610
  # @return [Array<(SandboxTransferTestClockListResponse, Integer, Hash)>] SandboxTransferTestClockListResponse data, response status code and response headers
@@ -17409,74 +17409,6 @@ module Plaid
17409
17409
  return data, status_code, headers
17410
17410
  end
17411
17411
 
17412
- # Enhance locally-held transaction data
17413
- # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
17414
- # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
17415
- # @param [Hash] opts the optional parameters
17416
- # @return [TransactionsEnhanceGetResponse]
17417
- def transactions_enhance(transactions_enhance_get_request, opts = {})
17418
- data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
17419
- data
17420
- end
17421
-
17422
- # Enhance locally-held transaction data
17423
- # The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
17424
- # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
17425
- # @param [Hash] opts the optional parameters
17426
- # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
17427
- def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
17428
- if @api_client.config.debugging
17429
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
17430
- end
17431
- # verify the required parameter 'transactions_enhance_get_request' is set
17432
- if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
17433
- fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
17434
- end
17435
- # resource path
17436
- local_var_path = '/beta/transactions/v1/enhance'
17437
-
17438
- # query parameters
17439
- query_params = opts[:query_params] || {}
17440
-
17441
- # header parameters
17442
- header_params = opts[:header_params] || {}
17443
- # HTTP header 'Accept' (if needed)
17444
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17445
- # HTTP header 'Content-Type'
17446
- content_type = @api_client.select_header_content_type(['application/json'])
17447
- if !content_type.nil?
17448
- header_params['Content-Type'] = content_type
17449
- end
17450
-
17451
- # form parameters
17452
- form_params = opts[:form_params] || {}
17453
-
17454
- # http body (model)
17455
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)
17456
-
17457
- # return_type
17458
- return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'
17459
-
17460
- # auth_names
17461
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17462
-
17463
- new_options = opts.merge(
17464
- :operation => :"PlaidApi.transactions_enhance",
17465
- :header_params => header_params,
17466
- :query_params => query_params,
17467
- :form_params => form_params,
17468
- :body => post_body,
17469
- :auth_names => auth_names,
17470
- :return_type => return_type
17471
- )
17472
-
17473
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17474
- if @api_client.config.debugging
17475
- @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17476
- end
17477
- return data, status_code, headers
17478
- end
17479
-
17480
17412
  # Enrich locally-held transaction data
17481
17413
  # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
17482
17414
  # @param transactions_enrich_request [TransactionsEnrichRequest]
@@ -17546,7 +17478,7 @@ module Plaid
17546
17478
  end
17547
17479
 
17548
17480
  # Get transaction data
17549
- # Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student` or `mortgage`; coverage may be limited). For transaction history from investment accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
17481
+ # Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and loan-type accounts (coverage may be limited). For transaction history from investment accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
17550
17482
  # @param transactions_get_request [TransactionsGetRequest]
17551
17483
  # @param [Hash] opts the optional parameters
17552
17484
  # @return [TransactionsGetResponse]
@@ -17556,7 +17488,7 @@ module Plaid
17556
17488
  end
17557
17489
 
17558
17490
  # Get transaction data
17559
- # Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;; coverage may be limited). For transaction history from investment accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
17491
+ # Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and loan-type accounts (coverage may be limited). For transaction history from investment accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
17560
17492
  # @param transactions_get_request [TransactionsGetRequest]
17561
17493
  # @param [Hash] opts the optional parameters
17562
17494
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -17817,8 +17749,8 @@ module Plaid
17817
17749
  return data, status_code, headers
17818
17750
  end
17819
17751
 
17820
- # Return a list of rules created for the Item associated with the access token.
17821
- # The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
17752
+ # Return a list of rules created for the end user.
17753
+ # The `/beta/transactions/rules/v1/list` returns a list of transaction rules created for the end user specified by `client_user_id`.
17822
17754
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
17823
17755
  # @param [Hash] opts the optional parameters
17824
17756
  # @return [TransactionsRulesListResponse]
@@ -17827,8 +17759,8 @@ module Plaid
17827
17759
  data
17828
17760
  end
17829
17761
 
17830
- # Return a list of rules created for the Item associated with the access token.
17831
- # The &#x60;/beta/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
17762
+ # Return a list of rules created for the end user.
17763
+ # The &#x60;/beta/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the end user specified by &#x60;client_user_id&#x60;.
17832
17764
  # @param transactions_rules_list_request [TransactionsRulesListRequest]
17833
17765
  # @param [Hash] opts the optional parameters
17834
17766
  # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
@@ -17954,7 +17886,7 @@ module Plaid
17954
17886
  end
17955
17887
 
17956
17888
  # Get incremental transaction updates on an Item
17957
- # The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student` or `mortgage`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update (e.g. due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
17889
+ # 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 `loan`-type accounts. 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.
17958
17890
  # @param transactions_sync_request [TransactionsSyncRequest]
17959
17891
  # @param [Hash] opts the optional parameters
17960
17892
  # @return [TransactionsSyncResponse]
@@ -17964,7 +17896,7 @@ module Plaid
17964
17896
  end
17965
17897
 
17966
17898
  # Get incremental transaction updates on an Item
17967
- # The &#x60;/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g. due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
17899
+ # 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 &#x60;loan&#x60;-type accounts. 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.
17968
17900
  # @param transactions_sync_request [TransactionsSyncRequest]
17969
17901
  # @param [Hash] opts the optional parameters
17970
17902
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -18002,7 +17934,7 @@ module Plaid
18002
17934
  return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
18003
17935
 
18004
17936
  # auth_names
18005
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17937
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
18006
17938
 
18007
17939
  new_options = opts.merge(
18008
17940
  :operation => :"PlaidApi.transactions_sync",
@@ -18498,7 +18430,7 @@ module Plaid
18498
18430
  end
18499
18431
 
18500
18432
  # Create a transfer
18501
- # Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `transfer_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
18433
+ # Use the `/transfer/create` endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided `authorization_id` has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
18502
18434
  # @param transfer_create_request [TransferCreateRequest]
18503
18435
  # @param [Hash] opts the optional parameters
18504
18436
  # @return [TransferCreateResponse]
@@ -18508,7 +18440,7 @@ module Plaid
18508
18440
  end
18509
18441
 
18510
18442
  # Create a transfer
18511
- # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided &#x60;transfer_id&#x60; has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
18443
+ # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer. This endpoint is retryable and idempotent; if a transfer with the provided &#x60;authorization_id&#x60; has already been created, it will return the transfer details without creating a new transfer. A transfer may still be created if a 500 error is returned; to detect this scenario, use [Transfer events](https://plaid.com/docs/transfer/reconciling-transfers/).
18512
18444
  # @param transfer_create_request [TransferCreateRequest]
18513
18445
  # @param [Hash] opts the optional parameters
18514
18446
  # @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
@@ -20674,7 +20606,7 @@ module Plaid
20674
20606
  end
20675
20607
 
20676
20608
  # Lists historical repayments
20677
- # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
20609
+ # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_date`.
20678
20610
  # @param transfer_repayment_list_request [TransferRepaymentListRequest]
20679
20611
  # @param [Hash] opts the optional parameters
20680
20612
  # @return [TransferRepaymentListResponse]
@@ -20684,7 +20616,7 @@ module Plaid
20684
20616
  end
20685
20617
 
20686
20618
  # Lists historical repayments
20687
- # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.
20619
+ # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_date&#x60;.
20688
20620
  # @param transfer_repayment_list_request [TransferRepaymentListRequest]
20689
20621
  # @param [Hash] opts the optional parameters
20690
20622
  # @return [Array<(TransferRepaymentListResponse, Integer, Hash)>] TransferRepaymentListResponse data, response status code and response headers
@@ -20810,7 +20742,7 @@ module Plaid
20810
20742
  end
20811
20743
 
20812
20744
  # Report a return recovery
20813
- # Use the `/transfer/return/recover` endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the original transfer's amount.
20745
+ # Use the `/transfer/return/recover` endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the guaranteed amount of the original transfer.
20814
20746
  # @param transfer_return_recover_request [TransferReturnRecoverRequest]
20815
20747
  # @param [Hash] opts the optional parameters
20816
20748
  # @return [TransferReturnRecoverResponse]
@@ -20820,7 +20752,7 @@ module Plaid
20820
20752
  end
20821
20753
 
20822
20754
  # Report a return recovery
20823
- # Use the &#x60;/transfer/return/recover&#x60; endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the original transfer&#39;s amount.
20755
+ # Use the &#x60;/transfer/return/recover&#x60; endpoint to notify Plaid that you have recovered some or all of the loss on a returned guaranteed transfer. Recovery can be reported in full or in parts; the sum of recovered amounts across calls cannot exceed the guaranteed amount of the original transfer.
20824
20756
  # @param transfer_return_recover_request [TransferReturnRecoverRequest]
20825
20757
  # @param [Hash] opts the optional parameters
20826
20758
  # @return [Array<(TransferReturnRecoverResponse, Integer, Hash)>] TransferReturnRecoverResponse data, response status code and response headers
@@ -21221,7 +21153,7 @@ module Plaid
21221
21153
  end
21222
21154
 
21223
21155
  # Refresh user items for Financial-Insights bundle
21224
- # `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead.
21156
+ # `/user/financial_data/refresh` is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions and Investments product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the `results` array in the response to understand the outcome for each Item. This endpoint is distinct from `/transactions/refresh`, which triggers a refresh for a single Item. Use `/user/financial_data/refresh` to target all Items for a user instead.
21225
21157
  # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest]
21226
21158
  # @param [Hash] opts the optional parameters
21227
21159
  # @return [UserFinancialDataRefreshResponse]
@@ -21231,7 +21163,7 @@ module Plaid
21231
21163
  end
21232
21164
 
21233
21165
  # Refresh user items for Financial-Insights bundle
21234
- # &#x60;/user/financial_data/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions, Investments, and Liabilities product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.
21166
+ # &#x60;/user/financial_data/refresh&#x60; is an optional endpoint that initiates an on-demand extraction to fetch the newest transactions for a User using the Financial Insights bundle. This bundle refreshes the Transactions and Investments product data. This endpoint is for clients who use the Financial Insights bundle and want to proactively update all linked Items under a user. The refresh may succeed or fail on a per-Item basis. Use the &#x60;results&#x60; array in the response to understand the outcome for each Item. This endpoint is distinct from &#x60;/transactions/refresh&#x60;, which triggers a refresh for a single Item. Use &#x60;/user/financial_data/refresh&#x60; to target all Items for a user instead.
21235
21167
  # @param user_financial_data_refresh_request [UserFinancialDataRefreshRequest]
21236
21168
  # @param [Hash] opts the optional parameters
21237
21169
  # @return [Array<(UserFinancialDataRefreshResponse, Integer, Hash)>] UserFinancialDataRefreshResponse data, response status code and response headers
@@ -21634,8 +21566,8 @@ module Plaid
21634
21566
  return data, status_code, headers
21635
21567
  end
21636
21568
 
21637
- # Terminate user-based products
21638
- # Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Servicing) associated with a `user_id`. After you call this endpoint, the user will no longer be billed for these products. For CRA Servicing, the subscription is canceled but historical data remains available for future report requests.
21569
+ # Terminate products for a user
21570
+ # Terminates Financial Management, Plaid Protect, and Servicing products associated with a `user_id`. Use this endpoint when offboarding a user or ending their subscriptions. Item access tokens are not required. For Financial Management products, including Transactions, Liabilities, and Investments, this endpoint removes each associated Item that contains one of these products. Removal makes the Item inaccessible, initiates deletion of its product data, and terminates its per-Item subscription billing. The entire Item is removed, including access to any other products on that Item. To connect the accounts again, the user must complete Link to create a new Item. If the user has at least one associated Item and every associated Item contains a Financial Management product, this endpoint also removes the associated Plaid user. The removed `user_id` can no longer be used to access the user. For Plaid Protect, this endpoint terminates Protect products. For Servicing, it cancels the subscription and preserves CRA Items and historical data for future report requests.
21639
21571
  # @param user_products_terminate_request [UserProductsTerminateRequest]
21640
21572
  # @param [Hash] opts the optional parameters
21641
21573
  # @return [UserProductsTerminateResponse]
@@ -21644,8 +21576,8 @@ module Plaid
21644
21576
  data
21645
21577
  end
21646
21578
 
21647
- # Terminate user-based products
21648
- # Terminates user-based recurring subscription bundles or products (Financial Management, Plaid Protect, and CRA Servicing) associated with a &#x60;user_id&#x60;. After you call this endpoint, the user will no longer be billed for these products. For CRA Servicing, the subscription is canceled but historical data remains available for future report requests.
21579
+ # Terminate products for a user
21580
+ # Terminates Financial Management, Plaid Protect, and Servicing products associated with a &#x60;user_id&#x60;. Use this endpoint when offboarding a user or ending their subscriptions. Item access tokens are not required. For Financial Management products, including Transactions, Liabilities, and Investments, this endpoint removes each associated Item that contains one of these products. Removal makes the Item inaccessible, initiates deletion of its product data, and terminates its per-Item subscription billing. The entire Item is removed, including access to any other products on that Item. To connect the accounts again, the user must complete Link to create a new Item. If the user has at least one associated Item and every associated Item contains a Financial Management product, this endpoint also removes the associated Plaid user. The removed &#x60;user_id&#x60; can no longer be used to access the user. For Plaid Protect, this endpoint terminates Protect products. For Servicing, it cancels the subscription and preserves CRA Items and historical data for future report requests.
21649
21581
  # @param user_products_terminate_request [UserProductsTerminateRequest]
21650
21582
  # @param [Hash] opts the optional parameters
21651
21583
  # @return [Array<(UserProductsTerminateResponse, Integer, Hash)>] UserProductsTerminateResponse data, response status code and response headers
@@ -22029,7 +21961,7 @@ module Plaid
22029
21961
  return_type = opts[:debug_return_type] || 'UserUpdateResponse'
22030
21962
 
22031
21963
  # auth_names
22032
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
21964
+ auth_names = opts[:debug_auth_names] || ['clientId', 'oauth2', 'plaidVersion', 'secret']
22033
21965
 
22034
21966
  new_options = opts.merge(
22035
21967
  :operation => :"PlaidApi.user_update",