plaid 36.0.0 → 37.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 (1779) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +139 -0
  3. data/Gemfile.lock +5 -5
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +329 -397
  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 +14 -4
  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 +14 -4
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_document_upload.rb +14 -4
  20. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score.rb +14 -4
  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 +14 -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 +1 -1
  33. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  34. data/lib/plaid/models/accounts_balance_get_request_payment_details.rb +2 -2
  35. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +2 -2
  36. data/lib/plaid/models/accounts_get_request.rb +1 -1
  37. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  38. data/lib/plaid/models/accounts_get_response.rb +1 -1
  39. data/lib/plaid/models/ach_class.rb +1 -1
  40. data/lib/plaid/models/action_state.rb +1 -1
  41. data/lib/plaid/models/activity.rb +1 -1
  42. data/lib/plaid/models/activity_type.rb +1 -1
  43. data/lib/plaid/models/address.rb +1 -1
  44. data/lib/plaid/models/address_data.rb +1 -1
  45. data/lib/plaid/models/address_data_not_required.rb +1 -1
  46. data/lib/plaid/models/address_data_nullable.rb +1 -1
  47. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  48. data/lib/plaid/models/address_match_score.rb +1 -1
  49. data/lib/plaid/models/address_nullable.rb +1 -1
  50. data/lib/plaid/models/address_purpose_label.rb +1 -1
  51. data/lib/plaid/models/application.rb +1 -1
  52. data/lib/plaid/models/application_get_request.rb +1 -1
  53. data/lib/plaid/models/application_get_response.rb +1 -1
  54. data/lib/plaid/models/apr.rb +1 -1
  55. data/lib/plaid/models/asset.rb +1 -1
  56. data/lib/plaid/models/asset_detail.rb +1 -1
  57. data/lib/plaid/models/asset_holder.rb +1 -1
  58. data/lib/plaid/models/asset_holder_name.rb +1 -1
  59. data/lib/plaid/models/asset_owner.rb +1 -1
  60. data/lib/plaid/models/asset_owners.rb +1 -1
  61. data/lib/plaid/models/asset_report.rb +1 -1
  62. data/lib/plaid/models/asset_report_account_balance.rb +1 -1
  63. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  64. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  67. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  71. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  75. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  77. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  78. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  79. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  80. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  81. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  82. data/lib/plaid/models/asset_report_investment_transaction.rb +440 -0
  83. data/lib/plaid/models/asset_report_investments.rb +30 -223
  84. data/lib/plaid/models/asset_report_item.rb +1 -1
  85. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  86. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  87. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  88. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  89. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  90. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  91. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  92. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  93. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  94. data/lib/plaid/models/asset_report_type.rb +1 -1
  95. data/lib/plaid/models/asset_report_user.rb +1 -1
  96. data/lib/plaid/models/asset_transaction.rb +1 -1
  97. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  98. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  99. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  100. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  101. data/lib/plaid/models/asset_transactions.rb +1 -1
  102. data/lib/plaid/models/asset_type.rb +1 -1
  103. data/lib/plaid/models/assets.rb +1 -1
  104. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  105. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  106. data/lib/plaid/models/auth_default_update_webhook.rb +1 -1
  107. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  108. data/lib/plaid/models/auth_get_request.rb +1 -1
  109. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  110. data/lib/plaid/models/auth_get_response.rb +1 -1
  111. data/lib/plaid/models/auth_metadata.rb +1 -1
  112. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  113. data/lib/plaid/models/auth_update_types.rb +1 -1
  114. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  115. data/lib/plaid/models/balance_plus_attributes.rb +1 -1
  116. data/lib/plaid/models/balance_plus_risk_level.rb +1 -1
  117. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  118. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  119. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  120. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  121. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  122. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  123. data/lib/plaid/models/bank_transfer.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  143. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  144. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  145. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  149. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  151. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +3 -3
  153. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  154. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  156. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  157. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  158. data/lib/plaid/models/base_report.rb +14 -5
  159. data/lib/plaid/models/base_report_account.rb +1 -1
  160. data/lib/plaid/models/base_report_account_balances.rb +1 -1
  161. data/lib/plaid/models/base_report_account_insights.rb +1 -1
  162. data/lib/plaid/models/base_report_account_metadata.rb +1 -1
  163. data/lib/plaid/models/base_report_attributes.rb +23 -23
  164. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  165. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  166. data/lib/plaid/models/base_report_historical_balance.rb +1 -1
  167. data/lib/plaid/models/base_report_item.rb +1 -1
  168. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  169. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  170. data/lib/plaid/models/base_report_transaction.rb +1 -1
  171. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  172. data/lib/plaid/models/base_report_user_attributes.rb +331 -0
  173. data/lib/plaid/models/base_report_warning.rb +1 -1
  174. data/lib/plaid/models/base_report_warning_code.rb +2 -2
  175. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  176. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  178. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  179. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  180. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  181. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  182. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  183. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  184. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  185. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  186. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  187. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  188. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  189. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  190. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  191. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  192. data/lib/plaid/models/beacon_report.rb +1 -1
  193. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  194. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  195. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  196. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  197. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  198. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  199. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  200. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication.rb +17 -2
  202. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  205. data/lib/plaid/models/beacon_report_syndication_get_response.rb +17 -2
  206. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  207. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  208. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  209. data/lib/plaid/models/beacon_report_type.rb +1 -1
  210. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  211. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  212. data/lib/plaid/models/beacon_user.rb +1 -1
  213. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  214. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  215. data/lib/plaid/models/beacon_user_address.rb +1 -1
  216. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  217. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  218. data/lib/plaid/models/beacon_user_data.rb +1 -1
  219. data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
  220. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  221. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  222. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  223. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  224. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  225. data/lib/plaid/models/beacon_user_name.rb +1 -1
  226. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  227. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  228. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  229. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  230. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  231. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  232. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  233. data/lib/plaid/models/beacon_user_status.rb +1 -1
  234. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  235. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  236. data/lib/plaid/models/beacon_user_update_request_data.rb +1 -1
  237. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  238. data/lib/plaid/models/business_finance_category.rb +252 -0
  239. data/lib/plaid/models/{deposit_switch_target_account.rb → cash_flow_updates_expected_deposit_missed_webhook.rb} +59 -58
  240. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +306 -0
  241. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +306 -0
  242. data/lib/plaid/models/{deposit_switch_token_create_response.rb → cash_flow_updates_low_balance_webhook.rb} +87 -37
  243. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +306 -0
  244. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +306 -0
  245. data/lib/plaid/models/{deposit_switch_state_update_webhook.rb → cash_flow_updates_nsf_webhook.rb} +46 -22
  246. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  247. data/lib/plaid/models/cashflow_report_get_request.rb +339 -0
  248. data/lib/plaid/models/cashflow_report_get_response.rb +319 -0
  249. data/lib/plaid/models/{cra_bank_income_create_request.rb → cashflow_report_refresh_request.rb} +44 -69
  250. data/lib/plaid/models/{cra_base_report_create_response.rb → cashflow_report_refresh_response.rb} +5 -5
  251. data/lib/plaid/models/categories_get_response.rb +1 -1
  252. data/lib/plaid/models/category.rb +1 -1
  253. data/lib/plaid/models/category_insight_details.rb +1 -1
  254. data/lib/plaid/models/category_insights.rb +1 -1
  255. data/lib/plaid/models/cause.rb +2 -2
  256. data/lib/plaid/models/cause_all_of.rb +1 -1
  257. data/lib/plaid/models/check_report_warning.rb +272 -0
  258. data/lib/plaid/models/check_report_warning_code.rb +40 -0
  259. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  260. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  261. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  262. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  263. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  264. data/lib/plaid/models/connected_application.rb +1 -1
  265. data/lib/plaid/models/consent_event.rb +1 -1
  266. data/lib/plaid/models/consent_event_code.rb +2 -1
  267. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  268. data/lib/plaid/models/consent_event_type.rb +1 -1
  269. data/lib/plaid/models/consent_events_get_request.rb +1 -1
  270. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  271. data/lib/plaid/models/consented_account.rb +1 -1
  272. data/lib/plaid/models/consumer_dispute.rb +1 -1
  273. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  274. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  275. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  276. data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
  277. data/lib/plaid/models/counterparty.rb +1 -1
  278. data/lib/plaid/models/counterparty_insights.rb +1 -1
  279. data/lib/plaid/models/counterparty_type.rb +1 -1
  280. data/lib/plaid/models/country_code.rb +3 -1
  281. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  282. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  283. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  284. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  285. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  286. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  287. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  288. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  289. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  290. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  291. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  292. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  293. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  294. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  295. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  296. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  297. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +1 -1
  298. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  299. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +2 -3
  300. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +1 -1
  301. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +17 -5
  302. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +2 -2
  303. data/lib/plaid/models/cra_check_report_create_request.rb +14 -3
  304. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  305. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  306. data/lib/plaid/models/{deposit_switch_token_create_request.rb → cra_check_report_freddie_mac_get_request.rb} +22 -22
  307. data/lib/plaid/models/{deposit_switch_alt_create_response.rb → cra_check_report_freddie_mac_get_response.rb} +33 -19
  308. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +253 -0
  309. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
  310. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +17 -5
  311. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +1 -1
  312. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +17 -5
  313. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  314. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +1 -1
  315. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +17 -5
  316. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
  317. data/lib/plaid/models/cra_check_report_ready_webhook.rb +28 -2
  318. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +39 -0
  319. data/lib/plaid/models/{cra_bank_income_get_request.rb → cra_check_report_verification_get_request.rb} +33 -6
  320. data/lib/plaid/models/cra_check_report_verification_get_response.rb +257 -0
  321. data/lib/plaid/models/cra_check_report_verification_get_voe_options.rb +247 -0
  322. data/lib/plaid/models/cra_income_insights.rb +13 -2
  323. data/lib/plaid/models/cra_loan_application.rb +2 -2
  324. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  325. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  326. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  327. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  328. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  329. data/lib/plaid/models/cra_loan_register.rb +2 -2
  330. data/lib/plaid/models/cra_loan_register_application.rb +2 -2
  331. data/lib/plaid/models/cra_loan_status.rb +1 -1
  332. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  333. data/lib/plaid/models/cra_loan_type.rb +1 -1
  334. data/lib/plaid/models/cra_loan_unregister.rb +2 -2
  335. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  336. data/lib/plaid/models/cra_loan_update.rb +2 -2
  337. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  338. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  339. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  340. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  341. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  342. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  343. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  344. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +1 -1
  345. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +1 -1
  346. data/lib/plaid/models/cra_monitoring_insights_item.rb +18 -6
  347. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +18 -5
  348. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  349. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  350. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  351. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  352. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  353. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  354. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  355. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  356. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  357. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  358. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  359. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  360. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  361. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  362. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  363. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  364. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  365. data/lib/plaid/models/cra_verification_report.rb +257 -0
  366. data/lib/plaid/models/{cra_bank_income.rb → cra_voa_report.rb} +37 -39
  367. data/lib/plaid/models/cra_voa_report_account.rb +396 -0
  368. data/lib/plaid/models/cra_voa_report_account_balances.rb +309 -0
  369. data/lib/plaid/models/{deposit_switch_address_data.rb → cra_voa_report_account_historical_balance.rb} +42 -65
  370. data/lib/plaid/models/cra_voa_report_attributes.rb +231 -0
  371. data/lib/plaid/models/{deposit_switch_target_user.rb → cra_voa_report_item.rb} +60 -62
  372. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +250 -0
  373. data/lib/plaid/models/cra_voe_report.rb +258 -0
  374. data/lib/plaid/models/{deposit_switch_create_request.rb → cra_voe_report_account.rb} +66 -66
  375. data/lib/plaid/models/cra_voe_report_item.rb +288 -0
  376. data/lib/plaid/models/cra_voe_report_transaction.rb +286 -0
  377. data/lib/plaid/models/credit1099.rb +1 -1
  378. data/lib/plaid/models/credit1099_filer.rb +1 -1
  379. data/lib/plaid/models/credit1099_payer.rb +1 -1
  380. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  381. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  382. data/lib/plaid/models/credit_ach_class.rb +1 -1
  383. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  384. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  385. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  386. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  387. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  388. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  389. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  390. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  391. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  392. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  393. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  394. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  395. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  396. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  397. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  398. data/lib/plaid/models/credit_bank_income.rb +1 -1
  399. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  400. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  401. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  402. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  403. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  404. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  405. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  406. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  407. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  408. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  409. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  410. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  411. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  412. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  413. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  414. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  415. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  416. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  417. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  418. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  419. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  420. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  421. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  422. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  423. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  424. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  425. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  426. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  427. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  428. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  429. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  430. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  431. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  432. data/lib/plaid/models/credit_card_liability.rb +1 -1
  433. data/lib/plaid/models/credit_category.rb +1 -1
  434. data/lib/plaid/models/credit_document_metadata.rb +2 -2
  435. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  436. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  437. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  438. data/lib/plaid/models/credit_employment_item.rb +1 -1
  439. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  440. data/lib/plaid/models/credit_filter.rb +1 -1
  441. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  442. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  443. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  444. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  445. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  446. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  447. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  448. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  449. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  450. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  451. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  452. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  453. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  454. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  455. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  456. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  457. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  458. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  459. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  460. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  461. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  462. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  463. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  464. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  465. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  466. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  467. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  468. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  469. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  470. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  471. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  472. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  473. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  474. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  475. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  476. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  477. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  478. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  479. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  480. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  481. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  482. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  483. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  484. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  485. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  486. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  487. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  488. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  489. data/lib/plaid/models/credit_session.rb +1 -1
  490. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  491. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  492. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  493. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  494. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  495. data/lib/plaid/models/credit_session_error.rb +1 -1
  496. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  497. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  498. data/lib/plaid/models/credit_session_results.rb +1 -1
  499. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  500. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  501. data/lib/plaid/models/credit_w2.rb +1 -1
  502. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  503. data/lib/plaid/models/dashboard_user.rb +1 -1
  504. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  505. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  506. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  507. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  508. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  509. data/lib/plaid/models/data_sources.rb +1 -1
  510. data/lib/plaid/models/date_range.rb +1 -1
  511. data/lib/plaid/models/deductions.rb +1 -1
  512. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  513. data/lib/plaid/models/deductions_total.rb +1 -1
  514. data/lib/plaid/models/default_update_webhook.rb +1 -1
  515. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  516. data/lib/plaid/models/depository_filter.rb +1 -1
  517. data/lib/plaid/models/detailed_originator.rb +1 -1
  518. data/lib/plaid/models/detected_account.rb +1 -1
  519. data/lib/plaid/models/device_id.rb +1 -1
  520. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  521. data/lib/plaid/models/doc_type.rb +1 -1
  522. data/lib/plaid/models/document_analysis.rb +16 -6
  523. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  524. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  525. data/lib/plaid/models/document_metadata.rb +1 -1
  526. data/lib/plaid/models/document_name_match_code.rb +1 -1
  527. data/lib/plaid/models/document_risk_signal.rb +1 -1
  528. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  529. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  530. data/lib/plaid/models/document_risk_summary.rb +1 -1
  531. data/lib/plaid/models/document_status.rb +1 -1
  532. data/lib/plaid/models/documentary_verification.rb +1 -1
  533. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  534. data/lib/plaid/models/earnings.rb +1 -1
  535. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  536. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  537. data/lib/plaid/models/earnings_total.rb +1 -1
  538. data/lib/plaid/models/email.rb +1 -1
  539. data/lib/plaid/models/email_address_match_score.rb +1 -1
  540. data/lib/plaid/models/employee.rb +1 -1
  541. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  542. data/lib/plaid/models/employer.rb +1 -1
  543. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  544. data/lib/plaid/models/employer_verification.rb +1 -1
  545. data/lib/plaid/models/employers_search_request.rb +1 -1
  546. data/lib/plaid/models/employers_search_response.rb +1 -1
  547. data/lib/plaid/models/employment_details.rb +1 -1
  548. data/lib/plaid/models/employment_source_type.rb +1 -1
  549. data/lib/plaid/models/employment_verification.rb +1 -1
  550. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  551. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  552. data/lib/plaid/models/employment_verification_status.rb +1 -1
  553. data/lib/plaid/models/enhancements.rb +1 -1
  554. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  555. data/lib/plaid/models/enrichments.rb +1 -1
  556. data/lib/plaid/models/entity_document.rb +1 -1
  557. data/lib/plaid/models/entity_document_type.rb +1 -1
  558. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  559. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  560. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  561. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  562. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  563. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  564. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  565. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  566. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  567. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  568. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  569. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  570. data/lib/plaid/models/entity_watchlist_code.rb +3 -1
  571. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  572. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  573. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  574. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  575. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  576. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  577. data/lib/plaid/models/expiration_date.rb +1 -1
  578. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  579. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  580. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  581. data/lib/plaid/models/external_payment_options.rb +1 -1
  582. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  583. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  584. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  585. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  586. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  587. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  588. data/lib/plaid/models/fdx_content_types.rb +1 -1
  589. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  590. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  591. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  592. data/lib/plaid/models/fdx_notification.rb +1 -1
  593. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  594. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  595. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  596. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  597. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  598. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  599. data/lib/plaid/models/fdx_party.rb +1 -1
  600. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  601. data/lib/plaid/models/fdx_party_type.rb +1 -1
  602. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  603. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  604. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  605. data/lib/plaid/models/fixed_income.rb +1 -1
  606. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  607. data/lib/plaid/models/form1099_type.rb +1 -1
  608. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  609. data/lib/plaid/models/fraud_amount.rb +1 -1
  610. data/lib/plaid/models/fraud_analysis_details.rb +1 -1
  611. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  612. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  613. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  614. data/lib/plaid/models/get_recipient_response.rb +1 -1
  615. data/lib/plaid/models/get_recipients_response.rb +1 -1
  616. data/lib/plaid/models/health_incident.rb +1 -1
  617. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  618. data/lib/plaid/models/historical_annual_income.rb +1 -1
  619. data/lib/plaid/models/historical_balance.rb +1 -1
  620. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  621. data/lib/plaid/models/holding.rb +1 -1
  622. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  623. data/lib/plaid/models/holdings_override.rb +1 -1
  624. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  625. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  626. data/lib/plaid/models/human_review.rb +247 -0
  627. data/lib/plaid/models/human_review_status.rb +40 -0
  628. data/lib/plaid/models/id_number_type.rb +1 -1
  629. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  630. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  631. data/lib/plaid/models/identity_document_upload.rb +1 -1
  632. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  633. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  634. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  635. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  636. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  637. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  638. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  639. data/lib/plaid/models/identity_get_request.rb +1 -1
  640. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  641. data/lib/plaid/models/identity_get_response.rb +1 -1
  642. data/lib/plaid/models/identity_match_request.rb +1 -1
  643. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  644. data/lib/plaid/models/identity_match_response.rb +1 -1
  645. data/lib/plaid/models/identity_match_user.rb +1 -1
  646. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  647. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  648. data/lib/plaid/models/identity_update_types.rb +1 -1
  649. data/lib/plaid/models/identity_verification.rb +1 -1
  650. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  651. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  652. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  653. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  654. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  655. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  656. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  657. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  658. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  659. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  660. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  661. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  662. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  663. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  664. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  665. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  666. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  667. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  668. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  669. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  670. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  671. data/lib/plaid/models/identity_verification_status.rb +1 -1
  672. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  673. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  674. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  675. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  676. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  677. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  678. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  679. data/lib/plaid/models/image_quality.rb +1 -1
  680. data/lib/plaid/models/image_quality_details.rb +1 -1
  681. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  682. data/lib/plaid/models/incident_update.rb +1 -1
  683. data/lib/plaid/models/income_breakdown.rb +1 -1
  684. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  685. data/lib/plaid/models/income_override.rb +1 -1
  686. data/lib/plaid/models/income_sources_counts.rb +1 -1
  687. data/lib/plaid/models/income_summary.rb +1 -1
  688. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  689. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  690. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  691. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  692. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  693. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  694. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  695. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  696. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  697. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  698. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  699. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  700. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  701. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  702. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  703. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  704. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  705. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  706. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  707. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  708. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  709. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  710. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  711. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  712. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  713. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  714. data/lib/plaid/models/individual_name.rb +1 -1
  715. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  716. data/lib/plaid/models/individual_watchlist_code.rb +2 -1
  717. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  718. data/lib/plaid/models/inflow_model.rb +1 -1
  719. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  720. data/lib/plaid/models/institution.rb +1 -1
  721. data/lib/plaid/models/institution_status.rb +1 -1
  722. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  723. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  724. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  725. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  726. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  727. data/lib/plaid/models/institutions_get_request.rb +1 -1
  728. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  729. data/lib/plaid/models/institutions_get_response.rb +1 -1
  730. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  731. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  732. data/lib/plaid/models/institutions_search_request.rb +1 -1
  733. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  734. data/lib/plaid/models/institutions_search_response.rb +1 -1
  735. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  736. data/lib/plaid/models/investment_filter.rb +1 -1
  737. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  738. data/lib/plaid/models/investment_transaction.rb +1 -1
  739. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  740. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  741. data/lib/plaid/models/investments_auth401k_contribution_details.rb +2 -2
  742. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  743. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  744. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  745. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  746. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  747. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  748. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  749. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  750. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  751. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  752. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  753. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  754. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  755. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  756. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  757. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  758. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  759. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  760. data/lib/plaid/models/iso_currency_code.rb +1 -1
  761. data/lib/plaid/models/issue.rb +1 -1
  762. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  763. data/lib/plaid/models/issues_get_request.rb +1 -1
  764. data/lib/plaid/models/issues_get_response.rb +1 -1
  765. data/lib/plaid/models/issues_search_request.rb +1 -1
  766. data/lib/plaid/models/issues_search_response.rb +1 -1
  767. data/lib/plaid/models/issues_status.rb +1 -1
  768. data/lib/plaid/models/issues_subscribe_request.rb +6 -1
  769. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  770. data/lib/plaid/models/issuing_country.rb +1 -1
  771. data/lib/plaid/models/item.rb +2 -2
  772. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  773. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  774. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  775. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  776. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  777. data/lib/plaid/models/item_application_list_request.rb +1 -1
  778. data/lib/plaid/models/item_application_list_response.rb +1 -1
  779. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  780. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  781. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  782. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  783. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  784. data/lib/plaid/models/item_auth_method.rb +1 -1
  785. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  786. data/lib/plaid/models/item_create_authentication.rb +1 -1
  787. data/lib/plaid/models/item_error_webhook.rb +1 -1
  788. data/lib/plaid/models/item_get_request.rb +1 -1
  789. data/lib/plaid/models/item_get_response.rb +1 -1
  790. data/lib/plaid/models/item_import_request.rb +1 -1
  791. data/lib/plaid/models/item_import_request_options.rb +1 -1
  792. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  793. data/lib/plaid/models/item_import_response.rb +1 -1
  794. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  795. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  796. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  797. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  798. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  799. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  800. data/lib/plaid/models/item_remove_request.rb +1 -1
  801. data/lib/plaid/models/item_remove_response.rb +1 -1
  802. data/lib/plaid/models/item_status.rb +1 -1
  803. data/lib/plaid/models/item_status_investments.rb +1 -1
  804. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  805. data/lib/plaid/models/item_status_nullable.rb +1 -1
  806. data/lib/plaid/models/item_status_transactions.rb +1 -1
  807. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  808. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  809. data/lib/plaid/models/item_with_consent_fields.rb +2 -2
  810. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  811. data/lib/plaid/models/jwk_public_key.rb +1 -1
  812. data/lib/plaid/models/jwt_header.rb +1 -1
  813. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  814. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  815. data/lib/plaid/models/kyc_check_details.rb +1 -1
  816. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  817. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  818. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  819. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  820. data/lib/plaid/models/last_data_access_times.rb +1 -1
  821. data/lib/plaid/models/layer_authentication_passed_webhook.rb +307 -0
  822. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  823. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  824. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  825. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  826. data/lib/plaid/models/liabilities_object.rb +1 -1
  827. data/lib/plaid/models/liability_override.rb +1 -1
  828. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  829. data/lib/plaid/models/link_delivery_account.rb +1 -1
  830. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  831. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  832. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  833. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  834. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  835. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  836. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  837. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  838. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  839. data/lib/plaid/models/link_delivery_options.rb +1 -1
  840. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  841. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  842. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  843. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  844. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  845. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  846. data/lib/plaid/models/link_event.rb +1 -1
  847. data/lib/plaid/models/link_event_metadata.rb +1 -1
  848. data/lib/plaid/models/link_event_name.rb +1 -1
  849. data/lib/plaid/models/link_events_webhook.rb +1 -1
  850. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  851. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  852. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  853. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  854. data/lib/plaid/models/link_session_cra_document_upload_result.rb +1 -1
  855. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  856. data/lib/plaid/models/link_session_exit.rb +1 -1
  857. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  858. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  859. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  860. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  861. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  862. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  863. data/lib/plaid/models/link_session_results.rb +1 -1
  864. data/lib/plaid/models/link_session_success.rb +1 -1
  865. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  866. data/lib/plaid/models/link_session_success_metadata_account.rb +2 -2
  867. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  868. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  869. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  870. data/lib/plaid/models/link_token_cashflow_report.rb +2 -2
  871. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  872. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  873. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  874. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  875. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  876. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  877. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  878. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  879. data/lib/plaid/models/link_token_create_request.rb +56 -5
  880. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  881. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +41 -0
  882. data/lib/plaid/models/link_token_create_request_auth.rb +5 -5
  883. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  884. data/lib/plaid/models/link_token_create_request_cra_options.rb +14 -3
  885. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  886. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +2 -3
  887. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  888. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  889. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  890. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  891. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  892. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  893. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  894. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  895. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  896. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  897. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  898. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  899. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  900. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  901. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  902. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  903. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  904. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  905. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  906. data/lib/plaid/models/link_token_create_response.rb +1 -1
  907. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  908. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  909. data/lib/plaid/models/link_token_get_request.rb +1 -1
  910. data/lib/plaid/models/link_token_get_response.rb +1 -1
  911. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  912. data/lib/plaid/models/link_token_investments.rb +1 -1
  913. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  914. data/lib/plaid/models/link_token_transactions.rb +1 -1
  915. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  916. data/lib/plaid/models/loan.rb +1 -1
  917. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  918. data/lib/plaid/models/loan_filter.rb +1 -1
  919. data/lib/plaid/models/loan_identifier.rb +1 -1
  920. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  921. data/lib/plaid/models/loan_identifiers.rb +1 -1
  922. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  923. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  924. data/lib/plaid/models/loans.rb +1 -1
  925. data/lib/plaid/models/location.rb +1 -1
  926. data/lib/plaid/models/match_summary.rb +1 -1
  927. data/lib/plaid/models/match_summary_code.rb +1 -1
  928. data/lib/plaid/models/merchant_insights.rb +1 -1
  929. data/lib/plaid/models/meta.rb +1 -1
  930. data/lib/plaid/models/mfa.rb +1 -1
  931. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  932. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  933. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  934. data/lib/plaid/models/monitoring_insights.rb +1 -1
  935. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  936. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  937. data/lib/plaid/models/monitoring_insights_webhook.rb +2 -13
  938. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  939. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  940. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  941. data/lib/plaid/models/mortgage_liability.rb +1 -1
  942. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  943. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  944. data/lib/plaid/models/name_match_score.rb +1 -1
  945. data/lib/plaid/models/net_pay.rb +1 -1
  946. data/lib/plaid/models/network_insights_item.rb +1 -1
  947. data/lib/plaid/models/network_insights_report.rb +1 -1
  948. data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
  949. data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
  950. data/lib/plaid/models/network_status_get_request.rb +1 -1
  951. data/lib/plaid/models/network_status_get_response.rb +1 -1
  952. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  953. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  954. data/lib/plaid/models/network_status_get_user.rb +1 -1
  955. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  956. data/lib/plaid/models/numbers.rb +1 -1
  957. data/lib/plaid/models/numbers_acats.rb +2 -2
  958. data/lib/plaid/models/numbers_ach.rb +2 -2
  959. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  960. data/lib/plaid/models/numbers_aton.rb +1 -1
  961. data/lib/plaid/models/numbers_bacs.rb +1 -1
  962. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  963. data/lib/plaid/models/numbers_eft.rb +1 -1
  964. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  965. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  966. data/lib/plaid/models/numbers_international.rb +1 -1
  967. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  968. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  969. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  970. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  971. data/lib/plaid/models/option_contract.rb +2 -2
  972. data/lib/plaid/models/originating_fund_source.rb +1 -1
  973. data/lib/plaid/models/originator.rb +1 -1
  974. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  975. data/lib/plaid/models/other_account_subtype.rb +1 -1
  976. data/lib/plaid/models/other_filter.rb +1 -1
  977. data/lib/plaid/models/override_account_type.rb +1 -1
  978. data/lib/plaid/models/override_accounts.rb +1 -1
  979. data/lib/plaid/models/owner.rb +1 -1
  980. data/lib/plaid/models/owner_override.rb +1 -1
  981. data/lib/plaid/models/ownership_type.rb +1 -1
  982. data/lib/plaid/models/parties.rb +1 -1
  983. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  984. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  985. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  986. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  987. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  988. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  989. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  990. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  991. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  992. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  993. data/lib/plaid/models/partner_end_customer.rb +1 -1
  994. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  995. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  996. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  997. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  998. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  999. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  1000. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1001. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1002. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1003. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1004. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1005. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1006. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  1007. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1008. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  1009. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1010. data/lib/plaid/models/party.rb +1 -1
  1011. data/lib/plaid/models/party_individual.rb +1 -1
  1012. data/lib/plaid/models/party_role_type.rb +1 -1
  1013. data/lib/plaid/models/pay.rb +1 -1
  1014. data/lib/plaid/models/pay_frequency.rb +1 -1
  1015. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1016. data/lib/plaid/models/pay_period_details.rb +1 -1
  1017. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1018. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  1019. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  1020. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  1021. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  1022. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  1023. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1024. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1025. data/lib/plaid/models/payment_amount.rb +1 -1
  1026. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1027. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1028. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1029. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1030. data/lib/plaid/models/payment_channel.rb +1 -1
  1031. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1032. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1033. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1034. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1035. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1036. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1037. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1038. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1039. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1040. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1041. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1042. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1043. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  1044. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +2 -2
  1045. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
  1046. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1047. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1048. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1049. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1050. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1051. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1052. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1053. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1054. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1055. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1056. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1057. data/lib/plaid/models/payment_initiation_payment.rb +2 -2
  1058. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1059. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1060. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1061. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1062. data/lib/plaid/models/payment_initiation_payment_get_response.rb +2 -2
  1063. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1064. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1065. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1066. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1067. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1068. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1069. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1070. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1071. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1072. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1073. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1074. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1075. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1076. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1077. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1078. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1079. data/lib/plaid/models/payment_meta.rb +1 -1
  1080. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1081. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1082. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1083. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1084. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1085. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1086. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1087. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1088. data/lib/plaid/models/payment_scheme.rb +1 -1
  1089. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1090. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1091. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1092. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1093. data/lib/plaid/models/payroll_item.rb +1 -1
  1094. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1095. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1096. data/lib/plaid/models/paystub.rb +1 -1
  1097. data/lib/plaid/models/paystub_address.rb +1 -1
  1098. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1099. data/lib/plaid/models/paystub_details.rb +1 -1
  1100. data/lib/plaid/models/paystub_employer.rb +1 -1
  1101. data/lib/plaid/models/paystub_override.rb +1 -1
  1102. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1103. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1104. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1105. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1106. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1107. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1108. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1109. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1110. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1111. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1112. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1113. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1114. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1115. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1116. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1117. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1118. data/lib/plaid/models/pending_disconnect_webhook.rb +1 -1
  1119. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1120. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  1121. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1122. data/lib/plaid/models/phone_number.rb +1 -1
  1123. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1124. data/lib/plaid/models/phone_type.rb +1 -1
  1125. data/lib/plaid/models/physical_document_category.rb +1 -1
  1126. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1127. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1128. data/lib/plaid/models/physical_document_images.rb +1 -1
  1129. data/lib/plaid/models/plaid_check_score.rb +3 -3
  1130. data/lib/plaid/models/plaid_check_score_version.rb +39 -0
  1131. data/lib/plaid/models/plaid_error.rb +2 -2
  1132. data/lib/plaid/models/plaid_error_type.rb +3 -1
  1133. data/lib/plaid/models/platform_ids.rb +1 -1
  1134. data/lib/plaid/models/po_box_status.rb +1 -1
  1135. data/lib/plaid/models/prism_cash_score.rb +2 -6
  1136. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1137. data/lib/plaid/models/prism_cash_score_version.rb +1 -1
  1138. data/lib/plaid/models/prism_first_detect.rb +2 -6
  1139. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1140. data/lib/plaid/models/prism_insights.rb +1 -1
  1141. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1142. data/lib/plaid/models/prism_product.rb +1 -1
  1143. data/lib/plaid/models/prism_versions.rb +1 -1
  1144. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1145. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1146. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1147. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1148. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1149. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1150. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1151. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1152. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1153. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1154. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1155. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1156. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1157. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1158. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1159. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1160. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1161. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1162. data/lib/plaid/models/processor_investments_holdings_get_response.rb +1 -1
  1163. data/lib/plaid/models/processor_investments_transactions_get_request.rb +1 -1
  1164. data/lib/plaid/models/processor_investments_transactions_get_response.rb +1 -1
  1165. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1166. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1167. data/lib/plaid/models/processor_number.rb +1 -1
  1168. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1169. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1170. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1171. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1172. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1173. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1174. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1175. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1176. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1177. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1178. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1179. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1180. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  1181. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1182. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1183. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1184. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1185. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1186. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1187. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1188. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1189. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1190. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1191. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1192. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1193. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1194. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1195. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1196. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1197. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1198. data/lib/plaid/models/processor_transactions_sync_response.rb +2 -2
  1199. data/lib/plaid/models/product_access.rb +1 -1
  1200. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1201. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1202. data/lib/plaid/models/product_status.rb +1 -1
  1203. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1204. data/lib/plaid/models/products.rb +1 -1
  1205. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1206. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1207. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1208. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1209. data/lib/plaid/models/proxy_type.rb +1 -1
  1210. data/lib/plaid/models/pslf_status.rb +1 -1
  1211. data/lib/plaid/models/reason_code.rb +52 -0
  1212. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1213. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1214. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1215. data/lib/plaid/models/recommendation_string.rb +1 -1
  1216. data/lib/plaid/models/recurrence.rb +1 -1
  1217. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1218. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1219. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1220. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1221. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1222. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1223. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1224. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1225. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1226. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1227. data/lib/plaid/models/removed_transaction.rb +1 -1
  1228. data/lib/plaid/models/report_type.rb +1 -1
  1229. data/lib/plaid/models/reporting_information.rb +1 -1
  1230. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1231. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1232. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1233. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1234. data/lib/plaid/models/risk_check_details.rb +1 -1
  1235. data/lib/plaid/models/risk_check_device.rb +1 -1
  1236. data/lib/plaid/models/risk_check_email.rb +1 -1
  1237. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1238. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1239. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1240. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1241. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1242. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1243. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1244. data/lib/plaid/models/risk_check_network.rb +1 -1
  1245. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1246. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1247. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1248. data/lib/plaid/models/risk_level.rb +1 -1
  1249. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1250. data/lib/plaid/models/risk_profile.rb +1 -1
  1251. data/lib/plaid/models/risk_reason.rb +1 -1
  1252. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1253. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1254. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1255. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1256. data/lib/plaid/models/role.rb +1 -1
  1257. data/lib/plaid/models/role_detail.rb +1 -1
  1258. data/lib/plaid/models/roles.rb +1 -1
  1259. data/lib/plaid/models/rule_details.rb +267 -0
  1260. data/lib/plaid/models/rule_result.rb +40 -0
  1261. data/lib/plaid/models/ruleset.rb +12 -2
  1262. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1263. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1264. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1265. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1266. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1267. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1268. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1269. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1270. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +1 -1
  1271. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +1 -1
  1272. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1273. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1274. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1275. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  1276. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1277. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1278. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1279. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1280. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1281. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1282. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1283. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1284. data/lib/plaid/models/sandbox_payment_simulate_request.rb +2 -2
  1285. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1286. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1287. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1288. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1289. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1290. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1291. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1292. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1293. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1294. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1295. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1296. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1297. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1298. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1299. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1300. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  1301. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1302. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1303. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1304. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1305. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1306. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1307. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1308. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1309. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1310. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1311. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1312. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1313. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1314. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1315. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1316. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1317. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1318. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1319. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1320. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1321. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1322. data/lib/plaid/models/scopes.rb +1 -1
  1323. data/lib/plaid/models/scopes_context.rb +1 -1
  1324. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1325. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1326. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1327. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1328. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1329. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1330. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1331. data/lib/plaid/models/security.rb +1 -1
  1332. data/lib/plaid/models/security_override.rb +1 -1
  1333. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1334. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1335. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1336. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1337. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1338. data/lib/plaid/models/selfie_capture.rb +1 -1
  1339. data/lib/plaid/models/selfie_check.rb +1 -1
  1340. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1341. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1342. data/lib/plaid/models/selfie_status.rb +1 -1
  1343. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1344. data/lib/plaid/models/service.rb +1 -1
  1345. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1346. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1347. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1348. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1349. data/lib/plaid/models/services.rb +1 -1
  1350. data/lib/plaid/models/{deposit_switch_alt_create_request.rb → session_token_create_request.rb} +29 -77
  1351. data/lib/plaid/models/session_token_create_request_user.rb +231 -0
  1352. data/lib/plaid/models/{cra_bank_income_get_response.rb → session_token_create_response.rb} +18 -20
  1353. data/lib/plaid/models/session_token_create_response_link.rb +241 -0
  1354. data/lib/plaid/models/signal_address_data.rb +1 -1
  1355. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1356. data/lib/plaid/models/signal_decision_report_request.rb +16 -6
  1357. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1358. data/lib/plaid/models/signal_device.rb +1 -1
  1359. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1360. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1361. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1362. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1363. data/lib/plaid/models/signal_person_name.rb +1 -1
  1364. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1365. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1366. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1367. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1368. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -1
  1369. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1370. data/lib/plaid/models/signal_schedule_request.rb +1 -1
  1371. data/lib/plaid/models/signal_schedule_response.rb +1 -1
  1372. data/lib/plaid/models/signal_scores.rb +1 -1
  1373. data/lib/plaid/models/signal_user.rb +1 -1
  1374. data/lib/plaid/models/signal_warning.rb +1 -1
  1375. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1376. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1377. data/lib/plaid/models/sms_verification.rb +1 -1
  1378. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1379. data/lib/plaid/models/source.rb +1 -1
  1380. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1381. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1382. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1383. data/lib/plaid/models/statements_account.rb +1 -1
  1384. data/lib/plaid/models/statements_download_request.rb +1 -1
  1385. data/lib/plaid/models/statements_list_request.rb +1 -1
  1386. data/lib/plaid/models/statements_list_response.rb +1 -1
  1387. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1388. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1389. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1390. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1391. data/lib/plaid/models/statements_statement.rb +13 -2
  1392. data/lib/plaid/models/status.rb +1 -1
  1393. data/lib/plaid/models/statuses.rb +1 -1
  1394. data/lib/plaid/models/strategy.rb +1 -1
  1395. data/lib/plaid/models/student_loan.rb +1 -1
  1396. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1397. data/lib/plaid/models/student_loan_status.rb +1 -1
  1398. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1399. data/lib/plaid/models/sweep_failure.rb +2 -2
  1400. data/lib/plaid/models/sweep_status.rb +2 -1
  1401. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1402. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1403. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1404. data/lib/plaid/models/taxform.rb +1 -1
  1405. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1406. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1407. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1408. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1409. data/lib/plaid/models/total.rb +1 -1
  1410. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1411. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1412. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1413. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1414. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1415. data/lib/plaid/models/total_monthly_income_insights.rb +1 -1
  1416. data/lib/plaid/models/total_outflow_amount.rb +1 -1
  1417. data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
  1418. data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
  1419. data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
  1420. data/lib/plaid/models/total_report_inflow_amount.rb +248 -0
  1421. data/lib/plaid/models/total_report_inflow_amount30d.rb +248 -0
  1422. data/lib/plaid/models/total_report_inflow_amount60d.rb +248 -0
  1423. data/lib/plaid/models/total_report_inflow_amount90d.rb +248 -0
  1424. data/lib/plaid/models/total_report_outflow_amount.rb +248 -0
  1425. data/lib/plaid/models/total_report_outflow_amount30d.rb +248 -0
  1426. data/lib/plaid/models/total_report_outflow_amount60d.rb +248 -0
  1427. data/lib/plaid/models/total_report_outflow_amount90d.rb +248 -0
  1428. data/lib/plaid/models/transaction.rb +13 -3
  1429. data/lib/plaid/models/transaction_all_of.rb +12 -2
  1430. data/lib/plaid/models/transaction_base.rb +2 -2
  1431. data/lib/plaid/models/transaction_code.rb +1 -1
  1432. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1433. data/lib/plaid/models/transaction_data.rb +1 -1
  1434. data/lib/plaid/models/transaction_override.rb +1 -1
  1435. data/lib/plaid/models/transaction_stream.rb +1 -1
  1436. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1437. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1438. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1439. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1440. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1441. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1442. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1443. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1444. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1445. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1446. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1447. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1448. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1449. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1450. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1451. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1452. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1453. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1454. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1455. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1456. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1457. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1458. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1459. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1460. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1461. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1462. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1463. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1464. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1465. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1466. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1467. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1468. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1469. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1470. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1471. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1472. data/lib/plaid/models/transactions_sync_request_options.rb +3 -3
  1473. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1474. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1475. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1476. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1477. data/lib/plaid/models/transfer.rb +2 -2
  1478. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1479. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1480. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1481. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1482. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  1483. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1484. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1485. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1486. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1487. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1488. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1489. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1490. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1491. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1492. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1493. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1494. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1495. data/lib/plaid/models/transfer_balance.rb +1 -1
  1496. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1497. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1498. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1499. data/lib/plaid/models/transfer_cancel_request.rb +37 -6
  1500. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1501. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1502. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1503. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +1 -1
  1504. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1505. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1506. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1507. data/lib/plaid/models/transfer_create_request.rb +2 -2
  1508. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1509. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1510. data/lib/plaid/models/transfer_credit_usage_configuration.rb +2 -2
  1511. data/lib/plaid/models/transfer_debit_usage_configuration.rb +2 -2
  1512. data/lib/plaid/models/transfer_device.rb +1 -1
  1513. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1514. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1515. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1516. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1517. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1518. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1519. data/lib/plaid/models/transfer_event.rb +18 -7
  1520. data/lib/plaid/models/transfer_event_list_request.rb +3 -3
  1521. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1522. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1523. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1524. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1525. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1526. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1527. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1528. data/lib/plaid/models/transfer_failure.rb +2 -2
  1529. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1530. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +259 -0
  1531. data/lib/plaid/models/{cra_bank_income_create_response.rb → transfer_funding_account_with_display_name_all_of.rb} +12 -13
  1532. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1533. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1534. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1535. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1536. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1537. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1538. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1539. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1540. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1541. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1542. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1543. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1544. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1545. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1546. data/lib/plaid/models/transfer_ledger_deposit_request.rb +1 -1
  1547. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1548. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1549. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1550. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1551. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1552. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1553. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +1 -1
  1554. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1555. data/lib/plaid/models/transfer_list_request.rb +3 -3
  1556. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1557. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1558. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1559. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1560. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1561. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1562. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1563. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1564. data/lib/plaid/models/transfer_network.rb +1 -1
  1565. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1566. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1567. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1568. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1569. data/lib/plaid/models/{deposit_switch_get_request.rb → transfer_originator_funding_account_create_request.rb} +30 -16
  1570. data/lib/plaid/models/{deposit_switch_create_response.rb → transfer_originator_funding_account_create_response.rb} +13 -18
  1571. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1572. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1573. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1574. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1575. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1576. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1577. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  1578. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  1579. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1580. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1581. data/lib/plaid/models/transfer_platform_person_create_request.rb +42 -6
  1582. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1583. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1584. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1585. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1586. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1587. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1588. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1589. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1590. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1591. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1592. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1593. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1594. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1595. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1596. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1597. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1598. data/lib/plaid/models/transfer_recurring_list_request.rb +3 -3
  1599. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1600. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1601. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1602. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1603. data/lib/plaid/models/transfer_refund.rb +1 -1
  1604. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1605. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1606. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1607. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1608. data/lib/plaid/models/transfer_refund_failure.rb +2 -2
  1609. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1610. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1611. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1612. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1613. data/lib/plaid/models/transfer_repayment_list_request.rb +3 -3
  1614. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1615. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1616. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1617. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1618. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1619. data/lib/plaid/models/transfer_status.rb +1 -1
  1620. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1621. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1622. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1623. data/lib/plaid/models/transfer_sweep_list_request.rb +3 -3
  1624. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1625. data/lib/plaid/models/transfer_sweep_status.rb +1 -2
  1626. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1627. data/lib/plaid/models/transfer_type.rb +1 -1
  1628. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1629. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1630. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1631. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1632. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1633. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1634. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1635. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1636. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1637. data/lib/plaid/models/user_account_identity.rb +2 -2
  1638. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1639. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1640. data/lib/plaid/models/user_account_item.rb +1 -1
  1641. data/lib/plaid/models/user_account_revoked_webhook.rb +1 -1
  1642. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1643. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1644. data/lib/plaid/models/user_address.rb +1 -1
  1645. data/lib/plaid/models/user_create_request.rb +1 -1
  1646. data/lib/plaid/models/user_create_response.rb +1 -1
  1647. data/lib/plaid/models/user_custom_password.rb +1 -1
  1648. data/lib/plaid/models/user_data_overview.rb +1 -1
  1649. data/lib/plaid/models/user_id_number.rb +1 -1
  1650. data/lib/plaid/models/user_items_get_request.rb +1 -1
  1651. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1652. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1653. data/lib/plaid/models/user_remove_request.rb +1 -1
  1654. data/lib/plaid/models/user_remove_response.rb +1 -1
  1655. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1656. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1657. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1658. data/lib/plaid/models/user_third_party_token_create_request.rb +1 -1
  1659. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1660. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  1661. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  1662. data/lib/plaid/models/user_update_request.rb +1 -1
  1663. data/lib/plaid/models/user_update_response.rb +1 -1
  1664. data/lib/plaid/models/validation_source.rb +1 -1
  1665. data/lib/plaid/models/validation_sources.rb +1 -1
  1666. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1667. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1668. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1669. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1670. data/lib/plaid/models/verification_status.rb +1 -1
  1671. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1672. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1673. data/lib/plaid/models/w2.rb +1 -1
  1674. data/lib/plaid/models/w2_box12.rb +1 -1
  1675. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1676. data/lib/plaid/models/w2_override.rb +1 -1
  1677. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1678. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1679. data/lib/plaid/models/wallet.rb +1 -1
  1680. data/lib/plaid/models/wallet_balance.rb +1 -1
  1681. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1682. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1683. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1684. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1685. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1686. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1687. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1688. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1689. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1690. data/lib/plaid/models/wallet_status.rb +1 -1
  1691. data/lib/plaid/models/wallet_transaction.rb +1 -1
  1692. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1693. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1694. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1695. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1696. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1697. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1698. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1699. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1700. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1701. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  1702. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1703. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1704. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1705. data/lib/plaid/models/wallet_transaction_relation.rb +2 -2
  1706. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1707. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1708. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1709. data/lib/plaid/models/warning.rb +1 -1
  1710. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1711. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1712. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1713. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1714. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1715. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1716. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1717. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1718. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1719. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1720. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1721. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1722. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1723. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1724. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1725. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1726. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1727. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1728. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1729. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1730. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1731. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1732. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1733. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1734. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1735. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1736. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1737. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1738. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1739. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1740. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1741. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1742. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1743. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1744. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1745. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1746. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1747. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1748. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1749. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1750. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1751. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1752. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1753. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1754. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1755. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1756. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1757. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1758. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1759. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1760. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1761. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1762. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1763. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1764. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1765. data/lib/plaid/models/webhook_type.rb +1 -1
  1766. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1767. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1768. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1769. data/lib/plaid/models/yield_rate.rb +1 -1
  1770. data/lib/plaid/models/yield_rate_type.rb +1 -1
  1771. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1772. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1773. data/lib/plaid/version.rb +2 -2
  1774. data/lib/plaid.rb +61 -20
  1775. data/plaid.gemspec +1 -1
  1776. data/test/test_accounts.rb +0 -22
  1777. metadata +62 -21
  1778. data/lib/plaid/models/deposit_switch_create_request_options.rb +0 -252
  1779. data/lib/plaid/models/deposit_switch_get_response.rb +0 -449
