plaid 36.1.0 → 41.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 (1838) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +236 -0
  3. data/Gemfile.lock +5 -5
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +990 -576
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +1 -1
  11. data/lib/plaid/models/account_balance.rb +2 -2
  12. data/lib/plaid/models/account_base.rb +5 -5
  13. data/lib/plaid/models/account_base_nullable.rb +391 -0
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_holder_category.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +5 -5
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_document_upload.rb +5 -5
  20. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score.rb +5 -5
  22. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  23. data/lib/plaid/models/account_product_access.rb +1 -1
  24. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  25. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  26. data/lib/plaid/models/account_subtype.rb +1 -1
  27. data/lib/plaid/models/account_type.rb +1 -1
  28. data/lib/plaid/models/account_verification_insights.rb +3 -3
  29. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  30. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  31. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  32. data/lib/plaid/models/accounts_balance_get_request.rb +5 -15
  33. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  34. data/lib/plaid/models/accounts_get_request.rb +1 -1
  35. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  36. data/lib/plaid/models/accounts_get_response.rb +2 -12
  37. data/lib/plaid/models/ach_class.rb +1 -1
  38. data/lib/plaid/models/action_state.rb +1 -1
  39. data/lib/plaid/models/activity.rb +1 -1
  40. data/lib/plaid/models/activity_type.rb +1 -1
  41. data/lib/plaid/models/address.rb +1 -1
  42. data/lib/plaid/models/address_data.rb +1 -1
  43. data/lib/plaid/models/address_data_not_required.rb +1 -1
  44. data/lib/plaid/models/address_data_nullable.rb +1 -1
  45. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  46. data/lib/plaid/models/address_match_score.rb +1 -1
  47. data/lib/plaid/models/address_nullable.rb +1 -1
  48. data/lib/plaid/models/address_purpose_label.rb +1 -1
  49. data/lib/plaid/models/application.rb +1 -1
  50. data/lib/plaid/models/application_get_request.rb +1 -1
  51. data/lib/plaid/models/application_get_response.rb +1 -1
  52. data/lib/plaid/models/apr.rb +1 -1
  53. data/lib/plaid/models/asset.rb +1 -1
  54. data/lib/plaid/models/asset_detail.rb +1 -1
  55. data/lib/plaid/models/asset_holder.rb +1 -1
  56. data/lib/plaid/models/asset_holder_name.rb +1 -1
  57. data/lib/plaid/models/asset_owner.rb +1 -1
  58. data/lib/plaid/models/asset_owners.rb +1 -1
  59. data/lib/plaid/models/asset_report.rb +1 -1
  60. data/lib/plaid/models/asset_report_account_balance.rb +1 -1
  61. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  62. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  63. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  67. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  69. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  70. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  73. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  74. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  75. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  77. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  78. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  79. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  80. data/lib/plaid/models/asset_report_investment_transaction.rb +440 -0
  81. data/lib/plaid/models/asset_report_investments.rb +30 -223
  82. data/lib/plaid/models/asset_report_item.rb +1 -1
  83. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  84. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  85. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  86. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  87. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  88. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  89. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  90. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  91. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  92. data/lib/plaid/models/asset_report_type.rb +1 -1
  93. data/lib/plaid/models/asset_report_user.rb +1 -1
  94. data/lib/plaid/models/asset_transaction.rb +1 -1
  95. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  96. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  97. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  98. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  99. data/lib/plaid/models/asset_transactions.rb +1 -1
  100. data/lib/plaid/models/asset_type.rb +1 -1
  101. data/lib/plaid/models/assets.rb +1 -1
  102. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  103. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  104. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  105. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  106. data/lib/plaid/models/auth_get_request.rb +1 -1
  107. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  108. data/lib/plaid/models/auth_get_response.rb +1 -1
  109. data/lib/plaid/models/auth_metadata.rb +1 -1
  110. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  111. data/lib/plaid/models/auth_update_types.rb +1 -1
  112. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  113. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  114. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  115. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  116. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  117. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  118. data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
  119. data/lib/plaid/models/bank_transfer.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +3 -3
  149. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  152. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  153. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  154. data/lib/plaid/models/base_report.rb +1 -1
  155. data/lib/plaid/models/base_report_account.rb +1 -1
  156. data/lib/plaid/models/base_report_account_balances.rb +1 -1
  157. data/lib/plaid/models/base_report_account_insights.rb +2 -2
  158. data/lib/plaid/models/base_report_account_metadata.rb +3 -3
  159. data/lib/plaid/models/base_report_attributes.rb +1 -1
  160. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  161. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  162. data/lib/plaid/models/base_report_historical_balance.rb +1 -1
  163. data/lib/plaid/models/base_report_item.rb +1 -1
  164. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  165. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  166. data/lib/plaid/models/base_report_transaction.rb +1 -1
  167. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  168. data/lib/plaid/models/base_report_user_attributes.rb +1 -1
  169. data/lib/plaid/models/base_report_warning.rb +1 -1
  170. data/lib/plaid/models/base_report_warning_code.rb +2 -2
  171. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  172. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  173. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  174. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  175. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  176. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  178. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  179. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  180. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  181. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  182. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  183. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  184. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  185. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  186. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  187. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  188. data/lib/plaid/models/beacon_report.rb +1 -1
  189. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  190. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  191. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  192. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  193. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  194. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  195. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  196. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  197. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  198. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  199. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  200. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  202. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  205. data/lib/plaid/models/beacon_report_type.rb +1 -1
  206. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  207. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  208. data/lib/plaid/models/beacon_user.rb +1 -1
  209. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  210. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  211. data/lib/plaid/models/beacon_user_address.rb +1 -1
  212. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  213. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  214. data/lib/plaid/models/beacon_user_data.rb +1 -1
  215. data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
  216. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  217. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  218. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  219. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  220. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  221. data/lib/plaid/models/beacon_user_name.rb +1 -1
  222. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  223. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  224. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  225. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  226. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  227. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  228. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  229. data/lib/plaid/models/beacon_user_status.rb +1 -1
  230. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  231. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  232. data/lib/plaid/models/beacon_user_update_request_data.rb +1 -1
  233. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  234. data/lib/plaid/models/business_account.rb +404 -0
  235. data/lib/plaid/models/business_account_all_of.rb +222 -0
  236. data/lib/plaid/models/business_finance_category.rb +1 -1
  237. data/lib/plaid/models/{monitoring_insights_expected_deposit_missed_webhook.rb → cash_flow_updates_expected_deposit_missed_webhook.rb} +5 -5
  238. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +306 -0
  239. data/lib/plaid/models/{monitoring_insights_large_deposit_webhook.rb → cash_flow_updates_large_deposit_webhook.rb} +6 -6
  240. data/lib/plaid/models/{monitoring_insights_low_balance_webhook.rb → cash_flow_updates_low_balance_webhook.rb} +6 -6
  241. data/lib/plaid/models/{monitoring_insights_new_income_stream_webhook.rb → cash_flow_updates_new_income_stream_webhook.rb} +5 -5
  242. data/lib/plaid/models/{monitoring_insights_new_loan_payment_webhook.rb → cash_flow_updates_new_loan_payment_webhook.rb} +5 -5
  243. data/lib/plaid/models/{monitoring_insights_nsf_webhook.rb → cash_flow_updates_nsf_webhook.rb} +5 -5
  244. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  245. data/lib/plaid/models/cashflow_report_account_insights.rb +245 -0
  246. data/lib/plaid/models/cashflow_report_get_request.rb +15 -6
  247. data/lib/plaid/models/cashflow_report_get_request_options.rb +223 -0
  248. data/lib/plaid/models/cashflow_report_get_response.rb +3 -3
  249. data/lib/plaid/models/{deposit_switch_state_update_webhook.rb → cashflow_report_historical_balance.rb} +48 -67
  250. data/lib/plaid/models/{deposit_switch_get_request.rb → cashflow_report_insights_get_request.rb} +22 -22
  251. data/lib/plaid/models/cashflow_report_insights_get_response.rb +286 -0
  252. data/lib/plaid/models/cashflow_report_monthly_summary.rb +448 -0
  253. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +248 -0
  254. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +248 -0
  255. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +248 -0
  256. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +248 -0
  257. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +248 -0
  258. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +248 -0
  259. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +248 -0
  260. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +248 -0
  261. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +248 -0
  262. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +248 -0
  263. data/lib/plaid/models/cashflow_report_payment_meta.rb +299 -0
  264. data/lib/plaid/models/cashflow_report_refresh_request.rb +2 -2
  265. data/lib/plaid/models/cashflow_report_refresh_response.rb +1 -1
  266. data/lib/plaid/models/cashflow_report_transaction.rb +559 -0
  267. data/lib/plaid/models/{deposit_switch_alt_create_request.rb → cashflow_report_transactions_get_request.rb} +59 -69
  268. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +223 -0
  269. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +319 -0
  270. data/lib/plaid/models/categories_get_response.rb +1 -1
  271. data/lib/plaid/models/category.rb +1 -1
  272. data/lib/plaid/models/category_insight_details.rb +1 -1
  273. data/lib/plaid/models/category_insights.rb +1 -1
  274. data/lib/plaid/models/cause.rb +2 -2
  275. data/lib/plaid/models/cause_all_of.rb +1 -1
  276. data/lib/plaid/models/check_report_warning.rb +272 -0
  277. data/lib/plaid/models/check_report_warning_code.rb +40 -0
  278. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  279. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  280. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  281. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  282. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  283. data/lib/plaid/models/connected_application.rb +1 -1
  284. data/lib/plaid/models/consent_event.rb +1 -1
  285. data/lib/plaid/models/consent_event_code.rb +2 -1
  286. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  287. data/lib/plaid/models/consent_event_type.rb +1 -1
  288. data/lib/plaid/models/consent_events_get_request.rb +1 -1
  289. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  290. data/lib/plaid/models/consented_account.rb +1 -1
  291. data/lib/plaid/models/consumer_dispute.rb +1 -1
  292. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  293. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  294. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  295. data/lib/plaid/models/consumer_report_user_identity.rb +13 -2
  296. data/lib/plaid/models/counterparty.rb +1 -1
  297. data/lib/plaid/models/counterparty_insights.rb +1 -1
  298. data/lib/plaid/models/counterparty_type.rb +1 -1
  299. data/lib/plaid/models/country_code.rb +3 -1
  300. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  301. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  302. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  303. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  304. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  305. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  306. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  307. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  308. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  309. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  310. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  311. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  312. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  313. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  314. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  315. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  316. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +1 -1
  317. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  318. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +2 -3
  319. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +1 -1
  320. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +17 -5
  321. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +17 -7
  322. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +233 -0
  323. data/lib/plaid/models/cra_check_report_create_request.rb +15 -4
  324. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  325. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  326. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +246 -0
  327. data/lib/plaid/models/{deposit_switch_create_response.rb → cra_check_report_freddie_mac_get_response.rb} +33 -19
  328. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +253 -0
  329. data/lib/plaid/models/cra_check_report_gse_options.rb +228 -0
  330. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
  331. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +17 -5
  332. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +1 -1
  333. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +17 -5
  334. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +3 -3
  335. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +221 -0
  336. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +11 -2
  337. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +17 -5
  338. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
  339. data/lib/plaid/models/cra_check_report_ready_webhook.rb +28 -2
  340. data/lib/plaid/models/{balance_plus_risk_level.rb → cra_check_report_verification_get_report_type.rb} +4 -7
  341. data/lib/plaid/models/cra_check_report_verification_get_request.rb +268 -0
  342. data/lib/plaid/models/cra_check_report_verification_get_response.rb +257 -0
  343. data/lib/plaid/models/cra_check_report_verification_get_voe_options.rb +247 -0
  344. data/lib/plaid/models/cra_income_insights.rb +13 -2
  345. data/lib/plaid/models/cra_loan_application.rb +2 -2
  346. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  347. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  348. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  349. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  350. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  351. data/lib/plaid/models/cra_loan_register.rb +2 -2
  352. data/lib/plaid/models/cra_loan_register_application.rb +2 -2
  353. data/lib/plaid/models/cra_loan_status.rb +1 -1
  354. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  355. data/lib/plaid/models/cra_loan_type.rb +1 -1
  356. data/lib/plaid/models/cra_loan_unregister.rb +2 -2
  357. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  358. data/lib/plaid/models/cra_loan_update.rb +2 -2
  359. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  360. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  361. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  362. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  363. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  364. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  365. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  366. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +1 -1
  367. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  368. data/lib/plaid/models/cra_monitoring_insights_item.rb +18 -6
  369. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +18 -5
  370. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  371. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  372. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  373. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  374. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  375. data/lib/plaid/models/cra_partner_insights.rb +13 -2
  376. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  377. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  378. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  379. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  380. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  381. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  382. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  383. data/lib/plaid/models/cra_partner_insights_prism.rb +22 -2
  384. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  385. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  386. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  387. data/lib/plaid/models/cra_verification_report.rb +257 -0
  388. data/lib/plaid/models/{cra_bank_income.rb → cra_voa_report.rb} +37 -39
  389. data/lib/plaid/models/{accounts_balance_get_response_payment_risk_assessment.rb → cra_voa_report_account.rb} +137 -81
  390. data/lib/plaid/models/cra_voa_report_account_balances.rb +309 -0
  391. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +263 -0
  392. data/lib/plaid/models/cra_voa_report_attributes.rb +231 -0
  393. data/lib/plaid/models/cra_voa_report_item.rb +288 -0
  394. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +250 -0
  395. data/lib/plaid/models/cra_voe_report.rb +258 -0
  396. data/lib/plaid/models/cra_voe_report_account.rb +315 -0
  397. data/lib/plaid/models/cra_voe_report_item.rb +288 -0
  398. data/lib/plaid/models/cra_voe_report_transaction.rb +286 -0
  399. data/lib/plaid/models/credit1099.rb +1 -1
  400. data/lib/plaid/models/credit1099_filer.rb +1 -1
  401. data/lib/plaid/models/credit1099_payer.rb +1 -1
  402. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  403. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  404. data/lib/plaid/models/credit_ach_class.rb +1 -1
  405. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  406. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  407. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  408. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  409. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  410. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  411. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  412. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  413. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  414. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  415. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  416. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  417. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  418. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  419. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  420. data/lib/plaid/models/credit_bank_income.rb +1 -1
  421. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  422. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  423. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  424. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  425. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  426. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  427. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  428. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  429. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  430. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  431. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  432. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  433. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  434. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  435. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  436. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  437. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  438. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  439. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  440. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  441. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  442. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  443. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  444. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  445. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  446. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  447. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  448. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  449. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  450. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  451. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  452. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  453. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  454. data/lib/plaid/models/credit_card_liability.rb +1 -1
  455. data/lib/plaid/models/credit_category.rb +1 -1
  456. data/lib/plaid/models/credit_document_metadata.rb +2 -2
  457. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  458. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  459. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  460. data/lib/plaid/models/credit_employment_item.rb +1 -1
  461. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  462. data/lib/plaid/models/credit_filter.rb +1 -1
  463. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  464. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  465. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  466. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  467. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  468. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  469. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  470. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  471. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  472. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  473. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  474. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  475. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  476. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  477. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  478. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  479. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  480. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  481. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  482. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  483. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  484. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  485. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  486. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  487. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  488. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  489. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  490. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  491. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  492. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  493. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  494. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  495. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  496. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  497. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  498. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  499. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  500. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  501. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  502. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  503. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  504. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  505. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  506. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  507. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  508. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  509. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  510. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  511. data/lib/plaid/models/credit_session.rb +1 -1
  512. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  513. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  514. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  515. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  516. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  517. data/lib/plaid/models/credit_session_error.rb +1 -1
  518. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  519. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  520. data/lib/plaid/models/credit_session_results.rb +1 -1
  521. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  522. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  523. data/lib/plaid/models/credit_w2.rb +1 -1
  524. data/lib/plaid/models/custom_sandbox_transaction.rb +281 -0
  525. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  526. data/lib/plaid/models/dashboard_user.rb +1 -1
  527. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  528. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  529. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  530. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  531. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  532. data/lib/plaid/models/data_sources.rb +1 -1
  533. data/lib/plaid/models/date_range.rb +1 -1
  534. data/lib/plaid/models/deductions.rb +1 -1
  535. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  536. data/lib/plaid/models/deductions_total.rb +1 -1
  537. data/lib/plaid/models/default_update_webhook.rb +1 -1
  538. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  539. data/lib/plaid/models/depository_filter.rb +1 -1
  540. data/lib/plaid/models/detailed_originator.rb +1 -1
  541. data/lib/plaid/models/detected_account.rb +1 -1
  542. data/lib/plaid/models/device_id.rb +1 -1
  543. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  544. data/lib/plaid/models/doc_type.rb +1 -1
  545. data/lib/plaid/models/document_analysis.rb +16 -6
  546. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  547. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  548. data/lib/plaid/models/document_metadata.rb +1 -1
  549. data/lib/plaid/models/document_name_match_code.rb +1 -1
  550. data/lib/plaid/models/document_risk_signal.rb +1 -1
  551. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  552. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  553. data/lib/plaid/models/document_risk_summary.rb +1 -1
  554. data/lib/plaid/models/document_status.rb +1 -1
  555. data/lib/plaid/models/documentary_verification.rb +1 -1
  556. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  557. data/lib/plaid/models/earnings.rb +1 -1
  558. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  559. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  560. data/lib/plaid/models/earnings_total.rb +1 -1
  561. data/lib/plaid/models/email.rb +1 -1
  562. data/lib/plaid/models/email_address_match_score.rb +1 -1
  563. data/lib/plaid/models/employee.rb +1 -1
  564. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  565. data/lib/plaid/models/employer.rb +1 -1
  566. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  567. data/lib/plaid/models/employer_verification.rb +1 -1
  568. data/lib/plaid/models/employers_search_request.rb +1 -1
  569. data/lib/plaid/models/employers_search_response.rb +1 -1
  570. data/lib/plaid/models/employment_details.rb +1 -1
  571. data/lib/plaid/models/employment_source_type.rb +1 -1
  572. data/lib/plaid/models/employment_verification.rb +1 -1
  573. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  574. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  575. data/lib/plaid/models/employment_verification_status.rb +1 -1
  576. data/lib/plaid/models/enhancements.rb +1 -1
  577. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  578. data/lib/plaid/models/enrichments.rb +2 -1
  579. data/lib/plaid/models/entity_document.rb +1 -1
  580. data/lib/plaid/models/entity_document_type.rb +1 -1
  581. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  582. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  583. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  584. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  585. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  586. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  587. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  588. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  589. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  590. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  591. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  592. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  593. data/lib/plaid/models/entity_watchlist_code.rb +3 -1
  594. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  595. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  596. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  597. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  598. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  599. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  600. data/lib/plaid/models/expiration_date.rb +1 -1
  601. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  602. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  603. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  604. data/lib/plaid/models/external_payment_options.rb +1 -1
  605. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  606. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  607. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  608. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  609. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  610. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  611. data/lib/plaid/models/fdx_content_types.rb +1 -1
  612. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  613. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  614. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  615. data/lib/plaid/models/fdx_notification.rb +1 -1
  616. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  617. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  618. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  619. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  620. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  621. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  622. data/lib/plaid/models/fdx_party.rb +1 -1
  623. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  624. data/lib/plaid/models/fdx_party_type.rb +1 -1
  625. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  626. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  627. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  628. data/lib/plaid/models/fixed_income.rb +1 -1
  629. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  630. data/lib/plaid/models/form1099_type.rb +1 -1
  631. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  632. data/lib/plaid/models/fraud_amount.rb +1 -1
  633. data/lib/plaid/models/fraud_analysis_details.rb +1 -1
  634. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  635. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  636. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  637. data/lib/plaid/models/get_recipient_response.rb +1 -1
  638. data/lib/plaid/models/get_recipients_response.rb +1 -1
  639. data/lib/plaid/models/gse_report_type.rb +39 -0
  640. data/lib/plaid/models/health_incident.rb +1 -1
  641. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  642. data/lib/plaid/models/historical_annual_income.rb +1 -1
  643. data/lib/plaid/models/historical_balance.rb +1 -1
  644. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  645. data/lib/plaid/models/holding.rb +1 -1
  646. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  647. data/lib/plaid/models/holdings_override.rb +1 -1
  648. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  649. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  650. data/lib/plaid/models/human_review.rb +247 -0
  651. data/lib/plaid/models/human_review_status.rb +40 -0
  652. data/lib/plaid/models/id_number_type.rb +1 -1
  653. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  654. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  655. data/lib/plaid/models/identity_document_upload.rb +1 -1
  656. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  657. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  658. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  659. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  660. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  661. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  662. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  663. data/lib/plaid/models/identity_get_request.rb +1 -1
  664. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  665. data/lib/plaid/models/identity_get_response.rb +1 -1
  666. data/lib/plaid/models/identity_match_request.rb +1 -1
  667. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  668. data/lib/plaid/models/identity_match_response.rb +1 -1
  669. data/lib/plaid/models/identity_match_user.rb +1 -1
  670. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  671. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  672. data/lib/plaid/models/identity_update_types.rb +1 -1
  673. data/lib/plaid/models/identity_verification.rb +1 -1
  674. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  675. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  676. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  677. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  678. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  679. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  680. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  681. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  682. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  683. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  684. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  685. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  686. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  687. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  688. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  689. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  690. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  691. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  692. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  693. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  694. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  695. data/lib/plaid/models/identity_verification_status.rb +1 -1
  696. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  697. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  698. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  699. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  700. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  701. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  702. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  703. data/lib/plaid/models/image_quality.rb +1 -1
  704. data/lib/plaid/models/image_quality_details.rb +1 -1
  705. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  706. data/lib/plaid/models/incident_update.rb +1 -1
  707. data/lib/plaid/models/income_breakdown.rb +1 -1
  708. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  709. data/lib/plaid/models/income_override.rb +1 -1
  710. data/lib/plaid/models/income_sources_counts.rb +1 -1
  711. data/lib/plaid/models/income_summary.rb +1 -1
  712. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  713. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  714. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  715. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  716. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  717. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  718. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  719. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  720. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  721. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  722. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  723. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  724. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  725. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  726. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  727. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  728. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  729. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  730. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  731. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  732. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  733. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  734. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  735. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  736. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  737. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  738. data/lib/plaid/models/individual_name.rb +1 -1
  739. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  740. data/lib/plaid/models/individual_watchlist_code.rb +2 -1
  741. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  742. data/lib/plaid/models/inflow_model.rb +1 -1
  743. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  744. data/lib/plaid/models/institution.rb +1 -1
  745. data/lib/plaid/models/institution_status.rb +1 -1
  746. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  747. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  748. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  749. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  750. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  751. data/lib/plaid/models/institutions_get_request.rb +1 -1
  752. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  753. data/lib/plaid/models/institutions_get_response.rb +1 -1
  754. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  755. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  756. data/lib/plaid/models/institutions_search_request.rb +1 -1
  757. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  758. data/lib/plaid/models/institutions_search_response.rb +1 -1
  759. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  760. data/lib/plaid/models/investment_filter.rb +1 -1
  761. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  762. data/lib/plaid/models/investment_transaction.rb +1 -1
  763. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  764. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  765. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  766. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  767. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  768. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  769. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  770. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  771. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  772. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  773. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  774. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  775. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  776. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  777. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  778. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  779. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  780. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  781. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  782. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  783. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  784. data/lib/plaid/models/iso_currency_code.rb +1 -1
  785. data/lib/plaid/models/issue.rb +1 -1
  786. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  787. data/lib/plaid/models/issues_get_request.rb +1 -1
  788. data/lib/plaid/models/issues_get_response.rb +1 -1
  789. data/lib/plaid/models/issues_search_request.rb +1 -1
  790. data/lib/plaid/models/issues_search_response.rb +1 -1
  791. data/lib/plaid/models/issues_status.rb +1 -1
  792. data/lib/plaid/models/issues_subscribe_request.rb +6 -1
  793. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  794. data/lib/plaid/models/issuing_country.rb +1 -1
  795. data/lib/plaid/models/item.rb +1 -1
  796. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  797. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  798. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  799. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  800. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  801. data/lib/plaid/models/item_application_list_request.rb +1 -1
  802. data/lib/plaid/models/item_application_list_response.rb +1 -1
  803. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  804. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  805. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  806. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  807. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  808. data/lib/plaid/models/item_auth_method.rb +1 -1
  809. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  810. data/lib/plaid/models/item_create_authentication.rb +1 -1
  811. data/lib/plaid/models/item_error_webhook.rb +1 -1
  812. data/lib/plaid/models/item_get_request.rb +1 -1
  813. data/lib/plaid/models/item_get_response.rb +1 -1
  814. data/lib/plaid/models/item_import_request.rb +12 -2
  815. data/lib/plaid/models/item_import_request_options.rb +1 -1
  816. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  817. data/lib/plaid/models/item_import_response.rb +1 -1
  818. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  819. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  820. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  821. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  822. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  823. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  824. data/lib/plaid/models/item_remove_request.rb +1 -1
  825. data/lib/plaid/models/item_remove_response.rb +1 -1
  826. data/lib/plaid/models/item_status.rb +1 -1
  827. data/lib/plaid/models/item_status_investments.rb +1 -1
  828. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  829. data/lib/plaid/models/item_status_nullable.rb +1 -1
  830. data/lib/plaid/models/item_status_transactions.rb +1 -1
  831. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  832. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  833. data/lib/plaid/models/item_with_consent_fields.rb +1 -1
  834. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  835. data/lib/plaid/models/jwk_public_key.rb +1 -1
  836. data/lib/plaid/models/jwt_header.rb +1 -1
  837. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  838. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  839. data/lib/plaid/models/kyc_check_details.rb +1 -1
  840. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  841. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  842. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  843. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  844. data/lib/plaid/models/last_data_access_times.rb +1 -1
  845. data/lib/plaid/models/latest_scored_event.rb +274 -0
  846. data/lib/plaid/models/layer_authentication_passed_webhook.rb +307 -0
  847. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  848. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  849. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  850. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  851. data/lib/plaid/models/liabilities_object.rb +1 -1
  852. data/lib/plaid/models/liability_override.rb +1 -1
  853. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  854. data/lib/plaid/models/link_delivery_account.rb +1 -1
  855. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  856. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  857. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  858. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  859. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  860. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  861. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  862. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  863. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  864. data/lib/plaid/models/link_delivery_options.rb +1 -1
  865. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  866. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  867. data/lib/plaid/models/link_delivery_verification_status.rb +2 -1
  868. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  869. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  870. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  871. data/lib/plaid/models/link_event.rb +1 -1
  872. data/lib/plaid/models/link_event_metadata.rb +1 -1
  873. data/lib/plaid/models/link_event_name.rb +1 -1
  874. data/lib/plaid/models/link_events_webhook.rb +1 -1
  875. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  876. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  877. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  878. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  879. data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
  880. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  881. data/lib/plaid/models/link_session_exit.rb +1 -1
  882. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  883. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  884. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  885. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  886. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  887. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  888. data/lib/plaid/models/link_session_protect_result.rb +249 -0
  889. data/lib/plaid/models/link_session_results.rb +16 -6
  890. data/lib/plaid/models/link_session_success.rb +1 -1
  891. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  892. data/lib/plaid/models/link_session_success_metadata_account.rb +2 -2
  893. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  894. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  895. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  896. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  897. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  898. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  899. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  900. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  901. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  902. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  903. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  904. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  905. data/lib/plaid/models/link_token_create_request.rb +40 -17
  906. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  907. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +41 -0
  908. data/lib/plaid/models/link_token_create_request_auth.rb +5 -5
  909. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  910. data/lib/plaid/models/link_token_create_request_cra_options.rb +14 -3
  911. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +17 -7
  912. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +228 -0
  913. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +2 -3
  914. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  915. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  916. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  917. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  918. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  919. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  920. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  921. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  922. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  923. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  924. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  925. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  926. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  927. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  928. data/lib/plaid/models/link_token_create_request_user.rb +3 -3
  929. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  930. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  931. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  932. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  933. data/lib/plaid/models/link_token_create_response.rb +15 -5
  934. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  935. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  936. data/lib/plaid/models/link_token_get_request.rb +1 -1
  937. data/lib/plaid/models/link_token_get_response.rb +1 -1
  938. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  939. data/lib/plaid/models/link_token_investments.rb +1 -1
  940. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  941. data/lib/plaid/models/link_token_transactions.rb +1 -1
  942. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  943. data/lib/plaid/models/loan.rb +1 -1
  944. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  945. data/lib/plaid/models/loan_filter.rb +1 -1
  946. data/lib/plaid/models/loan_identifier.rb +1 -1
  947. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  948. data/lib/plaid/models/loan_identifiers.rb +1 -1
  949. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  950. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  951. data/lib/plaid/models/loans.rb +1 -1
  952. data/lib/plaid/models/location.rb +1 -1
  953. data/lib/plaid/models/match_summary.rb +1 -1
  954. data/lib/plaid/models/match_summary_code.rb +1 -1
  955. data/lib/plaid/models/merchant_insights.rb +1 -1
  956. data/lib/plaid/models/meta.rb +1 -1
  957. data/lib/plaid/models/mfa.rb +1 -1
  958. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  959. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  960. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  961. data/lib/plaid/models/monitoring_insights.rb +1 -1
  962. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  963. data/lib/plaid/models/monitoring_insights_status.rb +1 -4
  964. data/lib/plaid/models/monitoring_insights_webhook.rb +1 -1
  965. data/lib/plaid/models/monitoring_item_status_code.rb +1 -3
  966. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  967. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  968. data/lib/plaid/models/mortgage_liability.rb +1 -1
  969. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  970. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  971. data/lib/plaid/models/name_match_score.rb +1 -1
  972. data/lib/plaid/models/net_pay.rb +1 -1
  973. data/lib/plaid/models/network_insights_item.rb +1 -1
  974. data/lib/plaid/models/network_insights_report.rb +1 -1
  975. data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
  976. data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
  977. data/lib/plaid/models/network_status_get_request.rb +1 -1
  978. data/lib/plaid/models/network_status_get_response.rb +1 -1
  979. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  980. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  981. data/lib/plaid/models/network_status_get_user.rb +1 -1
  982. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  983. data/lib/plaid/models/numbers.rb +1 -1
  984. data/lib/plaid/models/numbers_acats.rb +1 -1
  985. data/lib/plaid/models/numbers_ach.rb +2 -2
  986. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  987. data/lib/plaid/models/numbers_aton.rb +1 -1
  988. data/lib/plaid/models/numbers_bacs.rb +1 -1
  989. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  990. data/lib/plaid/models/numbers_eft.rb +1 -1
  991. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  992. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  993. data/lib/plaid/models/numbers_international.rb +1 -1
  994. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  995. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  996. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  997. data/lib/plaid/models/o_auth_error_code.rb +43 -0
  998. data/lib/plaid/models/o_auth_error_response.rb +277 -0
  999. data/lib/plaid/models/o_auth_grant_type.rb +40 -0
  1000. data/lib/plaid/models/o_auth_introspect_request.rb +256 -0
  1001. data/lib/plaid/models/o_auth_introspect_response.rb +331 -0
  1002. data/lib/plaid/models/o_auth_revoke_request.rb +256 -0
  1003. data/lib/plaid/models/{cra_base_report_create_response.rb → o_auth_revoke_response.rb} +5 -5
  1004. data/lib/plaid/models/o_auth_subject_token_type.rb +39 -0
  1005. data/lib/plaid/models/{cra_bank_income_create_request.rb → o_auth_token_request.rb} +76 -58
  1006. data/lib/plaid/models/o_auth_token_response.rb +286 -0
  1007. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1008. data/lib/plaid/models/option_contract.rb +2 -2
  1009. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1010. data/lib/plaid/models/originator.rb +1 -1
  1011. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1012. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1013. data/lib/plaid/models/other_filter.rb +1 -1
  1014. data/lib/plaid/models/override_account_type.rb +1 -1
  1015. data/lib/plaid/models/override_accounts.rb +1 -1
  1016. data/lib/plaid/models/owner.rb +1 -1
  1017. data/lib/plaid/models/owner_override.rb +1 -1
  1018. data/lib/plaid/models/ownership_type.rb +1 -1
  1019. data/lib/plaid/models/parties.rb +1 -1
  1020. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  1021. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1022. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1023. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1024. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1025. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1026. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1027. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1028. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1029. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1030. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1031. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1032. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1033. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1034. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +3 -2
  1035. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1036. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  1037. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1038. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1039. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1040. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1041. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1042. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1043. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1044. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1045. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  1046. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1047. data/lib/plaid/models/party.rb +1 -1
  1048. data/lib/plaid/models/party_individual.rb +1 -1
  1049. data/lib/plaid/models/party_role_type.rb +1 -1
  1050. data/lib/plaid/models/pay.rb +1 -1
  1051. data/lib/plaid/models/pay_frequency.rb +1 -1
  1052. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1053. data/lib/plaid/models/pay_period_details.rb +1 -1
  1054. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1055. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  1056. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  1057. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  1058. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  1059. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  1060. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1061. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1062. data/lib/plaid/models/payment_amount.rb +1 -1
  1063. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1064. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1065. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1066. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1067. data/lib/plaid/models/payment_channel.rb +1 -1
  1068. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1069. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1070. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1071. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1072. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1073. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1074. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1075. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1076. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1077. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1078. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1079. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1080. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  1081. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +2 -2
  1082. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
  1083. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1084. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +15 -5
  1085. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1086. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1087. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1088. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1089. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1090. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1091. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1092. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1093. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1094. data/lib/plaid/models/payment_initiation_payment.rb +16 -6
  1095. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1096. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1097. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1098. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1099. data/lib/plaid/models/payment_initiation_payment_get_response.rb +12 -2
  1100. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1101. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1102. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1103. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1104. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1105. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1106. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1107. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1108. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1109. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1110. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1111. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1112. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1113. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1114. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1115. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1116. data/lib/plaid/models/payment_meta.rb +1 -1
  1117. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1118. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1119. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1120. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1121. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1122. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1123. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1124. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1125. data/lib/plaid/models/payment_scheme.rb +1 -1
  1126. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1127. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1128. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1129. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1130. data/lib/plaid/models/payroll_item.rb +1 -1
  1131. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1132. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1133. data/lib/plaid/models/paystub.rb +1 -1
  1134. data/lib/plaid/models/paystub_address.rb +1 -1
  1135. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1136. data/lib/plaid/models/paystub_details.rb +1 -1
  1137. data/lib/plaid/models/paystub_employer.rb +1 -1
  1138. data/lib/plaid/models/paystub_override.rb +1 -1
  1139. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1140. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1141. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1142. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1143. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1144. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1145. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1146. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1147. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1148. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1149. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1150. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1151. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1152. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1153. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1154. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1155. data/lib/plaid/models/pending_disconnect_webhook.rb +1 -1
  1156. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1157. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1158. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1159. data/lib/plaid/models/phone_number.rb +1 -1
  1160. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1161. data/lib/plaid/models/phone_type.rb +1 -1
  1162. data/lib/plaid/models/physical_document_category.rb +1 -1
  1163. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1164. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1165. data/lib/plaid/models/physical_document_images.rb +1 -1
  1166. data/lib/plaid/models/plaid_check_score.rb +3 -3
  1167. data/lib/plaid/models/plaid_check_score_version.rb +39 -0
  1168. data/lib/plaid/models/plaid_error.rb +2 -2
  1169. data/lib/plaid/models/plaid_error_type.rb +3 -1
  1170. data/lib/plaid/models/platform_ids.rb +1 -1
  1171. data/lib/plaid/models/po_box_status.rb +1 -1
  1172. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1173. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1174. data/lib/plaid/models/prism_cash_score_version.rb +2 -1
  1175. data/lib/plaid/models/prism_detect.rb +268 -0
  1176. data/lib/plaid/models/prism_detect_version.rb +39 -0
  1177. data/lib/plaid/models/prism_extend.rb +268 -0
  1178. data/lib/plaid/models/prism_extend_version.rb +39 -0
  1179. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1180. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1181. data/lib/plaid/models/prism_insights.rb +1 -1
  1182. data/lib/plaid/models/prism_insights_version.rb +2 -1
  1183. data/lib/plaid/models/prism_product.rb +1 -1
  1184. data/lib/plaid/models/prism_versions.rb +22 -2
  1185. data/lib/plaid/models/prism_versions_deprecated.rb +283 -0
  1186. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1187. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1188. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1189. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1190. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1191. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1192. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1193. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1194. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1195. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1196. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1197. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1198. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1199. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1200. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1201. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1202. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1203. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1204. data/lib/plaid/models/processor_investments_holdings_get_response.rb +1 -1
  1205. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1206. data/lib/plaid/models/processor_investments_transactions_get_response.rb +1 -1
  1207. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1208. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1209. data/lib/plaid/models/processor_number.rb +1 -1
  1210. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1211. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1212. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1213. data/lib/plaid/models/processor_signal_evaluate_request.rb +2 -2
  1214. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1215. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1216. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1217. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1218. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1219. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1220. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1221. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1222. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1223. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1224. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1225. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1226. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1227. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1228. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1229. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1230. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1231. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1232. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1233. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1234. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1235. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1236. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1237. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1238. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1239. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1240. data/lib/plaid/models/processor_transactions_sync_response.rb +3 -7
  1241. data/lib/plaid/models/product_access.rb +1 -1
  1242. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1243. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1244. data/lib/plaid/models/product_status.rb +1 -1
  1245. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1246. data/lib/plaid/models/products.rb +2 -1
  1247. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1248. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1249. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1250. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1251. data/lib/plaid/models/{deposit_switch_create_request_options.rb → protect_event.rb} +61 -38
  1252. data/lib/plaid/models/{cra_bank_income_get_request.rb → protect_event_get_request.rb} +18 -13
  1253. data/lib/plaid/models/{deposit_switch_token_create_response.rb → protect_event_get_response.rb} +49 -26
  1254. data/lib/plaid/models/{deposit_switch_target_user.rb → protect_event_send_request.rb} +48 -67
  1255. data/lib/plaid/models/protect_event_send_response.rb +264 -0
  1256. data/lib/plaid/models/protect_user_event_webhook.rb +297 -0
  1257. data/lib/plaid/models/{deposit_switch_token_create_request.rb → protect_user_insights_get_request.rb} +23 -18
  1258. data/lib/plaid/models/{deposit_switch_alt_create_response.rb → protect_user_insights_get_response.rb} +26 -16
  1259. data/lib/plaid/models/proxy_type.rb +1 -1
  1260. data/lib/plaid/models/pslf_status.rb +1 -1
  1261. data/lib/plaid/models/reason_code.rb +52 -0
  1262. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1263. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1264. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1265. data/lib/plaid/models/recommendation_string.rb +1 -1
  1266. data/lib/plaid/models/recurrence.rb +1 -1
  1267. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1268. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1269. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1270. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1271. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1272. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1273. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1274. data/lib/plaid/models/recurring_transfer.rb +2 -1
  1275. data/lib/plaid/models/recurring_transfer_nullable.rb +2 -1
  1276. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1277. data/lib/plaid/models/removed_transaction.rb +1 -1
  1278. data/lib/plaid/models/report_type.rb +1 -1
  1279. data/lib/plaid/models/reporting_information.rb +1 -1
  1280. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1281. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1282. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1283. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1284. data/lib/plaid/models/risk_check_details.rb +1 -1
  1285. data/lib/plaid/models/risk_check_device.rb +1 -1
  1286. data/lib/plaid/models/risk_check_email.rb +1 -1
  1287. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1288. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1289. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1290. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1291. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1292. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1293. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1294. data/lib/plaid/models/risk_check_network.rb +1 -1
  1295. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1296. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1297. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1298. data/lib/plaid/models/risk_level.rb +1 -1
  1299. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1300. data/lib/plaid/models/risk_profile.rb +2 -2
  1301. data/lib/plaid/models/risk_reason.rb +1 -1
  1302. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1303. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1304. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1305. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1306. data/lib/plaid/models/role.rb +1 -1
  1307. data/lib/plaid/models/role_detail.rb +1 -1
  1308. data/lib/plaid/models/roles.rb +1 -1
  1309. data/lib/plaid/models/rule_details.rb +231 -0
  1310. data/lib/plaid/models/rule_result.rb +40 -0
  1311. data/lib/plaid/models/ruleset.rb +49 -3
  1312. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1313. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1314. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1315. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1316. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1317. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1318. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1319. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1320. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +1 -1
  1321. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
  1322. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1323. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1324. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1325. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  1326. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1327. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1328. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1329. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1330. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1331. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1332. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1333. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1334. data/lib/plaid/models/sandbox_payment_simulate_request.rb +18 -3
  1335. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1336. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1337. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1338. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1339. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1340. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1341. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1342. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1343. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1344. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1345. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1346. data/lib/plaid/models/sandbox_transactions_create_request.rb +263 -0
  1347. data/lib/plaid/models/{cra_bank_income_create_response.rb → sandbox_transactions_create_response.rb} +10 -5
  1348. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1349. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1350. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1351. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1352. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +13 -2
  1353. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1354. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1355. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1356. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1357. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1358. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1359. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1360. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1361. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1362. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1363. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1364. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1365. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1366. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1367. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1368. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1369. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1370. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1371. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1372. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1373. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1374. data/lib/plaid/models/scopes.rb +1 -1
  1375. data/lib/plaid/models/scopes_context.rb +1 -1
  1376. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1377. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1378. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1379. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1380. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1381. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1382. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1383. data/lib/plaid/models/security.rb +1 -1
  1384. data/lib/plaid/models/security_override.rb +1 -1
  1385. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1386. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1387. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1388. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1389. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1390. data/lib/plaid/models/selfie_capture.rb +1 -1
  1391. data/lib/plaid/models/selfie_check.rb +1 -1
  1392. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1393. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1394. data/lib/plaid/models/selfie_status.rb +1 -1
  1395. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1396. data/lib/plaid/models/service.rb +1 -1
  1397. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1398. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1399. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1400. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1401. data/lib/plaid/models/services.rb +1 -1
  1402. data/lib/plaid/models/session_token_create_request.rb +40 -5
  1403. data/lib/plaid/models/session_token_create_request_user.rb +20 -5
  1404. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1405. data/lib/plaid/models/session_token_create_response_link.rb +15 -5
  1406. data/lib/plaid/models/signal_address_data.rb +1 -1
  1407. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1408. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1409. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1410. data/lib/plaid/models/signal_device.rb +1 -1
  1411. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1412. data/lib/plaid/models/signal_evaluate_request.rb +5 -5
  1413. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1414. data/lib/plaid/models/signal_payment_method.rb +2 -3
  1415. data/lib/plaid/models/signal_person_name.rb +1 -1
  1416. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1417. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1418. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1419. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1420. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -3
  1421. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1422. data/lib/plaid/models/signal_schedule_request.rb +1 -1
  1423. data/lib/plaid/models/signal_schedule_response.rb +1 -1
  1424. data/lib/plaid/models/signal_scores.rb +1 -1
  1425. data/lib/plaid/models/signal_user.rb +1 -1
  1426. data/lib/plaid/models/signal_warning.rb +1 -1
  1427. data/lib/plaid/models/simulated_transfer_sweep.rb +13 -2
  1428. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1429. data/lib/plaid/models/sms_verification.rb +1 -1
  1430. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1431. data/lib/plaid/models/source.rb +1 -1
  1432. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1433. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1434. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1435. data/lib/plaid/models/statements_account.rb +1 -1
  1436. data/lib/plaid/models/statements_download_request.rb +1 -1
  1437. data/lib/plaid/models/statements_list_request.rb +1 -1
  1438. data/lib/plaid/models/statements_list_response.rb +1 -1
  1439. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1440. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1441. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1442. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1443. data/lib/plaid/models/statements_statement.rb +13 -2
  1444. data/lib/plaid/models/status.rb +1 -1
  1445. data/lib/plaid/models/statuses.rb +1 -1
  1446. data/lib/plaid/models/strategy.rb +1 -1
  1447. data/lib/plaid/models/student_loan.rb +1 -1
  1448. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1449. data/lib/plaid/models/student_loan_status.rb +1 -1
  1450. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1451. data/lib/plaid/models/sweep_failure.rb +2 -2
  1452. data/lib/plaid/models/sweep_status.rb +2 -1
  1453. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1454. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1455. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1456. data/lib/plaid/models/taxform.rb +1 -1
  1457. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1458. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1459. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1460. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1461. data/lib/plaid/models/{deposit_switch_address_data.rb → tch_notification.rb} +42 -65
  1462. data/lib/plaid/models/tch_notification_response.rb +261 -0
  1463. data/lib/plaid/models/total.rb +1 -1
  1464. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1465. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1466. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1467. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1468. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1469. data/lib/plaid/models/total_monthly_income_insights.rb +1 -1
  1470. data/lib/plaid/models/total_outflow_amount.rb +1 -1
  1471. data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
  1472. data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
  1473. data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
  1474. data/lib/plaid/models/total_report_inflow_amount.rb +1 -1
  1475. data/lib/plaid/models/total_report_inflow_amount30d.rb +1 -1
  1476. data/lib/plaid/models/total_report_inflow_amount60d.rb +1 -1
  1477. data/lib/plaid/models/total_report_inflow_amount90d.rb +1 -1
  1478. data/lib/plaid/models/total_report_outflow_amount.rb +1 -1
  1479. data/lib/plaid/models/total_report_outflow_amount30d.rb +1 -1
  1480. data/lib/plaid/models/total_report_outflow_amount60d.rb +1 -1
  1481. data/lib/plaid/models/total_report_outflow_amount90d.rb +1 -1
  1482. data/lib/plaid/models/transaction.rb +2 -2
  1483. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1484. data/lib/plaid/models/transaction_base.rb +2 -2
  1485. data/lib/plaid/models/transaction_code.rb +1 -1
  1486. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1487. data/lib/plaid/models/transaction_data.rb +1 -1
  1488. data/lib/plaid/models/transaction_override.rb +1 -1
  1489. data/lib/plaid/models/transaction_stream.rb +3 -11
  1490. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1491. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1492. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1493. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1494. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1495. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1496. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1497. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1498. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1499. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1500. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1501. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1502. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1503. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1504. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1505. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1506. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1507. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1508. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1509. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1510. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1511. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1512. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1513. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1514. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1515. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1516. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1517. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1518. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1519. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1520. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1521. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1522. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1523. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1524. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1525. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1526. data/lib/plaid/models/transactions_sync_request_options.rb +3 -3
  1527. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1528. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1529. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1530. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1531. data/lib/plaid/models/transfer.rb +14 -3
  1532. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1533. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1534. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1535. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1536. data/lib/plaid/models/transfer_authorization_create_request.rb +2 -2
  1537. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1538. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1539. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1540. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1541. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1542. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1543. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1544. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1545. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1546. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1547. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1548. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1549. data/lib/plaid/models/transfer_balance.rb +1 -1
  1550. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1551. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1552. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1553. data/lib/plaid/models/transfer_cancel_request.rb +37 -6
  1554. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1555. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1556. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1557. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1558. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1559. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1560. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1561. data/lib/plaid/models/transfer_create_request.rb +3 -3
  1562. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1563. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1564. data/lib/plaid/models/transfer_credit_usage_configuration.rb +2 -2
  1565. data/lib/plaid/models/transfer_debit_usage_configuration.rb +2 -2
  1566. data/lib/plaid/models/transfer_device.rb +1 -1
  1567. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1568. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1569. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1570. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1571. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1572. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1573. data/lib/plaid/models/transfer_event.rb +2 -2
  1574. data/lib/plaid/models/transfer_event_list_request.rb +3 -3
  1575. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1576. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1577. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1578. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1579. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1580. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1581. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1582. data/lib/plaid/models/transfer_failure.rb +2 -2
  1583. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1584. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +259 -0
  1585. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +220 -0
  1586. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1587. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1588. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1589. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1590. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1591. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1592. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1593. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1594. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1595. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1596. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1597. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1598. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1599. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1600. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  1601. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1602. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1603. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1604. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1605. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1606. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1607. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  1608. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1609. data/lib/plaid/models/transfer_list_request.rb +3 -3
  1610. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1611. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1612. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1613. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1614. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1615. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1616. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1617. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1618. data/lib/plaid/models/transfer_network.rb +1 -1
  1619. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1620. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1621. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1622. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1623. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +260 -0
  1624. data/lib/plaid/models/{cra_bank_income_get_response.rb → transfer_originator_funding_account_create_response.rb} +13 -14
  1625. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1626. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1627. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1628. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1629. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1630. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1631. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  1632. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1633. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1634. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1635. data/lib/plaid/models/transfer_platform_person_create_request.rb +42 -6
  1636. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1637. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1638. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1639. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1640. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1641. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1642. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1643. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1644. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1645. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1646. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1647. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1648. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
  1649. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1650. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1651. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1652. data/lib/plaid/models/transfer_recurring_list_request.rb +3 -3
  1653. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1654. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1655. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1656. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1657. data/lib/plaid/models/transfer_refund.rb +1 -1
  1658. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1659. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1660. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1661. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1662. data/lib/plaid/models/transfer_refund_failure.rb +2 -2
  1663. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1664. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1665. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1666. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1667. data/lib/plaid/models/transfer_repayment_list_request.rb +3 -3
  1668. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1669. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1670. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1671. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1672. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1673. data/lib/plaid/models/transfer_status.rb +1 -1
  1674. data/lib/plaid/models/transfer_sweep.rb +13 -2
  1675. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1676. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1677. data/lib/plaid/models/transfer_sweep_list_request.rb +3 -3
  1678. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1679. data/lib/plaid/models/transfer_sweep_status.rb +1 -2
  1680. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  1681. data/lib/plaid/models/transfer_type.rb +1 -1
  1682. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1683. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1684. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1685. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1686. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1687. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1688. data/lib/plaid/models/trust_index.rb +251 -0
  1689. data/lib/plaid/models/trust_index_subscore.rb +226 -0
  1690. data/lib/plaid/models/trust_index_subscores.rb +231 -0
  1691. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1692. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1693. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1694. data/lib/plaid/models/user_account_identity.rb +2 -2
  1695. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1696. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1697. data/lib/plaid/models/user_account_item.rb +1 -1
  1698. data/lib/plaid/models/user_account_revoked_webhook.rb +2 -2
  1699. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1700. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1701. data/lib/plaid/models/user_address.rb +1 -1
  1702. data/lib/plaid/models/user_create_request.rb +1 -1
  1703. data/lib/plaid/models/user_create_response.rb +1 -6
  1704. data/lib/plaid/models/user_custom_password.rb +1 -1
  1705. data/lib/plaid/models/user_data_overview.rb +1 -1
  1706. data/lib/plaid/models/user_id_number.rb +1 -1
  1707. data/lib/plaid/models/user_items_get_request.rb +1 -1
  1708. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1709. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1710. data/lib/plaid/models/user_remove_request.rb +15 -10
  1711. data/lib/plaid/models/user_remove_response.rb +1 -1
  1712. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1713. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1714. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1715. data/lib/plaid/models/user_third_party_token_create_request.rb +1 -1
  1716. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1717. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  1718. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  1719. data/lib/plaid/models/user_update_request.rb +1 -1
  1720. data/lib/plaid/models/user_update_response.rb +1 -1
  1721. data/lib/plaid/models/validation_source.rb +1 -1
  1722. data/lib/plaid/models/validation_sources.rb +1 -1
  1723. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1724. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1725. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1726. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1727. data/lib/plaid/models/verification_status.rb +1 -1
  1728. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1729. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1730. data/lib/plaid/models/w2.rb +1 -1
  1731. data/lib/plaid/models/w2_box12.rb +1 -1
  1732. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1733. data/lib/plaid/models/w2_override.rb +1 -1
  1734. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1735. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1736. data/lib/plaid/models/wallet.rb +1 -1
  1737. data/lib/plaid/models/wallet_balance.rb +1 -1
  1738. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1739. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1740. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1741. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1742. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1743. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1744. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1745. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1746. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1747. data/lib/plaid/models/wallet_status.rb +1 -1
  1748. data/lib/plaid/models/wallet_transaction.rb +1 -1
  1749. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1750. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1751. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1752. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1753. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1754. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1755. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1756. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1757. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1758. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  1759. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1760. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1761. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1762. data/lib/plaid/models/wallet_transaction_relation.rb +2 -2
  1763. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1764. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1765. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1766. data/lib/plaid/models/warning.rb +1 -1
  1767. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1768. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1769. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1770. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1771. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1772. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1773. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1774. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1775. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1776. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1777. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1778. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1779. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1780. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1781. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1782. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1783. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1784. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1785. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1786. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1787. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1788. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1789. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1790. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1791. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1792. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1793. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1794. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1795. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1796. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1797. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1798. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1799. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1800. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1801. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1802. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1803. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1804. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1805. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1806. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1807. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1808. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1809. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1810. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1811. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1812. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1813. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1814. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1815. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1816. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1817. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1818. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1819. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1820. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1821. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1822. data/lib/plaid/models/webhook_type.rb +1 -1
  1823. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1824. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1825. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1826. data/lib/plaid/models/yield_rate.rb +1 -1
  1827. data/lib/plaid/models/yield_rate_type.rb +1 -1
  1828. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1829. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1830. data/lib/plaid/version.rb +2 -2
  1831. data/lib/plaid.rb +104 -30
  1832. data/plaid.gemspec +1 -1
  1833. metadata +105 -31
  1834. data/lib/plaid/models/accounts_balance_get_request_payment_details.rb +0 -327
  1835. data/lib/plaid/models/balance_plus_attributes.rb +0 -508
  1836. data/lib/plaid/models/deposit_switch_create_request.rb +0 -315
  1837. data/lib/plaid/models/deposit_switch_get_response.rb +0 -449
  1838. data/lib/plaid/models/deposit_switch_target_account.rb +0 -305
