plaid 34.0.0 → 35.1.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 (1732) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +147 -0
  3. data/Dockerfile +1 -1
  4. data/Gemfile.lock +9 -9
  5. data/Makefile +1 -1
  6. data/README.md +1 -1
  7. data/lib/plaid/api/plaid_api.rb +471 -267
  8. data/lib/plaid/api_client.rb +2 -2
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +1 -1
  11. data/lib/plaid/models/account_access.rb +1 -1
  12. data/lib/plaid/models/account_assets.rb +1 -1
  13. data/lib/plaid/models/account_balance.rb +2 -2
  14. data/lib/plaid/models/account_base.rb +2 -2
  15. data/lib/plaid/models/account_filter.rb +1 -1
  16. data/lib/plaid/models/account_filters_response.rb +1 -1
  17. data/lib/plaid/models/account_holder_category.rb +1 -1
  18. data/lib/plaid/models/account_identity.rb +2 -2
  19. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  20. data/lib/plaid/models/account_identity_document_upload.rb +2 -2
  21. data/lib/plaid/models/account_identity_document_upload_all_of.rb +1 -1
  22. data/lib/plaid/models/account_identity_match_score.rb +2 -2
  23. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  24. data/lib/plaid/models/account_product_access.rb +1 -1
  25. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  26. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  27. data/lib/plaid/models/account_subtype.rb +1 -1
  28. data/lib/plaid/models/account_type.rb +1 -1
  29. data/lib/plaid/models/account_verification_insights.rb +1 -1
  30. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  31. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  32. data/lib/plaid/models/account_verification_insights_previous_returns.rb +1 -1
  33. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  34. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  35. data/lib/plaid/models/accounts_balance_get_request_payment_details.rb +1 -1
  36. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +1 -1
  37. data/lib/plaid/models/accounts_get_request.rb +1 -1
  38. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  39. data/lib/plaid/models/accounts_get_response.rb +1 -1
  40. data/lib/plaid/models/ach_class.rb +1 -1
  41. data/lib/plaid/models/action_state.rb +1 -1
  42. data/lib/plaid/models/activity.rb +1 -1
  43. data/lib/plaid/models/activity_type.rb +1 -1
  44. data/lib/plaid/models/address.rb +1 -1
  45. data/lib/plaid/models/address_data.rb +1 -1
  46. data/lib/plaid/models/address_data_not_required.rb +1 -1
  47. data/lib/plaid/models/address_data_nullable.rb +1 -1
  48. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  49. data/lib/plaid/models/address_match_score.rb +1 -1
  50. data/lib/plaid/models/address_nullable.rb +1 -1
  51. data/lib/plaid/models/address_purpose_label.rb +1 -1
  52. data/lib/plaid/models/application.rb +1 -1
  53. data/lib/plaid/models/application_get_request.rb +1 -1
  54. data/lib/plaid/models/application_get_response.rb +1 -1
  55. data/lib/plaid/models/apr.rb +1 -1
  56. data/lib/plaid/models/asset.rb +1 -1
  57. data/lib/plaid/models/asset_detail.rb +1 -1
  58. data/lib/plaid/models/asset_holder.rb +1 -1
  59. data/lib/plaid/models/asset_holder_name.rb +1 -1
  60. data/lib/plaid/models/asset_owner.rb +1 -1
  61. data/lib/plaid/models/asset_owners.rb +1 -1
  62. data/lib/plaid/models/asset_report.rb +1 -1
  63. data/lib/plaid/models/asset_report_account_balance.rb +1 -1
  64. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  65. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  67. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  69. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  70. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  72. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  73. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  74. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  75. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  76. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  78. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  80. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  81. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  82. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  83. data/lib/plaid/models/asset_report_investments.rb +1 -1
  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 +1 -1
  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 +1 -1
  159. data/lib/plaid/models/base_report_account.rb +2 -2
  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 +32 -2
  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_warning.rb +1 -1
  173. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  174. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  175. data/lib/plaid/models/beacon_account_risk_attributes.rb +1 -1
  176. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  177. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +1 -1
  178. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  179. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +1 -1
  180. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  181. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  182. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  183. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  184. data/lib/plaid/models/beacon_bank_account_insights.rb +1 -1
  185. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  186. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  187. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  188. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  189. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  190. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  191. data/lib/plaid/models/beacon_report.rb +1 -1
  192. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  193. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  194. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  195. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  196. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  197. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  198. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  199. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  200. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  201. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  202. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  203. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  204. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  205. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  206. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  207. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  208. data/lib/plaid/models/beacon_report_type.rb +1 -1
  209. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  210. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +1 -1
  211. data/lib/plaid/models/beacon_user.rb +1 -1
  212. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +1 -1
  213. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +1 -1
  214. data/lib/plaid/models/beacon_user_address.rb +1 -1
  215. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  216. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  217. data/lib/plaid/models/beacon_user_data.rb +1 -1
  218. data/lib/plaid/models/beacon_user_depository_account.rb +1 -1
  219. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  220. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  221. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  222. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  223. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  224. data/lib/plaid/models/beacon_user_name.rb +1 -1
  225. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  226. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  227. data/lib/plaid/models/beacon_user_request_address_nullable.rb +1 -1
  228. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  229. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  230. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  231. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  232. data/lib/plaid/models/beacon_user_status.rb +1 -1
  233. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  234. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  235. data/lib/plaid/models/beacon_user_update_request_data.rb +1 -1
  236. data/lib/plaid/models/beacon_user_update_response.rb +1 -1
  237. data/lib/plaid/models/cashflow_attributes_version.rb +1 -1
  238. data/lib/plaid/models/categories_get_response.rb +1 -1
  239. data/lib/plaid/models/category.rb +1 -1
  240. data/lib/plaid/models/category_insight_details.rb +1 -1
  241. data/lib/plaid/models/category_insights.rb +1 -1
  242. data/lib/plaid/models/cause.rb +2 -2
  243. data/lib/plaid/models/cause_all_of.rb +1 -1
  244. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  245. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  246. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  247. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  248. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  249. data/lib/plaid/models/connected_application.rb +1 -1
  250. data/lib/plaid/models/consent_event.rb +1 -1
  251. data/lib/plaid/models/consent_event_code.rb +1 -1
  252. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  253. data/lib/plaid/models/consent_event_type.rb +1 -1
  254. data/lib/plaid/models/consent_events_get_request.rb +1 -1
  255. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  256. data/lib/plaid/models/consented_account.rb +1 -1
  257. data/lib/plaid/models/consumer_dispute.rb +2 -2
  258. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  259. data/lib/plaid/models/consumer_report_pdf_get_request.rb +1 -1
  260. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  261. data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
  262. data/lib/plaid/models/counterparty.rb +1 -1
  263. data/lib/plaid/models/counterparty_insights.rb +1 -1
  264. data/lib/plaid/models/counterparty_type.rb +1 -1
  265. data/lib/plaid/models/country_code.rb +1 -1
  266. data/lib/plaid/models/cra_bank_income.rb +1 -1
  267. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  268. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  269. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  270. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  271. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  272. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  273. data/lib/plaid/models/cra_bank_income_create_request.rb +1 -1
  274. data/lib/plaid/models/cra_bank_income_create_response.rb +1 -1
  275. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  276. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  277. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  278. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  279. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  280. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  281. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  282. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  283. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  284. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  285. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  286. data/lib/plaid/models/cra_base_report_create_response.rb +1 -1
  287. data/lib/plaid/models/cra_cashflow_insights_report.rb +1 -1
  288. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +1 -1
  289. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +1 -1
  290. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +1 -1
  291. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +261 -0
  292. data/lib/plaid/models/{link_profile_eligibility_check_response.rb → cra_check_report_cashflow_insights_get_response.rb} +15 -16
  293. data/lib/plaid/models/{link_profile_eligibility_check_user.rb → cra_check_report_create_base_report_options.rb} +14 -18
  294. data/lib/plaid/models/cra_check_report_create_request.rb +62 -2
  295. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  296. data/lib/plaid/models/cra_check_report_failed_webhook.rb +1 -1
  297. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +1 -1
  298. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  299. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +1 -1
  300. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +1 -1
  301. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +1 -1
  302. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +1 -1
  303. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +1 -1
  304. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +1 -1
  305. data/lib/plaid/models/cra_check_report_ready_webhook.rb +1 -1
  306. data/lib/plaid/models/cra_income_insights.rb +1 -1
  307. data/lib/plaid/models/cra_loan_application.rb +1 -1
  308. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  309. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  310. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  311. data/lib/plaid/models/cra_loan_payment_history.rb +1 -1
  312. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  313. data/lib/plaid/models/cra_loan_register.rb +1 -1
  314. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  315. data/lib/plaid/models/cra_loan_status.rb +1 -1
  316. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  317. data/lib/plaid/models/cra_loan_type.rb +1 -1
  318. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  319. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  320. data/lib/plaid/models/cra_loan_update.rb +1 -1
  321. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  322. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  323. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  324. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  325. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  326. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  327. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  328. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +1 -1
  329. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +17 -2
  330. data/lib/plaid/models/cra_monitoring_insights_item.rb +1 -1
  331. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +1 -1
  332. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +1 -1
  333. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  334. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +1 -1
  335. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  336. data/lib/plaid/models/cra_network_insights_report.rb +1 -1
  337. data/lib/plaid/models/cra_partner_insights.rb +1 -1
  338. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  339. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  340. data/lib/plaid/models/cra_partner_insights_get_request.rb +1 -1
  341. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  342. data/lib/plaid/models/cra_partner_insights_item.rb +1 -1
  343. data/lib/plaid/models/cra_partner_insights_item_account.rb +1 -1
  344. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  345. data/lib/plaid/models/cra_partner_insights_prism.rb +1 -1
  346. data/lib/plaid/models/cra_pdf_add_ons.rb +1 -1
  347. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  348. data/lib/plaid/models/{base_reports_product_ready_webhook.rb → cra_upgrade_failed_webhook.rb} +26 -9
  349. data/lib/plaid/models/credit1099.rb +1 -1
  350. data/lib/plaid/models/credit1099_filer.rb +1 -1
  351. data/lib/plaid/models/credit1099_payer.rb +1 -1
  352. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  353. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  354. data/lib/plaid/models/credit_ach_class.rb +1 -1
  355. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  356. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  357. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  358. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  359. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  360. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  361. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  362. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  363. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  364. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  365. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  366. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  367. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  368. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  369. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  370. data/lib/plaid/models/credit_bank_income.rb +1 -1
  371. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  372. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  373. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  374. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  375. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  376. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  377. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  378. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  379. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  380. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  381. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  382. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  383. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  384. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  385. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  386. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  387. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  388. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  389. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  390. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  391. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  392. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  393. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  394. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  395. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  396. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  397. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  398. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  399. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  400. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  401. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  402. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +1 -1
  403. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  404. data/lib/plaid/models/credit_card_liability.rb +1 -1
  405. data/lib/plaid/models/credit_category.rb +1 -1
  406. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  407. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  408. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  409. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  410. data/lib/plaid/models/credit_employment_item.rb +1 -1
  411. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  412. data/lib/plaid/models/credit_filter.rb +1 -1
  413. data/lib/plaid/models/credit_freddie_mac_asset.rb +1 -1
  414. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  415. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  416. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  417. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  418. data/lib/plaid/models/credit_freddie_mac_loan.rb +1 -1
  419. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  420. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  421. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  422. data/lib/plaid/models/credit_freddie_mac_party.rb +1 -1
  423. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  424. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +1 -1
  425. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  426. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  427. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  428. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  429. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  430. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  431. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  432. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  433. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  434. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  435. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  436. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  437. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  438. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  439. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  440. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  441. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +1 -1
  442. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  443. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +1 -1
  444. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +1 -1
  445. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  446. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  447. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  448. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  449. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  450. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  451. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  452. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  453. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  454. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  455. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  456. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  457. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  458. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  459. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  460. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  461. data/lib/plaid/models/credit_session.rb +1 -1
  462. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  463. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  464. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  465. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  466. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  467. data/lib/plaid/models/credit_session_error.rb +1 -1
  468. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  469. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  470. data/lib/plaid/models/credit_session_results.rb +1 -1
  471. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  472. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  473. data/lib/plaid/models/credit_w2.rb +1 -1
  474. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  475. data/lib/plaid/models/dashboard_user.rb +1 -1
  476. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  477. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  478. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  479. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  480. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  481. data/lib/plaid/models/data_sources.rb +1 -1
  482. data/lib/plaid/models/date_range.rb +1 -1
  483. data/lib/plaid/models/deductions.rb +1 -1
  484. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  485. data/lib/plaid/models/deductions_total.rb +1 -1
  486. data/lib/plaid/models/default_update_webhook.rb +1 -1
  487. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  488. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  489. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  490. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  491. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  492. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  493. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  494. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  495. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  496. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  497. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  498. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  499. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  500. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  501. data/lib/plaid/models/depository_filter.rb +1 -1
  502. data/lib/plaid/models/detailed_originator.rb +1 -1
  503. data/lib/plaid/models/detected_account.rb +1 -1
  504. data/lib/plaid/models/device_id.rb +1 -1
  505. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  506. data/lib/plaid/models/doc_type.rb +1 -1
  507. data/lib/plaid/models/document_analysis.rb +26 -6
  508. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  509. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  510. data/lib/plaid/models/document_metadata.rb +1 -1
  511. data/lib/plaid/models/document_name_match_code.rb +1 -1
  512. data/lib/plaid/models/document_risk_signal.rb +1 -1
  513. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  514. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  515. data/lib/plaid/models/document_risk_summary.rb +1 -1
  516. data/lib/plaid/models/document_status.rb +1 -1
  517. data/lib/plaid/models/documentary_verification.rb +1 -1
  518. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  519. data/lib/plaid/models/earnings.rb +1 -1
  520. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  521. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  522. data/lib/plaid/models/earnings_total.rb +1 -1
  523. data/lib/plaid/models/email.rb +1 -1
  524. data/lib/plaid/models/email_address_match_score.rb +1 -1
  525. data/lib/plaid/models/employee.rb +1 -1
  526. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  527. data/lib/plaid/models/employer.rb +1 -1
  528. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  529. data/lib/plaid/models/employer_verification.rb +1 -1
  530. data/lib/plaid/models/employers_search_request.rb +1 -1
  531. data/lib/plaid/models/employers_search_response.rb +1 -1
  532. data/lib/plaid/models/employment_details.rb +1 -1
  533. data/lib/plaid/models/employment_source_type.rb +1 -1
  534. data/lib/plaid/models/employment_verification.rb +1 -1
  535. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  536. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  537. data/lib/plaid/models/employment_verification_status.rb +1 -1
  538. data/lib/plaid/models/enhancements.rb +1 -1
  539. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  540. data/lib/plaid/models/enrichments.rb +1 -1
  541. data/lib/plaid/models/entity_document.rb +1 -1
  542. data/lib/plaid/models/entity_document_type.rb +1 -1
  543. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  544. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  545. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  546. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  547. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  548. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  549. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  550. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  551. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  552. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  553. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  554. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  555. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  556. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  557. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  558. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  559. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  560. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  561. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  562. data/lib/plaid/models/expiration_date.rb +1 -1
  563. data/lib/plaid/models/extended_recipient_metadata.rb +1 -1
  564. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +1 -1
  565. data/lib/plaid/models/external_payment_initiation_consent_options.rb +2 -2
  566. data/lib/plaid/models/external_payment_options.rb +1 -1
  567. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  568. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  569. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  570. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  571. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  572. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  573. data/lib/plaid/models/fdx_content_types.rb +1 -1
  574. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  575. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  576. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  577. data/lib/plaid/models/fdx_notification.rb +1 -1
  578. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  579. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  580. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  581. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  582. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  583. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  584. data/lib/plaid/models/fdx_party.rb +1 -1
  585. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  586. data/lib/plaid/models/fdx_party_type.rb +1 -1
  587. data/lib/plaid/models/fdx_recipient_metadata.rb +1 -1
  588. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  589. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  590. data/lib/plaid/models/fixed_income.rb +254 -0
  591. data/lib/plaid/models/forecasted_monthly_income.rb +1 -1
  592. data/lib/plaid/models/form1099_type.rb +1 -1
  593. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  594. data/lib/plaid/models/fraud_amount.rb +1 -1
  595. data/lib/plaid/models/fraud_analysis_details.rb +331 -0
  596. data/lib/plaid/models/fraud_check_outcome.rb +39 -0
  597. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +40 -0
  598. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  599. data/lib/plaid/models/get_recipient_response.rb +1 -1
  600. data/lib/plaid/models/get_recipients_response.rb +1 -1
  601. data/lib/plaid/models/health_incident.rb +1 -1
  602. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  603. data/lib/plaid/models/historical_annual_income.rb +1 -1
  604. data/lib/plaid/models/historical_balance.rb +1 -1
  605. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  606. data/lib/plaid/models/holding.rb +1 -1
  607. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  608. data/lib/plaid/models/holdings_override.rb +1 -1
  609. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  610. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +1 -1
  611. data/lib/plaid/models/id_number_type.rb +1 -1
  612. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  613. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  614. data/lib/plaid/models/identity_document_upload.rb +1 -1
  615. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  616. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  617. data/lib/plaid/models/identity_document_upload_risk_signal.rb +1 -1
  618. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  619. data/lib/plaid/models/identity_documents_uploads_get_request.rb +1 -1
  620. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  621. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  622. data/lib/plaid/models/identity_get_request.rb +1 -1
  623. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  624. data/lib/plaid/models/identity_get_response.rb +1 -1
  625. data/lib/plaid/models/identity_match_request.rb +1 -1
  626. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  627. data/lib/plaid/models/identity_match_response.rb +1 -1
  628. data/lib/plaid/models/identity_match_user.rb +1 -1
  629. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  630. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  631. data/lib/plaid/models/identity_update_types.rb +1 -1
  632. data/lib/plaid/models/identity_verification.rb +1 -1
  633. data/lib/plaid/models/identity_verification_autofill_address.rb +1 -1
  634. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  635. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  636. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  637. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  638. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  639. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  640. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  641. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  642. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  643. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  644. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  645. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  646. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  647. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  648. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  649. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  650. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  651. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  652. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  653. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  654. data/lib/plaid/models/identity_verification_status.rb +1 -1
  655. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  656. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  657. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  658. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  659. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  660. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  661. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  662. data/lib/plaid/models/image_quality.rb +1 -1
  663. data/lib/plaid/models/{profile_identity_address.rb → image_quality_details.rb} +61 -63
  664. data/lib/plaid/models/image_quality_outcome.rb +39 -0
  665. data/lib/plaid/models/incident_update.rb +1 -1
  666. data/lib/plaid/models/income_breakdown.rb +1 -1
  667. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  668. data/lib/plaid/models/income_override.rb +1 -1
  669. data/lib/plaid/models/income_sources_counts.rb +1 -1
  670. data/lib/plaid/models/income_summary.rb +1 -1
  671. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  672. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  673. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  674. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  675. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  676. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  677. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  678. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  679. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  680. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  681. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  682. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  683. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  684. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  685. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  686. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  687. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  688. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  689. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  690. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  691. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  692. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  693. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  694. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  695. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  696. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  697. data/lib/plaid/models/individual_name.rb +1 -1
  698. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  699. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  700. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  701. data/lib/plaid/models/inflow_model.rb +1 -1
  702. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  703. data/lib/plaid/models/institution.rb +1 -1
  704. data/lib/plaid/models/institution_status.rb +1 -1
  705. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  706. data/lib/plaid/models/institution_supported_networks.rb +20 -6
  707. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  708. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  709. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  710. data/lib/plaid/models/institutions_get_request.rb +1 -1
  711. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  712. data/lib/plaid/models/institutions_get_response.rb +1 -1
  713. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  714. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  715. data/lib/plaid/models/institutions_search_request.rb +1 -1
  716. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  717. data/lib/plaid/models/institutions_search_response.rb +1 -1
  718. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  719. data/lib/plaid/models/investment_filter.rb +1 -1
  720. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  721. data/lib/plaid/models/investment_transaction.rb +1 -1
  722. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  723. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  724. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  725. data/lib/plaid/models/investments_auth_get_numbers.rb +16 -5
  726. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  727. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  728. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  729. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  730. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  731. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  732. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  733. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  734. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  735. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  736. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  737. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  738. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  739. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  740. data/lib/plaid/models/iso_currency_code.rb +1 -1
  741. data/lib/plaid/models/issue.rb +1 -1
  742. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  743. data/lib/plaid/models/issues_get_request.rb +1 -1
  744. data/lib/plaid/models/issues_get_response.rb +1 -1
  745. data/lib/plaid/models/issues_search_request.rb +1 -1
  746. data/lib/plaid/models/issues_search_response.rb +1 -1
  747. data/lib/plaid/models/issues_status.rb +1 -1
  748. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  749. data/lib/plaid/models/issues_subscribe_response.rb +1 -1
  750. data/lib/plaid/models/issuing_country.rb +1 -1
  751. data/lib/plaid/models/item.rb +25 -4
  752. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  753. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  754. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  755. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  756. data/lib/plaid/models/item_add_result_webhook.rb +1 -1
  757. data/lib/plaid/models/item_application_list_request.rb +1 -1
  758. data/lib/plaid/models/item_application_list_response.rb +1 -1
  759. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  760. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  761. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  762. data/lib/plaid/models/item_application_unlink_request.rb +1 -1
  763. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  764. data/lib/plaid/models/item_auth_method.rb +46 -0
  765. data/lib/plaid/models/item_consented_data_scope.rb +1 -1
  766. data/lib/plaid/models/item_create_authentication.rb +1 -1
  767. data/lib/plaid/models/item_error_webhook.rb +1 -1
  768. data/lib/plaid/models/item_get_request.rb +1 -1
  769. data/lib/plaid/models/item_get_response.rb +1 -1
  770. data/lib/plaid/models/item_import_request.rb +1 -1
  771. data/lib/plaid/models/item_import_request_options.rb +1 -1
  772. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  773. data/lib/plaid/models/item_import_response.rb +1 -1
  774. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  775. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  776. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  777. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  778. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  779. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  780. data/lib/plaid/models/item_remove_request.rb +1 -1
  781. data/lib/plaid/models/item_remove_response.rb +1 -1
  782. data/lib/plaid/models/item_status.rb +1 -1
  783. data/lib/plaid/models/item_status_investments.rb +1 -1
  784. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  785. data/lib/plaid/models/item_status_nullable.rb +1 -1
  786. data/lib/plaid/models/item_status_transactions.rb +1 -1
  787. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  788. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  789. data/lib/plaid/models/item_with_consent_fields.rb +25 -4
  790. data/lib/plaid/models/item_with_consent_fields_all_of.rb +1 -1
  791. data/lib/plaid/models/jwk_public_key.rb +1 -1
  792. data/lib/plaid/models/jwt_header.rb +1 -1
  793. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  794. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  795. data/lib/plaid/models/kyc_check_details.rb +1 -1
  796. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  797. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  798. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  799. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  800. data/lib/plaid/models/last_data_access_times.rb +1 -1
  801. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  802. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  803. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  804. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  805. data/lib/plaid/models/liabilities_object.rb +1 -1
  806. data/lib/plaid/models/liability_override.rb +1 -1
  807. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  808. data/lib/plaid/models/link_delivery_account.rb +1 -1
  809. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  810. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  811. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  812. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  813. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  814. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  815. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  816. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  817. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  818. data/lib/plaid/models/link_delivery_options.rb +1 -1
  819. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  820. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  821. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  822. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  823. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  824. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  825. data/lib/plaid/models/link_event.rb +1 -1
  826. data/lib/plaid/models/link_event_metadata.rb +2 -2
  827. data/lib/plaid/models/link_event_name.rb +1 -1
  828. data/lib/plaid/models/link_events_webhook.rb +1 -1
  829. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  830. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  831. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  832. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  833. data/lib/plaid/models/{profile_item.rb → link_session_cra_document_upload_result.rb} +18 -23
  834. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  835. data/lib/plaid/models/link_session_exit.rb +1 -1
  836. data/lib/plaid/models/link_session_exit_deprecated.rb +1 -1
  837. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  838. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  839. data/lib/plaid/models/link_session_finished_webhook.rb +2 -2
  840. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  841. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  842. data/lib/plaid/models/link_session_results.rb +16 -6
  843. data/lib/plaid/models/link_session_success.rb +1 -1
  844. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  845. data/lib/plaid/models/link_session_success_metadata_account.rb +2 -2
  846. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  847. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  848. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  849. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  850. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  851. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  852. data/lib/plaid/models/link_token_create_hosted_link.rb +1 -1
  853. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  854. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  855. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  856. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  857. data/lib/plaid/models/link_token_create_request.rb +1 -1
  858. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  859. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  860. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  861. data/lib/plaid/models/link_token_create_request_cra_options.rb +1 -1
  862. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +1 -1
  863. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +1 -1
  864. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +1 -1
  865. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +1 -1
  866. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  867. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  868. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  869. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  870. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  871. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  872. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  873. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  874. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  875. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  876. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  877. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  878. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  879. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  880. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  881. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  882. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  883. data/lib/plaid/models/link_token_create_response.rb +1 -1
  884. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  885. data/lib/plaid/models/link_token_get_metadata_response.rb +6 -16
  886. data/lib/plaid/models/link_token_get_request.rb +1 -1
  887. data/lib/plaid/models/link_token_get_response.rb +1 -1
  888. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  889. data/lib/plaid/models/link_token_investments.rb +1 -1
  890. data/lib/plaid/models/link_token_investments_auth.rb +19 -6
  891. data/lib/plaid/models/link_token_transactions.rb +1 -1
  892. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  893. data/lib/plaid/models/loan.rb +1 -1
  894. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  895. data/lib/plaid/models/loan_filter.rb +1 -1
  896. data/lib/plaid/models/loan_identifier.rb +1 -1
  897. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  898. data/lib/plaid/models/loan_identifiers.rb +1 -1
  899. data/lib/plaid/models/loan_payments_counts.rb +1 -1
  900. data/lib/plaid/models/loan_payments_merchant_counts.rb +1 -1
  901. data/lib/plaid/models/loans.rb +1 -1
  902. data/lib/plaid/models/location.rb +1 -1
  903. data/lib/plaid/models/match_summary.rb +1 -1
  904. data/lib/plaid/models/match_summary_code.rb +1 -1
  905. data/lib/plaid/models/merchant_insights.rb +1 -1
  906. data/lib/plaid/models/meta.rb +1 -1
  907. data/lib/plaid/models/mfa.rb +1 -1
  908. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  909. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  910. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  911. data/lib/plaid/models/monitoring_insights.rb +1 -1
  912. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  913. data/lib/plaid/models/monitoring_insights_status.rb +1 -1
  914. data/lib/plaid/models/monitoring_insights_webhook.rb +2 -2
  915. data/lib/plaid/models/monitoring_item_status_code.rb +1 -1
  916. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  917. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  918. data/lib/plaid/models/mortgage_liability.rb +2 -6
  919. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  920. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  921. data/lib/plaid/models/name_match_score.rb +1 -1
  922. data/lib/plaid/models/net_pay.rb +1 -1
  923. data/lib/plaid/models/network_insights_item.rb +1 -1
  924. data/lib/plaid/models/network_insights_report.rb +1 -1
  925. data/lib/plaid/models/network_insights_report_get_request.rb +1 -1
  926. data/lib/plaid/models/network_insights_report_get_response.rb +1 -1
  927. data/lib/plaid/models/{link_profile_eligibility_check_request.rb → network_status_get_request.rb} +19 -24
  928. data/lib/plaid/models/{cra_base_report_get_response.rb → network_status_get_response.rb} +44 -29
  929. data/lib/plaid/models/{profile_identity_name.rb → network_status_get_response_layer.rb} +18 -21
  930. data/lib/plaid/models/{profile_network_status_get_network_status.rb → network_status_get_response_network_status.rb} +2 -2
  931. data/lib/plaid/models/{profile_network_status_get_user.rb → network_status_get_user.rb} +6 -6
  932. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  933. data/lib/plaid/models/numbers.rb +1 -1
  934. data/lib/plaid/models/numbers_acats.rb +1 -1
  935. data/lib/plaid/models/numbers_ach.rb +13 -3
  936. data/lib/plaid/models/numbers_ach_nullable.rb +13 -3
  937. data/lib/plaid/models/numbers_aton.rb +1 -1
  938. data/lib/plaid/models/numbers_bacs.rb +1 -1
  939. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  940. data/lib/plaid/models/numbers_eft.rb +1 -1
  941. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  942. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  943. data/lib/plaid/models/numbers_international.rb +1 -1
  944. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  945. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  946. data/lib/plaid/models/numbers_retirement401k.rb +246 -0
  947. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  948. data/lib/plaid/models/option_contract.rb +1 -1
  949. data/lib/plaid/models/originator.rb +1 -1
  950. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  951. data/lib/plaid/models/other_account_subtype.rb +1 -1
  952. data/lib/plaid/models/other_filter.rb +1 -1
  953. data/lib/plaid/models/override_account_type.rb +1 -1
  954. data/lib/plaid/models/override_accounts.rb +1 -1
  955. data/lib/plaid/models/owner.rb +1 -1
  956. data/lib/plaid/models/owner_override.rb +1 -1
  957. data/lib/plaid/models/ownership_type.rb +1 -1
  958. data/lib/plaid/models/parties.rb +1 -1
  959. data/lib/plaid/models/partner_customer_create_request.rb +2 -2
  960. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  961. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  962. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  963. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  964. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  965. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  966. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  967. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  968. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  969. data/lib/plaid/models/partner_end_customer.rb +1 -1
  970. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  971. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  972. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  973. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  974. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  975. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  976. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  977. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  978. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  979. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  980. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  981. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  982. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  983. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  984. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  985. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  986. data/lib/plaid/models/party.rb +1 -1
  987. data/lib/plaid/models/party_individual.rb +1 -1
  988. data/lib/plaid/models/party_role_type.rb +1 -1
  989. data/lib/plaid/models/pay.rb +1 -1
  990. data/lib/plaid/models/pay_frequency.rb +1 -1
  991. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  992. data/lib/plaid/models/pay_period_details.rb +1 -1
  993. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  994. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  995. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  996. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  997. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  998. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  999. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  1000. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1001. data/lib/plaid/models/payment_amount.rb +1 -1
  1002. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1003. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1004. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1005. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1006. data/lib/plaid/models/payment_channel.rb +1 -1
  1007. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1008. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1009. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1010. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1011. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1012. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1013. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1014. data/lib/plaid/models/payment_initiation_consent.rb +15 -10
  1015. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1016. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  1017. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1018. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1019. data/lib/plaid/models/payment_initiation_consent_get_response.rb +12 -7
  1020. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1021. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +1 -1
  1022. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  1023. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  1024. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1025. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1026. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  1027. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1028. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1029. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +345 -0
  1030. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1031. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  1032. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1033. data/lib/plaid/models/payment_initiation_payment.rb +17 -6
  1034. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  1035. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1036. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1037. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1038. data/lib/plaid/models/payment_initiation_payment_get_response.rb +13 -2
  1039. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1040. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1041. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  1042. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  1043. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1044. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1045. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  1046. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1047. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  1048. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  1049. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1050. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1051. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1052. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  1053. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  1054. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  1055. data/lib/plaid/models/payment_meta.rb +1 -1
  1056. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1057. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1058. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1059. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1060. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1061. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1062. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1063. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1064. data/lib/plaid/models/payment_scheme.rb +1 -1
  1065. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  1066. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1067. data/lib/plaid/models/payroll_income_object.rb +1 -1
  1068. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1069. data/lib/plaid/models/payroll_item.rb +1 -1
  1070. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1071. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1072. data/lib/plaid/models/paystub.rb +1 -1
  1073. data/lib/plaid/models/paystub_address.rb +1 -1
  1074. data/lib/plaid/models/paystub_deduction.rb +1 -1
  1075. data/lib/plaid/models/paystub_details.rb +1 -1
  1076. data/lib/plaid/models/paystub_employer.rb +1 -1
  1077. data/lib/plaid/models/paystub_override.rb +1 -1
  1078. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1079. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1080. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1081. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1082. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1083. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +1 -1
  1084. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1085. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1086. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1087. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1088. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1089. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1090. data/lib/plaid/models/paystub_override_pay_period_details.rb +1 -1
  1091. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1092. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1093. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1094. data/lib/plaid/models/pending_disconnect_webhook.rb +1 -1
  1095. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1096. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  1097. data/lib/plaid/models/personal_finance_category.rb +1 -1
  1098. data/lib/plaid/models/phone_number.rb +1 -1
  1099. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1100. data/lib/plaid/models/phone_type.rb +1 -1
  1101. data/lib/plaid/models/physical_document_category.rb +1 -1
  1102. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  1103. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1104. data/lib/plaid/models/physical_document_images.rb +1 -1
  1105. data/lib/plaid/models/plaid_check_score.rb +1 -1
  1106. data/lib/plaid/models/plaid_error.rb +2 -2
  1107. data/lib/plaid/models/plaid_error_type.rb +1 -1
  1108. data/lib/plaid/models/platform_ids.rb +1 -1
  1109. data/lib/plaid/models/po_box_status.rb +1 -1
  1110. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1111. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1112. data/lib/plaid/models/prism_cash_score_version.rb +2 -1
  1113. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1114. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1115. data/lib/plaid/models/prism_insights.rb +1 -1
  1116. data/lib/plaid/models/prism_insights_version.rb +1 -1
  1117. data/lib/plaid/models/prism_product.rb +1 -1
  1118. data/lib/plaid/models/prism_versions.rb +1 -1
  1119. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1120. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1121. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  1122. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1123. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1124. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1125. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  1126. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1127. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  1128. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1129. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1130. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1131. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1132. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1133. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1134. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1135. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1136. data/lib/plaid/models/{profile_get_request.rb → processor_investments_holdings_get_request.rb} +22 -22
  1137. data/lib/plaid/models/processor_investments_holdings_get_response.rb +284 -0
  1138. data/lib/plaid/models/processor_investments_transactions_get_request.rb +285 -0
  1139. data/lib/plaid/models/processor_investments_transactions_get_response.rb +299 -0
  1140. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1141. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1142. data/lib/plaid/models/processor_number.rb +1 -1
  1143. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1144. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  1145. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1146. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  1147. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  1148. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1149. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1150. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  1151. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1152. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  1153. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  1154. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  1155. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  1156. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1157. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1158. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1159. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1160. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1161. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1162. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1163. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1164. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  1165. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1166. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1167. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1168. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  1169. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1170. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1171. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1172. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  1173. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  1174. data/lib/plaid/models/product_access.rb +1 -1
  1175. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1176. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1177. data/lib/plaid/models/product_status.rb +1 -1
  1178. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  1179. data/lib/plaid/models/products.rb +2 -1
  1180. data/lib/plaid/models/profile_network_status_get_request.rb +2 -2
  1181. data/lib/plaid/models/profile_network_status_get_response.rb +2 -2
  1182. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1183. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1184. data/lib/plaid/models/proxy_type.rb +1 -1
  1185. data/lib/plaid/models/pslf_status.rb +1 -1
  1186. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  1187. data/lib/plaid/models/recipient_bacs.rb +1 -1
  1188. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  1189. data/lib/plaid/models/recommendation_string.rb +40 -0
  1190. data/lib/plaid/models/recurrence.rb +1 -1
  1191. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  1192. data/lib/plaid/models/recurring_frequency.rb +1 -1
  1193. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1194. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  1195. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1196. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1197. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1198. data/lib/plaid/models/recurring_transfer.rb +1 -1
  1199. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  1200. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  1201. data/lib/plaid/models/removed_transaction.rb +1 -1
  1202. data/lib/plaid/models/report_type.rb +1 -1
  1203. data/lib/plaid/models/reporting_information.rb +1 -1
  1204. data/lib/plaid/models/risk_check_behavior.rb +14 -5
  1205. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1206. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1207. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1208. data/lib/plaid/models/risk_check_details.rb +16 -6
  1209. data/lib/plaid/models/risk_check_device.rb +27 -6
  1210. data/lib/plaid/models/risk_check_email.rb +26 -5
  1211. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1212. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1213. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1214. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1215. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1216. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1217. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1218. data/lib/plaid/models/risk_check_network.rb +264 -0
  1219. data/lib/plaid/models/risk_check_phone.rb +48 -5
  1220. data/lib/plaid/models/risk_check_stolen_identity.rb +36 -5
  1221. data/lib/plaid/models/risk_check_synthetic_identity.rb +56 -5
  1222. data/lib/plaid/models/risk_level.rb +40 -0
  1223. data/lib/plaid/models/risk_level_with_no_data.rb +41 -0
  1224. data/lib/plaid/models/risk_profile.rb +1 -1
  1225. data/lib/plaid/models/risk_reason.rb +1 -1
  1226. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1227. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1228. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1229. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1230. data/lib/plaid/models/role.rb +1 -1
  1231. data/lib/plaid/models/role_detail.rb +1 -1
  1232. data/lib/plaid/models/roles.rb +1 -1
  1233. data/lib/plaid/models/ruleset.rb +1 -1
  1234. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1235. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1236. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1237. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1238. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1239. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1240. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  1241. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1242. data/lib/plaid/models/{cra_base_report_get_request.rb → sandbox_cra_cashflow_updates_update_request.rb} +5 -5
  1243. data/lib/plaid/models/{profile_get_response.rb → sandbox_cra_cashflow_updates_update_response.rb} +6 -32
  1244. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  1245. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1246. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +1 -1
  1247. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  1248. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  1249. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  1250. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1251. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  1252. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1253. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  1254. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1255. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1256. data/lib/plaid/models/sandbox_payment_simulate_request.rb +261 -0
  1257. data/lib/plaid/models/sandbox_payment_simulate_response.rb +276 -0
  1258. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1259. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  1260. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1261. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  1262. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1263. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  1264. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1265. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1266. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  1267. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1268. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1269. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1270. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  1271. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1272. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  1273. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1274. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  1275. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1276. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +1 -1
  1277. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1278. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  1279. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  1280. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  1281. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1282. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  1283. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1284. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  1285. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1286. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1287. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1288. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1289. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1290. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1291. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1292. data/lib/plaid/models/sandbox_user_reset_login_request.rb +1 -1
  1293. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1294. data/lib/plaid/models/scopes.rb +1 -1
  1295. data/lib/plaid/models/scopes_context.rb +1 -1
  1296. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1297. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1298. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1299. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1300. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1301. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1302. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1303. data/lib/plaid/models/security.rb +16 -6
  1304. data/lib/plaid/models/security_override.rb +1 -1
  1305. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1306. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1307. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1308. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1309. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1310. data/lib/plaid/models/selfie_capture.rb +1 -1
  1311. data/lib/plaid/models/selfie_check.rb +1 -1
  1312. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1313. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1314. data/lib/plaid/models/selfie_status.rb +1 -1
  1315. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1316. data/lib/plaid/models/service.rb +1 -1
  1317. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1318. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1319. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1320. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1321. data/lib/plaid/models/services.rb +1 -1
  1322. data/lib/plaid/models/signal_address_data.rb +1 -1
  1323. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1324. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1325. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1326. data/lib/plaid/models/signal_device.rb +1 -1
  1327. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1328. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1329. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1330. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1331. data/lib/plaid/models/signal_person_name.rb +1 -1
  1332. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1333. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1334. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1335. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1336. data/lib/plaid/models/signal_schedule_default_payment_method.rb +42 -0
  1337. data/lib/plaid/models/signal_schedule_recommendation.rb +263 -0
  1338. data/lib/plaid/models/{cra_base_report_create_request.rb → signal_schedule_request.rb} +72 -58
  1339. data/lib/plaid/models/signal_schedule_response.rb +271 -0
  1340. data/lib/plaid/models/signal_scores.rb +1 -1
  1341. data/lib/plaid/models/signal_user.rb +1 -1
  1342. data/lib/plaid/models/signal_warning.rb +1 -1
  1343. data/lib/plaid/models/simulated_transfer_sweep.rb +16 -6
  1344. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1345. data/lib/plaid/models/sms_verification.rb +1 -1
  1346. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1347. data/lib/plaid/models/source.rb +1 -1
  1348. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1349. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1350. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1351. data/lib/plaid/models/statements_account.rb +1 -1
  1352. data/lib/plaid/models/statements_download_request.rb +1 -1
  1353. data/lib/plaid/models/statements_list_request.rb +1 -1
  1354. data/lib/plaid/models/statements_list_response.rb +1 -1
  1355. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1356. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1357. data/lib/plaid/models/statements_refresh_request.rb +1 -1
  1358. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1359. data/lib/plaid/models/statements_statement.rb +1 -1
  1360. data/lib/plaid/models/status.rb +1 -1
  1361. data/lib/plaid/models/statuses.rb +1 -1
  1362. data/lib/plaid/models/strategy.rb +1 -1
  1363. data/lib/plaid/models/student_loan.rb +1 -1
  1364. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1365. data/lib/plaid/models/student_loan_status.rb +1 -1
  1366. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1367. data/lib/plaid/models/sweep_failure.rb +233 -0
  1368. data/lib/plaid/models/sweep_status.rb +1 -1
  1369. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1370. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1371. data/lib/plaid/models/synthetic_fraud.rb +247 -0
  1372. data/lib/plaid/models/taxform.rb +1 -1
  1373. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1374. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1375. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1376. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1377. data/lib/plaid/models/total.rb +1 -1
  1378. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1379. data/lib/plaid/models/total_inflow_amount.rb +1 -1
  1380. data/lib/plaid/models/total_inflow_amount30d.rb +1 -1
  1381. data/lib/plaid/models/total_inflow_amount60d.rb +1 -1
  1382. data/lib/plaid/models/total_inflow_amount90d.rb +1 -1
  1383. data/lib/plaid/models/total_monthly_income_insights.rb +1 -1
  1384. data/lib/plaid/models/total_outflow_amount.rb +1 -1
  1385. data/lib/plaid/models/total_outflow_amount30d.rb +1 -1
  1386. data/lib/plaid/models/total_outflow_amount60d.rb +1 -1
  1387. data/lib/plaid/models/total_outflow_amount90d.rb +1 -1
  1388. data/lib/plaid/models/transaction.rb +1 -1
  1389. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1390. data/lib/plaid/models/transaction_base.rb +1 -1
  1391. data/lib/plaid/models/transaction_code.rb +1 -1
  1392. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1393. data/lib/plaid/models/transaction_data.rb +1 -1
  1394. data/lib/plaid/models/transaction_override.rb +1 -1
  1395. data/lib/plaid/models/transaction_stream.rb +1 -1
  1396. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1397. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1398. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1399. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1400. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1401. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1402. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1403. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1404. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1405. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  1406. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1407. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1408. data/lib/plaid/models/transactions_recurring_create_request.rb +1 -1
  1409. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1410. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1411. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1412. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1413. data/lib/plaid/models/transactions_recurring_merge_input.rb +1 -1
  1414. data/lib/plaid/models/transactions_recurring_merge_request.rb +1 -1
  1415. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1416. data/lib/plaid/models/transactions_recurring_update_input.rb +1 -1
  1417. data/lib/plaid/models/transactions_recurring_update_request.rb +1 -1
  1418. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1419. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1420. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1421. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1422. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1423. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1424. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1425. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1426. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1427. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1428. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1429. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1430. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1431. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1432. data/lib/plaid/models/transactions_sync_request_options.rb +15 -5
  1433. data/lib/plaid/models/transactions_sync_response.rb +3 -3
  1434. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1435. data/lib/plaid/models/transactions_user_insights_get_request.rb +1 -1
  1436. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1437. data/lib/plaid/models/transfer.rb +1 -1
  1438. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1439. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1440. data/lib/plaid/models/transfer_authorization_cancel_request.rb +1 -1
  1441. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1442. data/lib/plaid/models/transfer_authorization_create_request.rb +17 -6
  1443. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1444. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1445. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1446. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1447. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1448. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1449. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1450. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1451. data/lib/plaid/models/transfer_authorization_payment_risk.rb +1 -1
  1452. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1453. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1454. data/lib/plaid/models/transfer_authorization_user_in_request.rb +2 -2
  1455. data/lib/plaid/models/transfer_balance.rb +1 -1
  1456. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1457. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1458. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1459. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1460. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1461. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1462. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1463. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +223 -0
  1464. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1465. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1466. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1467. data/lib/plaid/models/transfer_create_request.rb +1 -1
  1468. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1469. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1470. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1471. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1472. data/lib/plaid/models/transfer_device.rb +1 -1
  1473. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1474. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1475. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1476. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1477. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1478. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1479. data/lib/plaid/models/transfer_event.rb +1 -1
  1480. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1481. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1482. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1483. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1484. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1485. data/lib/plaid/models/transfer_event_type.rb +2 -1
  1486. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1487. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1488. data/lib/plaid/models/transfer_failure.rb +13 -2
  1489. data/lib/plaid/models/transfer_funding_account.rb +1 -1
  1490. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1491. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1492. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1493. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1494. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1495. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1496. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1497. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1498. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1499. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1500. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1501. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1502. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1503. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1504. data/lib/plaid/models/transfer_ledger_deposit_request.rb +2 -2
  1505. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1506. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  1507. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  1508. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1509. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1510. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1511. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +2 -2
  1512. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1513. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1514. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1515. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  1516. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1517. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1518. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  1519. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  1520. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1521. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1522. data/lib/plaid/models/transfer_network.rb +1 -1
  1523. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1524. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1525. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1526. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1527. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1528. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1529. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1530. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1531. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1532. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1533. data/lib/plaid/models/{profile_identity.rb → transfer_platform_onboarding_update_webhook.rb} +76 -69
  1534. data/lib/plaid/models/transfer_platform_originator_create_request.rb +15 -5
  1535. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  1536. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  1537. data/lib/plaid/models/transfer_platform_person_create_request.rb +1 -1
  1538. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  1539. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  1540. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  1541. data/lib/plaid/models/transfer_platform_requirement.rb +1 -1
  1542. data/lib/plaid/models/transfer_platform_requirement_submission.rb +1 -1
  1543. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +1 -1
  1544. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  1545. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  1546. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1547. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1548. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1549. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1550. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1551. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1552. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1553. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1554. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1555. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1556. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  1557. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1558. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1559. data/lib/plaid/models/transfer_refund.rb +1 -1
  1560. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1561. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1562. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1563. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1564. data/lib/plaid/models/transfer_refund_failure.rb +14 -3
  1565. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1566. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1567. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1568. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1569. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1570. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1571. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1572. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1573. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1574. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1575. data/lib/plaid/models/transfer_status.rb +1 -1
  1576. data/lib/plaid/models/transfer_sweep.rb +16 -6
  1577. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1578. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1579. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1580. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1581. data/lib/plaid/models/transfer_sweep_status.rb +2 -1
  1582. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1583. data/lib/plaid/models/transfer_type.rb +1 -1
  1584. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1585. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1586. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1587. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1588. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1589. data/lib/plaid/models/transfer_wire_details.rb +1 -1
  1590. data/lib/plaid/models/trusted_device_data.rb +1 -1
  1591. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1592. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1593. data/lib/plaid/models/user_account_identity.rb +1 -1
  1594. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  1595. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  1596. data/lib/plaid/models/user_account_item.rb +1 -1
  1597. data/lib/plaid/models/user_account_revoked_webhook.rb +3 -13
  1598. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  1599. data/lib/plaid/models/user_account_session_get_response.rb +1 -1
  1600. data/lib/plaid/models/user_address.rb +1 -1
  1601. data/lib/plaid/models/user_create_request.rb +1 -1
  1602. data/lib/plaid/models/user_create_response.rb +1 -1
  1603. data/lib/plaid/models/user_custom_password.rb +1 -1
  1604. data/lib/plaid/models/user_data_overview.rb +1 -1
  1605. data/lib/plaid/models/user_id_number.rb +1 -1
  1606. data/lib/plaid/models/user_items_get_request.rb +1 -1
  1607. data/lib/plaid/models/user_items_get_response.rb +1 -1
  1608. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1609. data/lib/plaid/models/user_remove_request.rb +1 -1
  1610. data/lib/plaid/models/user_remove_response.rb +1 -1
  1611. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1612. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1613. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1614. data/lib/plaid/models/user_third_party_token_create_request.rb +1 -1
  1615. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  1616. data/lib/plaid/models/user_third_party_token_remove_request.rb +1 -1
  1617. data/lib/plaid/models/user_third_party_token_remove_response.rb +1 -1
  1618. data/lib/plaid/models/user_update_request.rb +1 -1
  1619. data/lib/plaid/models/user_update_response.rb +1 -1
  1620. data/lib/plaid/models/validation_source.rb +1 -1
  1621. data/lib/plaid/models/validation_sources.rb +1 -1
  1622. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1623. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1624. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1625. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1626. data/lib/plaid/models/verification_status.rb +1 -1
  1627. data/lib/plaid/models/verify_sms_details.rb +1 -1
  1628. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  1629. data/lib/plaid/models/w2.rb +1 -1
  1630. data/lib/plaid/models/w2_box12.rb +1 -1
  1631. data/lib/plaid/models/w2_box12_override.rb +1 -1
  1632. data/lib/plaid/models/w2_override.rb +1 -1
  1633. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1634. data/lib/plaid/models/w2_state_and_local_wages_override.rb +1 -1
  1635. data/lib/plaid/models/wallet.rb +1 -1
  1636. data/lib/plaid/models/wallet_balance.rb +1 -1
  1637. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1638. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1639. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1640. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1641. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1642. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1643. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1644. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1645. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1646. data/lib/plaid/models/wallet_status.rb +1 -1
  1647. data/lib/plaid/models/wallet_transaction.rb +1 -1
  1648. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1649. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1650. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1651. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1652. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1653. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1654. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1655. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1656. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1657. data/lib/plaid/models/wallet_transaction_get_response.rb +1 -1
  1658. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1659. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1660. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1661. data/lib/plaid/models/wallet_transaction_relation.rb +1 -1
  1662. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1663. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1664. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1665. data/lib/plaid/models/warning.rb +1 -1
  1666. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1667. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1668. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1669. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1670. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1671. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1672. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1673. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1674. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1675. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1676. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1677. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1678. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1679. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1680. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1681. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1682. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1683. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1684. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1685. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1686. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1687. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1688. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1689. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1690. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1691. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1692. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1693. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1694. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1695. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1696. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1697. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1698. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1699. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1700. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1701. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1702. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1703. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1704. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1705. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1706. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1707. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1708. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1709. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1710. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1711. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1712. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1713. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1714. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1715. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1716. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1717. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1718. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1719. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1720. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1721. data/lib/plaid/models/webhook_type.rb +1 -1
  1722. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1723. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1724. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1725. data/lib/plaid/models/yield_rate.rb +258 -0
  1726. data/lib/plaid/models/yield_rate_type.rb +42 -0
  1727. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1728. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1729. data/lib/plaid/version.rb +2 -2
  1730. data/lib/plaid.rb +42 -16
  1731. data/plaid.gemspec +2 -2
  1732. metadata +48 -22