@@ -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.617.1
6
+ The version of the OpenAPI document: 2020-09-14_1.633.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -2467,31 +2467,31 @@ module Plaid
2467
2467
  return data, status_code, headers
2468
2468
  end
2469
2469
 
2470
- # Get categories
2471
- # 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.
2472
- # @param body [Object]
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.
2472
+ # @param cashflow_report_get_request [CashflowReportGetRequest]
2473
2473
  # @param [Hash] opts the optional parameters
2474
- # @return [CategoriesGetResponse]
2475
- def categories_get(body, opts = {})
2476
- data, _status_code, _headers = categories_get_with_http_info(body, opts)
2474
+ # @return [CashflowReportGetResponse]
2475
+ def cashflow_report_get(cashflow_report_get_request, opts = {})
2476
+ data, _status_code, _headers = cashflow_report_get_with_http_info(cashflow_report_get_request, opts)
2477
2477
  data
2478
2478
  end
2479
2479
 
2480
- # Get categories
2481
- # 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.
2482
- # @param body [Object]
2480
+ # Gets transaction data in cashflow_report
2481
+ # 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.
2482
+ # @param cashflow_report_get_request [CashflowReportGetRequest]
2483
2483
  # @param [Hash] opts the optional parameters
2484
- # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
2485
- def categories_get_with_http_info(body, opts = {})
2484
+ # @return [Array<(CashflowReportGetResponse, Integer, Hash)>] CashflowReportGetResponse data, response status code and response headers
2485
+ def cashflow_report_get_with_http_info(cashflow_report_get_request, opts = {})
2486
2486
  if @api_client.config.debugging