@@ -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.620.0
6
+ The version of the OpenAPI document: 2020-09-14_1.645.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -1176,7 +1176,7 @@ module Plaid
1176
1176
  end
1177
1177
 
1178
1178
  # Sync bank transfer events
1179
- # `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1179
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).
1180
1180
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1181
1181
  # @param [Hash] opts the optional parameters
1182
1182
  # @return [BankTransferEventSyncResponse]
@@ -1186,7 +1186,7 @@ module Plaid
1186
1186
  end
1187
1187
 
1188
1188
  # Sync bank transfer events
1189
- # `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
1189
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 Plaid-initiated bank transfer events that happened after a specific `event_id`. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://plaid.com/docs/auth/coverage/microdeposit-events/).
1190
1190
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1191
1191
  # @param [Hash] opts the optional parameters
1192
1192
  # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
@@ -2468,7 +2468,7 @@ module Plaid
2468
2468
  end
2469
2469
 
2470
2470
  # Gets transaction data in cashflow_report
2471
- # The `/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn't, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
2471
+ # The `/cashflow_report/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn't, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
2472
2472
  # @param cashflow_report_get_request [CashflowReportGetRequest]
2473
2473
  # @param [Hash] opts the optional parameters
2474
2474
  # @return [CashflowReportGetResponse]