@@ -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.586.4
6
+ The version of the OpenAPI document: 2020-09-14_1.614.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.3.0
@@ -836,7 +836,7 @@ module Plaid
836
836
  end
837
837
 
838
838
  # Retrieve auth data
839
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
839
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking, savings, and cash management accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
840
840
  # @param auth_get_request [AuthGetRequest]
841
841
  # @param [Hash] opts the optional parameters
842
842
  # @return [AuthGetResponse]
@@ -846,7 +846,7 @@ module Plaid
846
846
  end
847
847
 
848
848
  # Retrieve auth data
849
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
849
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking, savings, and cash management accounts, along with high-level account data and balances when available. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
850
850
  # @param auth_get_request [AuthGetRequest]
851
851
  # @param [Hash] opts the optional parameters
852
852
  # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
@@ -2536,7 +2536,7 @@ module Plaid
2536
2536
  end
2537
2537
 
2538
2538
  # List a historical log of item consent events
2539
- # 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
2540
  # @param consent_events_get_request [ConsentEventsGetRequest]
2541
2541
  # @param [Hash] opts the optional parameters
2542
2542
  # @return [ConsentEventsGetResponse]
@@ -2546,7 +2546,7 @@ module Plaid
2546
2546
  end
2547
2547
 
2548
2548
  # List a historical log of item consent events