2487
- @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
2487
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_get ...'
2488
2488
  end
2489
- # verify the required parameter 'body' is set
2490
- if @api_client.config.client_side_validation && body.nil?
2491
- fail ArgumentError, "Missing the required parameter 'body' when calling PlaidApi.categories_get"
2489
+ # verify the required parameter 'cashflow_report_get_request' is set
2490
+ if @api_client.config.client_side_validation && cashflow_report_get_request.nil?
2491
+ fail ArgumentError, "Missing the required parameter 'cashflow_report_get_request' when calling PlaidApi.cashflow_report_get"
2492
2492
  end
2493
2493
  # resource path
2494
- local_var_path = '/categories/get'
2494
+ local_var_path = '/cashflow_report/get'
2495
2495
 
2496
2496
  # query parameters
2497
2497
  query_params = opts[:query_params] || {}
@@ -2510,16 +2510,16 @@ module Plaid
2510
2510
  form_params = opts[:form_params] || {}
2511
2511
 
2512
2512
  # http body (model)
2513
- post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
2513
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_get_request)
2514
2514
 
2515
2515
  # return_type
2516
- return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
2516
+ return_type = opts[:debug_return_type] || 'CashflowReportGetResponse'
2517
2517
 
2518
2518
  # auth_names
2519
- auth_names = opts[:debug_auth_names] || []
2519
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2520
2520
 