@@ -2478,7 +2478,7 @@ module Plaid
2478
2478
  end
2479
2479
 
2480
2480
  # Gets transaction data in cashflow_report
2481
- # The &#x60;/cashflow_report/get&#x60; endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn&#39;t, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
2481
+ # The &#x60;/cashflow_report/get&#x60; endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn&#39;t, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
2482
2482
  # @param cashflow_report_get_request [CashflowReportGetRequest]
2483
2483
  # @param [Hash] opts the optional parameters
2484
2484
  # @return [Array<(CashflowReportGetResponse, Integer, Hash)>] CashflowReportGetResponse data, response status code and response headers
@@ -2535,31 +2535,31 @@ module Plaid
2535
2535
  return data, status_code, headers
2536
2536
  end
2537
2537
 
2538
- # Refresh transaction data in cashflow_report
2539
- # `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
2540
- # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
2538
+ # Gets insights data in Cashflow Report
2539
+ # The `/cashflow_report/insights/get` endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.
2540
+ # @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
2541
2541
  # @param [Hash] opts the optional parameters
2542
- # @return [CashflowReportRefreshResponse]
2543
- def cashflow_report_refresh(cashflow_report_refresh_request, opts = {})
2544
- data, _status_code, _headers = cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts)
2542
+ # @return [CashflowReportInsightsGetResponse]
2543
+ def cashflow_report_insights_get(cashflow_report_insights_get_request, opts = {})
2544
+ data, _status_code, _headers = cashflow_report_insights_get_with_http_info(cashflow_report_insights_get_request, opts)
2545
2545
  data
2546
2546
  end
2547
2547
 
2548
- # Refresh transaction data in cashflow_report
2549
- # &#x60;/cashflow_report/refresh&#x60; is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an &#x60;item_id&#x60;). The item must already have Cashflow Report added as a product in order to call &#x60;/cashflow_report/refresh&#x60;. After calling &#x60;/cashflow_report/refresh&#x60;, Plaid will fire a webhook &#x60;CASHFLOW_REPORT_READY&#x60; alerting clients that new transactions data can then be ingested via &#x60;/cashflow_report/get&#x60; or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the &#x60;/cashflow_report/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
2550
- # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
2548
+ # Gets insights data in Cashflow Report
2549
+ # The &#x60;/cashflow_report/insights/get&#x60; endpoint retrieves insights data associated with an item. Insights are only calculated on credit and depository accounts.
2550
+ # @param cashflow_report_insights_get_request [CashflowReportInsightsGetRequest]
2551
2551
  # @param [Hash] opts the optional parameters
2552
- # @return [Array<(CashflowReportRefreshResponse, Integer, Hash)>] CashflowReportRefreshResponse data, response status code and response headers
2553
- def cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts = {})
2552
+ # @return [Array<(CashflowReportInsightsGetResponse, Integer, Hash)>] CashflowReportInsightsGetResponse data, response status code and response headers
2553
+ def cashflow_report_insights_get_with_http_info(cashflow_report_insights_get_request, opts = {})
2554
2554
  if @api_client.config.debugging
2555
- @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_refresh ...'
2555
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_insights_get ...'
2556
2556
  end
2557
- # verify the required parameter 'cashflow_report_refresh_request' is set
2558
- if @api_client.config.client_side_validation && cashflow_report_refresh_request.nil?
2559
- fail ArgumentError, "Missing the required parameter 'cashflow_report_refresh_request' when calling PlaidApi.cashflow_report_refresh"
2557
+ # verify the required parameter 'cashflow_report_insights_get_request' is set
2558
+ if @api_client.config.client_side_validation && cashflow_report_insights_get_request.nil?
2559
+ fail ArgumentError, "Missing the required parameter 'cashflow_report_insights_get_request' when calling PlaidApi.cashflow_report_insights_get"
2560
2560
  end
2561
2561
  # resource path
2562
- local_var_path = '/cashflow_report/refresh'
2562
+ local_var_path = '/cashflow_report/insights/get'
2563
2563
 
2564
2564
  # query parameters
2565
2565
  query_params = opts[:query_params] || {}
@@ -2578,16 +2578,16 @@ module Plaid
2578
2578
  form_params = opts[:form_params] || {}
2579
2579
 
2580
2580
  # http body (model)
2581
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_refresh_request)
2581
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_insights_get_request)
2582
2582
 
2583
2583
  # return_type
2584
- return_type = opts[:debug_return_type] || 'CashflowReportRefreshResponse'
2584
+ return_type = opts[:debug_return_type] || 'CashflowReportInsightsGetResponse'
2585
2585
 
2586
2586
  # auth_names
2587
2587
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2588
2588
 
2589
2589
  new_options = opts.merge(
2590
- :operation => :"PlaidApi.cashflow_report_refresh",
2590
+ :operation => :"PlaidApi.cashflow_report_insights_get",
2591
2591
  :header_params => header_params,
2592
2592
  :query_params => query_params,
2593
2593
  :form_params => form_params,
@@ -2598,36 +2598,36 @@ module Plaid
2598
2598
 
2599
2599
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2600
2600
  if @api_client.config.debugging
2601
- @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2601
+ @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2602
2602
  end
2603
2603
  return data, status_code, headers
2604
2604
  end
2605
2605
 
2606
- # Get categories
2607
- # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
2608
- # @param body [Object]
2606
+ # Refresh transaction data in cashflow_report
2607
+ # `/cashflow_report/refresh` is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an `item_id`). The item must already have Cashflow Report added as a product in order to call `/cashflow_report/refresh`. After calling `/cashflow_report/refresh`, Plaid will fire a webhook `CASHFLOW_REPORT_READY` alerting clients that new transactions data can then be ingested via `/cashflow_report/get` or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the `/cashflow_report/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
2608
+ # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
2609
2609
  # @param [Hash] opts the optional parameters
2610
- # @return [CategoriesGetResponse]
2611
- def categories_get(body, opts = {})
2612
- data, _status_code, _headers = categories_get_with_http_info(body, opts)
2610
+ # @return [CashflowReportRefreshResponse]
2611
+ def cashflow_report_refresh(cashflow_report_refresh_request, opts = {})
2612
+ data, _status_code, _headers = cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts)
2613
2613
  data
2614
2614
  end
2615
2615
 
2616
- # Get categories
2617
- # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer &#x60;personal_finance_category&#x60; taxonomy instead of the older &#x60;category&#x60; taxonomy supported by this endpoint. The [&#x60;personal_finance_category taxonomy&#x60; CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
2618
- # @param body [Object]
2616
+ # Refresh transaction data in cashflow_report
2617
+ # &#x60;/cashflow_report/refresh&#x60; is an endpoint that initiates an on-demand extraction to fetch the newest transactions for an item (given an &#x60;item_id&#x60;). The item must already have Cashflow Report added as a product in order to call &#x60;/cashflow_report/refresh&#x60;. After calling &#x60;/cashflow_report/refresh&#x60;, Plaid will fire a webhook &#x60;CASHFLOW_REPORT_READY&#x60; alerting clients that new transactions data can then be ingested via &#x60;/cashflow_report/get&#x60; or the webhook will contain an error code informing there was an error in refreshing transactions data. Note that the &#x60;/cashflow_report/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but up to 30 seconds or more). If you encounter errors, you may find it necessary to adjust your timeout period for requests.
2618
+ # @param cashflow_report_refresh_request [CashflowReportRefreshRequest]
2619
2619
  # @param [Hash] opts the optional parameters