2549
- # 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
2550
  # @param consent_events_get_request [ConsentEventsGetRequest]
2551
2551
  # @param [Hash] opts the optional parameters
2552
2552
  # @return [Array<(ConsentEventsGetResponse, Integer, Hash)>] ConsentEventsGetResponse data, response status code and response headers
@@ -2807,99 +2807,31 @@ module Plaid
2807
2807
  return data, status_code, headers
2808
2808
  end
2809
2809
 
2810
- # Create a Base Report
2811
- # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
2812
- # @param cra_base_report_create_request [CraBaseReportCreateRequest]
2813
- # @param [Hash] opts the optional parameters
2814
- # @return [CraBaseReportCreateResponse]
2815
- def cra_base_report_create(cra_base_report_create_request, opts = {})
2816
- data, _status_code, _headers = cra_base_report_create_with_http_info(cra_base_report_create_request, opts)
2817
- data
2818
- end
2819
-
2820
- # Create a Base Report
2821
- # This endpoint allows the customer to create a Base Report by passing in a user token. The Base Report will be generated based on the most recently linked item from the user token.
2822
- # @param cra_base_report_create_request [CraBaseReportCreateRequest]
2823
- # @param [Hash] opts the optional parameters
2824
- # @return [Array<(CraBaseReportCreateResponse, Integer, Hash)>] CraBaseReportCreateResponse data, response status code and response headers
2825
- def cra_base_report_create_with_http_info(cra_base_report_create_request, opts = {})
2826
- if @api_client.config.debugging
2827
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_create ...'
2828
- end
2829
- # verify the required parameter 'cra_base_report_create_request' is set
2830
- if @api_client.config.client_side_validation && cra_base_report_create_request.nil?
2831
- fail ArgumentError, "Missing the required parameter 'cra_base_report_create_request' when calling PlaidApi.cra_base_report_create"
2832
- end
2833
- # resource path
2834
- local_var_path = '/cra/base_report/create'
2835
-
2836
- # query parameters
2837
- query_params = opts[:query_params] || {}
2838
-
2839
- # header parameters
2840
- header_params = opts[:header_params] || {}
2841
- # HTTP header 'Accept' (if needed)
2842
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2843
- # HTTP header 'Content-Type'
2844
- content_type = @api_client.select_header_content_type(['application/json'])
2845
- if !content_type.nil?
2846
- header_params['Content-Type'] = content_type
2847
- end
2848
-
2849
- # form parameters
2850
- form_params = opts[:form_params] || {}
2851
-
2852
- # http body (model)
2853
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_create_request)
2854
-
2855
- # return_type
2856
- return_type = opts[:debug_return_type] || 'CraBaseReportCreateResponse'
2857
-
2858
- # auth_names
2859
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2860
-
2861
- new_options = opts.merge(
2862
- :operation => :"PlaidApi.cra_base_report_create",
2863
- :header_params => header_params,
2864
- :query_params => query_params,
2865
- :form_params => form_params,
2866
- :body => post_body,
2867
- :auth_names => auth_names,
2868
- :return_type => return_type
2869
- )
2870
-
2871
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2872
- if @api_client.config.debugging
2873
- @api_client.config.logger.debug "API called: PlaidApi#cra_base_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2874
- end
2875
- return data, status_code, headers
2876
- end
2877
-
2878
2810
  # Retrieve a Base Report