2521
2521
  new_options = opts.merge(
2522
- :operation => :"PlaidApi.categories_get",
2522
+ :operation => :"PlaidApi.cashflow_report_get",
2523
2523
  :header_params => header_params,
2524
2524
  :query_params => query_params,
2525
2525
  :form_params => form_params,
@@ -2530,36 +2530,36 @@ module Plaid
2530
2530
 
2531
2531
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2532
2532
  if @api_client.config.debugging
2533
- @api_client.config.logger.debug "API called: PlaidApi#categories_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2533
+ @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2534
2534
  end
2535
2535
  return data, status_code, headers
2536
2536
  end
2537
2537
 
2538
- # List a historical log of item consent events
2539
- # 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.
2540
- # @param consent_events_get_request [ConsentEventsGetRequest]
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]
2541
2541
  # @param [Hash] opts the optional parameters
2542
- # @return [ConsentEventsGetResponse]
2543
- def consent_events_get(consent_events_get_request, opts = {})
2544
- data, _status_code, _headers = consent_events_get_with_http_info(consent_events_get_request, opts)
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)
2545
2545
  data
2546
2546
  end
2547
2547
 
2548
- # List a historical log of item consent events
2549
- # 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.
2550
- # @param consent_events_get_request [ConsentEventsGetRequest]
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]
2551
2551
  # @param [Hash] opts the optional parameters