2620
- # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
2621
- def categories_get_with_http_info(body, opts = {})
2620
+ # @return [Array<(CashflowReportRefreshResponse, Integer, Hash)>] CashflowReportRefreshResponse data, response status code and response headers
2621
+ def cashflow_report_refresh_with_http_info(cashflow_report_refresh_request, opts = {})
2622
2622
  if @api_client.config.debugging
2623
- @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
2623
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_refresh ...'
2624
2624
  end
2625
- # verify the required parameter 'body' is set
2626
- if @api_client.config.client_side_validation && body.nil?
2627
- fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
2625
+ # verify the required parameter 'cashflow_report_refresh_request' is set
2626
+ if @api_client.config.client_side_validation && cashflow_report_refresh_request.nil?
2627
+ fail ArgumentError, "Missing the required parameter 'cashflow_report_refresh_request' when calling PlaidApi.cashflow_report_refresh"
2628
2628
  end
2629
2629
  # resource path
2630
- local_var_path = '/categories/get'
2630
+ local_var_path = '/cashflow_report/refresh'
2631
2631
 
2632
2632
  # query parameters
2633
2633
  query_params = opts[:query_params] || {}
@@ -2646,16 +2646,16 @@ module Plaid
2646
2646
  form_params = opts[:form_params] || {}
2647
2647
 
2648
2648
  # http body (model)
2649
- post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
2649
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_refresh_request)
2650
2650
 
2651
2651
  # return_type
2652
- return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
2652
+ return_type = opts[:debug_return_type] || 'CashflowReportRefreshResponse'
2653
2653
 
2654
2654
  # auth_names
2655
- auth_names = opts[:debug_auth_names] || []
2655
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2656
2656
 
2657
2657
  new_options = opts.merge(
2658
- :operation => :"PlaidApi.categories_get",
2658
+ :operation => :"PlaidApi.cashflow_report_refresh",
2659
2659
  :header_params => header_params,
2660
2660
  :query_params => query_params,
2661
2661
  :form_params => form_params,
@@ -2666,36 +2666,36 @@ module Plaid
2666
2666
 
2667
2667
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2668
2668
  if @api_client.config.debugging
2669
- @api_client.config.logger.debug "API called: PlaidApi#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2669
+ @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2670
2670
  end
2671
2671
  return data, status_code, headers
2672
2672
  end
2673
2673
 
2674
- # List a historical log of item consent events
2675
- # List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint.
2676
- # @param consent_events_get_request [ConsentEventsGetRequest]
2674
+ # Gets transaction data in cashflow_report
2675
+ # The `/cashflow_report/transactions/get` endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `cursor` parameters in conjunction with the `has_more` response body field to fetch all available transactions. Note that data isn't likely to be immediately available to `/cashflow_report/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn't, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the `CASHFLOW_REPORT_READY` webhook.
2676
+ # @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
2677
2677
  # @param [Hash] opts the optional parameters
2678
- # @return [ConsentEventsGetResponse]
2679
- def consent_events_get(consent_events_get_request, opts = {})
2680
- data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
2678
+ # @return [CashflowReportTransactionsGetResponse]
2679
+ def cashflow_report_transactions_get(cashflow_report_transactions_get_request, opts = {})
2680
+ data, _status_code, _headers = cashflow_report_transactions_get_with_http_info(cashflow_report_transactions_get_request, opts)
2681
2681
  data
2682
2682
  end
2683
2683
 
2684
- # List a historical log of item consent events
2685
- # List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint.
2686
- # @param consent_events_get_request [ConsentEventsGetRequest]
2684
+ # Gets transaction data in cashflow_report
2685
+ # The &#x60;/cashflow_report/transactions/get&#x60; endpoint retrieves transactions data associated with an item. Transactions data is standardized across financial institutions. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;cursor&#x60; parameters in conjunction with the &#x60;has_more&#x60; response body field to fetch all available transactions. Note that data isn&#39;t likely to be immediately available to &#x60;/cashflow_report/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with cashflow_report, or if it wasn&#39;t, upon the first call to /cashflow_report/refresh. To be alerted when transaction data is ready to be fetched, listen for the &#x60;CASHFLOW_REPORT_READY&#x60; webhook.
2686
+ # @param cashflow_report_transactions_get_request [CashflowReportTransactionsGetRequest]
2687
2687
  # @param [Hash] opts the optional parameters
2688
- # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
2689
- def consent_events_get_with_http_info(consent_events_get_request, opts = {})
2688
+ # @return [Array<(CashflowReportTransactionsGetResponse, Integer, Hash)>] CashflowReportTransactionsGetResponse data, response status code and response headers
2689
+ def cashflow_report_transactions_get_with_http_info(cashflow_report_transactions_get_request, opts = {})
2690
2690
  if @api_client.config.debugging
2691
- @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
2691
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_transactions_get ...'
2692
2692
  end
2693
- # verify the required parameter 'consent_events_get_request' is set
2694
- if @api_client.config.client_side_validation && consent_events_get_request.nil?
2695
- fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
2693
+ # verify the required parameter 'cashflow_report_transactions_get_request' is set
2694
+ if @api_client.config.client_side_validation && cashflow_report_transactions_get_request.nil?
2695
+ fail ArgumentError, "Missing the required parameter 'cashflow_report_transactions_get_request' when calling PlaidApi.cashflow_report_transactions_get"
2696
2696
  end
2697
2697
  # resource path
2698
- local_var_path = '/consent/events/get'
2698
+ local_var_path = '/cashflow_report/transactions/get'
2699
2699
 
2700
2700
  # query parameters
2701
2701
  query_params = opts[:query_params] || {}
@@ -2714,16 +2714,16 @@ module Plaid
2714
2714
  form_params = opts[:form_params] || {}
2715
2715
 
2716
2716
  # http body (model)
2717
- post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)
2717
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_transactions_get_request)
2718
2718
 
2719
2719
  # return_type
2720
- return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
2720
+ return_type = opts[:debug_return_type] || 'CashflowReportTransactionsGetResponse'
2721
2721
 
2722
2722
  # auth_names
2723
2723
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2724
2724
 
2725
2725
  new_options = opts.merge(
2726
- :operation => :"PlaidApi.consent_events_get",
2726
+ :operation => :"PlaidApi.cashflow_report_transactions_get",
2727
2727
  :header_params => header_params,
2728
2728
  :query_params => query_params,
2729
2729
  :form_params => form_params,
@@ -2734,36 +2734,36 @@ module Plaid
2734
2734
 
2735
2735
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2736
2736
  if @api_client.config.debugging
2737
- @api_client.config.logger.debug "API called: PlaidApi#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2737
+ @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2738
2738
  end
2739
2739
  return data, status_code, headers
2740
2740
  end
2741
2741
 
2742
- # Retrieve a PDF Reports
2743
- # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
2744
- # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2742
+ # Get categories
2743
+ # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
2744
+ # @param body [Object]
2745
2745
  # @param [Hash] opts the optional parameters
2746
- # @return [File]
2747
- def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
2748
- data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
2746
+ # @return [CategoriesGetResponse]
2747
+ def categories_get(body, opts = {})
2748
+ data, _status_code, _headers = categories_get_with_http_info(body, opts)
2749
2749
  data
2750
2750
  end
2751
2751
 
2752
- # Retrieve a PDF Reports
2753
- # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2754
- # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2752
+ # Get categories
2753
+ # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer &#x60;personal_finance_category&#x60; taxonomy instead of the older &#x60;category&#x60; taxonomy supported by this endpoint. The [&#x60;personal_finance_category taxonomy&#x60; CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
2754
+ # @param body [Object]
2755
2755
  # @param [Hash] opts the optional parameters
2756
- # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
2757
- def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
2756
+ # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
2757
+ def categories_get_with_http_info(body, opts = {})
2758
2758
  if @api_client.config.debugging
2759
- @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
2759
+ @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
2760
2760
  end
2761
- # verify the required parameter 'consumer_report_pdf_get_request' is set
2762
- if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
2763
- fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
2761
+ # verify the required parameter 'body' is set
2762
+ if @api_client.config.client_side_validation && body.nil?
2763
+ fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
2764
2764
  end
2765
2765
  # resource path
2766
- local_var_path = '/consumer_report/pdf/get'
2766
+ local_var_path = '/categories/get'
2767
2767
 
2768
2768
  # query parameters
2769
2769
  query_params = opts[:query_params] || {}
@@ -2771,7 +2771,7 @@ module Plaid
2771
2771
  # header parameters
2772
2772
  header_params = opts[:header_params] || {}
2773
2773
  # HTTP header 'Accept' (if needed)
2774
- header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
2774
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2775
2775
  # HTTP header 'Content-Type'
2776
2776
  content_type = @api_client.select_header_content_type(['application/json'])
2777
2777
  if !content_type.nil?
@@ -2782,16 +2782,16 @@ module Plaid
2782
2782
  form_params = opts[:form_params] || {}
2783
2783
 
2784
2784
  # http body (model)
2785
- post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)
2785
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
2786
2786
 
2787
2787
  # return_type
2788
- return_type = opts[:debug_return_type] || 'File'
2788
+ return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
2789
2789
 
2790
2790
  # auth_names
2791
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2791
+ auth_names = opts[:debug_auth_names] || []
2792
2792
 
2793
2793
  new_options = opts.merge(
2794
- :operation => :"PlaidApi.consumer_report_pdf_get",
2794
+ :operation => :"PlaidApi.categories_get",
2795
2795
  :header_params => header_params,
2796
2796
  :query_params => query_params,
2797
2797
  :form_params => form_params,
@@ -2802,36 +2802,36 @@ module Plaid
2802
2802
 
2803
2803
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2804
2804
  if @api_client.config.debugging
2805
- @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2805
+ @api_client.config.logger.debug "API called: PlaidApi#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2806
2806
  end
2807
2807
  return data, status_code, headers
2808
2808
  end
2809
2809
 
2810
- # Create a CRA report for income verification
2811
- # `/cra/bank_income/create` creates a CRA report for income verification
2812
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
2810
+ # List a historical log of item consent events
2811
+ # List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint.
2812
+ # @param consent_events_get_request [ConsentEventsGetRequest]
2813
2813
  # @param [Hash] opts the optional parameters
2814
- # @return [CraBankIncomeCreateResponse]
2815
- def cra_bank_income_create(cra_bank_income_create_request, opts = {})
2816
- data, _status_code, _headers = cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts)
2814
+ # @return [ConsentEventsGetResponse]
2815
+ def consent_events_get(consent_events_get_request, opts = {})
2816
+ data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
2817
2817
  data
2818
2818
  end
2819
2819
 
2820
- # Create a CRA report for income verification
2821
- # &#x60;/cra/bank_income/create&#x60; creates a CRA report for income verification
2822
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
2820
+ # List a historical log of item consent events
2821
+ # List a historical log of Item consent events. Consent logs are only available for events occurring on or after November 7, 2024. Up to three years of consent logs will be available via the endpoint.
2822
+ # @param consent_events_get_request [ConsentEventsGetRequest]
2823
2823
  # @param [Hash] opts the optional parameters
2824
- # @return [Array<(CraBankIncomeCreateResponse, Integer, Hash)>] CraBankIncomeCreateResponse data, response status code and response headers
2825
- def cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts = {})
2824
+ # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
2825
+ def consent_events_get_with_http_info(consent_events_get_request, opts = {})
2826
2826
  if @api_client.config.debugging
2827
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_create ...'
2827
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
2828
2828
  end
2829
- # verify the required parameter 'cra_bank_income_create_request' is set
2830
- if @api_client.config.client_side_validation && cra_bank_income_create_request.nil?
2831
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_create_request' when calling PlaidApi.cra_bank_income_create"
2829
+ # verify the required parameter 'consent_events_get_request' is set
2830
+ if @api_client.config.client_side_validation && consent_events_get_request.nil?
2831
+ fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
2832
2832
  end
2833
2833
  # resource path
2834
- local_var_path = '/cra/bank_income/create'
2834
+ local_var_path = '/consent/events/get'
2835
2835
 
2836
2836
  # query parameters
2837
2837
  query_params = opts[:query_params] || {}
@@ -2850,16 +2850,16 @@ module Plaid
2850
2850
  form_params = opts[:form_params] || {}
2851
2851
 
2852
2852
  # http body (model)
2853
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_bank_income_create_request)
2853
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)
2854
2854
 
2855
2855
  # return_type
2856
- return_type = opts[:debug_return_type] || 'CraBankIncomeCreateResponse'
2856
+ return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
2857
2857
 
2858
2858
  # auth_names
2859
2859
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2860
2860
 
2861
2861
  new_options = opts.merge(
2862
- :operation => :"PlaidApi.cra_bank_income_create",
2862
+ :operation => :"PlaidApi.consent_events_get",
2863
2863
  :header_params => header_params,
2864
2864
  :query_params => query_params,
2865
2865
  :form_params => form_params,
@@ -2870,36 +2870,36 @@ module Plaid
2870
2870
 
2871
2871
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2872
2872
  if @api_client.config.debugging
2873
- @api_client.config.logger.debug "API called: PlaidApi#cra_bank_income_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2873
+ @api_client.config.logger.debug "API called: PlaidApi#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2874
2874
  end
2875
2875
  return data, status_code, headers
2876
2876
  end
2877
2877
 
2878
- # Retrieve information from the bank accounts used for income verification
2879
- # `/cra/bank_income/get` returns the bank income report(s) for a specified user.
2880
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
2878
+ # Retrieve a PDF Reports
2879
+ # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header.
2880
+ # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2881
2881
  # @param [Hash] opts the optional parameters
2882
- # @return [CraBankIncomeGetResponse]
2883
- def cra_bank_income_get(cra_bank_income_get_request, opts = {})
2884
- data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
2882
+ # @return [File]
2883
+ def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
2884
+ data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
2885
2885
  data
2886
2886
  end
2887
2887
 
2888
- # Retrieve information from the bank accounts used for income verification
2889
- # &#x60;/cra/bank_income/get&#x60; returns the bank income report(s) for a specified user.
2890
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
2888
+ # Retrieve a PDF Reports
2889
+ # Retrieves all existing CRB Bank Income and Base reports for the consumer in PDF format. Response is PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2890
+ # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
2891
2891
  # @param [Hash] opts the optional parameters
2892
- # @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
2893
- def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
2892
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
2893
+ def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
2894
2894
  if @api_client.config.debugging
2895
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
2895
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
2896
2896
  end
2897
- # verify the required parameter 'cra_bank_income_get_request' is set
2898
- if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
2899
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
2897
+ # verify the required parameter 'consumer_report_pdf_get_request' is set
2898
+ if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
2899
+ fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
2900
2900
  end
2901
2901
  # resource path
2902
- local_var_path = '/cra/bank_income/get'
2902
+ local_var_path = '/consumer_report/pdf/get'
2903
2903
 
2904
2904
  # query parameters
2905
2905
  query_params = opts[:query_params] || {}
@@ -2907,7 +2907,7 @@ module Plaid
2907
2907
  # header parameters
2908
2908
  header_params = opts[:header_params] || {}
2909
2909
  # HTTP header 'Accept' (if needed)
2910
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2910
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
2911
2911
  # HTTP header 'Content-Type'
2912
2912
  content_type = @api_client.select_header_content_type(['application/json'])
2913
2913
  if !content_type.nil?
@@ -2918,16 +2918,16 @@ module Plaid
2918
2918
  form_params = opts[:form_params] || {}
2919
2919
 
2920
2920
  # http body (model)
2921
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_bank_income_get_request)
2921
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)
2922
2922
 
2923
2923
  # return_type
2924
- return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
2924
+ return_type = opts[:debug_return_type] || 'File'
2925
2925
 
2926
2926
  # auth_names
2927
2927
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2928
2928
 
2929
2929
  new_options = opts.merge(
2930
- :operation => :"PlaidApi.cra_bank_income_get",
2930
+ :operation => :"PlaidApi.consumer_report_pdf_get",
2931
2931
  :header_params => header_params,
2932
2932
  :query_params => query_params,
2933
2933
  :form_params => form_params,
@@ -2938,7 +2938,7 @@ module Plaid
2938
2938
 
2939
2939
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2940
2940
  if @api_client.config.debugging
2941
- @api_client.config.logger.debug "API called: PlaidApi#cra_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2941
+ @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2942
2942
  end
2943
2943
  return data, status_code, headers
2944
2944
  end
@@ -3419,6 +3419,74 @@ module Plaid
3419
3419
  return data, status_code, headers
3420
3420
  end
3421
3421
 
3422
+ # Retrieve various verification reports for a user.
3423
+ # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or VoE report, you need to make sure that `cra_base_report` is included in the `products` parameter when calling `/link/token/create` or `/cra/check_report/create`. You should call this endpoint after you've received a `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.\"
3424
+ # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
3425
+ # @param [Hash] opts the optional parameters
3426
+ # @return [CraCheckReportVerificationGetResponse]
3427
+ def cra_check_report_verification_get(cra_check_report_verification_get_request, opts = {})
3428
+ data, _status_code, _headers = cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts)
3429
+ data
3430
+ end
3431
+
3432
+ # Retrieve various verification reports for a user.
3433
+ # This endpoint allows you to retrieve verification reports for a user. To obtain a VoA or VoE report, you need to make sure that &#x60;cra_base_report&#x60; is included in the &#x60;products&#x60; parameter when calling &#x60;/link/token/create&#x60; or &#x60;/cra/check_report/create&#x60;. You should call this endpoint after you&#39;ve received a &#x60;CHECK_REPORT_READY&#x60; webhook, either after the Link session for the user or after calling &#x60;/cra/check_report/create&#x60;. If the most recent consumer report for the user doesn’t have sufficient data to generate the report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.\&quot;
3434
+ # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
3435
+ # @param [Hash] opts the optional parameters
3436
+ # @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
3437
+ def cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts = {})
3438
+ if @api_client.config.debugging
3439
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_verification_get ...'
3440
+ end
3441
+ # verify the required parameter 'cra_check_report_verification_get_request' is set
3442
+ if @api_client.config.client_side_validation && cra_check_report_verification_get_request.nil?
3443
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_verification_get_request' when calling PlaidApi.cra_check_report_verification_get"
3444
+ end
3445
+ # resource path
3446
+ local_var_path = '/cra/check_report/verification/get'
3447
+
3448
+ # query parameters
3449
+ query_params = opts[:query_params] || {}
3450
+
3451
+ # header parameters
3452
+ header_params = opts[:header_params] || {}
3453
+ # HTTP header 'Accept' (if needed)
3454
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3455
+ # HTTP header 'Content-Type'
3456
+ content_type = @api_client.select_header_content_type(['application/json'])
3457
+ if !content_type.nil?
3458
+ header_params['Content-Type'] = content_type
3459
+ end
3460
+
3461
+ # form parameters
3462
+ form_params = opts[:form_params] || {}
3463
+
3464
+ # http body (model)
3465
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_verification_get_request)
3466
+
3467
+ # return_type
3468
+ return_type = opts[:debug_return_type] || 'CraCheckReportVerificationGetResponse'
3469
+
3470
+ # auth_names
3471
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3472
+
3473
+ new_options = opts.merge(
3474
+ :operation => :"PlaidApi.cra_check_report_verification_get",
3475
+ :header_params => header_params,
3476
+ :query_params => query_params,
3477
+ :form_params => form_params,
3478
+ :body => post_body,
3479
+ :auth_names => auth_names,
3480
+ :return_type => return_type
3481
+ )
3482
+
3483
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3484
+ if @api_client.config.debugging
3485
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3486
+ end
3487
+ return data, status_code, headers
3488
+ end
3489
+
3422
3490
  # Register loan applications and decisions.
3423
3491
  # `/cra/loans/applications/register` registers loan applications and decisions.
3424
3492
  # @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
@@ -5731,31 +5799,31 @@ module Plaid
5731
5799
  return data, status_code, headers
5732
5800
  end
5733
5801
 
5734
- # (Deprecated) Create a deposit switch without using Plaid Exchange
5735
- # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5736
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5802
+ # Search employer database
5803
+ # `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
5804
+ # @param employers_search_request [EmployersSearchRequest]
5737
5805
  # @param [Hash] opts the optional parameters
5738
- # @return [DepositSwitchAltCreateResponse]
5739
- def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
5740
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
5806
+ # @return [EmployersSearchResponse]
5807
+ def employers_search(employers_search_request, opts = {})
5808
+ data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
5741
5809
  data
5742
5810
  end
5743
5811
 
5744
- # (Deprecated) Create a deposit switch without using Plaid Exchange
5745
- # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5746
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5812
+ # Search employer database
5813
+ # &#x60;/employers/search&#x60; allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
5814
+ # @param employers_search_request [EmployersSearchRequest]
5747
5815
  # @param [Hash] opts the optional parameters