2879
- # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/user/create`.
2880
- # @param cra_base_report_get_request [CraBaseReportGetRequest]
2811
+ # This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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 base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
2812
+ # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2881
2813
  # @param [Hash] opts the optional parameters
2882
- # @return [CraBaseReportGetResponse]
2883
- def cra_base_report_get(cra_base_report_get_request, opts = {})
2884
- data, _status_code, _headers = cra_base_report_get_with_http_info(cra_base_report_get_request, opts)
2814
+ # @return [CraCheckReportBaseReportGetResponse]
2815
+ def cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {})
2816
+ data, _status_code, _headers = cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts)
2885
2817
  data
2886
2818
  end
2887
2819
 
2888
2820
  # Retrieve a Base Report
2889
- # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the &#x60;user_token&#x60; created in &#x60;/user/create&#x60;.
2890
- # @param cra_base_report_get_request [CraBaseReportGetRequest]
2821
+ # This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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&#39;t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.
2822
+ # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2891
2823
  # @param [Hash] opts the optional parameters
2892
- # @return [Array<(CraBaseReportGetResponse, Integer, Hash)>] CraBaseReportGetResponse data, response status code and response headers
2893
- def cra_base_report_get_with_http_info(cra_base_report_get_request, opts = {})
2824
+ # @return [Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>] CraCheckReportBaseReportGetResponse data, response status code and response headers
2825
+ def cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {})
2894
2826
  if @api_client.config.debugging