2552
- # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
2553
- def consent_events_get_with_http_info(consent_events_get_request, opts = {})
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 = {})
2554
2554
  if @api_client.config.debugging
2555
- @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
2555
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cashflow_report_refresh ...'
2556
2556
  end
2557
- # verify the required parameter 'consent_events_get_request' is set
2558
- if @api_client.config.client_side_validation && consent_events_get_request.nil?
2559
- fail ArgumentError, "Missing the required parameter 'consent_events_get_request' when calling PlaidApi.consent_events_get"
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"
2560
2560
  end
2561
2561
  # resource path
2562
- local_var_path = '/consent/events/get'
2562
+ local_var_path = '/cashflow_report/refresh'
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(consent_events_get_request)
2581
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cashflow_report_refresh_request)
2582
2582
 
2583
2583
  # return_type
2584
- return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
2584
+ return_type = opts[:debug_return_type] || 'CashflowReportRefreshResponse'
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.consent_events_get",
2590
+ :operation => :"PlaidApi.cashflow_report_refresh",
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#consent_events_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2601
+ @api_client.config.logger.debug "API called: PlaidApi#cashflow_report_refresh\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
- # Retrieve a PDF Reports
2607
- # 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.
2608
- # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
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]
2609
2609
  # @param [Hash] opts the optional parameters