5748
- # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
5749
- def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
5816
+ # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
5817
+ def employers_search_with_http_info(employers_search_request, opts = {})
5750
5818
  if @api_client.config.debugging
5751
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
5819
+ @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
5752
5820
  end
5753
- # verify the required parameter 'deposit_switch_alt_create_request' is set
5754
- if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
5755
- fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
5821
+ # verify the required parameter 'employers_search_request' is set
5822
+ if @api_client.config.client_side_validation && employers_search_request.nil?
5823
+ fail ArgumentError, "Missing the required parameter 'employers_search_request' when calling PlaidApi.employers_search"
5756
5824
  end
5757
5825
  # resource path
5758
- local_var_path = '/deposit_switch/alt/create'
5826
+ local_var_path = '/employers/search'
5759
5827
 
5760
5828
  # query parameters
5761
5829
  query_params = opts[:query_params] || {}
@@ -5774,16 +5842,16 @@ module Plaid
5774
5842
  form_params = opts[:form_params] || {}
5775
5843
 
5776
5844
  # http body (model)
5777
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
5845
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)
5778
5846
 
5779
5847
  # return_type
5780
- return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
5848
+ return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
5781
5849
 
5782
5850
  # auth_names
5783
5851
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5784
5852
 
5785
5853
  new_options = opts.merge(
5786
- :operation => :"PlaidApi.deposit_switch_alt_create",
5854
+ :operation => :"PlaidApi.employers_search",
5787
5855
  :header_params => header_params,
5788
5856
  :query_params => query_params,
5789
5857
  :form_params => form_params,
@@ -5794,36 +5862,36 @@ module Plaid
5794
5862
 
5795
5863
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5796
5864
  if @api_client.config.debugging
5797
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5865
+ @api_client.config.logger.debug "API called: PlaidApi#employers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5798
5866
  end
5799
5867
  return data, status_code, headers
5800
5868
  end
5801
5869
 
5802
- # (Deprecated) Create a deposit switch
5803
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5804
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5870
+ # (Deprecated) Retrieve a summary of an individual's employment information
5871
+ # `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
5872
+ # @param employment_verification_get_request [EmploymentVerificationGetRequest]
5805
5873
  # @param [Hash] opts the optional parameters
5806
- # @return [DepositSwitchCreateResponse]
5807
- def deposit_switch_create(deposit_switch_create_request, opts = {})
5808
- data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
5874
+ # @return [EmploymentVerificationGetResponse]
5875
+ def employment_verification_get(employment_verification_get_request, opts = {})
5876
+ data, _status_code, _headers = employment_verification_get_with_http_info(employment_verification_get_request, opts)
5809
5877
  data
5810
5878
  end
5811
5879
 
5812
- # (Deprecated) Create a deposit switch
5813
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5814
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5880
+ # (Deprecated) Retrieve a summary of an individual&#39;s employment information
5881
+ # &#x60;/employment/verification/get&#x60; returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use &#x60;/credit/employment/get&#x60; instead.
5882
+ # @param employment_verification_get_request [EmploymentVerificationGetRequest]
5815
5883
  # @param [Hash] opts the optional parameters
5816
- # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
5817
- def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
5884
+ # @return [Array<(EmploymentVerificationGetResponse, Integer, Hash)>] EmploymentVerificationGetResponse data, response status code and response headers
5885
+ def employment_verification_get_with_http_info(employment_verification_get_request, opts = {})
5818
5886
  if @api_client.config.debugging
5819
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
5887
+ @api_client.config.logger.debug 'Calling API: PlaidApi.employment_verification_get ...'
5820
5888
  end
5821
- # verify the required parameter 'deposit_switch_create_request' is set
5822
- if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
5823
- fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
5889
+ # verify the required parameter 'employment_verification_get_request' is set
5890
+ if @api_client.config.client_side_validation && employment_verification_get_request.nil?
5891
+ fail ArgumentError, "Missing the required parameter 'employment_verification_get_request' when calling PlaidApi.employment_verification_get"
5824
5892
  end
5825
5893
  # resource path
5826
- local_var_path = '/deposit_switch/create'
5894
+ local_var_path = '/employment/verification/get'
5827
5895
 
5828
5896
  # query parameters
5829
5897
  query_params = opts[:query_params] || {}
@@ -5842,16 +5910,16 @@ module Plaid
5842
5910
  form_params = opts[:form_params] || {}
5843
5911
 
5844
5912
  # http body (model)
5845
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_create_request)
5913
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(employment_verification_get_request)
5846
5914
 
5847
5915
  # return_type
5848
- return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
5916
+ return_type = opts[:debug_return_type] || 'EmploymentVerificationGetResponse'
5849
5917
 
5850
5918
  # auth_names
5851
5919
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5852
5920
 
5853
5921
  new_options = opts.merge(
5854
- :operation => :"PlaidApi.deposit_switch_create",
5922
+ :operation => :"PlaidApi.employment_verification_get",
5855
5923
  :header_params => header_params,
5856
5924
  :query_params => query_params,
5857
5925
  :form_params => form_params,
@@ -5862,279 +5930,7 @@ module Plaid
5862
5930
 
5863
5931
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5864
5932
  if @api_client.config.debugging
5865
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5866
- end
5867
- return data, status_code, headers
5868
- end
5869
-
5870
- # (Deprecated) Retrieve a deposit switch
5871
- # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
5872
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
5873
- # @param [Hash] opts the optional parameters
5874
- # @return [DepositSwitchGetResponse]
5875
- def deposit_switch_get(deposit_switch_get_request, opts = {})
5876
- data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
5877
- data
5878
- end
5879
-
5880
- # (Deprecated) Retrieve a deposit switch
5881
- # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
5882
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
5883
- # @param [Hash] opts the optional parameters
5884
- # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
5885
- def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
5886
- if @api_client.config.debugging
5887
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
5888
- end
5889
- # verify the required parameter 'deposit_switch_get_request' is set
5890
- if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
5891
- fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
5892
- end
5893
- # resource path
5894
- local_var_path = '/deposit_switch/get'
5895
-
5896
- # query parameters
5897
- query_params = opts[:query_params] || {}
5898
-
5899
- # header parameters
5900
- header_params = opts[:header_params] || {}
5901
- # HTTP header 'Accept' (if needed)
5902
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5903
- # HTTP header 'Content-Type'
5904
- content_type = @api_client.select_header_content_type(['application/json'])
5905
- if !content_type.nil?
5906
- header_params['Content-Type'] = content_type
5907
- end
5908
-
5909
- # form parameters
5910
- form_params = opts[:form_params] || {}
5911
-
5912
- # http body (model)
5913
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_get_request)
5914
-
5915
- # return_type
5916
- return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
5917
-
5918
- # auth_names
5919
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5920
-
5921
- new_options = opts.merge(
5922
- :operation => :"PlaidApi.deposit_switch_get",
5923
- :header_params => header_params,
5924
- :query_params => query_params,
5925
- :form_params => form_params,
5926
- :body => post_body,
5927
- :auth_names => auth_names,
5928
- :return_type => return_type
5929
- )
5930
-
5931
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5932
- if @api_client.config.debugging
5933
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5934
- end
5935
- return data, status_code, headers
5936
- end
5937
-
5938
- # (Deprecated) Create a deposit switch token
5939
- # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
5940
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5941
- # @param [Hash] opts the optional parameters
5942
- # @return [DepositSwitchTokenCreateResponse]
5943
- def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
5944
- data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
5945
- data
5946
- end
5947
-
5948
- # (Deprecated) Create a deposit switch token
5949
- # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
5950
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5951
- # @param [Hash] opts the optional parameters
5952
- # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
5953
- def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
5954
- if @api_client.config.debugging
5955
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
5956
- end
5957
- # verify the required parameter 'deposit_switch_token_create_request' is set
5958
- if @api_client.config.client_side_validation && deposit_switch_token_create_request.nil?
5959
- fail ArgumentError, "Missing the required parameter 'deposit_switch_token_create_request' when calling PlaidApi.deposit_switch_token_create"
5960
- end
5961
- # resource path
5962
- local_var_path = '/deposit_switch/token/create'
5963
-
5964
- # query parameters
5965
- query_params = opts[:query_params] || {}
5966
-
5967
- # header parameters
5968
- header_params = opts[:header_params] || {}
5969
- # HTTP header 'Accept' (if needed)
5970
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5971
- # HTTP header 'Content-Type'
5972
- content_type = @api_client.select_header_content_type(['application/json'])
5973
- if !content_type.nil?
5974
- header_params['Content-Type'] = content_type
5975
- end
5976
-
5977
- # form parameters
5978
- form_params = opts[:form_params] || {}
5979
-
5980
- # http body (model)
5981
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_token_create_request)
5982
-
5983
- # return_type
5984
- return_type = opts[:debug_return_type] || 'DepositSwitchTokenCreateResponse'
5985
-
5986
- # auth_names
5987
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5988
-
5989
- new_options = opts.merge(
5990
- :operation => :"PlaidApi.deposit_switch_token_create",
5991
- :header_params => header_params,
5992
- :query_params => query_params,
5993
- :form_params => form_params,
5994
- :body => post_body,
5995
- :auth_names => auth_names,
5996
- :return_type => return_type
5997
- )
5998
-
5999
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6000
- if @api_client.config.debugging
6001
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6002
- end
6003
- return data, status_code, headers
6004
- end
6005
-
6006
- # Search employer database
6007
- # `/employers/search` allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user's employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6008
- # @param employers_search_request [EmployersSearchRequest]
6009
- # @param [Hash] opts the optional parameters
6010
- # @return [EmployersSearchResponse]
6011
- def employers_search(employers_search_request, opts = {})
6012
- data, _status_code, _headers = employers_search_with_http_info(employers_search_request, opts)
6013
- data
6014
- end
6015
-
6016
- # Search employer database
6017
- # &#x60;/employers/search&#x60; allows you the ability to search Plaid’s database of known employers, for use with Deposit Switch. You can use this endpoint to look up a user&#39;s employer in order to confirm that they are supported. Users with non-supported employers can then be routed out of the Deposit Switch flow. The data in the employer database is currently limited. As the Deposit Switch and Income products progress through their respective beta periods, more employers are being regularly added. Because the employer database is frequently updated, we recommend that you do not cache or store data from this endpoint for more than a day.
6018
- # @param employers_search_request [EmployersSearchRequest]
6019
- # @param [Hash] opts the optional parameters
6020
- # @return [Array<(EmployersSearchResponse, Integer, Hash)>] EmployersSearchResponse data, response status code and response headers
6021
- def employers_search_with_http_info(employers_search_request, opts = {})
6022
- if @api_client.config.debugging
6023
- @api_client.config.logger.debug 'Calling API: PlaidApi.employers_search ...'
6024
- end
6025
- # verify the required parameter 'employers_search_request' is set
6026
- if @api_client.config.client_side_validation && employers_search_request.nil?
6027
- fail ArgumentError, "Missing the required parameter 'employers_search_request' when calling PlaidApi.employers_search"
6028
- end
6029
- # resource path
6030
- local_var_path = '/employers/search'
6031
-
6032
- # query parameters
6033
- query_params = opts[:query_params] || {}
6034
-
6035
- # header parameters
6036
- header_params = opts[:header_params] || {}
6037
- # HTTP header 'Accept' (if needed)
6038
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6039
- # HTTP header 'Content-Type'
6040
- content_type = @api_client.select_header_content_type(['application/json'])
6041
- if !content_type.nil?
6042
- header_params['Content-Type'] = content_type
6043
- end
6044
-
6045
- # form parameters
6046
- form_params = opts[:form_params] || {}
6047
-
6048
- # http body (model)
6049
- post_body = opts[:debug_body] || @api_client.object_to_http_body(employers_search_request)
6050
-
6051
- # return_type
6052
- return_type = opts[:debug_return_type] || 'EmployersSearchResponse'
6053
-
6054
- # auth_names
6055
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6056
-
6057
- new_options = opts.merge(
6058
- :operation => :"PlaidApi.employers_search",
6059
- :header_params => header_params,
6060
- :query_params => query_params,
6061
- :form_params => form_params,
6062
- :body => post_body,
6063
- :auth_names => auth_names,
6064
- :return_type => return_type
6065
- )
6066
-
6067
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6068
- if @api_client.config.debugging
6069
- @api_client.config.logger.debug "API called: PlaidApi#employers_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6070
- end
6071
- return data, status_code, headers
6072
- end
6073
-
6074
- # (Deprecated) Retrieve a summary of an individual's employment information
6075
- # `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
6076
- # @param employment_verification_get_request [EmploymentVerificationGetRequest]
6077
- # @param [Hash] opts the optional parameters
6078
- # @return [EmploymentVerificationGetResponse]
6079
- def employment_verification_get(employment_verification_get_request, opts = {})
6080
- data, _status_code, _headers = employment_verification_get_with_http_info(employment_verification_get_request, opts)
6081
- data
6082
- end
6083
-
6084
- # (Deprecated) Retrieve a summary of an individual&#39;s employment information
6085
- # &#x60;/employment/verification/get&#x60; returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use &#x60;/credit/employment/get&#x60; instead.
6086
- # @param employment_verification_get_request [EmploymentVerificationGetRequest]
6087
- # @param [Hash] opts the optional parameters
6088
- # @return [Array<(EmploymentVerificationGetResponse, Integer, Hash)>] EmploymentVerificationGetResponse data, response status code and response headers
6089
- def employment_verification_get_with_http_info(employment_verification_get_request, opts = {})
6090
- if @api_client.config.debugging
6091
- @api_client.config.logger.debug 'Calling API: PlaidApi.employment_verification_get ...'
6092
- end
6093
- # verify the required parameter 'employment_verification_get_request' is set
6094
- if @api_client.config.client_side_validation && employment_verification_get_request.nil?
6095
- fail ArgumentError, "Missing the required parameter 'employment_verification_get_request' when calling PlaidApi.employment_verification_get"
6096
- end
6097
- # resource path
6098
- local_var_path = '/employment/verification/get'
6099
-
6100
- # query parameters
6101
- query_params = opts[:query_params] || {}
6102
-
6103
- # header parameters
6104
- header_params = opts[:header_params] || {}
6105
- # HTTP header 'Accept' (if needed)
6106
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6107
- # HTTP header 'Content-Type'
6108
- content_type = @api_client.select_header_content_type(['application/json'])
6109
- if !content_type.nil?
6110
- header_params['Content-Type'] = content_type
6111
- end
6112
-
6113
- # form parameters
6114
- form_params = opts[:form_params] || {}
6115
-
6116
- # http body (model)
6117
- post_body = opts[:debug_body] || @api_client.object_to_http_body(employment_verification_get_request)
6118
-
6119
- # return_type
6120
- return_type = opts[:debug_return_type] || 'EmploymentVerificationGetResponse'
6121
-
6122
- # auth_names
6123
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6124
-
6125
- new_options = opts.merge(
6126
- :operation => :"PlaidApi.employment_verification_get",
6127
- :header_params => header_params,
6128
- :query_params => query_params,
6129
- :form_params => form_params,
6130
- :body => post_body,
6131
- :auth_names => auth_names,
6132
- :return_type => return_type
6133
- )
6134
-
6135
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6136
- if @api_client.config.debugging
6137
- @api_client.config.logger.debug "API called: PlaidApi#employment_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5933
+ @api_client.config.logger.debug "API called: PlaidApi#employment_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6138
5934
  end
6139
5935
  return data, status_code, headers
6140
5936
  end
@@ -7827,7 +7623,7 @@ module Plaid
7827
7623
  end
7828
7624
 
7829
7625
  # Search for an Issue
7830
- # 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.
7626
+ # 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.
7831
7627
  # @param issues_search_request [IssuesSearchRequest]
7832
7628
  # @param [Hash] opts the optional parameters
7833
7629
  # @return [IssuesSearchResponse]
@@ -7837,7 +7633,7 @@ module Plaid
7837
7633
  end
7838
7634
 
7839
7635
  # Search for an Issue
7840
- # 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.
7636
+ # 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.
7841
7637
  # @param issues_search_request [IssuesSearchRequest]
7842
7638
  # @param [Hash] opts the optional parameters
7843
7639
  # @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
@@ -8575,7 +8371,7 @@ module Plaid
8575
8371
  end
8576
8372
 
8577
8373
  # Remove an Item
8578
- # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item. For money movement products such as Auth and Transfer, if the Item is at an institution that uses Tokenized Account Numbers (TANs), such as Chase or PNC, calling `/item/remove` will invalidate the TAN, and subsequent ACH transfer attempts using that TAN will be returned. In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
8374
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling `/item/remove` is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling `/item/remove` is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). In Limited Production, calling `/item/remove` does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the `/asset_report/remove` endpoint. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
8579
8375
  # @param item_remove_request [ItemRemoveRequest]
8580
8376
  # @param [Hash] opts the optional parameters
8581
8377
  # @return [ItemRemoveResponse]
@@ -8585,7 +8381,7 @@ module Plaid
8585
8381
  end
8586
8382
 
8587
8383
  # Remove an Item
8588
- # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item. For money movement products such as Auth and Transfer, if the Item is at an institution that uses Tokenized Account Numbers (TANs), such as Chase or PNC, calling &#x60;/item/remove&#x60; will invalidate the TAN, and subsequent ACH transfer attempts using that TAN will be returned. In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
8384
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens associated with the Item, is no longer valid and cannot be used to access any data that was associated with the Item. Calling &#x60;/item/remove&#x60; is a recommended best practice when offboarding users or if a user chooses to disconnect an account linked via Plaid. For subscription products, such as Transactions, Liabilities, and Investments, calling &#x60;/item/remove&#x60; is required to end subscription billing for the Item, unless the end user revoked permission (e.g. via [https://my.plaid.com/](https://my.plaid.com/). For more details, see [Subscription fee model](https://plaid.com/docs/account/billing/#subscription-fee). In Limited Production, calling &#x60;/item/remove&#x60; does not impact the number of remaining Limited Production Items you have available. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove access to them specifically using the &#x60;/asset_report/remove&#x60; endpoint. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
8589
8385
  # @param item_remove_request [ItemRemoveRequest]
8590
8386
  # @param [Hash] opts the optional parameters
8591
8387
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -9254,31 +9050,31 @@ module Plaid
9254
9050
  return data, status_code, headers
9255
9051
  end
9256
9052
 
9257
- # Creates a new end customer for a Plaid reseller.
9258
- # The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
9259
- # @param partner_customer_create_request [PartnerCustomerCreateRequest]
9053
+ # Get metadata about an OAuth token
9054
+ # `/oauth/introspect` returns metadata about an access token or refresh token. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9055
+ # @param o_auth_introspect_request [OAuthIntrospectRequest]
9260
9056
  # @param [Hash] opts the optional parameters
9261
- # @return [PartnerCustomerCreateResponse]
9262
- def partner_customer_create(partner_customer_create_request, opts = {})
9263
- data, _status_code, _headers = partner_customer_create_with_http_info(partner_customer_create_request, opts)
9057
+ # @return [OAuthIntrospectResponse]
9058
+ def oauth_introspect(o_auth_introspect_request, opts = {})
9059
+ data, _status_code, _headers = oauth_introspect_with_http_info(o_auth_introspect_request, opts)
9264
9060
  data
9265
9061
  end
9266
9062
 
9267
- # Creates a new end customer for a Plaid reseller.
9268
- # The &#x60;/partner/customer/create&#x60; endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
9269
- # @param partner_customer_create_request [PartnerCustomerCreateRequest]
9063
+ # Get metadata about an OAuth token
9064
+ # &#x60;/oauth/introspect&#x60; returns metadata about an access token or refresh token. Note: This endpoint supports &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9065
+ # @param o_auth_introspect_request [OAuthIntrospectRequest]
9270
9066
  # @param [Hash] opts the optional parameters
9271
- # @return [Array<(PartnerCustomerCreateResponse, Integer, Hash)>] PartnerCustomerCreateResponse data, response status code and response headers
9272
- def partner_customer_create_with_http_info(partner_customer_create_request, opts = {})
9067
+ # @return [Array<(OAuthIntrospectResponse, Integer, Hash)>] OAuthIntrospectResponse data, response status code and response headers
9068
+ def oauth_introspect_with_http_info(o_auth_introspect_request, opts = {})
9273
9069
  if @api_client.config.debugging
9274
- @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_create ...'
9070
+ @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_introspect ...'
9275
9071
  end
9276
- # verify the required parameter 'partner_customer_create_request' is set
9277
- if @api_client.config.client_side_validation && partner_customer_create_request.nil?
9278
- fail ArgumentError, "Missing the required parameter 'partner_customer_create_request' when calling PlaidApi.partner_customer_create"
9072
+ # verify the required parameter 'o_auth_introspect_request' is set
9073
+ if @api_client.config.client_side_validation && o_auth_introspect_request.nil?
9074
+ fail ArgumentError, "Missing the required parameter 'o_auth_introspect_request' when calling PlaidApi.oauth_introspect"
9279
9075
  end