2895
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_base_report_get ...'
2827
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_base_report_get ...'
2896
2828
  end
2897
- # verify the required parameter 'cra_base_report_get_request' is set
2898
- if @api_client.config.client_side_validation && cra_base_report_get_request.nil?
2899
- fail ArgumentError, "Missing the required parameter 'cra_base_report_get_request' when calling PlaidApi.cra_base_report_get"
2829
+ # verify the required parameter 'cra_check_report_base_report_get_request' is set
2830
+ if @api_client.config.client_side_validation && cra_check_report_base_report_get_request.nil?
2831
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_base_report_get_request' when calling PlaidApi.cra_check_report_base_report_get"
2900
2832
  end
2901
2833
  # resource path
2902
- local_var_path = '/cra/base_report/get'
2834
+ local_var_path = '/cra/check_report/base_report/get'
2903
2835
 
2904
2836
  # query parameters
2905
2837
  query_params = opts[:query_params] || {}
@@ -2918,16 +2850,16 @@ module Plaid
2918
2850
  form_params = opts[:form_params] || {}
2919
2851
 
2920
2852
  # http body (model)
2921
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_base_report_get_request)
2853
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_base_report_get_request)
2922
2854
 
2923
2855
  # return_type
2924
- return_type = opts[:debug_return_type] || 'CraBaseReportGetResponse'
2856
+ return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'
2925
2857
 
2926
2858
  # auth_names
2927
2859
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2928
2860
 
2929
2861
  new_options = opts.merge(
2930
- :operation => :"PlaidApi.cra_base_report_get",
2862
+ :operation => :"PlaidApi.cra_check_report_base_report_get",
2931
2863
  :header_params => header_params,
2932
2864
  :query_params => query_params,
2933
2865
  :form_params => form_params,
@@ -2938,36 +2870,36 @@ module Plaid
2938
2870
 
2939
2871
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2940
2872
  if @api_client.config.debugging
2941
- @api_client.config.logger.debug "API called: PlaidApi#cra_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2873
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2942
2874
  end
2943
2875
  return data, status_code, headers
2944
2876
  end
2945
2877
 
2946
- # Retrieve a Base Report
2947
- # This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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 base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`.
2948
- # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2878
+ # Retrieve cash flow insights from your user's banking data
2879
+ # This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you've received the `CHECK_REPORT_READY` webhook, either after the Link session for the user or after calling `/cra/check_report/create`. If the most recent consumer report for the user doesnt have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling `/cra/check_report/create`. If you did not initialize Link with the `cra_cashflow_insights` product or have generated a report using `/cra/check_report/create`, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under `options` to configure which insights you want to receive.
2880
+ # @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
2949
2881
  # @param [Hash] opts the optional parameters
2950
- # @return [CraCheckReportBaseReportGetResponse]
2951
- def cra_check_report_base_report_get(cra_check_report_base_report_get_request, opts = {})
2952
- data, _status_code, _headers = cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts)
2882
+ # @return [CraCheckReportCashflowInsightsGetResponse]
2883
+ def cra_check_report_cashflow_insights_get(cra_check_report_cashflow_insights_get_request, opts = {})
2884
+ data, _status_code, _headers = cra_check_report_cashflow_insights_get_with_http_info(cra_check_report_cashflow_insights_get_request, opts)
2953
2885
  data
2954
2886
  end
2955
2887
 
2956
- # Retrieve a Base Report
2957
- # This endpoint allows you to retrieve the Base Report for your user, allowing you to receive comprehensive bank account and cash flow data. 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&#39;t have sufficient data to generate the base report, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;.
2958
- # @param cra_check_report_base_report_get_request [CraCheckReportBaseReportGetRequest]
2888
+ # Retrieve cash flow insights from your user&#39;s banking data
2889
+ # This endpoint allows you to retrieve the Cashflow Insights report for your user. You should call this endpoint after you&#39;ve received the &#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 doesnt have sufficient data to generate the insights, or the consumer report has expired, you will receive an error indicating that you should create a new consumer report by calling &#x60;/cra/check_report/create&#x60;. If you did not initialize Link with the &#x60;cra_cashflow_insights&#x60; product or have generated a report using &#x60;/cra/check_report/create&#x60;, we will generate the insights when you call this endpoint. In this case, you may optionally provide parameters under &#x60;options&#x60; to configure which insights you want to receive.
2890
+ # @param cra_check_report_cashflow_insights_get_request [CraCheckReportCashflowInsightsGetRequest]
2959
2891
  # @param [Hash] opts the optional parameters
2960
- # @return [Array<(CraCheckReportBaseReportGetResponse, Integer, Hash)>] CraCheckReportBaseReportGetResponse data, response status code and response headers
2961
- def cra_check_report_base_report_get_with_http_info(cra_check_report_base_report_get_request, opts = {})
2892
+ # @return [Array<(CraCheckReportCashflowInsightsGetResponse, Integer, Hash)>] CraCheckReportCashflowInsightsGetResponse data, response status code and response headers
2893
+ def cra_check_report_cashflow_insights_get_with_http_info(cra_check_report_cashflow_insights_get_request, opts = {})
2962
2894
  if @api_client.config.debugging
2963
- @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_base_report_get ...'
2895
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_check_report_cashflow_insights_get ...'
2964
2896
  end
2965
- # verify the required parameter 'cra_check_report_base_report_get_request' is set
2966
- if @api_client.config.client_side_validation && cra_check_report_base_report_get_request.nil?
2967
- fail ArgumentError, "Missing the required parameter 'cra_check_report_base_report_get_request' when calling PlaidApi.cra_check_report_base_report_get"
2897
+ # verify the required parameter 'cra_check_report_cashflow_insights_get_request' is set
2898
+ if @api_client.config.client_side_validation && cra_check_report_cashflow_insights_get_request.nil?
2899
+ fail ArgumentError, "Missing the required parameter 'cra_check_report_cashflow_insights_get_request' when calling PlaidApi.cra_check_report_cashflow_insights_get"
2968
2900
  end
2969
2901
  # resource path
2970
- local_var_path = '/cra/check_report/base_report/get'
2902
+ local_var_path = '/cra/check_report/cashflow_insights/get'
2971
2903
 
2972
2904
  # query parameters
2973
2905
  query_params = opts[:query_params] || {}
@@ -2986,16 +2918,16 @@ module Plaid
2986
2918
  form_params = opts[:form_params] || {}
2987
2919
 
2988
2920
  # http body (model)
2989
- post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_base_report_get_request)
2921
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_check_report_cashflow_insights_get_request)
2990
2922
 
2991
2923
  # return_type
2992
- return_type = opts[:debug_return_type] || 'CraCheckReportBaseReportGetResponse'
2924
+ return_type = opts[:debug_return_type] || 'CraCheckReportCashflowInsightsGetResponse'
2993
2925
 
2994
2926
  # auth_names
2995
2927
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2996
2928
 