2610
- # @return [File]
2611
- def consumer_report_pdf_get(consumer_report_pdf_get_request, opts = {})
2612
- data, _status_code, _headers = consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts)
2610
+ # @return [CategoriesGetResponse]
2611
+ def categories_get(body, opts = {})
2612
+ data, _status_code, _headers = categories_get_with_http_info(body, opts)
2613
2613
  data
2614
2614
  end
2615
2615
 
2616
- # Retrieve a PDF Reports
2617
- # 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.
2618
- # @param consumer_report_pdf_get_request [ConsumerReportPDFGetRequest]
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]
2619
2619
  # @param [Hash] opts the optional parameters
2620
- # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
2621
- def consumer_report_pdf_get_with_http_info(consumer_report_pdf_get_request, opts = {})
2620
+ # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
2621
+ def categories_get_with_http_info(body, opts = {})
2622
2622
  if @api_client.config.debugging
2623
- @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
2623
+ @api_client.config.logger.debug 'Calling API: PlaidApi.categories_get ...'
2624
2624
  end
2625
- # verify the required parameter 'consumer_report_pdf_get_request' is set
2626
- if @api_client.config.client_side_validation && consumer_report_pdf_get_request.nil?
2627
- fail ArgumentError, "Missing the required parameter 'consumer_report_pdf_get_request' when calling PlaidApi.consumer_report_pdf_get"
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"
2628
2628
  end
2629
2629
  # resource path
2630
- local_var_path = '/consumer_report/pdf/get'
2630
+ local_var_path = '/categories/get'
2631
2631
 
2632
2632
  # query parameters
2633
2633
  query_params = opts[:query_params] || {}
@@ -2635,7 +2635,7 @@ module Plaid
2635
2635
  # header parameters
2636
2636
  header_params = opts[:header_params] || {}
2637
2637
  # HTTP header 'Accept' (if needed)
2638
- header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
2638
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2639
2639
  # HTTP header 'Content-Type'
2640
2640
  content_type = @api_client.select_header_content_type(['application/json'])
2641
2641
  if !content_type.nil?
@@ -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(consumer_report_pdf_get_request)
2649
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
2650
2650
 
2651
2651
  # return_type
2652
- return_type = opts[:debug_return_type] || 'File'
2652
+ return_type = opts[:debug_return_type] || 'CategoriesGetResponse'
2653
2653
 
2654
2654
  # auth_names
2655
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2655
+ auth_names = opts[:debug_auth_names] || []
2656
2656
 
2657
2657
  new_options = opts.merge(
2658
- :operation => :"PlaidApi.consumer_report_pdf_get",
2658
+ :operation => :"PlaidApi.categories_get",
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#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2669
+ @api_client.config.logger.debug "API called: PlaidApi#categories_get\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
- # Create a CRA report for income verification
2675
- # `/cra/bank_income/create` creates a CRA report for income verification
2676
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
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]
2677
2677
  # @param [Hash] opts the optional parameters
2678
- # @return [CraBankIncomeCreateResponse]
2679
- def cra_bank_income_create(cra_bank_income_create_request, opts = {})
2680
- data, _status_code, _headers = cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts)
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)
2681
2681
  data
2682
2682
  end
2683
2683
 
2684
- # Create a CRA report for income verification
2685
- # &#x60;/cra/bank_income/create&#x60; creates a CRA report for income verification
2686
- # @param cra_bank_income_create_request [CraBankIncomeCreateRequest]
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]
2687
2687
  # @param [Hash] opts the optional parameters
2688
- # @return [Array<(CraBankIncomeCreateResponse, Integer, Hash)>] CraBankIncomeCreateResponse data, response status code and response headers
2689
- def cra_bank_income_create_with_http_info(cra_bank_income_create_request, opts = {})
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 = {})
2690
2690
  if @api_client.config.debugging
2691
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_create ...'
2691
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consent_events_get ...'
2692
2692
  end
2693
- # verify the required parameter 'cra_bank_income_create_request' is set
2694
- if @api_client.config.client_side_validation && cra_bank_income_create_request.nil?
2695
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_create_request' when calling PlaidApi.cra_bank_income_create"
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"
2696
2696
  end
2697
2697
  # resource path
2698
- local_var_path = '/cra/bank_income/create'
2698
+ local_var_path = '/consent/events/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(cra_bank_income_create_request)
2717
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consent_events_get_request)
2718
2718
 
2719
2719
  # return_type
2720
- return_type = opts[:debug_return_type] || 'CraBankIncomeCreateResponse'
2720
+ return_type = opts[:debug_return_type] || 'ConsentEventsGetResponse'
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.cra_bank_income_create",
2726
+ :operation => :"PlaidApi.consent_events_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#cra_bank_income_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2737
+ @api_client.config.logger.debug "API called: PlaidApi#consent_events_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 information from the bank accounts used for income verification
2743
- # `/cra/bank_income/get` returns the bank income report(s) for a specified user.
2744
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
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]
2745
2745
  # @param [Hash] opts the optional parameters
2746
- # @return [CraBankIncomeGetResponse]
2747
- def cra_bank_income_get(cra_bank_income_get_request, opts = {})
2748
- data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
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)
2749
2749
  data
2750
2750
  end
2751
2751
 
2752
- # Retrieve information from the bank accounts used for income verification
2753
- # &#x60;/cra/bank_income/get&#x60; returns the bank income report(s) for a specified user.
2754
- # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
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]
2755
2755
  # @param [Hash] opts the optional parameters
2756
- # @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
2757
- def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
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 = {})
2758
2758
  if @api_client.config.debugging
2759
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
2759
+ @api_client.config.logger.debug 'Calling API: PlaidApi.consumer_report_pdf_get ...'
2760
2760
  end
2761
- # verify the required parameter 'cra_bank_income_get_request' is set
2762
- if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
2763
- fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
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"
2764
2764
  end
2765
2765
  # resource path
2766
- local_var_path = '/cra/bank_income/get'
2766
+ local_var_path = '/consumer_report/pdf/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/json'])
2774
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
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(cra_bank_income_get_request)
2785
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(consumer_report_pdf_get_request)
2786
2786
 
2787
2787
  # return_type
2788
- return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
2788
+ return_type = opts[:debug_return_type] || 'File'
2789
2789
 
2790
2790
  # auth_names
2791
2791
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2792
2792
 
2793
2793
  new_options = opts.merge(
2794
- :operation => :"PlaidApi.cra_bank_income_get",
2794
+ :operation => :"PlaidApi.consumer_report_pdf_get",
2795
2795
  :header_params => header_params,
2796
2796
  :query_params => query_params,
2797
2797
  :form_params => form_params,
@@ -2802,7 +2802,7 @@ 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#cra_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2805
+ @api_client.config.logger.debug "API called: PlaidApi#consumer_report_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2806
2806
  end
2807
2807
  return data, status_code, headers
2808
2808
  end
@@ -3283,6 +3283,74 @@ module Plaid
3283
3283
  return data, status_code, headers
3284
3284
  end
3285
3285
 
3286
+ # Retrieve various verification reports for a user.
3287
+ # 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`.\"
3288
+ # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
3289
+ # @param [Hash] opts the optional parameters
3290
+ # @return [CraCheckReportVerificationGetResponse]
3291
+ def cra_check_report_verification_get(cra_check_report_verification_get_request, opts = {})
3292
+ data, _status_code, _headers = cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts)
3293
+ data
3294
+ end
3295
+
3296
+ # Retrieve various verification reports for a user.
3297
+ # 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;
3298
+ # @param cra_check_report_verification_get_request [CraCheckReportVerificationGetRequest]
3299
+ # @param [Hash] opts the optional parameters
3300
+ # @return [Array<(CraCheckReportVerificationGetResponse, Integer, Hash)>] CraCheckReportVerificationGetResponse data, response status code and response headers
3301
+ def cra_check_report_verification_get_with_http_info(cra_check_report_verification_get_request, opts = {})
3302
+ if @api_client.config.debugging
3303
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_verification_get ...'
3304
+ end
3305
+ # verify the required parameter 'cra_check_report_verification_get_request' is set
3306
+ if @api_client.config.client_side_validation && cra_check_report_verification_get_request.nil?
3307
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_verification_get_request' when calling PlaidApi.cra_check_report_verification_get"
3308
+ end
3309
+ # resource path
3310
+ local_var_path = '/cra/check_report/verification/get'
3311
+
3312
+ # query parameters
3313
+ query_params = opts[:query_params] || {}
3314
+
3315
+ # header parameters
3316
+ header_params = opts[:header_params] || {}
3317
+ # HTTP header 'Accept' (if needed)
3318
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3319
+ # HTTP header 'Content-Type'
3320
+ content_type = @api_client.select_header_content_type(['application/json'])
3321
+ if !content_type.nil?
3322
+ header_params['Content-Type'] = content_type
3323
+ end
3324
+
3325
+ # form parameters
3326
+ form_params = opts[:form_params] || {}
3327
+
3328
+ # http body (model)
3329
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_verification_get_request)
3330
+
3331
+ # return_type
3332
+ return_type = opts[:debug_return_type] || 'CraCheckReportVerificationGetResponse'
3333
+
3334
+ # auth_names
3335
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3336
+
3337
+ new_options = opts.merge(
3338
+ :operation => :"PlaidApi.cra_check_report_verification_get",
3339
+ :header_params => header_params,
3340
+ :query_params => query_params,
3341
+ :form_params => form_params,
3342
+ :body => post_body,
3343
+ :auth_names => auth_names,
3344
+ :return_type => return_type
3345
+ )
3346
+
3347
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3348
+ if @api_client.config.debugging
3349
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_verification_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3350
+ end
3351
+ return data, status_code, headers
3352
+ end
3353
+
3286
3354
  # Register loan applications and decisions.
3287
3355
  # `/cra/loans/applications/register` registers loan applications and decisions.
3288
3356
  # @param cra_loans_applications_register_request [CraLoansApplicationsRegisterRequest]
@@ -5595,278 +5663,6 @@ module Plaid
5595
5663
  return data, status_code, headers
5596
5664
  end
5597
5665
 