9280
9076
  # resource path
9281
- local_var_path = '/partner/customer/create'
9077
+ local_var_path = '/oauth/introspect'
9282
9078
 
9283
9079
  # query parameters
9284
9080
  query_params = opts[:query_params] || {}
@@ -9297,16 +9093,16 @@ module Plaid
9297
9093
  form_params = opts[:form_params] || {}
9298
9094
 
9299
9095
  # http body (model)
9300
- post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_create_request)
9096
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_introspect_request)
9301
9097
 
9302
9098
  # return_type
9303
- return_type = opts[:debug_return_type] || 'PartnerCustomerCreateResponse'
9099
+ return_type = opts[:debug_return_type] || 'OAuthIntrospectResponse'
9304
9100
 
9305
9101
  # auth_names
9306
9102
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9307
9103
 
9308
9104
  new_options = opts.merge(
9309
- :operation => :"PlaidApi.partner_customer_create",
9105
+ :operation => :"PlaidApi.oauth_introspect",
9310
9106
  :header_params => header_params,
9311
9107
  :query_params => query_params,
9312
9108
  :form_params => form_params,
@@ -9317,16 +9113,220 @@ module Plaid
9317
9113
 
9318
9114
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9319
9115
  if @api_client.config.debugging
9320
- @api_client.config.logger.debug "API called: PlaidApi#partner_customer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9116
+ @api_client.config.logger.debug "API called: PlaidApi#oauth_introspect\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9321
9117
  end
9322
9118
  return data, status_code, headers
9323
9119
  end
9324
9120
 
9325
- # Enables a Plaid reseller's end customer in the Production environment.
9326
- # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
9327
- # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
9121
+ # Revoke an OAuth token
9122
+ # `/oauth/revoke` revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, including exchanged tokens. Note: This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9123
+ # @param o_auth_revoke_request [OAuthRevokeRequest]
9328
9124
  # @param [Hash] opts the optional parameters
9329
- # @return [PartnerCustomerEnableResponse]
9125
+ # @return [OAuthRevokeResponse]
9126
+ def oauth_revoke(o_auth_revoke_request, opts = {})
9127
+ data, _status_code, _headers = oauth_revoke_with_http_info(o_auth_revoke_request, opts)
9128
+ data
9129
+ end
9130
+
9131
+ # Revoke an OAuth token
9132
+ # &#x60;/oauth/revoke&#x60; revokes an access or refresh token, preventing any further use. If a refresh token is revoked, all access and refresh tokens derived from it are also revoked, including exchanged tokens. Note: This endpoint supports &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9133
+ # @param o_auth_revoke_request [OAuthRevokeRequest]
9134
+ # @param [Hash] opts the optional parameters
9135
+ # @return [Array<(OAuthRevokeResponse, Integer, Hash)>] OAuthRevokeResponse data, response status code and response headers
9136
+ def oauth_revoke_with_http_info(o_auth_revoke_request, opts = {})
9137
+ if @api_client.config.debugging
9138
+ @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_revoke ...'
9139
+ end
9140
+ # verify the required parameter 'o_auth_revoke_request' is set
9141
+ if @api_client.config.client_side_validation && o_auth_revoke_request.nil?
9142
+ fail ArgumentError, "Missing the required parameter 'o_auth_revoke_request' when calling PlaidApi.oauth_revoke"
9143
+ end
9144
+ # resource path
9145
+ local_var_path = '/oauth/revoke'
9146
+
9147
+ # query parameters
9148
+ query_params = opts[:query_params] || {}
9149
+
9150
+ # header parameters
9151
+ header_params = opts[:header_params] || {}
9152
+ # HTTP header 'Accept' (if needed)
9153
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9154
+ # HTTP header 'Content-Type'
9155
+ content_type = @api_client.select_header_content_type(['application/json'])
9156
+ if !content_type.nil?
9157
+ header_params['Content-Type'] = content_type
9158
+ end
9159
+
9160
+ # form parameters
9161
+ form_params = opts[:form_params] || {}
9162
+
9163
+ # http body (model)
9164
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_revoke_request)
9165
+
9166
+ # return_type
9167
+ return_type = opts[:debug_return_type] || 'OAuthRevokeResponse'
9168
+
9169
+ # auth_names
9170
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9171
+
9172
+ new_options = opts.merge(
9173
+ :operation => :"PlaidApi.oauth_revoke",
9174
+ :header_params => header_params,
9175
+ :query_params => query_params,
9176
+ :form_params => form_params,
9177
+ :body => post_body,
9178
+ :auth_names => auth_names,
9179
+ :return_type => return_type
9180
+ )
9181
+
9182
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9183
+ if @api_client.config.debugging
9184
+ @api_client.config.logger.debug "API called: PlaidApi#oauth_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9185
+ end
9186
+ return data, status_code, headers
9187
+ end
9188
+
9189
+ # Create or refresh an OAuth access token
9190
+ # `/oauth/token` issues an access token and refresh token depending on the `grant_type` provided. This endpoint supports `Content-Type: application/x-www-form-urlencoded` as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9191
+ # @param o_auth_token_request [OAuthTokenRequest]
9192
+ # @param [Hash] opts the optional parameters
9193
+ # @return [OAuthTokenResponse]
9194
+ def oauth_token(o_auth_token_request, opts = {})
9195
+ data, _status_code, _headers = oauth_token_with_http_info(o_auth_token_request, opts)
9196
+ data
9197
+ end
9198
+
9199
+ # Create or refresh an OAuth access token
9200
+ # &#x60;/oauth/token&#x60; issues an access token and refresh token depending on the &#x60;grant_type&#x60; provided. This endpoint supports &#x60;Content-Type: application/x-www-form-urlencoded&#x60; as well as JSON. The fields for the form are equivalent to the fields for JSON and conform to the OAuth 2.0 specification.
9201
+ # @param o_auth_token_request [OAuthTokenRequest]
9202
+ # @param [Hash] opts the optional parameters
9203
+ # @return [Array<(OAuthTokenResponse, Integer, Hash)>] OAuthTokenResponse data, response status code and response headers
9204
+ def oauth_token_with_http_info(o_auth_token_request, opts = {})
9205
+ if @api_client.config.debugging
9206
+ @api_client.config.logger.debug 'Calling API: PlaidApi.oauth_token ...'
9207
+ end
9208
+ # verify the required parameter 'o_auth_token_request' is set
9209
+ if @api_client.config.client_side_validation && o_auth_token_request.nil?
9210
+ fail ArgumentError, "Missing the required parameter 'o_auth_token_request' when calling PlaidApi.oauth_token"
9211
+ end
9212
+ # resource path
9213
+ local_var_path = '/oauth/token'
9214
+
9215
+ # query parameters
9216
+ query_params = opts[:query_params] || {}
9217
+
9218
+ # header parameters
9219
+ header_params = opts[:header_params] || {}
9220
+ # HTTP header 'Accept' (if needed)
9221
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9222
+ # HTTP header 'Content-Type'
9223
+ content_type = @api_client.select_header_content_type(['application/json'])
9224
+ if !content_type.nil?
9225
+ header_params['Content-Type'] = content_type
9226
+ end
9227
+
9228
+ # form parameters
9229
+ form_params = opts[:form_params] || {}
9230
+
9231
+ # http body (model)
9232
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth_token_request)
9233
+
9234
+ # return_type
9235
+ return_type = opts[:debug_return_type] || 'OAuthTokenResponse'
9236
+
9237
+ # auth_names
9238
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9239
+
9240
+ new_options = opts.merge(
9241
+ :operation => :"PlaidApi.oauth_token",
9242
+ :header_params => header_params,
9243
+ :query_params => query_params,
9244
+ :form_params => form_params,
9245
+ :body => post_body,
9246
+ :auth_names => auth_names,
9247
+ :return_type => return_type
9248
+ )
9249
+
9250
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9251
+ if @api_client.config.debugging
9252
+ @api_client.config.logger.debug "API called: PlaidApi#oauth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9253
+ end
9254
+ return data, status_code, headers
9255
+ end
9256
+
9257
+ # Creates a new end customer for a Plaid reseller.
9258
+ # The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
9259
+ # @param partner_customer_create_request [PartnerCustomerCreateRequest]
9260
+ # @param [Hash] opts the optional parameters
9261
+ # @return [PartnerCustomerCreateResponse]
9262
+ def partner_customer_create(partner_customer_create_request, opts = {})
9263
+ data, _status_code, _headers = partner_customer_create_with_http_info(partner_customer_create_request, opts)
9264
+ data
9265
+ end
9266
+
9267
+ # Creates a new end customer for a Plaid reseller.
9268
+ # The &#x60;/partner/customer/create&#x60; endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
9269
+ # @param partner_customer_create_request [PartnerCustomerCreateRequest]
9270
+ # @param [Hash] opts the optional parameters
9271
+ # @return [Array<(PartnerCustomerCreateResponse, Integer, Hash)>] PartnerCustomerCreateResponse data, response status code and response headers
9272
+ def partner_customer_create_with_http_info(partner_customer_create_request, opts = {})
9273
+ if @api_client.config.debugging
9274
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_create ...'
9275
+ end
9276
+ # verify the required parameter 'partner_customer_create_request' is set
9277
+ if @api_client.config.client_side_validation && partner_customer_create_request.nil?
9278
+ fail ArgumentError, "Missing the required parameter 'partner_customer_create_request' when calling PlaidApi.partner_customer_create"
9279
+ end
9280
+ # resource path
9281
+ local_var_path = '/partner/customer/create'
9282
+
9283
+ # query parameters
9284
+ query_params = opts[:query_params] || {}
9285
+
9286
+ # header parameters
9287
+ header_params = opts[:header_params] || {}
9288
+ # HTTP header 'Accept' (if needed)
9289
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9290
+ # HTTP header 'Content-Type'
9291
+ content_type = @api_client.select_header_content_type(['application/json'])
9292
+ if !content_type.nil?
9293
+ header_params['Content-Type'] = content_type
9294
+ end
9295
+
9296
+ # form parameters
9297
+ form_params = opts[:form_params] || {}
9298
+
9299
+ # http body (model)
9300
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_create_request)
9301
+
9302
+ # return_type
9303
+ return_type = opts[:debug_return_type] || 'PartnerCustomerCreateResponse'
9304
+
9305
+ # auth_names
9306
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9307
+
9308
+ new_options = opts.merge(
9309
+ :operation => :"PlaidApi.partner_customer_create",
9310
+ :header_params => header_params,
9311
+ :query_params => query_params,
9312
+ :form_params => form_params,
9313
+ :body => post_body,
9314
+ :auth_names => auth_names,
9315
+ :return_type => return_type
9316
+ )
9317
+
9318
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9319
+ if @api_client.config.debugging
9320
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9321
+ end
9322
+ return data, status_code, headers
9323
+ end
9324
+
9325
+ # Enables a Plaid reseller's end customer in the Production environment.
9326
+ # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the full Production environment.
9327
+ # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
9328
+ # @param [Hash] opts the optional parameters
9329
+ # @return [PartnerCustomerEnableResponse]
9330
9330
  def partner_customer_enable(partner_customer_enable_request, opts = {})
9331
9331
  data, _status_code, _headers = partner_customer_enable_with_http_info(partner_customer_enable_request, opts)
9332
9332
  data
@@ -10071,7 +10071,7 @@ module Plaid
10071
10071
  end
10072
10072
 
10073
10073
  # Reverse an existing payment
10074
- # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.
10074
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.
10075
10075
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
10076
10076
  # @param [Hash] opts the optional parameters
10077
10077
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -10081,7 +10081,7 @@ module Plaid
10081
10081
  end
10082
10082
 
10083
10083
  # Reverse an existing payment
10084
- # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.
10084
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund. Providing counterparty information such as date of birth and address increases the likelihood of refund being successful without human intervention.
10085
10085
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
10086
10086
  # @param [Hash] opts the optional parameters
10087
10087
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -11227,7 +11227,7 @@ module Plaid
11227
11227
  end
11228
11228
 
11229
11229
  # Report whether you initiated an ACH transaction
11230
- # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
11230
+ # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
11231
11231
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
11232
11232
  # @param [Hash] opts the optional parameters
11233
11233
  # @return [ProcessorSignalDecisionReportResponse]
@@ -11237,7 +11237,7 @@ module Plaid
11237
11237
  end
11238
11238
 
11239
11239
  # Report whether you initiated an ACH transaction
11240
- # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
11240
+ # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
11241
11241
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
11242
11242
  # @param [Hash] opts the optional parameters
11243
11243
  # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
@@ -11431,7 +11431,7 @@ module Plaid
11431
11431
  end
11432
11432
 
11433
11433
  # Report a return for an ACH transaction
11434
- # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
11434
+ # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
11435
11435
  # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
11436
11436
  # @param [Hash] opts the optional parameters
11437
11437
  # @return [ProcessorSignalReturnReportResponse]
@@ -11441,7 +11441,7 @@ module Plaid
11441
11441
  end
11442
11442
 
11443
11443
  # Report a return for an ACH transaction
11444
- # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
11444
+ # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
11445
11445
  # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
11446
11446
  # @param [Hash] opts the optional parameters
11447
11447
  # @return [Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>] ProcessorSignalReturnReportResponse data, response status code and response headers
@@ -11862,7 +11862,211 @@ module Plaid
11862
11862
  fail ArgumentError, "Missing the required parameter 'processor_transactions_get_request' when calling PlaidApi.processor_transactions_get"
11863
11863
  end
11864
11864
  # resource path
11865
- local_var_path = '/processor/transactions/get'
11865
+ local_var_path = '/processor/transactions/get'
11866
+
11867
+ # query parameters
11868
+ query_params = opts[:query_params] || {}
11869
+
11870
+ # header parameters
11871
+ header_params = opts[:header_params] || {}
11872
+ # HTTP header 'Accept' (if needed)
11873
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11874
+ # HTTP header 'Content-Type'
11875
+ content_type = @api_client.select_header_content_type(['application/json'])
11876
+ if !content_type.nil?
11877
+ header_params['Content-Type'] = content_type
11878
+ end
11879
+
11880
+ # form parameters
11881
+ form_params = opts[:form_params] || {}
11882
+
11883
+ # http body (model)
11884
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_get_request)
11885
+
11886
+ # return_type
11887
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsGetResponse'
11888
+
11889
+ # auth_names
11890
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11891
+
11892
+ new_options = opts.merge(
11893
+ :operation => :"PlaidApi.processor_transactions_get",
11894
+ :header_params => header_params,
11895
+ :query_params => query_params,
11896
+ :form_params => form_params,
11897
+ :body => post_body,
11898
+ :auth_names => auth_names,
11899
+ :return_type => return_type
11900
+ )
11901
+
11902
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11903
+ if @api_client.config.debugging
11904
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11905
+ end
11906
+ return data, status_code, headers
11907
+ end
11908
+
11909
+ # Fetch recurring transaction streams
11910
+ # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11911
+ # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
11912
+ # @param [Hash] opts the optional parameters
11913
+ # @return [ProcessorTransactionsRecurringGetResponse]
11914
+ def processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {})
11915
+ data, _status_code, _headers = processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts)
11916
+ data
11917
+ end
11918
+
11919
+ # Fetch recurring transaction streams
11920
+ # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11921
+ # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
11922
+ # @param [Hash] opts the optional parameters
11923
+ # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
11924
+ def processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {})
11925
+ if @api_client.config.debugging
11926
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_recurring_get ...'
11927
+ end
11928
+ # verify the required parameter 'processor_transactions_recurring_get_request' is set
11929
+ if @api_client.config.client_side_validation && processor_transactions_recurring_get_request.nil?
11930
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_recurring_get_request' when calling PlaidApi.processor_transactions_recurring_get"
11931
+ end
11932
+ # resource path
11933
+ local_var_path = '/processor/transactions/recurring/get'
11934
+
11935
+ # query parameters
11936
+ query_params = opts[:query_params] || {}
11937
+
11938
+ # header parameters
11939
+ header_params = opts[:header_params] || {}
11940
+ # HTTP header 'Accept' (if needed)
11941
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11942
+ # HTTP header 'Content-Type'
11943
+ content_type = @api_client.select_header_content_type(['application/json'])
11944
+ if !content_type.nil?
11945
+ header_params['Content-Type'] = content_type
11946
+ end
11947
+
11948
+ # form parameters
11949
+ form_params = opts[:form_params] || {}
11950
+
11951
+ # http body (model)
11952
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_recurring_get_request)
11953
+
11954
+ # return_type
11955
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsRecurringGetResponse'
11956
+
11957
+ # auth_names
11958
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11959
+
11960
+ new_options = opts.merge(
11961
+ :operation => :"PlaidApi.processor_transactions_recurring_get",
11962
+ :header_params => header_params,
11963
+ :query_params => query_params,
11964
+ :form_params => form_params,
11965
+ :body => post_body,
11966
+ :auth_names => auth_names,
11967
+ :return_type => return_type
11968
+ )
11969
+
11970
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11971
+ if @api_client.config.debugging
11972
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11973
+ end
11974
+ return data, status_code, headers
11975
+ end
11976
+
11977
+ # Refresh transaction data
11978
+ # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/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.
11979
+ # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
11980
+ # @param [Hash] opts the optional parameters
11981
+ # @return [ProcessorTransactionsRefreshResponse]
11982
+ def processor_transactions_refresh(processor_transactions_refresh_request, opts = {})
11983
+ data, _status_code, _headers = processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts)
11984
+ data
11985
+ end
11986
+
11987
+ # Refresh transaction data
11988
+ # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/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.
11989
+ # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
11990
+ # @param [Hash] opts the optional parameters
11991
+ # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
11992
+ def processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {})
11993
+ if @api_client.config.debugging
11994
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_refresh ...'
11995
+ end
11996
+ # verify the required parameter 'processor_transactions_refresh_request' is set
11997
+ if @api_client.config.client_side_validation && processor_transactions_refresh_request.nil?
11998
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_refresh_request' when calling PlaidApi.processor_transactions_refresh"
11999
+ end
12000
+ # resource path
12001
+ local_var_path = '/processor/transactions/refresh'
12002
+
12003
+ # query parameters
12004
+ query_params = opts[:query_params] || {}
12005
+
12006
+ # header parameters
12007
+ header_params = opts[:header_params] || {}
12008
+ # HTTP header 'Accept' (if needed)
12009
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12010
+ # HTTP header 'Content-Type'
12011
+ content_type = @api_client.select_header_content_type(['application/json'])
12012
+ if !content_type.nil?
12013
+ header_params['Content-Type'] = content_type
12014
+ end
12015
+
12016
+ # form parameters
12017
+ form_params = opts[:form_params] || {}
12018
+
12019
+ # http body (model)
12020
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_refresh_request)
12021
+
12022
+ # return_type
12023
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsRefreshResponse'
12024
+
12025
+ # auth_names
12026
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12027
+
12028
+ new_options = opts.merge(
12029
+ :operation => :"PlaidApi.processor_transactions_refresh",
12030
+ :header_params => header_params,
12031
+ :query_params => query_params,
12032
+ :form_params => form_params,
12033
+ :body => post_body,
12034
+ :auth_names => auth_names,
12035
+ :return_type => return_type
12036
+ )
12037
+
12038
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12039
+ if @api_client.config.debugging
12040
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12041
+ end
12042
+ return data, status_code, headers
12043
+ end
12044
+
12045
+ # Get incremental transaction updates on a processor token
12046
+ # The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12047
+ # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
12048
+ # @param [Hash] opts the optional parameters
12049
+ # @return [ProcessorTransactionsSyncResponse]
12050
+ def processor_transactions_sync(processor_transactions_sync_request, opts = {})
12051
+ data, _status_code, _headers = processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts)
12052
+ data
12053
+ end
12054
+
12055
+ # Get incremental transaction updates on a processor token
12056
+ # The &#x60;/processor/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12057
+ # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
12058
+ # @param [Hash] opts the optional parameters
12059
+ # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
12060
+ def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
12061
+ if @api_client.config.debugging
12062
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
12063
+ end
12064
+ # verify the required parameter 'processor_transactions_sync_request' is set
12065
+ if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
12066
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
12067
+ end
12068
+ # resource path
12069
+ local_var_path = '/processor/transactions/sync'
11866
12070
 
11867
12071
  # query parameters
11868
12072
  query_params = opts[:query_params] || {}
@@ -11881,16 +12085,16 @@ module Plaid
11881
12085
  form_params = opts[:form_params] || {}
11882
12086
 
11883
12087
  # http body (model)
11884
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_get_request)
12088
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
11885
12089
 
11886
12090
  # return_type
11887
- return_type = opts[:debug_return_type] || 'ProcessorTransactionsGetResponse'
12091
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
11888
12092
 
11889
12093
  # auth_names
11890
12094
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11891
12095
 