2997
2929
  new_options = opts.merge(
2998
- :operation => :"PlaidApi.cra_check_report_base_report_get",
2930
+ :operation => :"PlaidApi.cra_check_report_cashflow_insights_get",
2999
2931
  :header_params => header_params,
3000
2932
  :query_params => query_params,
3001
2933
  :form_params => form_params,
@@ -3006,7 +2938,7 @@ module Plaid
3006
2938
 
3007
2939
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3008
2940
  if @api_client.config.debugging
3009
- @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2941
+ @api_client.config.logger.debug "API called: PlaidApi#cra_check_report_cashflow_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3010
2942
  end
3011
2943
  return data, status_code, headers
3012
2944
  end
@@ -3692,7 +3624,7 @@ module Plaid
3692
3624
  end
3693
3625
 
3694
3626
  # Subscribe to Monitoring Insights
3695
- # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every 14 days.
3627
+ # This endpoint allows you to subscribe to insights for a user's linked CRA items, which are updated every day (best-effort).
3696
3628
  # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
3697
3629
  # @param [Hash] opts the optional parameters
3698
3630
  # @return [CraMonitoringInsightsSubscribeResponse]
@@ -3702,7 +3634,7 @@ module Plaid
3702
3634
  end
3703
3635
 
3704
3636
  # Subscribe to Monitoring Insights
3705
- # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated every 14 days.
3637
+ # This endpoint allows you to subscribe to insights for a user&#39;s linked CRA items, which are updated every day (best-effort).
3706
3638
  # @param cra_monitoring_insights_subscribe_request [CraMonitoringInsightsSubscribeRequest]
3707
3639
  # @param [Hash] opts the optional parameters
3708
3640
  # @return [Array<(CraMonitoringInsightsSubscribeResponse, Integer, Hash)>] CraMonitoringInsightsSubscribeResponse data, response status code and response headers
@@ -7555,7 +7487,7 @@ module Plaid
7555
7487
  end
7556
7488
 
7557
7489
  # Refresh investment data
7558
- # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7490
+ # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [`INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call `/sandbox/item/fire_webhook`. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/investments/refresh` is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7559
7491
  # @param investments_refresh_request [InvestmentsRefreshRequest]
7560
7492
  # @param [Hash] opts the optional parameters
7561
7493
  # @return [InvestmentsRefreshResponse]
@@ -7565,7 +7497,7 @@ module Plaid
7565
7497
  end
7566
7498
 
7567
7499
  # Refresh investment data
7568
- # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7500
+ # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investment holdings and transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [&#x60;INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. This webhook will typically not fire in the Sandbox environment, due to the lack of dynamic investment transactions and holdings data. To test this webhook in Sandbox, call &#x60;/sandbox/item/fire_webhook&#x60;. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
7569
7501
  # @param investments_refresh_request [InvestmentsRefreshRequest]
7570
7502
  # @param [Hash] opts the optional parameters
7571
7503
  # @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
@@ -8507,7 +8439,7 @@ module Plaid
8507
8439
  end
8508
8440
 
8509
8441
  # Remove an Item
8510
- # 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. 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.
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.
8511
8443
  # @param item_remove_request [ItemRemoveRequest]
8512
8444
  # @param [Hash] opts the optional parameters
8513
8445
  # @return [ItemRemoveResponse]
@@ -8517,7 +8449,7 @@ module Plaid
8517
8449
  end
8518
8450
 
8519
8451
  # Remove an Item
8520
- # 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. 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.
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.
8521
8453
  # @param item_remove_request [ItemRemoveRequest]
8522
8454
  # @param [Hash] opts the optional parameters
8523
8455
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -8914,74 +8846,6 @@ module Plaid
8914
8846
  return data, status_code, headers
8915
8847
  end
8916
8848
 
8917
- # Check profile eligibility
8918
- # The `/link/profile/eligibility/check` endpoint can be used to check whether a user with the supplied phone number has a saved profile that satisfies customer-defined eligibility requirements.
8919
- # @param link_profile_eligibility_check_request [LinkProfileEligibilityCheckRequest]
8920
- # @param [Hash] opts the optional parameters
8921
- # @return [LinkProfileEligibilityCheckResponse]
8922
- def link_profile_eligibility_check(link_profile_eligibility_check_request, opts = {})
8923
- data, _status_code, _headers = link_profile_eligibility_check_with_http_info(link_profile_eligibility_check_request, opts)
8924
- data
8925
- end
8926
-
8927
- # Check profile eligibility
8928
- # The &#x60;/link/profile/eligibility/check&#x60; endpoint can be used to check whether a user with the supplied phone number has a saved profile that satisfies customer-defined eligibility requirements.
8929
- # @param link_profile_eligibility_check_request [LinkProfileEligibilityCheckRequest]
8930
- # @param [Hash] opts the optional parameters
8931
- # @return [Array<(LinkProfileEligibilityCheckResponse, Integer, Hash)>] LinkProfileEligibilityCheckResponse data, response status code and response headers
8932
- def link_profile_eligibility_check_with_http_info(link_profile_eligibility_check_request, opts = {})
8933
- if @api_client.config.debugging
8934
- @api_client.config.logger.debug 'Calling API: PlaidApi.link_profile_eligibility_check ...'
8935
- end
8936
- # verify the required parameter 'link_profile_eligibility_check_request' is set
8937
- if @api_client.config.client_side_validation && link_profile_eligibility_check_request.nil?
8938
- fail ArgumentError, "Missing the required parameter 'link_profile_eligibility_check_request' when calling PlaidApi.link_profile_eligibility_check"
8939
- end
8940
- # resource path
8941
- local_var_path = '/link/profile/eligibility/check'
8942
-
8943
- # query parameters
8944
- query_params = opts[:query_params] || {}
8945
-
8946
- # header parameters
8947
- header_params = opts[:header_params] || {}
8948
- # HTTP header 'Accept' (if needed)
8949
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8950
- # HTTP header 'Content-Type'
8951
- content_type = @api_client.select_header_content_type(['application/json'])
8952
- if !content_type.nil?
8953
- header_params['Content-Type'] = content_type
8954
- end
8955
-
8956
- # form parameters
8957
- form_params = opts[:form_params] || {}
8958
-
8959
- # http body (model)
8960
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_profile_eligibility_check_request)
8961
-
8962
- # return_type
8963
- return_type = opts[:debug_return_type] || 'LinkProfileEligibilityCheckResponse'
8964
-
8965
- # auth_names
8966
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8967
-
8968
- new_options = opts.merge(
8969
- :operation => :"PlaidApi.link_profile_eligibility_check",
8970
- :header_params => header_params,
8971
- :query_params => query_params,
8972
- :form_params => form_params,
8973
- :body => post_body,
8974
- :auth_names => auth_names,
8975
- :return_type => return_type
8976
- )
8977
-
8978
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8979
- if @api_client.config.debugging
8980
- @api_client.config.logger.debug "API called: PlaidApi#link_profile_eligibility_check\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8981
- end
8982
- return data, status_code, headers
8983
- end
8984
-
8985
8849
  # Create Link Token
8986
8850
  # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`. For most Plaid products, the `public_token` is saved and exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. For more details, see the [Link flow overview](https://plaid.com/docs/link/#link-flow-overview). A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the [update mode](https://plaid.com/docs/link/update-mode) flow for tokens with expired credentials, or the Identity Verification flow.
8987
8851
  # @param link_token_create_request [LinkTokenCreateRequest]
@@ -9186,6 +9050,74 @@ module Plaid
9186
9050
  return data, status_code, headers
9187
9051
  end
9188
9052
 
9053
+ # Check a user's Plaid Network status
9054
+ # The `/network/status/get` endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. Note: it is strongly recommended to check for Layer eligibility in the frontend. `/network/status/get` should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9055
+ # @param network_status_get_request [NetworkStatusGetRequest]
9056
+ # @param [Hash] opts the optional parameters
9057
+ # @return [NetworkStatusGetResponse]
9058
+ def network_status_get(network_status_get_request, opts = {})
9059
+ data, _status_code, _headers = network_status_get_with_http_info(network_status_get_request, opts)
9060
+ data
9061
+ end
9062
+
9063
+ # Check a user&#39;s Plaid Network status
9064
+ # The &#x60;/network/status/get&#x60; endpoint can be used to check whether Plaid has a matching profile for the user. This is useful for determining if a user is eligible for a streamlined experience, such as Layer. Note: it is strongly recommended to check for Layer eligibility in the frontend. &#x60;/network/status/get&#x60; should only be used for checking Layer eligibility if a frontend check is not possible for your use case. For instructions on performing a frontend eligibility check, see the [Layer documentation](https://plaid.com/docs/layer/#integration-overview).
9065
+ # @param network_status_get_request [NetworkStatusGetRequest]
9066
+ # @param [Hash] opts the optional parameters
9067
+ # @return [Array<(NetworkStatusGetResponse, Integer, Hash)>] NetworkStatusGetResponse data, response status code and response headers
9068
+ def network_status_get_with_http_info(network_status_get_request, opts = {})
9069
+ if @api_client.config.debugging
9070
+ @api_client.config.logger.debug 'Calling API: PlaidApi.network_status_get ...'
9071
+ end
9072
+ # verify the required parameter 'network_status_get_request' is set
9073
+ if @api_client.config.client_side_validation && network_status_get_request.nil?
9074
+ fail ArgumentError, "Missing the required parameter 'network_status_get_request' when calling PlaidApi.network_status_get"
9075
+ end
9076
+ # resource path
9077
+ local_var_path = '/network/status/get'
9078
+
9079
+ # query parameters
9080
+ query_params = opts[:query_params] || {}
9081
+
9082
+ # header parameters
9083
+ header_params = opts[:header_params] || {}
9084
+ # HTTP header 'Accept' (if needed)
9085
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9086
+ # HTTP header 'Content-Type'
9087
+ content_type = @api_client.select_header_content_type(['application/json'])
9088
+ if !content_type.nil?
9089
+ header_params['Content-Type'] = content_type
9090
+ end
9091
+
9092
+ # form parameters
9093
+ form_params = opts[:form_params] || {}
9094
+
9095
+ # http body (model)
9096
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(network_status_get_request)
9097
+
9098
+ # return_type
9099
+ return_type = opts[:debug_return_type] || 'NetworkStatusGetResponse'
9100
+
9101
+ # auth_names
9102
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9103
+
9104
+ new_options = opts.merge(
9105
+ :operation => :"PlaidApi.network_status_get",
9106
+ :header_params => header_params,
9107
+ :query_params => query_params,
9108
+ :form_params => form_params,
9109
+ :body => post_body,
9110
+ :auth_names => auth_names,
9111
+ :return_type => return_type
9112
+ )
9113
+
9114
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9115
+ if @api_client.config.debugging
9116
+ @api_client.config.logger.debug "API called: PlaidApi#network_status_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9117
+ end
9118
+ return data, status_code, headers
9119
+ end
9120
+
9189
9121
  # Creates a new end customer for a Plaid reseller.
9190
9122
  # The `/partner/customer/create` endpoint is used by reseller partners to create end customers. To create end customers, it should be called in the Production environment only, even when creating Sandbox API keys. If called in the Sandbox environment, it will return a sample response, but no customer will be created and the API keys will not be valid.
9191
9123
  # @param partner_customer_create_request [PartnerCustomerCreateRequest]
@@ -10615,7 +10547,7 @@ module Plaid
10615
10547
  end
10616
10548
 
10617
10549
  # Retrieve Auth data
10618
- # The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
10550
+ # The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, savings, or cash management account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
10619
10551
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
10620
10552
  # @param [Hash] opts the optional parameters
10621
10553
  # @return [ProcessorAuthGetResponse]
@@ -10625,7 +10557,7 @@ module Plaid
10625
10557
  end
10626
10558
 
10627
10559
  # Retrieve Auth data
10628
- # The &#x60;/processor/auth/get&#x60; endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that&#39;&#39;s associated with a given &#x60;processor_token&#x60;. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the &#x60;numbers&#x60; object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
10560
+ # The &#x60;/processor/auth/get&#x60; endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking, savings, or cash management account that&#39;&#39;s associated with a given &#x60;processor_token&#x60;. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the &#x60;numbers&#x60; object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
10629
10561
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
10630
10562
  # @param [Hash] opts the optional parameters
10631
10563
  # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
@@ -10954,6 +10886,142 @@ module Plaid
10954
10886
  return data, status_code, headers
10955
10887
  end
10956
10888
 