5598
- # (Deprecated) Create a deposit switch without using Plaid Exchange
5599
- # 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.
5600
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5601
- # @param [Hash] opts the optional parameters
5602
- # @return [DepositSwitchAltCreateResponse]
5603
- def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
5604
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
5605
- data
5606
- end
5607
-
5608
- # (Deprecated) Create a deposit switch without using Plaid Exchange
5609
- # 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.
5610
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
5611
- # @param [Hash] opts the optional parameters
5612
- # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
5613
- def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
5614
- if @api_client.config.debugging
5615
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
5616
- end
5617
- # verify the required parameter 'deposit_switch_alt_create_request' is set
5618
- if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
5619
- fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
5620
- end
5621
- # resource path
5622
- local_var_path = '/deposit_switch/alt/create'
5623
-
5624
- # query parameters
5625
- query_params = opts[:query_params] || {}
5626
-
5627
- # header parameters
5628
- header_params = opts[:header_params] || {}
5629
- # HTTP header 'Accept' (if needed)
5630
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5631
- # HTTP header 'Content-Type'
5632
- content_type = @api_client.select_header_content_type(['application/json'])
5633
- if !content_type.nil?
5634
- header_params['Content-Type'] = content_type
5635
- end
5636
-
5637
- # form parameters
5638
- form_params = opts[:form_params] || {}
5639
-
5640
- # http body (model)
5641
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
5642
-
5643
- # return_type
5644
- return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
5645
-
5646
- # auth_names
5647
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5648
-
5649
- new_options = opts.merge(
5650
- :operation => :"PlaidApi.deposit_switch_alt_create",
5651
- :header_params => header_params,
5652
- :query_params => query_params,
5653
- :form_params => form_params,
5654
- :body => post_body,
5655
- :auth_names => auth_names,
5656
- :return_type => return_type
5657
- )
5658
-
5659
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5660
- if @api_client.config.debugging
5661
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5662
- end
5663
- return data, status_code, headers
5664
- end
5665
-
5666
- # (Deprecated) Create a deposit switch
5667
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5668
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5669
- # @param [Hash] opts the optional parameters
5670
- # @return [DepositSwitchCreateResponse]
5671
- def deposit_switch_create(deposit_switch_create_request, opts = {})
5672
- data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
5673
- data
5674
- end
5675
-
5676
- # (Deprecated) Create a deposit switch
5677
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
5678
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
5679
- # @param [Hash] opts the optional parameters
5680
- # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
5681
- def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
5682
- if @api_client.config.debugging
5683
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
5684
- end
5685
- # verify the required parameter 'deposit_switch_create_request' is set
5686
- if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
5687
- fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
5688
- end
5689
- # resource path
5690
- local_var_path = '/deposit_switch/create'
5691
-
5692
- # query parameters
5693
- query_params = opts[:query_params] || {}
5694
-
5695
- # header parameters
5696
- header_params = opts[:header_params] || {}
5697
- # HTTP header 'Accept' (if needed)
5698
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5699
- # HTTP header 'Content-Type'
5700
- content_type = @api_client.select_header_content_type(['application/json'])
5701
- if !content_type.nil?
5702
- header_params['Content-Type'] = content_type
5703
- end
5704
-
5705
- # form parameters
5706
- form_params = opts[:form_params] || {}
5707
-
5708
- # http body (model)
5709
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_create_request)
5710
-
5711
- # return_type
5712
- return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
5713
-
5714
- # auth_names
5715
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5716
-
5717
- new_options = opts.merge(
5718
- :operation => :"PlaidApi.deposit_switch_create",
5719
- :header_params => header_params,
5720
- :query_params => query_params,
5721
- :form_params => form_params,
5722
- :body => post_body,
5723
- :auth_names => auth_names,
5724
- :return_type => return_type
5725
- )
5726
-
5727
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5728
- if @api_client.config.debugging
5729
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5730
- end
5731
- return data, status_code, headers
5732
- end
5733
-
5734
- # (Deprecated) Retrieve a deposit switch
5735
- # 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.
5736
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
5737
- # @param [Hash] opts the optional parameters
5738
- # @return [DepositSwitchGetResponse]
5739
- def deposit_switch_get(deposit_switch_get_request, opts = {})
5740
- data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
5741
- data
5742
- end
5743
-
5744
- # (Deprecated) Retrieve a deposit switch
5745
- # 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.
5746
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
5747
- # @param [Hash] opts the optional parameters
5748
- # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
5749
- def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
5750
- if @api_client.config.debugging
5751
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
5752
- end
5753
- # verify the required parameter 'deposit_switch_get_request' is set
5754
- if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
5755
- fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
5756
- end
5757
- # resource path
5758
- local_var_path = '/deposit_switch/get'
5759
-
5760
- # query parameters
5761
- query_params = opts[:query_params] || {}
5762
-
5763
- # header parameters
5764
- header_params = opts[:header_params] || {}
5765
- # HTTP header 'Accept' (if needed)
5766
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5767
- # HTTP header 'Content-Type'
5768
- content_type = @api_client.select_header_content_type(['application/json'])
5769
- if !content_type.nil?
5770
- header_params['Content-Type'] = content_type
5771
- end
5772
-
5773
- # form parameters
5774
- form_params = opts[:form_params] || {}
5775
-
5776
- # http body (model)
5777
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_get_request)
5778
-
5779
- # return_type
5780
- return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
5781
-
5782
- # auth_names
5783
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5784
-
5785
- new_options = opts.merge(
5786
- :operation => :"PlaidApi.deposit_switch_get",
5787
- :header_params => header_params,
5788
- :query_params => query_params,
5789
- :form_params => form_params,
5790
- :body => post_body,
5791
- :auth_names => auth_names,
5792
- :return_type => return_type
5793
- )
5794
-
5795
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5796
- if @api_client.config.debugging
5797
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5798
- end
5799
- return data, status_code, headers
5800
- end
5801
-
5802
- # (Deprecated) Create a deposit switch token
5803
- # 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.
5804
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5805
- # @param [Hash] opts the optional parameters
5806
- # @return [DepositSwitchTokenCreateResponse]
5807
- def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
5808
- data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
5809
- data
5810
- end
5811
-
5812
- # (Deprecated) Create a deposit switch token
5813
- # 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.
5814
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
5815
- # @param [Hash] opts the optional parameters
5816
- # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
5817
- def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
5818
- if @api_client.config.debugging
5819
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
5820
- end
5821
- # verify the required parameter 'deposit_switch_token_create_request' is set
5822
- if @api_client.config.client_side_validation && deposit_switch_token_create_request.nil?
5823
- fail ArgumentError, "Missing the required parameter 'deposit_switch_token_create_request' when calling PlaidApi.deposit_switch_token_create"
5824
- end
5825
- # resource path
5826
- local_var_path = '/deposit_switch/token/create'
5827
-
5828
- # query parameters
5829
- query_params = opts[:query_params] || {}
5830
-
5831
- # header parameters
5832
- header_params = opts[:header_params] || {}
5833
- # HTTP header 'Accept' (if needed)
5834
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5835
- # HTTP header 'Content-Type'
5836
- content_type = @api_client.select_header_content_type(['application/json'])
5837
- if !content_type.nil?
5838
- header_params['Content-Type'] = content_type
5839
- end
5840
-
5841
- # form parameters
5842
- form_params = opts[:form_params] || {}
5843
-
5844
- # http body (model)
5845
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_token_create_request)
5846
-
5847
- # return_type
5848
- return_type = opts[:debug_return_type] || 'DepositSwitchTokenCreateResponse'
5849
-
5850
- # auth_names
5851
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5852
-
5853
- new_options = opts.merge(
5854
- :operation => :"PlaidApi.deposit_switch_token_create",
5855
- :header_params => header_params,
5856
- :query_params => query_params,
5857
- :form_params => form_params,
5858
- :body => post_body,
5859
- :auth_names => auth_names,
5860
- :return_type => return_type
5861
- )
5862
-
5863
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5864
- if @api_client.config.debugging
5865
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5866
- end
5867
- return data, status_code, headers
5868
- end
5869
-
5870
5666
  # Search employer database
5871
5667
  # `/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.
5872
5668
  # @param employers_search_request [EmployersSearchRequest]
@@ -7691,7 +7487,7 @@ module Plaid
7691
7487
  end
7692
7488
 
7693
7489
  # Search for an Issue
7694
- # 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.
7490
+ # 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.
7695
7491
  # @param issues_search_request [IssuesSearchRequest]
7696
7492
  # @param [Hash] opts the optional parameters
7697
7493
  # @return [IssuesSearchResponse]
@@ -7701,7 +7497,7 @@ module Plaid
7701
7497
  end
7702
7498
 
7703
7499
  # Search for an Issue
7704
- # 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.
7500
+ # 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.
7705
7501
  # @param issues_search_request [IssuesSearchRequest]
7706
7502
  # @param [Hash] opts the optional parameters
7707
7503
  # @return [Array<(IssuesSearchResponse, Integer, Hash)>] IssuesSearchResponse data, response status code and response headers
@@ -8439,7 +8235,7 @@ module Plaid
8439
8235
  end
8440
8236
 
8441
8237
  # Remove an Item
8442
- # 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.
8238
+ # 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 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.
8443
8239
  # @param item_remove_request [ItemRemoveRequest]
8444
8240
  # @param [Hash] opts the optional parameters
8445
8241
  # @return [ItemRemoveResponse]
@@ -8449,7 +8245,7 @@ module Plaid
8449
8245
  end
8450
8246
 
8451
8247
  # Remove an Item
8452
- # 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.
8248
+ # 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 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.
8453
8249
  # @param item_remove_request [ItemRemoveRequest]
8454
8250
  # @param [Hash] opts the optional parameters
8455
8251
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -9935,7 +9731,7 @@ module Plaid
9935
9731
  end
9936
9732
 
9937
9733
  # Reverse an existing payment
9938
- # 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.
9734
+ # 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.
9939
9735
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
9940
9736
  # @param [Hash] opts the optional parameters
9941
9737
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -9945,7 +9741,7 @@ module Plaid
9945
9741
  end
9946
9742
 
9947
9743
  # Reverse an existing payment
9948
- # 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.
9744
+ # 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.
9949
9745
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
9950
9746
  # @param [Hash] opts the optional parameters
9951
9747
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -11907,7 +11703,7 @@ module Plaid
11907
11703
  end
11908
11704
 
11909
11705
  # Get incremental transaction updates on a processor token
11910
- # 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.
11706
+ # 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.
11911
11707
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
11912
11708
  # @param [Hash] opts the optional parameters
11913
11709
  # @return [ProcessorTransactionsSyncResponse]
@@ -11917,7 +11713,7 @@ module Plaid
11917
11713
  end
11918
11714
 
11919
11715
  # Get incremental transaction updates on a processor token
11920
- # 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.
11716
+ # 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.
11921
11717
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
11922
11718
  # @param [Hash] opts the optional parameters
11923
11719
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -12383,7 +12179,7 @@ module Plaid
12383
12179
  end
12384
12180
 
12385
12181
  # Fire a test webhook