11892
12096
  new_options = opts.merge(
11893
- :operation => :"PlaidApi.processor_transactions_get",
12097
+ :operation => :"PlaidApi.processor_transactions_sync",
11894
12098
  :header_params => header_params,
11895
12099
  :query_params => query_params,
11896
12100
  :form_params => form_params,
@@ -11901,36 +12105,36 @@ module Plaid
11901
12105
 
11902
12106
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11903
12107
  if @api_client.config.debugging
11904
- @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12108
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11905
12109
  end
11906
12110
  return data, status_code, headers
11907
12111
  end
11908
12112
 
11909
- # Fetch recurring transaction streams
11910
- # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11911
- # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12113
+ # Check a user's Plaid Network status
12114
+ # The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
12115
+ # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
11912
12116
  # @param [Hash] opts the optional parameters
11913
- # @return [ProcessorTransactionsRecurringGetResponse]
11914
- def processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {})
11915
- data, _status_code, _headers = processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts)
12117
+ # @return [ProfileNetworkStatusGetResponse]
12118
+ def profile_network_status_get(profile_network_status_get_request, opts = {})
12119
+ data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
11916
12120
  data
11917
12121
  end
11918
12122
 
11919
- # Fetch recurring transaction streams
11920
- # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
11921
- # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
12123
+ # Check a user&#39;s Plaid Network status
12124
+ # The &#x60;/profile/network_status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user.
12125
+ # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
11922
12126
  # @param [Hash] opts the optional parameters
11923
- # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
11924
- def processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {})
12127
+ # @return [Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>] ProfileNetworkStatusGetResponse data, response status code and response headers
12128
+ def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
11925
12129
  if @api_client.config.debugging
11926
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_recurring_get ...'
12130
+ @api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
11927
12131
  end
11928
- # verify the required parameter 'processor_transactions_recurring_get_request' is set
11929
- if @api_client.config.client_side_validation && processor_transactions_recurring_get_request.nil?
11930
- fail ArgumentError, "Missing the required parameter 'processor_transactions_recurring_get_request' when calling PlaidApi.processor_transactions_recurring_get"
12132
+ # verify the required parameter 'profile_network_status_get_request' is set
12133
+ if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
12134
+ fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
11931
12135
  end
11932
12136
  # resource path
11933
- local_var_path = '/processor/transactions/recurring/get'
12137
+ local_var_path = '/profile/network_status/get'
11934
12138
 
11935
12139
  # query parameters
11936
12140
  query_params = opts[:query_params] || {}
@@ -11949,16 +12153,16 @@ module Plaid
11949
12153
  form_params = opts[:form_params] || {}
11950
12154
 
11951
12155
  # http body (model)
11952
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_recurring_get_request)
12156
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)
11953
12157
 
11954
12158
  # return_type
11955
- return_type = opts[:debug_return_type] || 'ProcessorTransactionsRecurringGetResponse'
12159
+ return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'
11956
12160
 
11957
12161
  # auth_names
11958
12162
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11959
12163
 
11960
12164
  new_options = opts.merge(
11961
- :operation => :"PlaidApi.processor_transactions_recurring_get",
12165
+ :operation => :"PlaidApi.profile_network_status_get",
11962
12166
  :header_params => header_params,
11963
12167
  :query_params => query_params,
11964
12168
  :form_params => form_params,
@@ -11969,36 +12173,36 @@ module Plaid
11969
12173
 
11970
12174
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11971
12175
  if @api_client.config.debugging
11972
- @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12176
+ @api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11973
12177
  end
11974
12178
  return data, status_code, headers
11975
12179
  end
11976
12180
 
11977
- # Refresh transaction data
11978
- # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) non-depository accounts and will result in a `PRODUCTS_NOT_SUPPORTED` error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/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.
11979
- # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
12181
+ # Get information about a user event
12182
+ # Get information about a user event including Trust Index score and fraud attributes.
12183
+ # @param protect_event_get_request [ProtectEventGetRequest]
11980
12184
  # @param [Hash] opts the optional parameters
11981
- # @return [ProcessorTransactionsRefreshResponse]
11982
- def processor_transactions_refresh(processor_transactions_refresh_request, opts = {})
11983
- data, _status_code, _headers = processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts)
12185
+ # @return [ProtectEventGetResponse]
12186
+ def protect_event_get(protect_event_get_request, opts = {})
12187
+ data, _status_code, _headers = protect_event_get_with_http_info(protect_event_get_request, opts)
11984
12188
  data
11985
12189
  end
11986
12190
 
11987
- # Refresh transaction data
11988
- # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) non-depository accounts and will result in a &#x60;PRODUCTS_NOT_SUPPORTED&#x60; error if called on an Item that contains only non-depository accounts from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/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.
11989
- # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
12191
+ # Get information about a user event
12192
+ # Get information about a user event including Trust Index score and fraud attributes.
12193
+ # @param protect_event_get_request [ProtectEventGetRequest]
11990
12194
  # @param [Hash] opts the optional parameters
11991
- # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
11992
- def processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {})
12195
+ # @return [Array<(ProtectEventGetResponse, Integer, Hash)>] ProtectEventGetResponse data, response status code and response headers
12196
+ def protect_event_get_with_http_info(protect_event_get_request, opts = {})
11993
12197
  if @api_client.config.debugging
11994
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_refresh ...'
12198
+ @api_client.config.logger.debug 'Calling API: PlaidApi.protect_event_get ...'
11995
12199
  end
11996
- # verify the required parameter 'processor_transactions_refresh_request' is set
11997
- if @api_client.config.client_side_validation && processor_transactions_refresh_request.nil?
11998
- fail ArgumentError, "Missing the required parameter 'processor_transactions_refresh_request' when calling PlaidApi.processor_transactions_refresh"
12200
+ # verify the required parameter 'protect_event_get_request' is set
12201
+ if @api_client.config.client_side_validation && protect_event_get_request.nil?
12202
+ fail ArgumentError, "Missing the required parameter 'protect_event_get_request' when calling PlaidApi.protect_event_get"
11999
12203
  end
12000
12204
  # resource path
12001
- local_var_path = '/processor/transactions/refresh'
12205
+ local_var_path = '/protect/event/get'
12002
12206
 
12003
12207
  # query parameters
12004
12208
  query_params = opts[:query_params] || {}
@@ -12017,16 +12221,16 @@ module Plaid
12017
12221
  form_params = opts[:form_params] || {}
12018
12222
 
12019
12223
  # http body (model)
12020
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_refresh_request)
12224
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_event_get_request)
12021
12225
 
12022
12226
  # return_type
12023
- return_type = opts[:debug_return_type] || 'ProcessorTransactionsRefreshResponse'
12227
+ return_type = opts[:debug_return_type] || 'ProtectEventGetResponse'
12024
12228
 
12025
12229
  # auth_names
12026
12230
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12027
12231
 
12028
12232
  new_options = opts.merge(
12029
- :operation => :"PlaidApi.processor_transactions_refresh",
12233
+ :operation => :"PlaidApi.protect_event_get",
12030
12234
  :header_params => header_params,
12031
12235
  :query_params => query_params,
12032
12236
  :form_params => form_params,
@@ -12037,36 +12241,36 @@ module Plaid
12037
12241
 
12038
12242
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12039
12243
  if @api_client.config.debugging
12040
- @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12244
+ @api_client.config.logger.debug "API called: PlaidApi#protect_event_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12041
12245
  end
12042
12246
  return data, status_code, headers
12043
12247
  end
12044
12248
 
12045
- # Get incremental transaction updates on a processor token
12046
- # The `/processor/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/processor/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/processor/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/processor/transactions/sync` was called within a few seconds of Item creation, `/processor/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12047
- # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
12249
+ # Send a new event to enrich user data
12250
+ # Send a new event to enrich user data and optionally get a Trust Index score for the event.
12251
+ # @param protect_event_send_request [ProtectEventSendRequest]
12048
12252
  # @param [Hash] opts the optional parameters
12049
- # @return [ProcessorTransactionsSyncResponse]
12050
- def processor_transactions_sync(processor_transactions_sync_request, opts = {})
12051
- data, _status_code, _headers = processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts)
12253
+ # @return [ProtectEventSendResponse]
12254
+ def protect_event_send(protect_event_send_request, opts = {})
12255
+ data, _status_code, _headers = protect_event_send_with_http_info(protect_event_send_request, opts)
12052
12256
  data
12053
12257
  end
12054
12258
 
12055
- # Get incremental transaction updates on a processor token
12056
- # The &#x60;/processor/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/processor/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/processor/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/processor/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/processor/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
12057
- # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
12259
+ # Send a new event to enrich user data
12260
+ # Send a new event to enrich user data and optionally get a Trust Index score for the event.
12261
+ # @param protect_event_send_request [ProtectEventSendRequest]
12058
12262
  # @param [Hash] opts the optional parameters
12059
- # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
12060
- def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
12263
+ # @return [Array<(ProtectEventSendResponse, Integer, Hash)>] ProtectEventSendResponse data, response status code and response headers
12264
+ def protect_event_send_with_http_info(protect_event_send_request, opts = {})
12061
12265
  if @api_client.config.debugging
12062
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
12266
+ @api_client.config.logger.debug 'Calling API: PlaidApi.protect_event_send ...'
12063
12267
  end
12064
- # verify the required parameter 'processor_transactions_sync_request' is set
12065
- if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
12066
- fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
12268
+ # verify the required parameter 'protect_event_send_request' is set
12269
+ if @api_client.config.client_side_validation && protect_event_send_request.nil?
12270
+ fail ArgumentError, "Missing the required parameter 'protect_event_send_request' when calling PlaidApi.protect_event_send"
12067
12271
  end
12068
12272
  # resource path
12069
- local_var_path = '/processor/transactions/sync'
12273
+ local_var_path = '/protect/event/send'
12070
12274
 
12071
12275
  # query parameters
12072
12276
  query_params = opts[:query_params] || {}
@@ -12085,16 +12289,16 @@ module Plaid
12085
12289
  form_params = opts[:form_params] || {}
12086
12290
 
12087
12291
  # http body (model)
12088
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
12292
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_event_send_request)
12089
12293
 
12090
12294
  # return_type
12091
- return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
12295
+ return_type = opts[:debug_return_type] || 'ProtectEventSendResponse'
12092
12296
 
12093
12297
  # auth_names
12094
12298
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12095
12299
 
12096
12300
  new_options = opts.merge(
12097
- :operation => :"PlaidApi.processor_transactions_sync",
12301
+ :operation => :"PlaidApi.protect_event_send",
12098
12302
  :header_params => header_params,
12099
12303
  :query_params => query_params,
12100
12304
  :form_params => form_params,
@@ -12105,36 +12309,36 @@ module Plaid
12105
12309
 
12106
12310
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12107
12311
  if @api_client.config.debugging
12108
- @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12312
+ @api_client.config.logger.debug "API called: PlaidApi#protect_event_send\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12109
12313
  end
12110
12314
  return data, status_code, headers
12111
12315
  end
12112
12316
 
12113
- # Check a user's Plaid Network status
12114
- # The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
12115
- # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
12317
+ # Get Protect user insights
12318
+ # Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect.
12319
+ # @param protect_user_insights_get_request [ProtectUserInsightsGetRequest]
12116
12320
  # @param [Hash] opts the optional parameters
12117
- # @return [ProfileNetworkStatusGetResponse]
12118
- def profile_network_status_get(profile_network_status_get_request, opts = {})
12119
- data, _status_code, _headers = profile_network_status_get_with_http_info(profile_network_status_get_request, opts)
12321
+ # @return [ProtectUserInsightsGetResponse]
12322
+ def protect_user_insights_get(protect_user_insights_get_request, opts = {})
12323
+ data, _status_code, _headers = protect_user_insights_get_with_http_info(protect_user_insights_get_request, opts)
12120
12324
  data
12121
12325
  end
12122
12326
 
12123
- # Check a user&#39;s Plaid Network status
12124
- # The &#x60;/profile/network_status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user.
12125
- # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
12327
+ # Get Protect user insights
12328
+ # Use this endpoint to get basic information about a user as it relates to their fraud profile with Protect.
12329
+ # @param protect_user_insights_get_request [ProtectUserInsightsGetRequest]
12126
12330
  # @param [Hash] opts the optional parameters
12127
- # @return [Array<(ProfileNetworkStatusGetResponse, Integer, Hash)>] ProfileNetworkStatusGetResponse data, response status code and response headers
12128
- def profile_network_status_get_with_http_info(profile_network_status_get_request, opts = {})
12331
+ # @return [Array<(ProtectUserInsightsGetResponse, Integer, Hash)>] ProtectUserInsightsGetResponse data, response status code and response headers
12332
+ def protect_user_insights_get_with_http_info(protect_user_insights_get_request, opts = {})
12129
12333
  if @api_client.config.debugging
12130
- @api_client.config.logger.debug 'Calling API: PlaidApi.profile_network_status_get ...'
12334
+ @api_client.config.logger.debug 'Calling API: PlaidApi.protect_user_insights_get ...'
12131
12335
  end
12132
- # verify the required parameter 'profile_network_status_get_request' is set
12133
- if @api_client.config.client_side_validation && profile_network_status_get_request.nil?
12134
- fail ArgumentError, "Missing the required parameter 'profile_network_status_get_request' when calling PlaidApi.profile_network_status_get"
12336
+ # verify the required parameter 'protect_user_insights_get_request' is set
12337
+ if @api_client.config.client_side_validation && protect_user_insights_get_request.nil?
12338
+ fail ArgumentError, "Missing the required parameter 'protect_user_insights_get_request' when calling PlaidApi.protect_user_insights_get"
12135
12339
  end
12136
12340
  # resource path
12137
- local_var_path = '/profile/network_status/get'
12341
+ local_var_path = '/protect/user/insights/get'
12138
12342
 
12139
12343
  # query parameters
12140
12344
  query_params = opts[:query_params] || {}
@@ -12153,16 +12357,16 @@ module Plaid
12153
12357
  form_params = opts[:form_params] || {}
12154
12358
 
12155
12359
  # http body (model)
12156
- post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_network_status_get_request)
12360
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(protect_user_insights_get_request)
12157
12361
 
12158
12362
  # return_type
12159
- return_type = opts[:debug_return_type] || 'ProfileNetworkStatusGetResponse'
12363
+ return_type = opts[:debug_return_type] || 'ProtectUserInsightsGetResponse'
12160
12364
 
12161
12365
  # auth_names
12162
12366
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12163
12367
 
12164
12368
  new_options = opts.merge(
12165
- :operation => :"PlaidApi.profile_network_status_get",
12369
+ :operation => :"PlaidApi.protect_user_insights_get",
12166
12370
  :header_params => header_params,
12167
12371
  :query_params => query_params,
12168
12372
  :form_params => form_params,
@@ -12173,7 +12377,7 @@ module Plaid
12173
12377
 
12174
12378
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12175
12379
  if @api_client.config.debugging
12176
- @api_client.config.logger.debug "API called: PlaidApi#profile_network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12380
+ @api_client.config.logger.debug "API called: PlaidApi#protect_user_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12177
12381
  end
12178
12382
  return data, status_code, headers
12179
12383
  end
@@ -12519,7 +12723,7 @@ module Plaid
12519
12723
  end
12520
12724
 
12521
12725
  # Fire a test webhook
12522
- # 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 and PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
12726
+ # 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 and PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type `TRANSFER`).
12523
12727
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12524
12728
  # @param [Hash] opts the optional parameters
12525
12729
  # @return [SandboxItemFireWebhookResponse]
@@ -12529,7 +12733,7 @@ module Plaid
12529
12733
  end
12530
12734
 
12531
12735
  # Fire a test webhook
12532
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid Sandbox &#x60;DEFAULT_UPDATE&#x60; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;USER_PERMISSION_REVOKED&#x60;: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions’ consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. &#x60;USER_ACCOUNT_REVOKED&#x60;: Fired when an end user has revoked access to their account on the Data Provider&#39;s portal. This webhook is currently sent only for Chase and PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type &#x60;TRANSFER&#x60;).
12736
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item simulating a default update event for the respective product as specified with the &#x60;webhook_type&#x60; in the request body. Valid Sandbox &#x60;DEFAULT_UPDATE&#x60; webhook types include: &#x60;AUTH&#x60;, &#x60;IDENTITY&#x60;, &#x60;TRANSACTIONS&#x60;, &#x60;INVESTMENTS_TRANSACTIONS&#x60;, &#x60;LIABILITIES&#x60;, &#x60;HOLDINGS&#x60;. If the Item does not support the product, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Fired to indicate that a new account is available on the Item and you can launch update mode to request access to it. &#x60;SMS_MICRODEPOSITS_VERIFICATION&#x60;: Fired when a given same day micro-deposit item is verified via SMS verification. &#x60;LOGIN_REPAIRED&#x60;: Fired when an Item recovers from the &#x60;ITEM_LOGIN_REQUIRED&#x60; without the user going through update mode in your app. &#x60;PENDING_DISCONNECT&#x60;: Fired when an Item will stop working in the near future (e.g. due to a planned bank migration) and must be sent through update mode to continue working. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;USER_PERMISSION_REVOKED&#x60;: Indicates an end user has revoked the permission that they previously granted to access an Item. May not always fire upon revocation, as some institutions’ consent portals do not trigger this webhook. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. &#x60;USER_ACCOUNT_REVOKED&#x60;: Fired when an end user has revoked access to their account on the Data Provider&#39;s portal. This webhook is currently sent only for Chase and PNC Items, but may be sent in the future for other financial institutions. Upon receiving this webhook, it is recommended to delete any stored data from Plaid associated with the account or Item. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production (except for webhooks of type &#x60;TRANSFER&#x60;).
12533
12737
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12534
12738
  # @param [Hash] opts the optional parameters
12535
12739
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -13062,6 +13266,74 @@ module Plaid
13062
13266
  return data, status_code, headers
13063
13267
  end
13064
13268
 
13269
+ # Create sandbox transactions
13270
+ # 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 is only available in the Sandbox environment, thus can only be used with Items that were created in the Sandbox. You can use this to add transactions to test the `/transactions/get` and `/transactions/sync` endpoints. For Items created in the Production environment, real transactions will be available once the transactions product is enabled.
13271
+ # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
13272
+ # @param [Hash] opts the optional parameters
13273
+ # @return [SandboxTransactionsCreateResponse]
13274
+ def sandbox_transactions_create(sandbox_transactions_create_request, opts = {})
13275
+ data, _status_code, _headers = sandbox_transactions_create_with_http_info(sandbox_transactions_create_request, opts)
13276
+ data
13277
+ end
13278
+
13279
+ # Create sandbox transactions
13280
+ # 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 is only available in the Sandbox environment, thus can only be used with Items that were created in the Sandbox. You can use this to add transactions to test the &#x60;/transactions/get&#x60; and &#x60;/transactions/sync&#x60; endpoints. For Items created in the Production environment, real transactions will be available once the transactions product is enabled.
13281
+ # @param sandbox_transactions_create_request [SandboxTransactionsCreateRequest]
13282
+ # @param [Hash] opts the optional parameters
13283
+ # @return [Array<(SandboxTransactionsCreateResponse, Integer, Hash)>] SandboxTransactionsCreateResponse data, response status code and response headers
13284
+ def sandbox_transactions_create_with_http_info(sandbox_transactions_create_request, opts = {})
13285
+ if @api_client.config.debugging
13286
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transactions_create ...'
13287
+ end
13288
+ # verify the required parameter 'sandbox_transactions_create_request' is set
13289
+ if @api_client.config.client_side_validation && sandbox_transactions_create_request.nil?
13290
+ fail ArgumentError, "Missing the required parameter 'sandbox_transactions_create_request' when calling PlaidApi.sandbox_transactions_create"
13291
+ end
13292
+ # resource path
13293
+ local_var_path = '/sandbox/transactions/create'
13294
+
13295
+ # query parameters
13296
+ query_params = opts[:query_params] || {}
13297
+
13298
+ # header parameters
13299
+ header_params = opts[:header_params] || {}
13300
+ # HTTP header 'Accept' (if needed)
13301
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13302
+ # HTTP header 'Content-Type'
13303
+ content_type = @api_client.select_header_content_type(['application/json'])
13304
+ if !content_type.nil?
13305
+ header_params['Content-Type'] = content_type
13306
+ end
13307
+
13308
+ # form parameters
13309
+ form_params = opts[:form_params] || {}
13310
+
13311
+ # http body (model)
13312
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transactions_create_request)
13313
+
13314
+ # return_type
13315
+ return_type = opts[:debug_return_type] || 'SandboxTransactionsCreateResponse'
13316
+
13317
+ # auth_names
13318
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
13319
+
13320
+ new_options = opts.merge(
13321
+ :operation => :"PlaidApi.sandbox_transactions_create",
13322
+ :header_params => header_params,
13323
+ :query_params => query_params,
13324
+ :form_params => form_params,
13325
+ :body => post_body,
13326
+ :auth_names => auth_names,
13327
+ :return_type => return_type
13328
+ )
13329
+
13330
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13331
+ if @api_client.config.debugging
13332
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transactions_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13333
+ end
13334
+ return data, status_code, headers
13335
+ end
13336
+
13065
13337
  # Manually fire a Transfer webhook