10889
+ # Retrieve Investment Holdings
10890
+ # This endpoint returns the stock position data of the account associated with a given processor token.
10891
+ # @param processor_investments_holdings_get_request [ProcessorInvestmentsHoldingsGetRequest]
10892
+ # @param [Hash] opts the optional parameters
10893
+ # @return [ProcessorInvestmentsHoldingsGetResponse]
10894
+ def processor_investments_holdings_get(processor_investments_holdings_get_request, opts = {})
10895
+ data, _status_code, _headers = processor_investments_holdings_get_with_http_info(processor_investments_holdings_get_request, opts)
10896
+ data
10897
+ end
10898
+
10899
+ # Retrieve Investment Holdings
10900
+ # This endpoint returns the stock position data of the account associated with a given processor token.
10901
+ # @param processor_investments_holdings_get_request [ProcessorInvestmentsHoldingsGetRequest]
10902
+ # @param [Hash] opts the optional parameters
10903
+ # @return [Array<(ProcessorInvestmentsHoldingsGetResponse, Integer, Hash)>] ProcessorInvestmentsHoldingsGetResponse data, response status code and response headers
10904
+ def processor_investments_holdings_get_with_http_info(processor_investments_holdings_get_request, opts = {})
10905
+ if @api_client.config.debugging
10906
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_holdings_get ...'
10907
+ end
10908
+ # verify the required parameter 'processor_investments_holdings_get_request' is set
10909
+ if @api_client.config.client_side_validation && processor_investments_holdings_get_request.nil?
10910
+ fail ArgumentError, "Missing the required parameter 'processor_investments_holdings_get_request' when calling PlaidApi.processor_investments_holdings_get"
10911
+ end
10912
+ # resource path
10913
+ local_var_path = '/processor/investments/holdings/get'
10914
+
10915
+ # query parameters
10916
+ query_params = opts[:query_params] || {}
10917
+
10918
+ # header parameters
10919
+ header_params = opts[:header_params] || {}
10920
+ # HTTP header 'Accept' (if needed)
10921
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10922
+ # HTTP header 'Content-Type'
10923
+ content_type = @api_client.select_header_content_type(['application/json'])
10924
+ if !content_type.nil?
10925
+ header_params['Content-Type'] = content_type
10926
+ end
10927
+
10928
+ # form parameters
10929
+ form_params = opts[:form_params] || {}
10930
+
10931
+ # http body (model)
10932
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_holdings_get_request)
10933
+
10934
+ # return_type
10935
+ return_type = opts[:debug_return_type] || 'ProcessorInvestmentsHoldingsGetResponse'
10936
+
10937
+ # auth_names
10938
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10939
+
10940
+ new_options = opts.merge(
10941
+ :operation => :"PlaidApi.processor_investments_holdings_get",
10942
+ :header_params => header_params,
10943
+ :query_params => query_params,
10944
+ :form_params => form_params,
10945
+ :body => post_body,
10946
+ :auth_names => auth_names,
10947
+ :return_type => return_type
10948
+ )
10949
+
10950
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10951
+ if @api_client.config.debugging
10952
+ @api_client.config.logger.debug "API called: PlaidApi#processor_investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10953
+ end
10954
+ return data, status_code, headers
10955
+ end
10956
+
10957
+ # Get investment transactions data
10958
+ # The `/processor/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated with the processor token. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with the account, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the `async_update` option). Instead, if transactions data is not ready when `/processor/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/processor/investments/transactions/get` immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when `async_update` is set to true) may not be immediately available to `/processor/investments/transactions/get`. To be alerted when the data is ready to be fetched, listen for the `HISTORICAL_UPDATE` webhook. If no investments history is ready when `/processor/investments/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Investments 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.
10959
+ # @param processor_investments_transactions_get_request [ProcessorInvestmentsTransactionsGetRequest]
10960
+ # @param [Hash] opts the optional parameters
10961
+ # @return [ProcessorInvestmentsTransactionsGetResponse]
10962
+ def processor_investments_transactions_get(processor_investments_transactions_get_request, opts = {})
10963
+ data, _status_code, _headers = processor_investments_transactions_get_with_http_info(processor_investments_transactions_get_request, opts)
10964
+ data
10965
+ end
10966
+
10967
+ # Get investment transactions data
10968
+ # The &#x60;/processor/investments/transactions/get&#x60; endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for the investment account associated with the processor token. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with the account, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded (unless you use the &#x60;async_update&#x60; option). Instead, if transactions data is not ready when &#x60;/processor/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/processor/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return. Data returned by the asynchronous investments extraction flow (when &#x60;async_update&#x60; is set to true) may not be immediately available to &#x60;/processor/investments/transactions/get&#x60;. To be alerted when the data is ready to be fetched, listen for the &#x60;HISTORICAL_UPDATE&#x60; webhook. If no investments history is ready when &#x60;/processor/investments/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Investments 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.
10969
+ # @param processor_investments_transactions_get_request [ProcessorInvestmentsTransactionsGetRequest]
10970
+ # @param [Hash] opts the optional parameters
10971
+ # @return [Array<(ProcessorInvestmentsTransactionsGetResponse, Integer, Hash)>] ProcessorInvestmentsTransactionsGetResponse data, response status code and response headers
10972
+ def processor_investments_transactions_get_with_http_info(processor_investments_transactions_get_request, opts = {})
10973
+ if @api_client.config.debugging
10974
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_investments_transactions_get ...'
10975
+ end
10976
+ # verify the required parameter 'processor_investments_transactions_get_request' is set
10977
+ if @api_client.config.client_side_validation && processor_investments_transactions_get_request.nil?
10978
+ fail ArgumentError, "Missing the required parameter 'processor_investments_transactions_get_request' when calling PlaidApi.processor_investments_transactions_get"
10979
+ end
10980
+ # resource path
10981
+ local_var_path = '/processor/investments/transactions/get'
10982
+
10983
+ # query parameters
10984
+ query_params = opts[:query_params] || {}
10985
+
10986
+ # header parameters
10987
+ header_params = opts[:header_params] || {}
10988
+ # HTTP header 'Accept' (if needed)
10989
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10990
+ # HTTP header 'Content-Type'
10991
+ content_type = @api_client.select_header_content_type(['application/json'])
10992
+ if !content_type.nil?
10993
+ header_params['Content-Type'] = content_type
10994
+ end
10995
+
10996
+ # form parameters
10997
+ form_params = opts[:form_params] || {}
10998
+
10999
+ # http body (model)
11000
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_investments_transactions_get_request)
11001
+
11002
+ # return_type
11003
+ return_type = opts[:debug_return_type] || 'ProcessorInvestmentsTransactionsGetResponse'
11004
+
11005
+ # auth_names
11006
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11007
+
11008
+ new_options = opts.merge(
11009
+ :operation => :"PlaidApi.processor_investments_transactions_get",
11010
+ :header_params => header_params,
11011
+ :query_params => query_params,
11012
+ :form_params => form_params,
11013
+ :body => post_body,
11014
+ :auth_names => auth_names,
11015
+ :return_type => return_type
11016
+ )
11017
+
11018
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11019
+ if @api_client.config.debugging
11020
+ @api_client.config.logger.debug "API called: PlaidApi#processor_investments_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11021
+ end
11022
+ return data, status_code, headers
11023
+ end
11024
+
10957
11025
  # Retrieve Liabilities data
10958
11026
  # The `/processor/liabilities/get` endpoint returns various details about a loan or credit account. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/processor/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the processor token. This is because Plaid must communicate directly with the institution to retrieve the additional data.
10959
11027
  # @param processor_liabilities_get_request [ProcessorLiabilitiesGetRequest]
@@ -11839,7 +11907,7 @@ module Plaid
11839
11907
  end
11840
11908
 
11841
11909
  # Get incremental transaction updates on a processor token
11842
- # This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that processor token. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. 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, which can occur as a result of 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. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created processor tokens, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
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.
11843
11911
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
11844
11912
  # @param [Hash] opts the optional parameters
11845
11913
  # @return [ProcessorTransactionsSyncResponse]
@@ -11849,7 +11917,7 @@ module Plaid
11849
11917
  end
11850
11918
 
11851
11919
  # Get incremental transaction updates on a processor token
11852
- # This endpoint replaces &#x60;/processor/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/processor/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/processor/transactions/sync&#x60; provides the same functionality as &#x60;/processor/transactions/get&#x60; and can be used instead of &#x60;/processor/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/processor/transactions/sync&#x60; for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that processor token. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/processor/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. 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, which can occur as a result of 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. Whenever new or updated transaction data becomes available, &#x60;/processor/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that for newly created processor tokens, data may not be immediately available to &#x60;/processor/transactions/sync&#x60;. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processor-partners/#processortokenwebhookupdate) endpoint.
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.
11853
11921
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
11854
11922
  # @param [Hash] opts the optional parameters
11855
11923
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -11906,74 +11974,6 @@ module Plaid
11906
11974
  return data, status_code, headers
11907
11975
  end
11908
11976
 
11909
- # Retrieve a Profile
11910
- # Returns user permissioned profile data including identity and item access tokens.
11911
- # @param profile_get_request [ProfileGetRequest]
11912
- # @param [Hash] opts the optional parameters
11913
- # @return [ProfileGetResponse]
11914
- def profile_get(profile_get_request, opts = {})
11915
- data, _status_code, _headers = profile_get_with_http_info(profile_get_request, opts)
11916
- data
11917
- end
11918
-
11919
- # Retrieve a Profile
11920
- # Returns user permissioned profile data including identity and item access tokens.
11921
- # @param profile_get_request [ProfileGetRequest]
11922
- # @param [Hash] opts the optional parameters
11923
- # @return [Array<(ProfileGetResponse, Integer, Hash)>] ProfileGetResponse data, response status code and response headers
11924
- def profile_get_with_http_info(profile_get_request, opts = {})
11925
- if @api_client.config.debugging
11926
- @api_client.config.logger.debug 'Calling API: PlaidApi.profile_get ...'
11927
- end
11928
- # verify the required parameter 'profile_get_request' is set
11929
- if @api_client.config.client_side_validation && profile_get_request.nil?
11930
- fail ArgumentError, "Missing the required parameter 'profile_get_request' when calling PlaidApi.profile_get"
11931
- end
11932
- # resource path
11933
- local_var_path = '/profile/get'
11934
-
11935
- # query parameters
11936
- query_params = opts[:query_params] || {}
11937
-
11938
- # header parameters
11939
- header_params = opts[:header_params] || {}
11940
- # HTTP header 'Accept' (if needed)
11941
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
11942
- # HTTP header 'Content-Type'
11943
- content_type = @api_client.select_header_content_type(['application/json'])
11944
- if !content_type.nil?
11945
- header_params['Content-Type'] = content_type
11946
- end
11947
-
11948
- # form parameters
11949
- form_params = opts[:form_params] || {}
11950
-
11951
- # http body (model)
11952
- post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_get_request)
11953
-
11954
- # return_type
11955
- return_type = opts[:debug_return_type] || 'ProfileGetResponse'
11956
-
11957
- # auth_names
11958
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
11959
-
11960
- new_options = opts.merge(
11961
- :operation => :"PlaidApi.profile_get",
11962
- :header_params => header_params,
11963
- :query_params => query_params,
11964
- :form_params => form_params,
11965
- :body => post_body,
11966
- :auth_names => auth_names,
11967
- :return_type => return_type
11968
- )
11969
-
11970
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11971
- if @api_client.config.debugging
11972
- @api_client.config.logger.debug "API called: PlaidApi#profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11973
- end
11974
- return data, status_code, headers
11975
- end
11976
-
11977
11977
  # Check a user's Plaid Network status
11978
11978
  # The `/profile/network_status/get` endpoint can be used to check whether Plaid has a matching profile for the user.
11979
11979
  # @param profile_network_status_get_request [ProfileNetworkStatusGetRequest]
@@ -12246,6 +12246,74 @@ module Plaid
12246
12246
  return data, status_code, headers
12247
12247
  end
12248
12248
 
12249
+ # Trigger an update for Cashflow Updates
12250
+ # Use the `/sandbox/cra/cashflow_updates/update` endpoint to manually trigger an update for cashflow updates (Monitoring) in the Sandbox environment.
12251
+ # @param sandbox_cra_cashflow_updates_update_request [SandboxCraCashflowUpdatesUpdateRequest]
12252
+ # @param [Hash] opts the optional parameters
12253
+ # @return [SandboxCraCashflowUpdatesUpdateResponse]
12254
+ def sandbox_cra_cashflow_updates_update(sandbox_cra_cashflow_updates_update_request, opts = {})
12255
+ data, _status_code, _headers = sandbox_cra_cashflow_updates_update_with_http_info(sandbox_cra_cashflow_updates_update_request, opts)
12256
+ data
12257
+ end
12258
+
12259
+ # Trigger an update for Cashflow Updates
12260
+ # Use the &#x60;/sandbox/cra/cashflow_updates/update&#x60; endpoint to manually trigger an update for cashflow updates (Monitoring) in the Sandbox environment.
12261
+ # @param sandbox_cra_cashflow_updates_update_request [SandboxCraCashflowUpdatesUpdateRequest]
12262
+ # @param [Hash] opts the optional parameters
12263
+ # @return [Array<(SandboxCraCashflowUpdatesUpdateResponse, Integer, Hash)>] SandboxCraCashflowUpdatesUpdateResponse data, response status code and response headers
12264
+ def sandbox_cra_cashflow_updates_update_with_http_info(sandbox_cra_cashflow_updates_update_request, opts = {})
12265
+ if @api_client.config.debugging
12266
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_cra_cashflow_updates_update ...'
12267
+ end
12268
+ # verify the required parameter 'sandbox_cra_cashflow_updates_update_request' is set
12269
+ if @api_client.config.client_side_validation && sandbox_cra_cashflow_updates_update_request.nil?
12270
+ fail ArgumentError, "Missing the required parameter 'sandbox_cra_cashflow_updates_update_request' when calling PlaidApi.sandbox_cra_cashflow_updates_update"
12271
+ end
12272
+ # resource path
12273
+ local_var_path = '/sandbox/cra/cashflow_updates/update'
12274
+
12275
+ # query parameters
12276
+ query_params = opts[:query_params] || {}
12277
+
12278
+ # header parameters
12279
+ header_params = opts[:header_params] || {}
12280
+ # HTTP header 'Accept' (if needed)
12281
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12282
+ # HTTP header 'Content-Type'
12283
+ content_type = @api_client.select_header_content_type(['application/json'])
12284
+ if !content_type.nil?
12285
+ header_params['Content-Type'] = content_type
12286
+ end
12287
+
12288
+ # form parameters
12289
+ form_params = opts[:form_params] || {}
12290
+
12291
+ # http body (model)
12292
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_cra_cashflow_updates_update_request)
12293
+
12294
+ # return_type
12295
+ return_type = opts[:debug_return_type] || 'SandboxCraCashflowUpdatesUpdateResponse'
12296
+
12297
+ # auth_names
12298
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12299
+
12300
+ new_options = opts.merge(
12301
+ :operation => :"PlaidApi.sandbox_cra_cashflow_updates_update",
12302
+ :header_params => header_params,
12303
+ :query_params => query_params,
12304
+ :form_params => form_params,
12305
+ :body => post_body,
12306
+ :auth_names => auth_names,
12307
+ :return_type => return_type
12308
+ )
12309
+
12310
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12311
+ if @api_client.config.debugging
12312
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_cra_cashflow_updates_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12313
+ end
12314
+ return data, status_code, headers
12315
+ end
12316
+
12249
12317
  # Manually fire an Income webhook