12386
- # 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`).
12182
+ # 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`).
12387
12183
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12388
12184
  # @param [Hash] opts the optional parameters
12389
12185
  # @return [SandboxItemFireWebhookResponse]
@@ -12393,7 +12189,7 @@ module Plaid
12393
12189
  end
12394
12190
 
12395
12191
  # Fire a test webhook
12396
- # 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;).
12192
+ # 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;).
12397
12193
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12398
12194
  # @param [Hash] opts the optional parameters
12399
12195
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -13810,6 +13606,74 @@ module Plaid
13810
13606
  return data, status_code, headers
13811
13607
  end
13812
13608
 
13609
+ # Create a Session Token
13610
+ # 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).
13611
+ # @param session_token_create_request [SessionTokenCreateRequest]
13612
+ # @param [Hash] opts the optional parameters
13613
+ # @return [SessionTokenCreateResponse]
13614
+ def session_token_create(session_token_create_request, opts = {})
13615
+ data, _status_code, _headers = session_token_create_with_http_info(session_token_create_request, opts)
13616
+ data
13617
+ end
13618
+
13619
+ # Create a Session Token
13620
+ # 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).
13621
+ # @param session_token_create_request [SessionTokenCreateRequest]
13622
+ # @param [Hash] opts the optional parameters
13623
+ # @return [Array<(SessionTokenCreateResponse, Integer, Hash)>] SessionTokenCreateResponse data, response status code and response headers
13624
+ def session_token_create_with_http_info(session_token_create_request, opts = {})
13625
+ if @api_client.config.debugging
13626
+ @api_client.config.logger.debug 'Calling API: PlaidApi.session_token_create ...'
13627
+ end
13628
+ # verify the required parameter 'session_token_create_request' is set
13629
+ if @api_client.config.client_side_validation && session_token_create_request.nil?
13630
+ fail ArgumentError, "Missing the required parameter 'session_token_create_request' when calling PlaidApi.session_token_create"
13631
+ end
13632
+ # resource path
13633
+ local_var_path = '/session/token/create'
13634
+
13635
+ # query parameters
13636
+ query_params = opts[:query_params] || {}
13637
+
13638
+ # header parameters
13639
+ header_params = opts[:header_params] || {}
13640
+ # HTTP header 'Accept' (if needed)
13641
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
13642
+ # HTTP header 'Content-Type'
13643
+ content_type = @api_client.select_header_content_type(['application/json'])
13644
+ if !content_type.nil?
13645
+ header_params['Content-Type'] = content_type
13646
+ end
13647
+
13648
+ # form parameters
13649
+ form_params = opts[:form_params] || {}
13650
+
13651
+ # http body (model)
13652
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(session_token_create_request)
13653
+
13654
+ # return_type
13655
+ return_type = opts[:debug_return_type] || 'SessionTokenCreateResponse'
13656
+
13657
+ # auth_names
13658
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
13659
+
13660
+ new_options = opts.merge(
13661
+ :operation => :"PlaidApi.session_token_create",
13662
+ :header_params => header_params,
13663
+ :query_params => query_params,
13664
+ :form_params => form_params,
13665
+ :body => post_body,
13666
+ :auth_names => auth_names,
13667
+ :return_type => return_type
13668
+ )
13669
+
13670
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
13671
+ if @api_client.config.debugging
13672
+ @api_client.config.logger.debug "API called: PlaidApi#session_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
13673
+ end
13674
+ return data, status_code, headers
13675
+ end
13676
+
13813
13677
  # Report whether you initiated an ACH transaction
13814
13678
  # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated.
13815
13679
  # @param signal_decision_report_request [SignalDecisionReportRequest]
@@ -14559,7 +14423,7 @@ module Plaid
14559
14423
  end
14560
14424
 
14561
14425
  # Fetch recurring transaction streams
14562
- # 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.
14426
+ # 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.
14563
14427
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
14564
14428
  # @param [Hash] opts the optional parameters
14565
14429
  # @return [TransactionsRecurringGetResponse]
@@ -14569,7 +14433,7 @@ module Plaid
14569
14433
  end
14570
14434
 
14571
14435
  # Fetch recurring transaction streams
14572
- # 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.
14436
+ # 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.
14573
14437
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
14574
14438
  # @param [Hash] opts the optional parameters
14575
14439
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -14899,7 +14763,7 @@ module Plaid
14899
14763
  end
14900
14764
 
14901
14765
  # Get incremental transaction updates on an Item
14902
- # 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.
14766
+ # 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.
14903
14767
  # @param transactions_sync_request [TransactionsSyncRequest]
14904
14768
  # @param [Hash] opts the optional parameters
14905
14769
  # @return [TransactionsSyncResponse]
@@ -14909,7 +14773,7 @@ module Plaid
14909
14773
  end
14910
14774
 
14911
14775
  # Get incremental transaction updates on an Item
14912
- # 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.
14776
+ # 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.
14913
14777
  # @param transactions_sync_request [TransactionsSyncRequest]
14914
14778
  # @param [Hash] opts the optional parameters
14915
14779
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -15103,7 +14967,7 @@ module Plaid
15103
14967
  end
15104
14968
 
15105
14969
  # Create a transfer authorization
15106
- # 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.
14970
+ # 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.
15107
14971
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
15108
14972
  # @param [Hash] opts the optional parameters
15109
14973
  # @return [TransferAuthorizationCreateResponse]
@@ -15113,7 +14977,7 @@ module Plaid
15113
14977
  end
15114
14978
 
15115
14979
  # Create a transfer authorization
15116
- # 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.
14980
+ # 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.
15117
14981
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
15118
14982
  # @param [Hash] opts the optional parameters
15119
14983
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -16530,6 +16394,74 @@ module Plaid
16530
16394
  return data, status_code, headers
16531
16395
  end
16532
16396
 
16397
+ # Create a new funding account for an originator
16398
+ # Use the `/transfer/originator/funding_account/create` endpoint to create a new funding account for the originator.
16399
+ # @param transfer_originator_funding_account_create_request [TransferOriginatorFundingAccountCreateRequest]
16400
+ # @param [Hash] opts the optional parameters
16401
+ # @return [TransferOriginatorFundingAccountCreateResponse]
16402
+ def transfer_originator_funding_account_create(transfer_originator_funding_account_create_request, opts = {})
16403
+ data, _status_code, _headers = transfer_originator_funding_account_create_with_http_info(transfer_originator_funding_account_create_request, opts)
16404
+ data
16405
+ end
16406
+
16407
+ # Create a new funding account for an originator
16408
+ # Use the &#x60;/transfer/originator/funding_account/create&#x60; endpoint to create a new funding account for the originator.
16409
+ # @param transfer_originator_funding_account_create_request [TransferOriginatorFundingAccountCreateRequest]
16410
+ # @param [Hash] opts the optional parameters
16411
+ # @return [Array<(TransferOriginatorFundingAccountCreateResponse, Integer, Hash)>] TransferOriginatorFundingAccountCreateResponse data, response status code and response headers
16412
+ def transfer_originator_funding_account_create_with_http_info(transfer_originator_funding_account_create_request, opts = {})
16413
+ if @api_client.config.debugging
16414
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_funding_account_create ...'
16415
+ end
16416
+ # verify the required parameter 'transfer_originator_funding_account_create_request' is set
16417
+ if @api_client.config.client_side_validation && transfer_originator_funding_account_create_request.nil?
16418
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_funding_account_create_request' when calling PlaidApi.transfer_originator_funding_account_create"
16419
+ end
16420
+ # resource path
16421
+ local_var_path = '/transfer/originator/funding_account/create'
16422
+
16423
+ # query parameters
16424
+ query_params = opts[:query_params] || {}
16425
+
16426
+ # header parameters
16427
+ header_params = opts[:header_params] || {}
16428
+ # HTTP header 'Accept' (if needed)
16429
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
16430
+ # HTTP header 'Content-Type'
16431
+ content_type = @api_client.select_header_content_type(['application/json'])
16432
+ if !content_type.nil?
16433
+ header_params['Content-Type'] = content_type
16434
+ end
16435
+
16436
+ # form parameters
16437
+ form_params = opts[:form_params] || {}
16438
+
16439
+ # http body (model)
16440
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_funding_account_create_request)
16441
+
16442
+ # return_type
16443
+ return_type = opts[:debug_return_type] || 'TransferOriginatorFundingAccountCreateResponse'
16444
+
16445
+ # auth_names
16446
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
16447
+
16448
+ new_options = opts.merge(
16449
+ :operation => :"PlaidApi.transfer_originator_funding_account_create",
16450
+ :header_params => header_params,
16451
+ :query_params => query_params,
16452
+ :form_params => form_params,
16453
+ :body => post_body,
16454
+ :auth_names => auth_names,
16455
+ :return_type => return_type
16456
+ )
16457
+
16458
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
16459
+ if @api_client.config.debugging
16460
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_funding_account_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
16461
+ end
16462
+ return data, status_code, headers
16463
+ end
16464
+
16533
16465
  # Update the funding account associated with the originator
16534
16466
  # Use the `/transfer/originator/funding_account/update` endpoint to update the funding account associated with the originator.
16535
16467
  # @param transfer_originator_funding_account_update_request [TransferOriginatorFundingAccountUpdateRequest]
@@ -17959,7 +17891,7 @@ module Plaid
17959
17891
  end
17960
17892
 
17961
17893
  # Remove user
17962
- # `/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.
17894
+ # `/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.
17963
17895
  # @param user_remove_request [UserRemoveRequest]
17964
17896
  # @param [Hash] opts the optional parameters
17965
17897
  # @return [UserRemoveResponse]
@@ -17969,7 +17901,7 @@ module Plaid
17969
17901
  end
17970
17902
 
17971
17903
  # Remove user
17972
- # &#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.
17904
+ # &#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.
17973
17905
  # @param user_remove_request [UserRemoveRequest]
17974
17906
  # @param [Hash] opts the optional parameters
17975
17907
  # @return [Array<(UserRemoveResponse, Integer, Hash)>] UserRemoveResponse data, response status code and response headers
@@ -18095,7 +18027,7 @@ module Plaid
18095
18027
  end
18096
18028
 
18097
18029
  # Remove a third-party user token
18098
- # 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.
18030
+ # 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.
18099
18031
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
18100
18032
  # @param [Hash] opts the optional parameters
18101
18033
  # @return [UserThirdPartyTokenRemoveResponse]
@@ -18105,7 +18037,7 @@ module Plaid
18105
18037
  end
18106
18038
 
18107
18039
  # Remove a third-party user token
18108
- # 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.
18040
+ # 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.
18109
18041
  # @param user_third_party_token_remove_request [UserThirdPartyTokenRemoveRequest]
18110
18042
  # @param [Hash] opts the optional parameters
18111
18043
  # @return [Array<(UserThirdPartyTokenRemoveResponse, Integer, Hash)>] UserThirdPartyTokenRemoveResponse data, response status code and response headers