13066
13338
  # Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a `TRANSFER_EVENTS_UPDATE` webhook in the Sandbox environment.
13067
13339
  # @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
@@ -13947,7 +14219,7 @@ module Plaid
13947
14219
  end
13948
14220
 
13949
14221
  # Create a Session Token
13950
- # Any Plaid experience a user sees such as connecting a bank account, verifying identity, or sharing a credit report is considered a session. Today, most sessions happen through Link and the token to start these Link session is a link token created and configured via `link/token/create`. Sessions are a higher level abstraction where configuration primarily happens in Plaid Dashboard. Depending on the template id provided, the session may a Link session, specified by a Link token, or may be another experience in the future. A primary benefit is that configuration changes can be done in Dashboard with no code changes required. Currently, this endpoint is only supported for Layer templates and Link but is reserved in the future to initialize other end-user Plaid experiences. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
14222
+ # Any Plaid experience a user sees such as connecting a bank account, verifying identity, or sharing a credit report is considered a session. Today, most sessions happen through Link and the token to start these Link session is a link token created and configured via `link/token/create`. Sessions are a higher level abstraction where configuration primarily happens in Plaid Dashboard. Depending on the template id provided, the session may a Link session, specified by a Link token, or may be another experience in the future. A primary benefit is that configuration changes can be done in Dashboard with no code changes required. Currently, this endpoint is only supported for Layer templates and Link but is reserved in the future to initialize other end-user Plaid experiences. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
13951
14223
  # @param session_token_create_request [SessionTokenCreateRequest]
13952
14224
  # @param [Hash] opts the optional parameters
13953
14225
  # @return [SessionTokenCreateResponse]
@@ -13957,7 +14229,7 @@ module Plaid
13957
14229
  end
13958
14230
 
13959
14231
  # Create a Session Token
13960
- # Any Plaid experience a user sees such as connecting a bank account, verifying identity, or sharing a credit report is considered a session. Today, most sessions happen through Link and the token to start these Link session is a link token created and configured via &#x60;link/token/create&#x60;. Sessions are a higher level abstraction where configuration primarily happens in Plaid Dashboard. Depending on the template id provided, the session may a Link session, specified by a Link token, or may be another experience in the future. A primary benefit is that configuration changes can be done in Dashboard with no code changes required. Currently, this endpoint is only supported for Layer templates and Link but is reserved in the future to initialize other end-user Plaid experiences. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
14232
+ # Any Plaid experience a user sees such as connecting a bank account, verifying identity, or sharing a credit report is considered a session. Today, most sessions happen through Link and the token to start these Link session is a link token created and configured via &#x60;link/token/create&#x60;. Sessions are a higher level abstraction where configuration primarily happens in Plaid Dashboard. Depending on the template id provided, the session may a Link session, specified by a Link token, or may be another experience in the future. A primary benefit is that configuration changes can be done in Dashboard with no code changes required. Currently, this endpoint is only supported for Layer templates and Link but is reserved in the future to initialize other end-user Plaid experiences. The returned Link token is used as an parameter when initializing the Link SDK. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview).
13961
14233
  # @param session_token_create_request [SessionTokenCreateRequest]
13962
14234
  # @param [Hash] opts the optional parameters
13963
14235
  # @return [Array<(SessionTokenCreateResponse, Integer, Hash)>] SessionTokenCreateResponse data, response status code and response headers
@@ -14558,6 +14830,74 @@ module Plaid
14558
14830
  return data, status_code, headers
14559
14831
  end
14560
14832
 
14833
+ # Receive token notifications from The Clearing House (TCH).
14834
+ # This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.
14835
+ # @param tch_notification [TCHNotification]
14836
+ # @param [Hash] opts the optional parameters
14837
+ # @return [TCHNotificationResponse]
14838
+ def tch_notifications(tch_notification, opts = {})
14839
+ data, _status_code, _headers = tch_notifications_with_http_info(tch_notification, opts)
14840
+ data
14841
+ end
14842
+
14843
+ # Receive token notifications from The Clearing House (TCH).
14844
+ # This endpoint allows us to receive token notifications from The Clearing House (TCH). The schema is defined by TCH.
14845
+ # @param tch_notification [TCHNotification]
14846
+ # @param [Hash] opts the optional parameters
14847
+ # @return [Array<(TCHNotificationResponse, Integer, Hash)>] TCHNotificationResponse data, response status code and response headers
14848
+ def tch_notifications_with_http_info(tch_notification, opts = {})
14849
+ if @api_client.config.debugging
14850
+ @api_client.config.logger.debug 'Calling API: PlaidApi.tch_notifications ...'
14851
+ end
14852
+ # verify the required parameter 'tch_notification' is set
14853
+ if @api_client.config.client_side_validation && tch_notification.nil?
14854
+ fail ArgumentError, "Missing the required parameter 'tch_notification' when calling PlaidApi.tch_notifications"
14855
+ end
14856
+ # resource path
14857
+ local_var_path = '/tch/notifications'
14858
+
14859
+ # query parameters
14860
+ query_params = opts[:query_params] || {}
14861
+
14862
+ # header parameters
14863
+ header_params = opts[:header_params] || {}
14864
+ # HTTP header 'Accept' (if needed)
14865
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14866
+ # HTTP header 'Content-Type'
14867
+ content_type = @api_client.select_header_content_type(['application/json'])
14868
+ if !content_type.nil?
14869
+ header_params['Content-Type'] = content_type
14870
+ end
14871
+
14872
+ # form parameters
14873
+ form_params = opts[:form_params] || {}
14874
+
14875
+ # http body (model)
14876
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(tch_notification)
14877
+
14878
+ # return_type
14879
+ return_type = opts[:debug_return_type] || 'TCHNotificationResponse'
14880
+
14881
+ # auth_names
14882
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
14883
+
14884
+ new_options = opts.merge(
14885
+ :operation => :"PlaidApi.tch_notifications",
14886
+ :header_params => header_params,
14887
+ :query_params => query_params,
14888
+ :form_params => form_params,
14889
+ :body => post_body,
14890
+ :auth_names => auth_names,
14891
+ :return_type => return_type
14892
+ )
14893
+
14894
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
14895
+ if @api_client.config.debugging
14896
+ @api_client.config.logger.debug "API called: PlaidApi#tch_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14897
+ end
14898
+ return data, status_code, headers
14899
+ end
14900
+
14561
14901
  # enhance locally-held transaction data
14562
14902
  # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
14563
14903
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
@@ -14763,7 +15103,7 @@ module Plaid
14763
15103
  end
14764
15104
 
14765
15105
  # Fetch recurring transaction streams
14766
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
15106
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). When using Recurring Transactions, for best results, make sure to use the [`days_requested`](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
14767
15107
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
14768
15108
  # @param [Hash] opts the optional parameters
14769
15109
  # @return [TransactionsRecurringGetResponse]
@@ -14773,7 +15113,7 @@ module Plaid
14773
15113
  end
14774
15114
 
14775
15115
  # Fetch recurring transaction streams
14776
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
15116
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). When using Recurring Transactions, for best results, make sure to use the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transactions-days-requested) parameter to request at least 180 days of history when initializing Items with Transactions. Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
14777
15117
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
14778
15118
  # @param [Hash] opts the optional parameters
14779
15119
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -15103,7 +15443,7 @@ module Plaid
15103
15443
  end
15104
15444
 
15105
15445
  # Get incremental transaction updates on an Item
15106
- # The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
15446
+ # The `/transactions/sync` endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with `/transactions/sync`, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports `credit`, `depository`, and some `loan`-type accounts (only those with account subtype `student`). For `investments` accounts, use `/investments/transactions/get` instead. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update (e.g due to the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the `/link/token/create` call or if `/transactions/sync` was called within a few seconds of Item creation, `/transactions/sync` will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. To be alerted when new transactions are available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
15107
15447
  # @param transactions_sync_request [TransactionsSyncRequest]
15108
15448
  # @param [Hash] opts the optional parameters
15109
15449
  # @return [TransactionsSyncResponse]
@@ -15113,7 +15453,7 @@ module Plaid
15113
15453
  end
15114
15454
 
15115
15455
  # Get incremental transaction updates on an Item
15116
- # The &#x60;/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
15456
+ # The &#x60;/transactions/sync&#x60; endpoint retrieves transactions associated with an Item and can fetch updates using a cursor to track which updates have already been seen. For important instructions on integrating with &#x60;/transactions/sync&#x60;, see the [Transactions integration overview](https://plaid.com/docs/transactions/#integration-overview). If you are migrating from an existing integration using &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint supports &#x60;credit&#x60;, &#x60;depository&#x60;, and some &#x60;loan&#x60;-type accounts (only those with account subtype &#x60;student&#x60;). For &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update (e.g due to the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error), the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. If transactions data is not yet available for the Item, which can happen if the Item was not initialized with transactions during the &#x60;/link/token/create&#x60; call or if &#x60;/transactions/sync&#x60; was called within a few seconds of Item creation, &#x60;/transactions/sync&#x60; will return empty transactions arrays. Plaid typically checks for new transactions data between one and four times per day, depending on the institution. To find out when transactions were last updated for an Item, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. To be alerted when new transactions are available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
15117
15457
  # @param transactions_sync_request [TransactionsSyncRequest]
15118
15458
  # @param [Hash] opts the optional parameters
15119
15459
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -15307,7 +15647,7 @@ module Plaid
15307
15647
  end
15308
15648
 
15309
15649
  # Create a transfer authorization
15310
- # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
15650
+ # Use the `/transfer/authorization/create` endpoint to authorize a transfer. This endpoint must be called prior to calling `/transfer/create`. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the `authorization.decision` in the response is `declined`, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the `authorization.decision` is `user_action_required`, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling `/link/token/create` to get a new Link token, instead of providing `access_token` in the request, you should set [`transfer.authorization_id`](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the `authorization.id`. After the Link flow is completed, you may re-attempt the authorization. - If the `authorization.decision` is `approved`, and the `authorization.rationale_code` is `null`, the transfer has passed the risk check and you can proceed to call `/transfer/create`. - If the `authorization.decision` is `approved` and the `authorization.rationale_code` is non-`null`, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with `null` rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of `user_action_required`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
15311
15651
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
15312
15652
  # @param [Hash] opts the optional parameters
15313
15653
  # @return [TransferAuthorizationCreateResponse]
@@ -15317,7 +15657,7 @@ module Plaid
15317
15657
  end
15318
15658
 
15319
15659
  # Create a transfer authorization
15320
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
15660
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to authorize a transfer. This endpoint must be called prior to calling &#x60;/transfer/create&#x60;. The transfer authorization will expire if not used after one hour. (You can contact your account manager to change the default authorization lifetime.) There are four possible outcomes to calling this endpoint: - If the &#x60;authorization.decision&#x60; in the response is &#x60;declined&#x60;, the proposed transfer has failed the risk check and you cannot proceed with the transfer. - If the &#x60;authorization.decision&#x60; is &#x60;user_action_required&#x60;, additional user input is needed, usually to fix a broken bank connection, before Plaid can properly assess the risk. You need to launch Link in update mode to complete the required user action. When calling &#x60;/link/token/create&#x60; to get a new Link token, instead of providing &#x60;access_token&#x60; in the request, you should set [&#x60;transfer.authorization_id&#x60;](https://plaid.com/docs/api/link/#link-token-create-request-transfer-authorization-id) as the &#x60;authorization.id&#x60;. After the Link flow is completed, you may re-attempt the authorization. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60;, and the &#x60;authorization.rationale_code&#x60; is &#x60;null&#x60;, the transfer has passed the risk check and you can proceed to call &#x60;/transfer/create&#x60;. - If the &#x60;authorization.decision&#x60; is &#x60;approved&#x60; and the &#x60;authorization.rationale_code&#x60; is non-&#x60;null&#x60;, the risk check could not be run: you may proceed with the transfer, but should perform your own risk evaluation. For more details, see the response schema. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with &#x60;null&#x60; rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To get an authorization decision of &#x60;user_action_required&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
15321
15661
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
15322
15662
  # @param [Hash] opts the optional parameters
15323
15663
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -16599,7 +16939,7 @@ module Plaid
16599
16939
  end
16600
16940
 
16601
16941
  # Migrate account into Transfers
16602
- # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
16942
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](https://dashboard.plaid.com/support).
16603
16943
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
16604
16944
  # @param [Hash] opts the optional parameters
16605
16945
  # @return [TransferMigrateAccountResponse]
@@ -16609,7 +16949,7 @@ module Plaid
16609
16949
  end
16610
16950
 
16611
16951
  # Migrate account into Transfers
16612
- # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
16952
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate previously-verified account and routing numbers to Plaid Items. This endpoint is also required when adding an Item for use with wire transfers; if you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager or [Support](https://dashboard.plaid.com/support).
16613
16953
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
16614
16954
  # @param [Hash] opts the optional parameters
16615
16955
  # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
@@ -16734,6 +17074,74 @@ module Plaid
16734
17074
  return data, status_code, headers
16735
17075
  end
16736
17076
 
17077
+ # Create a new funding account for an originator
17078
+ # Use the `/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator.
17079
+ # @param transfer_originator_funding_account_create_request [TransferOriginatorFundingAccountCreateRequest]
17080
+ # @param [Hash] opts the optional parameters
17081
+ # @return [TransferOriginatorFundingAccountCreateResponse]
17082
+ def transfer_originator_funding_account_create(transfer_originator_funding_account_create_request, opts = {})
17083
+ data, _status_code, _headers = transfer_originator_funding_account_create_with_http_info(transfer_originator_funding_account_create_request, opts)
17084
+ data
17085
+ end
17086
+
17087
+ # Create a new funding account for an originator
17088
+ # Use the &#x60;/transfer/originator/funding_account/create&#x60; endpoint to create a new funding account for the originator.
17089
+ # @param transfer_originator_funding_account_create_request [TransferOriginatorFundingAccountCreateRequest]
17090
+ # @param [Hash] opts the optional parameters
17091
+ # @return [Array<(TransferOriginatorFundingAccountCreateResponse, Integer, Hash)>] TransferOriginatorFundingAccountCreateResponse data, response status code and response headers
17092
+ def transfer_originator_funding_account_create_with_http_info(transfer_originator_funding_account_create_request, opts = {})
17093
+ if @api_client.config.debugging
17094
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_funding_account_create ...'
17095
+ end
17096
+ # verify the required parameter 'transfer_originator_funding_account_create_request' is set
17097
+ if @api_client.config.client_side_validation && transfer_originator_funding_account_create_request.nil?
17098
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_funding_account_create_request' when calling PlaidApi.transfer_originator_funding_account_create"
17099
+ end
17100
+ # resource path
17101
+ local_var_path = '/transfer/originator/funding_account/create'
17102
+
17103
+ # query parameters
17104
+ query_params = opts[:query_params] || {}
17105
+
17106
+ # header parameters
17107
+ header_params = opts[:header_params] || {}
17108
+ # HTTP header 'Accept' (if needed)
17109
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
17110
+ # HTTP header 'Content-Type'
17111
+ content_type = @api_client.select_header_content_type(['application/json'])
17112
+ if !content_type.nil?
17113
+ header_params['Content-Type'] = content_type
17114
+ end
17115
+
17116
+ # form parameters
17117
+ form_params = opts[:form_params] || {}
17118
+
17119
+ # http body (model)
17120
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_funding_account_create_request)
17121
+
17122
+ # return_type
17123
+ return_type = opts[:debug_return_type] || 'TransferOriginatorFundingAccountCreateResponse'
17124
+
17125
+ # auth_names
17126
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
17127
+
17128
+ new_options = opts.merge(
17129
+ :operation => :"PlaidApi.transfer_originator_funding_account_create",
17130
+ :header_params => header_params,
17131
+ :query_params => query_params,
17132
+ :form_params => form_params,
17133
+ :body => post_body,
17134
+ :auth_names => auth_names,
17135
+ :return_type => return_type
17136
+ )
17137
+
17138
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
17139
+ if @api_client.config.debugging
17140
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_funding_account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
17141
+ end
17142
+ return data, status_code, headers
17143
+ end
17144
+
16737
17145
  # Update the funding account associated with the originator
16738
17146
  # Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.
16739
17147
  # @param transfer_originator_funding_account_update_request [TransferOriginatorFundingAccountUpdateRequest]
@@ -18030,6 +18438,7 @@ module Plaid
18030
18438
  # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
18031
18439
  # @param user_create_request [UserCreateRequest]
18032
18440
  # @param [Hash] opts the optional parameters
18441
+ # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
18033
18442
  # @return [UserCreateResponse]
18034
18443
  def user_create(user_create_request, opts = {})
18035
18444
  data, _status_code, _headers = user_create_with_http_info(user_create_request, opts)
@@ -18040,6 +18449,7 @@ module Plaid
18040
18449
  # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The &#x60;consumer_report_user_identity&#x60; object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
18041
18450
  # @param user_create_request [UserCreateRequest]
18042
18451
  # @param [Hash] opts the optional parameters
18452
+ # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
18043
18453
  # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
18044
18454
  def user_create_with_http_info(user_create_request, opts = {})
18045
18455
  if @api_client.config.debugging
@@ -18064,6 +18474,7 @@ module Plaid
18064
18474
  if !content_type.nil?
18065
18475
  header_params['Content-Type'] = content_type
18066
18476
  end
18477
+ header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?
18067
18478
 
18068
18479
  # form parameters
18069
18480
  form_params = opts[:form_params] || {}
@@ -18163,9 +18574,10 @@ module Plaid
18163
18574
  end
18164
18575
 
18165
18576
  # Remove user
18166
- # `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
18577
+ # `/user/remove` deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist. If a user is created for a given `client_user_id` using `/user/create` and that user is then deleted with `/user/remove`, the `client_user_id` cannot be reused for another `/user/create` request.
18167
18578
  # @param user_remove_request [UserRemoveRequest]
18168
18579
  # @param [Hash] opts the optional parameters
18580
+ # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
18169
18581
  # @return [UserRemoveResponse]
18170
18582
  def user_remove(user_remove_request, opts = {})
18171
18583
  data, _status_code, _headers = user_remove_with_http_info(user_remove_request, opts)
@@ -18173,9 +18585,10 @@ module Plaid
18173
18585
  end
18174
18586
 
18175
18587
  # Remove user
18176
- # &#x60;/user/remove&#x60; deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist.
18588
+ # &#x60;/user/remove&#x60; deletes a user token and and associated information, including any Items associated with the token. Any subsequent calls to retrieve information using the same user token will result in an error stating the user does not exist. If a user is created for a given &#x60;client_user_id&#x60; using &#x60;/user/create&#x60; and that user is then deleted with &#x60;/user/remove&#x60;, the &#x60;client_user_id&#x60; cannot be reused for another &#x60;/user/create&#x60; request.
18177
18589
  # @param user_remove_request [UserRemoveRequest]
18178
18590
  # @param [Hash] opts the optional parameters
18591
+ # @option opts [Boolean] :plaid_new_user_api_enabled The HTTP header used in API requests to determine which set of User APIs to invoke: the legacy CRA version or the new User API version. (default to false)
18179
18592
  # @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
18180
18593
  def user_remove_with_http_info(user_remove_request, opts = {})
18181
18594
  if @api_client.config.debugging
@@ -18200,6 +18613,7 @@ module Plaid
18200
18613
  if !content_type.nil?
18201
18614
  header_params['Content-Type'] = content_type
18202
18615
  end
18616
+ header_params[:'Plaid-New-User-API-Enabled'] = opts[:'plaid_new_user_api_enabled'] if !opts[:'plaid_new_user_api_enabled'].nil?
18203
18617
 
18204
18618
  # form parameters
18205
18619
  form_params = opts[:form_params] || {}
@@ -18299,7 +18713,7 @@ module Plaid
18299
18713
  end
18300
18714
 
18301
18715
  # Remove a third-party user token
18302
- # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
18716
+ # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
18303
18717
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
18304
18718
  # @param [Hash] opts the optional parameters
18305
18719
  # @return [UserThirdPartyTokenRemoveResponse]
@@ -18309,7 +18723,7 @@ module Plaid
18309
18723
  end
18310
18724
 
18311
18725
  # Remove a third-party user token
18312
- # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
18726
+ # This endpoint is used to delete a third-party user token. Once removed, the token can longer be used to access data associated with the user. Any subsequent calls to retrieve information using the same third-party user token will result in an error stating the third-party user token does not exist.
18313
18727
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
18314
18728
  # @param [Hash] opts the optional parameters
18315
18729
  # @return [Array<(UserThirdPartyTokenRemoveResponse, Integer, Hash)>] UserThirdPartyTokenRemoveResponse data, response status code and response headers