12250
12318
  # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll or Document Income webhook in the Sandbox environment.
12251
12319
  # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
@@ -12315,7 +12383,7 @@ module Plaid
12315
12383
  end
12316
12384
 
12317
12385
  # Fire a test webhook
12318
- # 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. 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`).
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`).
12319
12387
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12320
12388
  # @param [Hash] opts the optional parameters
12321
12389
  # @return [SandboxItemFireWebhookResponse]
@@ -12325,7 +12393,7 @@ module Plaid
12325
12393
  end
12326
12394
 
12327
12395
  # Fire a test webhook
12328
- # 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. 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;).
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;).
12329
12397
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
12330
12398
  # @param [Hash] opts the optional parameters
12331
12399
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -12654,6 +12722,74 @@ module Plaid
12654
12722
  return data, status_code, headers
12655
12723
  end
12656
12724
 
12725
+ # Simulate a payment event in Sandbox
12726
+ # Use the `/sandbox/payment/simulate` endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook.
12727
+ # @param sandbox_payment_simulate_request [SandboxPaymentSimulateRequest]
12728
+ # @param [Hash] opts the optional parameters
12729
+ # @return [SandboxPaymentSimulateResponse]
12730
+ def sandbox_payment_simulate(sandbox_payment_simulate_request, opts = {})
12731
+ data, _status_code, _headers = sandbox_payment_simulate_with_http_info(sandbox_payment_simulate_request, opts)
12732
+ data
12733
+ end
12734
+
12735
+ # Simulate a payment event in Sandbox
12736
+ # Use the &#x60;/sandbox/payment/simulate&#x60; endpoint to simulate various payment events in the Sandbox environment. This endpoint will trigger the corresponding payment status webhook.
12737
+ # @param sandbox_payment_simulate_request [SandboxPaymentSimulateRequest]
12738
+ # @param [Hash] opts the optional parameters
12739
+ # @return [Array<(SandboxPaymentSimulateResponse, Integer, Hash)>] SandboxPaymentSimulateResponse data, response status code and response headers
12740
+ def sandbox_payment_simulate_with_http_info(sandbox_payment_simulate_request, opts = {})
12741
+ if @api_client.config.debugging
12742
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_payment_simulate ...'
12743
+ end
12744
+ # verify the required parameter 'sandbox_payment_simulate_request' is set
12745
+ if @api_client.config.client_side_validation && sandbox_payment_simulate_request.nil?
12746
+ fail ArgumentError, "Missing the required parameter 'sandbox_payment_simulate_request' when calling PlaidApi.sandbox_payment_simulate"
12747
+ end
12748
+ # resource path
12749
+ local_var_path = '/sandbox/payment/simulate'
12750
+
12751
+ # query parameters
12752
+ query_params = opts[:query_params] || {}
12753
+
12754
+ # header parameters
12755
+ header_params = opts[:header_params] || {}
12756
+ # HTTP header 'Accept' (if needed)
12757
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12758
+ # HTTP header 'Content-Type'
12759
+ content_type = @api_client.select_header_content_type(['application/json'])
12760
+ if !content_type.nil?
12761
+ header_params['Content-Type'] = content_type
12762
+ end
12763
+
12764
+ # form parameters
12765
+ form_params = opts[:form_params] || {}
12766
+
12767
+ # http body (model)
12768
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_payment_simulate_request)
12769
+
12770
+ # return_type
12771
+ return_type = opts[:debug_return_type] || 'SandboxPaymentSimulateResponse'
12772
+
12773
+ # auth_names
12774
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12775
+
12776
+ new_options = opts.merge(
12777
+ :operation => :"PlaidApi.sandbox_payment_simulate",
12778
+ :header_params => header_params,
12779
+ :query_params => query_params,
12780
+ :form_params => form_params,
12781
+ :body => post_body,
12782
+ :auth_names => auth_names,
12783
+ :return_type => return_type
12784
+ )
12785
+
12786
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12787
+ if @api_client.config.debugging
12788
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_payment_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12789
+ end
12790
+ return data, status_code, headers
12791
+ end
12792
+
12657
12793
  # Create a test Item and processor token
12658
12794
  # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
12659
12795
  # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
@@ -13946,6 +14082,74 @@ module Plaid
13946
14082
  return data, status_code, headers
13947
14083
  end
13948
14084
 
14085
+ # Schedule a planned ACH transaction
14086
+ # Use `/signal/schedule` to schedule a planned ACH transaction.
14087
+ # @param signal_schedule_request [SignalScheduleRequest]
14088
+ # @param [Hash] opts the optional parameters
14089
+ # @return [SignalScheduleResponse]
14090
+ def signal_schedule(signal_schedule_request, opts = {})
14091
+ data, _status_code, _headers = signal_schedule_with_http_info(signal_schedule_request, opts)
14092
+ data
14093
+ end
14094
+
14095
+ # Schedule a planned ACH transaction
14096
+ # Use &#x60;/signal/schedule&#x60; to schedule a planned ACH transaction.
14097
+ # @param signal_schedule_request [SignalScheduleRequest]
14098
+ # @param [Hash] opts the optional parameters
14099
+ # @return [Array<(SignalScheduleResponse, Integer, Hash)>] SignalScheduleResponse data, response status code and response headers
14100
+ def signal_schedule_with_http_info(signal_schedule_request, opts = {})
14101
+ if @api_client.config.debugging
14102
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_schedule ...'
14103
+ end
14104
+ # verify the required parameter 'signal_schedule_request' is set
14105
+ if @api_client.config.client_side_validation && signal_schedule_request.nil?
14106
+ fail ArgumentError, "Missing the required parameter 'signal_schedule_request' when calling PlaidApi.signal_schedule"
14107
+ end
14108
+ # resource path
14109
+ local_var_path = '/signal/schedule'
14110
+
14111
+ # query parameters
14112
+ query_params = opts[:query_params] || {}
14113
+
14114
+ # header parameters
14115
+ header_params = opts[:header_params] || {}
14116
+ # HTTP header 'Accept' (if needed)
14117
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
14118
+ # HTTP header 'Content-Type'
14119
+ content_type = @api_client.select_header_content_type(['application/json'])
14120
+ if !content_type.nil?
14121
+ header_params['Content-Type'] = content_type
14122
+ end
14123
+
14124
+ # form parameters
14125
+ form_params = opts[:form_params] || {}
14126
+
14127
+ # http body (model)
14128
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_schedule_request)
14129
+
14130
+ # return_type
14131
+ return_type = opts[:debug_return_type] || 'SignalScheduleResponse'
14132
+
14133
+ # auth_names
14134
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
14135
+
14136
+ new_options = opts.merge(
14137
+ :operation => :"PlaidApi.signal_schedule",
14138
+ :header_params => header_params,
14139
+ :query_params => query_params,
14140
+ :form_params => form_params,
14141
+ :body => post_body,
14142
+ :auth_names => auth_names,
14143
+ :return_type => return_type
14144
+ )
14145
+
14146
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
14147
+ if @api_client.config.debugging
14148
+ @api_client.config.logger.debug "API called: PlaidApi#signal_schedule\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
14149
+ end
14150
+ return data, status_code, headers
14151
+ end
14152
+
13949
14153
  # Retrieve a single statement.
13950
14154
  # The `/statements/download` endpoint retrieves a single statement PDF in binary format. The response will contain a `Plaid-Content-Hash` header containing a SHA 256 checksum of the statement. This can be used to verify that the file being sent by Plaid is the same file that was downloaded to your system.
13951
14155
  # @param statements_download_request [StatementsDownloadRequest]
@@ -14695,7 +14899,7 @@ module Plaid
14695
14899
  end
14696
14900
 
14697
14901
  # Get incremental transaction updates on an Item
14698
- # The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. To learn more about migrating from `/transactions/get`, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. 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 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. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call `/item/get`; the `item.status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. For newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
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.
14699
14903
  # @param transactions_sync_request [TransactionsSyncRequest]
14700
14904
  # @param [Hash] opts the optional parameters
14701
14905
  # @return [TransactionsSyncResponse]
@@ -14705,7 +14909,7 @@ module Plaid
14705
14909
  end
14706
14910
 
14707
14911
  # Get incremental transaction updates on an Item
14708
- # The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. To learn more about migrating from &#x60;/transactions/get&#x60;, see the [Transactions Sync migration guide](https://plaid.com/docs/transactions/sync-migration/). This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. 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 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. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To find out when the Item was last updated, use the [Item Debugger](https://plaid.com/docs/account/activity/#troubleshooting-with-item-debugger) or call &#x60;/item/get&#x60;; the &#x60;item.status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. For newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
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.
14709
14913
  # @param transactions_sync_request [TransactionsSyncRequest]
14710
14914
  # @param [Hash] opts the optional parameters
14711
14915
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -17143,7 +17347,7 @@ module Plaid
17143
17347
  end
17144
17348
 
17145
17349
  # Create a refund
17146
- # Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
17350
+ # Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds.
17147
17351
  # @param transfer_refund_create_request [TransferRefundCreateRequest]
17148
17352
  # @param [Hash] opts the optional parameters
17149
17353
  # @return [TransferRefundCreateResponse]
@@ -17153,7 +17357,7 @@ module Plaid
17153
17357
  end
17154
17358
 
17155
17359
  # Create a refund
17156
- # Use the &#x60;/transfer/refund/create&#x60; endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 4 business days following the transfer&#39;s settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
17360
+ # Use the &#x60;/transfer/refund/create&#x60; endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Refunds come out of the available balance of the ledger used for the original debit transfer. If there are not enough funds in the available balance to cover the refund amount, the refund will be rejected. You can create a refund at any time. Plaid does not impose any hold time on refunds.
17157
17361
  # @param transfer_refund_create_request [TransferRefundCreateRequest]
17158
17362
  # @param [Hash] opts the optional parameters
17159
17363
  # @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
@@ -17619,7 +17823,7 @@ module Plaid
17619
17823
  end
17620
17824
 
17621
17825
  # Create user
17622
- # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
17826
+ # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The `consumer_report_user_identity` object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the `/user/create` call, it can be added later by calling `/user/update`. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
17623
17827
  # @param user_create_request [UserCreateRequest]
17624
17828
  # @param [Hash] opts the optional parameters
17625
17829
  # @return [UserCreateResponse]
@@ -17629,7 +17833,7 @@ module Plaid
17629
17833
  end
17630
17834
 
17631
17835
  # Create user
17632
- # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The &#x60;consumer_report_user_identity&#x60; object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
17836
+ # This endpoint should be called for each of your end users before they begin a Plaid Check or Income flow, or a Multi-Item Link flow. This provides you a single token to access all data associated with the user. You should only create one per end user. The &#x60;consumer_report_user_identity&#x60; object must be present in order to create a Plaid Check Consumer Report for a user. If it is not provided during the &#x60;/user/create&#x60; call, it can be added later by calling &#x60;/user/update&#x60;. Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
17633
17837
  # @param user_create_request [UserCreateRequest]
17634
17838
  # @param [Hash] opts the optional parameters
17635
17839
  # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
@@ -17959,7 +18163,7 @@ module Plaid
17959
18163
  end
17960
18164
 
17961
18165
  # Update user information
17962
- # This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user.
18166
+ # This endpoint is used to update user information associated with an existing `user_token`. It can also be used to enable an existing `user_token` for use with Consumer Reports by Plaid Check, by adding a `consumer_report_user_identity` object to the user. Plaid Check Consumer Reports can only be created for US-based users; the user's address country must be `US`.
17963
18167
  # @param user_update_request [UserUpdateRequest]
17964
18168
  # @param [Hash] opts the optional parameters
17965
18169
  # @return [UserUpdateResponse]
@@ -17969,7 +18173,7 @@ module Plaid
17969
18173
  end
17970
18174
 
17971
18175
  # Update user information
17972
- # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. It can also be used to enable an existing &#x60;user_token&#x60; for use with Consumer Reports by Plaid Check, by adding a &#x60;consumer_report_user_identity&#x60; object to the user.
18176
+ # This endpoint is used to update user information associated with an existing &#x60;user_token&#x60;. It can also be used to enable an existing &#x60;user_token&#x60; for use with Consumer Reports by Plaid Check, by adding a &#x60;consumer_report_user_identity&#x60; object to the user. Plaid Check Consumer Reports can only be created for US-based users; the user&#39;s address country must be &#x60;US&#x60;.
17973
18177
  # @param user_update_request [UserUpdateRequest]
17974
18178
  # @param [Hash] opts the optional parameters
17975
18179
  # @return [Array<(UserUpdateResponse, Integer, Hash)>] UserUpdateResponse data, response status code and response headers