plaid 24.0.0 → 25.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1466) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +214 -0
  3. data/Gemfile.lock +9 -9
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +644 -32
  6. data/lib/plaid/api_client.rb +10 -5
  7. data/lib/plaid/api_error.rb +4 -3
  8. data/lib/plaid/configuration.rb +14 -2
  9. data/lib/plaid/models/account_access.rb +2 -2
  10. data/lib/plaid/models/account_assets.rb +3 -11
  11. data/lib/plaid/models/account_balance.rb +3 -3
  12. data/lib/plaid/models/account_base.rb +16 -7
  13. data/lib/plaid/models/account_filter.rb +2 -2
  14. data/lib/plaid/models/account_filters_response.rb +2 -2
  15. data/lib/plaid/models/account_identity.rb +31 -10
  16. data/lib/plaid/models/account_identity_all_of.rb +18 -6
  17. data/lib/plaid/models/account_identity_match_score.rb +16 -7
  18. data/lib/plaid/models/account_identity_match_score_all_of.rb +2 -2
  19. data/lib/plaid/models/account_product_access.rb +2 -2
  20. data/lib/plaid/models/account_product_access_nullable.rb +2 -2
  21. data/lib/plaid/models/account_selection_cardinality.rb +2 -2
  22. data/lib/plaid/models/account_subtype.rb +2 -2
  23. data/lib/plaid/models/account_type.rb +2 -2
  24. data/lib/plaid/models/account_verification_insights.rb +270 -0
  25. data/lib/plaid/models/account_verification_insights_account_number_format.rb +40 -0
  26. data/lib/plaid/models/account_verification_insights_network_status.rb +241 -0
  27. data/lib/plaid/models/account_verification_insights_previous_returns.rb +226 -0
  28. data/lib/plaid/models/accounts_balance_get_request.rb +16 -6
  29. data/lib/plaid/models/accounts_balance_get_request_options.rb +3 -3
  30. data/lib/plaid/models/accounts_balance_get_request_payment_details.rb +315 -0
  31. data/lib/plaid/models/accounts_balance_get_response_payment_risk_assessment.rb +299 -0
  32. data/lib/plaid/models/accounts_get_request.rb +2 -2
  33. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  34. data/lib/plaid/models/accounts_get_response.rb +13 -3
  35. data/lib/plaid/models/ach_class.rb +2 -2
  36. data/lib/plaid/models/action_state.rb +2 -2
  37. data/lib/plaid/models/activity.rb +24 -2
  38. data/lib/plaid/models/activity_type.rb +2 -2
  39. data/lib/plaid/models/address.rb +2 -2
  40. data/lib/plaid/models/address_data.rb +2 -2
  41. data/lib/plaid/models/address_data_not_required.rb +2 -2
  42. data/lib/plaid/models/address_data_nullable.rb +2 -2
  43. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +2 -2
  44. data/lib/plaid/models/address_match_score.rb +2 -2
  45. data/lib/plaid/models/address_nullable.rb +2 -2
  46. data/lib/plaid/models/address_purpose_label.rb +2 -2
  47. data/lib/plaid/models/application.rb +2 -2
  48. data/lib/plaid/models/application_get_request.rb +2 -2
  49. data/lib/plaid/models/application_get_response.rb +2 -2
  50. data/lib/plaid/models/apr.rb +2 -2
  51. data/lib/plaid/models/asset.rb +2 -2
  52. data/lib/plaid/models/asset_detail.rb +24 -2
  53. data/lib/plaid/models/asset_holder.rb +2 -2
  54. data/lib/plaid/models/asset_holder_name.rb +2 -2
  55. data/lib/plaid/models/asset_owner.rb +2 -2
  56. data/lib/plaid/models/asset_owners.rb +2 -2
  57. data/lib/plaid/models/asset_report.rb +2 -2
  58. data/lib/plaid/models/asset_report_account_balance.rb +288 -0
  59. data/lib/plaid/models/asset_report_add_ons.rb +2 -2
  60. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
  61. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  62. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +2 -2
  63. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +2 -2
  64. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  65. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  66. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  67. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  68. data/lib/plaid/models/asset_report_filter_request.rb +2 -2
  69. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  70. data/lib/plaid/models/asset_report_freddie.rb +2 -2
  71. data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
  72. data/lib/plaid/models/asset_report_freddie_get_response.rb +2 -2
  73. data/lib/plaid/models/asset_report_get_request.rb +2 -2
  74. data/lib/plaid/models/asset_report_get_request_options.rb +2 -2
  75. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  76. data/lib/plaid/models/asset_report_investment_holding.rb +2 -2
  77. data/lib/plaid/models/asset_report_investment_security.rb +2 -2
  78. data/lib/plaid/models/asset_report_investments.rb +55 -3
  79. data/lib/plaid/models/asset_report_item.rb +2 -2
  80. data/lib/plaid/models/asset_report_pdf_get_request.rb +2 -2
  81. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +2 -2
  82. data/lib/plaid/models/asset_report_refresh_request.rb +2 -2
  83. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  84. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  85. data/lib/plaid/models/asset_report_remove_request.rb +2 -2
  86. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  87. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  88. data/lib/plaid/models/asset_report_transaction_type.rb +2 -2
  89. data/lib/plaid/models/asset_report_user.rb +2 -2
  90. data/lib/plaid/models/asset_transaction.rb +2 -2
  91. data/lib/plaid/models/asset_transaction_category_type.rb +2 -2
  92. data/lib/plaid/models/asset_transaction_description.rb +2 -2
  93. data/lib/plaid/models/asset_transaction_detail.rb +24 -2
  94. data/lib/plaid/models/asset_transaction_type.rb +2 -2
  95. data/lib/plaid/models/asset_transactions.rb +2 -2
  96. data/lib/plaid/models/asset_type.rb +2 -2
  97. data/lib/plaid/models/assets.rb +2 -2
  98. data/lib/plaid/models/assets_error_webhook.rb +24 -2
  99. data/lib/plaid/models/assets_product_ready_webhook.rb +24 -2
  100. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  101. data/lib/plaid/models/auth_get_request.rb +2 -2
  102. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  103. data/lib/plaid/models/auth_get_response.rb +2 -2
  104. data/lib/plaid/models/auth_metadata.rb +2 -2
  105. data/lib/plaid/models/auth_supported_methods.rb +2 -2
  106. data/lib/plaid/models/automatically_verified_webhook.rb +24 -2
  107. data/lib/plaid/models/balance_plus_attributes.rb +508 -0
  108. data/lib/plaid/models/bank_income_complete_result.rb +2 -2
  109. data/lib/plaid/models/bank_income_complete_webhook.rb +24 -2
  110. data/lib/plaid/models/bank_income_refresh_complete_result.rb +2 -2
  111. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +24 -2
  112. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +24 -2
  113. data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
  114. data/lib/plaid/models/bank_transfer.rb +24 -2
  115. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  116. data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
  117. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  118. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  119. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  120. data/lib/plaid/models/bank_transfer_create_request.rb +24 -2
  121. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  122. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  123. data/lib/plaid/models/bank_transfer_event.rb +24 -2
  124. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +2 -2
  125. data/lib/plaid/models/bank_transfer_event_list_direction.rb +2 -2
  126. data/lib/plaid/models/bank_transfer_event_list_request.rb +24 -2
  127. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  128. data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
  129. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  130. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  131. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  132. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  133. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  134. data/lib/plaid/models/bank_transfer_list_request.rb +24 -2
  135. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  136. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +2 -2
  137. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  138. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  139. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  140. data/lib/plaid/models/bank_transfer_sweep.rb +2 -2
  141. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
  142. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +2 -2
  143. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -2
  144. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +2 -2
  145. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  146. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  147. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +24 -2
  148. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +24 -2
  149. data/lib/plaid/models/base_report.rb +2 -2
  150. data/lib/plaid/models/base_report_account.rb +24 -2
  151. data/lib/plaid/models/base_report_account_balances.rb +3 -3
  152. data/lib/plaid/models/base_report_account_balances_all_of.rb +2 -2
  153. data/lib/plaid/models/base_report_account_insights.rb +2 -2
  154. data/lib/plaid/models/base_report_average_flow_insights.rb +2 -2
  155. data/lib/plaid/models/base_report_average_monthly_balances.rb +2 -2
  156. data/lib/plaid/models/base_report_get_request.rb +2 -2
  157. data/lib/plaid/models/base_report_get_response.rb +2 -2
  158. data/lib/plaid/models/base_report_item.rb +2 -2
  159. data/lib/plaid/models/base_report_longest_gap_insights.rb +2 -2
  160. data/lib/plaid/models/base_report_number_flow_insights.rb +2 -2
  161. data/lib/plaid/models/base_report_transaction.rb +2 -2
  162. data/lib/plaid/models/base_report_warning.rb +24 -2
  163. data/lib/plaid/models/base_report_warning_code.rb +2 -2
  164. data/lib/plaid/models/base_reports_error_webhook.rb +24 -2
  165. data/lib/plaid/models/base_reports_product_ready_webhook.rb +24 -2
  166. data/lib/plaid/models/beacon_audit_trail.rb +24 -2
  167. data/lib/plaid/models/beacon_audit_trail_source.rb +2 -2
  168. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +292 -0
  169. data/lib/plaid/models/beacon_duplicate_get_request.rb +246 -0
  170. data/lib/plaid/models/beacon_duplicate_get_response.rb +283 -0
  171. data/lib/plaid/models/beacon_match_summary_analysis.rb +331 -0
  172. data/lib/plaid/models/beacon_match_summary_code.rb +2 -2
  173. data/lib/plaid/models/beacon_report.rb +24 -2
  174. data/lib/plaid/models/beacon_report_create_request.rb +24 -2
  175. data/lib/plaid/models/beacon_report_create_response.rb +24 -2
  176. data/lib/plaid/models/beacon_report_created_webhook.rb +292 -0
  177. data/lib/plaid/models/beacon_report_get_request.rb +246 -0
  178. data/lib/plaid/models/beacon_report_get_response.rb +346 -0
  179. data/lib/plaid/models/beacon_report_list_request.rb +2 -2
  180. data/lib/plaid/models/beacon_report_list_response.rb +2 -2
  181. data/lib/plaid/models/beacon_report_syndication.rb +2 -2
  182. data/lib/plaid/models/beacon_report_syndication_analysis.rb +24 -2
  183. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +292 -0
  184. data/lib/plaid/models/beacon_report_syndication_get_request.rb +246 -0
  185. data/lib/plaid/models/beacon_report_syndication_get_response.rb +269 -0
  186. data/lib/plaid/models/beacon_report_syndication_list_request.rb +2 -2
  187. data/lib/plaid/models/beacon_report_syndication_list_response.rb +2 -2
  188. data/lib/plaid/models/beacon_report_syndication_original_report.rb +24 -2
  189. data/lib/plaid/models/beacon_report_type.rb +2 -2
  190. data/lib/plaid/models/beacon_report_updated_webhook.rb +292 -0
  191. data/lib/plaid/models/beacon_user_address.rb +3 -3
  192. data/lib/plaid/models/beacon_user_create_request.rb +2 -2
  193. data/lib/plaid/models/beacon_user_create_response.rb +24 -2
  194. data/lib/plaid/models/beacon_user_data.rb +3 -7
  195. data/lib/plaid/models/beacon_user_get_request.rb +2 -2
  196. data/lib/plaid/models/beacon_user_get_response.rb +24 -2
  197. data/lib/plaid/models/beacon_user_id_number.rb +24 -2
  198. data/lib/plaid/models/beacon_user_name.rb +2 -2
  199. data/lib/plaid/models/beacon_user_name_nullable.rb +241 -0
  200. data/lib/plaid/models/beacon_user_request_address.rb +3 -3
  201. data/lib/plaid/models/beacon_user_request_address_nullable.rb +310 -0
  202. data/lib/plaid/models/beacon_user_request_data.rb +3 -2
  203. data/lib/plaid/models/beacon_user_review_request.rb +24 -2
  204. data/lib/plaid/models/beacon_user_revision.rb +241 -0
  205. data/lib/plaid/models/beacon_user_status.rb +2 -2
  206. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +24 -2
  207. data/lib/plaid/models/beacon_user_update_request.rb +260 -0
  208. data/lib/plaid/models/beacon_user_update_request_data.rb +283 -0
  209. data/lib/plaid/models/beacon_user_update_response.rb +386 -0
  210. data/lib/plaid/models/categories_get_response.rb +2 -2
  211. data/lib/plaid/models/category.rb +2 -2
  212. data/lib/plaid/models/category_insight_details.rb +2 -2
  213. data/lib/plaid/models/category_insights.rb +2 -2
  214. data/lib/plaid/models/cause.rb +24 -2
  215. data/lib/plaid/models/cause_all_of.rb +2 -2
  216. data/lib/plaid/models/client_provided_enhanced_transaction.rb +2 -2
  217. data/lib/plaid/models/client_provided_enriched_transaction.rb +24 -2
  218. data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
  219. data/lib/plaid/models/client_provided_transaction.rb +24 -2
  220. data/lib/plaid/models/client_provided_transaction_location.rb +2 -2
  221. data/lib/plaid/models/connected_application.rb +2 -2
  222. data/lib/plaid/models/consumer_report_permissible_purpose.rb +2 -2
  223. data/lib/plaid/models/consumer_report_user_identity.rb +2 -2
  224. data/lib/plaid/models/counterparty.rb +40 -7
  225. data/lib/plaid/models/counterparty_insights.rb +2 -2
  226. data/lib/plaid/models/counterparty_type.rb +2 -2
  227. data/lib/plaid/models/country_code.rb +2 -2
  228. data/lib/plaid/models/cra_bank_income.rb +2 -2
  229. data/lib/plaid/models/cra_bank_income_account.rb +24 -2
  230. data/lib/plaid/models/cra_bank_income_cause.rb +24 -2
  231. data/lib/plaid/models/cra_bank_income_complete_result.rb +2 -2
  232. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +24 -2
  233. data/lib/plaid/models/cra_bank_income_employer.rb +2 -2
  234. data/lib/plaid/models/cra_bank_income_get_request.rb +2 -2
  235. data/lib/plaid/models/cra_bank_income_get_response.rb +2 -2
  236. data/lib/plaid/models/cra_bank_income_historical_summary.rb +2 -2
  237. data/lib/plaid/models/cra_bank_income_item.rb +12 -2
  238. data/lib/plaid/models/cra_bank_income_source.rb +42 -3
  239. data/lib/plaid/models/cra_bank_income_summary.rb +2 -2
  240. data/lib/plaid/models/cra_bank_income_transaction.rb +2 -2
  241. data/lib/plaid/models/cra_bank_income_warning.rb +24 -2
  242. data/lib/plaid/models/cra_bank_income_warning_code.rb +2 -2
  243. data/lib/plaid/models/cra_partner_insights.rb +252 -0
  244. data/lib/plaid/models/cra_partner_insights_complete_result.rb +40 -0
  245. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +306 -0
  246. data/lib/plaid/models/cra_partner_insights_get_request.rb +241 -0
  247. data/lib/plaid/models/cra_partner_insights_get_response.rb +237 -0
  248. data/lib/plaid/models/cra_partner_insights_item.rb +253 -0
  249. data/lib/plaid/models/cra_partner_insights_item_account.rb +315 -0
  250. data/lib/plaid/models/cra_partner_insights_prism.rb +256 -0
  251. data/lib/plaid/models/cra_prediction_interval.rb +244 -0
  252. data/lib/plaid/models/credit1099.rb +24 -2
  253. data/lib/plaid/models/credit1099_filer.rb +2 -2
  254. data/lib/plaid/models/credit1099_payer.rb +2 -2
  255. data/lib/plaid/models/credit1099_recipient.rb +2 -2
  256. data/lib/plaid/models/credit_account_subtype.rb +2 -2
  257. data/lib/plaid/models/credit_ach_class.rb +2 -2
  258. data/lib/plaid/models/credit_amount_with_currency.rb +2 -2
  259. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +2 -2
  260. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +2 -2
  261. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +2 -2
  262. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +2 -2
  263. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +2 -2
  264. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +2 -2
  265. data/lib/plaid/models/credit_bank_employer.rb +2 -2
  266. data/lib/plaid/models/credit_bank_employment.rb +2 -2
  267. data/lib/plaid/models/credit_bank_employment_get_request.rb +2 -2
  268. data/lib/plaid/models/credit_bank_employment_get_response.rb +2 -2
  269. data/lib/plaid/models/credit_bank_employment_item.rb +2 -2
  270. data/lib/plaid/models/credit_bank_employment_report.rb +2 -2
  271. data/lib/plaid/models/credit_bank_employment_warning.rb +24 -2
  272. data/lib/plaid/models/credit_bank_employment_warning_type.rb +2 -2
  273. data/lib/plaid/models/credit_bank_income.rb +2 -2
  274. data/lib/plaid/models/credit_bank_income_account.rb +24 -2
  275. data/lib/plaid/models/credit_bank_income_account_type.rb +2 -2
  276. data/lib/plaid/models/credit_bank_income_category.rb +2 -2
  277. data/lib/plaid/models/credit_bank_income_cause.rb +24 -2
  278. data/lib/plaid/models/credit_bank_income_error_type.rb +2 -2
  279. data/lib/plaid/models/credit_bank_income_get_request.rb +2 -2
  280. data/lib/plaid/models/credit_bank_income_get_request_options.rb +2 -2
  281. data/lib/plaid/models/credit_bank_income_get_response.rb +2 -2
  282. data/lib/plaid/models/credit_bank_income_historical_summary.rb +2 -2
  283. data/lib/plaid/models/credit_bank_income_item.rb +2 -2
  284. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +2 -2
  285. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +2 -2
  286. data/lib/plaid/models/credit_bank_income_refresh_request.rb +2 -2
  287. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +2 -2
  288. data/lib/plaid/models/credit_bank_income_refresh_response.rb +2 -2
  289. data/lib/plaid/models/credit_bank_income_source.rb +24 -2
  290. data/lib/plaid/models/credit_bank_income_summary.rb +2 -2
  291. data/lib/plaid/models/credit_bank_income_transaction.rb +2 -2
  292. data/lib/plaid/models/credit_bank_income_warning.rb +24 -2
  293. data/lib/plaid/models/credit_bank_income_warning_code.rb +2 -2
  294. data/lib/plaid/models/credit_bank_income_warning_type.rb +2 -2
  295. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +2 -2
  296. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +2 -2
  297. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +2 -2
  298. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +2 -2
  299. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +2 -2
  300. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +2 -2
  301. data/lib/plaid/models/credit_bank_statement_upload_item.rb +2 -2
  302. data/lib/plaid/models/credit_bank_statement_upload_object.rb +2 -2
  303. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +2 -2
  304. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +15 -6
  305. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +223 -0
  306. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +2 -2
  307. data/lib/plaid/models/credit_card_liability.rb +2 -2
  308. data/lib/plaid/models/credit_category.rb +2 -2
  309. data/lib/plaid/models/credit_document_metadata.rb +2 -2
  310. data/lib/plaid/models/credit_employer_verification.rb +2 -2
  311. data/lib/plaid/models/credit_employment_get_request.rb +2 -2
  312. data/lib/plaid/models/credit_employment_get_response.rb +2 -2
  313. data/lib/plaid/models/credit_employment_item.rb +2 -2
  314. data/lib/plaid/models/credit_employment_verification.rb +2 -2
  315. data/lib/plaid/models/credit_filter.rb +2 -2
  316. data/lib/plaid/models/credit_freddie_mac_asset.rb +2 -2
  317. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +2 -2
  318. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +2 -2
  319. data/lib/plaid/models/credit_freddie_mac_assets.rb +2 -2
  320. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +2 -2
  321. data/lib/plaid/models/credit_freddie_mac_loan.rb +2 -2
  322. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +2 -2
  323. data/lib/plaid/models/credit_freddie_mac_loans.rb +2 -2
  324. data/lib/plaid/models/credit_freddie_mac_parties.rb +2 -2
  325. data/lib/plaid/models/credit_freddie_mac_party.rb +2 -2
  326. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +2 -2
  327. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +2 -2
  328. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +2 -2
  329. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +2 -2
  330. data/lib/plaid/models/credit_freddie_mac_service.rb +2 -2
  331. data/lib/plaid/models/credit_freddie_mac_services.rb +2 -2
  332. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +2 -2
  333. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +2 -2
  334. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +2 -2
  335. data/lib/plaid/models/credit_pay_stub.rb +2 -2
  336. data/lib/plaid/models/credit_pay_stub_address.rb +2 -2
  337. data/lib/plaid/models/credit_pay_stub_deductions.rb +2 -2
  338. data/lib/plaid/models/credit_pay_stub_earnings.rb +2 -2
  339. data/lib/plaid/models/credit_pay_stub_employee.rb +2 -2
  340. data/lib/plaid/models/credit_pay_stub_employer.rb +2 -2
  341. data/lib/plaid/models/credit_pay_stub_net_pay.rb +2 -2
  342. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +2 -2
  343. data/lib/plaid/models/credit_payroll_income_get_request.rb +15 -6
  344. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +223 -0
  345. data/lib/plaid/models/credit_payroll_income_get_response.rb +2 -2
  346. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +2 -2
  347. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +2 -2
  348. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +2 -2
  349. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +24 -2
  350. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +2 -2
  351. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +2 -2
  352. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +2 -2
  353. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
  354. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -2
  355. data/lib/plaid/models/credit_platform_ids.rb +2 -2
  356. data/lib/plaid/models/credit_relay_create_request.rb +2 -2
  357. data/lib/plaid/models/credit_relay_create_response.rb +2 -2
  358. data/lib/plaid/models/credit_relay_get_request.rb +24 -2
  359. data/lib/plaid/models/credit_relay_pdf_get_request.rb +24 -2
  360. data/lib/plaid/models/credit_relay_refresh_request.rb +24 -2
  361. data/lib/plaid/models/credit_relay_refresh_response.rb +2 -2
  362. data/lib/plaid/models/credit_relay_remove_request.rb +2 -2
  363. data/lib/plaid/models/credit_relay_remove_response.rb +2 -2
  364. data/lib/plaid/models/credit_session.rb +2 -2
  365. data/lib/plaid/models/credit_session_bank_employment_result.rb +24 -2
  366. data/lib/plaid/models/credit_session_bank_employment_status.rb +2 -2
  367. data/lib/plaid/models/credit_session_bank_income_result.rb +24 -2
  368. data/lib/plaid/models/credit_session_bank_income_status.rb +2 -2
  369. data/lib/plaid/models/credit_session_document_income_result.rb +21 -6
  370. data/lib/plaid/models/credit_session_error.rb +2 -2
  371. data/lib/plaid/models/credit_session_item_add_result.rb +2 -2
  372. data/lib/plaid/models/credit_session_payroll_income_result.rb +2 -2
  373. data/lib/plaid/models/credit_session_results.rb +2 -2
  374. data/lib/plaid/models/credit_sessions_get_request.rb +2 -2
  375. data/lib/plaid/models/credit_sessions_get_response.rb +2 -2
  376. data/lib/plaid/models/credit_w2.rb +2 -2
  377. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  378. data/lib/plaid/models/dashboard_user.rb +24 -2
  379. data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
  380. data/lib/plaid/models/dashboard_user_get_response.rb +24 -2
  381. data/lib/plaid/models/dashboard_user_list_request.rb +2 -2
  382. data/lib/plaid/models/dashboard_user_list_response.rb +2 -2
  383. data/lib/plaid/models/dashboard_user_status.rb +2 -2
  384. data/lib/plaid/models/date_range.rb +2 -2
  385. data/lib/plaid/models/deductions.rb +2 -2
  386. data/lib/plaid/models/deductions_breakdown.rb +2 -2
  387. data/lib/plaid/models/deductions_total.rb +2 -2
  388. data/lib/plaid/models/default_update_webhook.rb +24 -2
  389. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  390. data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
  391. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  392. data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
  393. data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
  394. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  395. data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
  396. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  397. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +24 -2
  398. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  399. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  400. data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
  401. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  402. data/lib/plaid/models/depository_account_subtype.rb +2 -2
  403. data/lib/plaid/models/depository_filter.rb +2 -2
  404. data/lib/plaid/models/detailed_originator.rb +24 -2
  405. data/lib/plaid/models/detected_account.rb +2 -2
  406. data/lib/plaid/models/distribution_breakdown.rb +2 -2
  407. data/lib/plaid/models/doc_type.rb +2 -2
  408. data/lib/plaid/models/document_analysis.rb +24 -2
  409. data/lib/plaid/models/document_authenticity_match_code.rb +2 -2
  410. data/lib/plaid/models/document_date_of_birth_match_code.rb +3 -2
  411. data/lib/plaid/models/document_metadata.rb +24 -2
  412. data/lib/plaid/models/document_name_match_code.rb +3 -2
  413. data/lib/plaid/models/document_risk_signal.rb +2 -2
  414. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +2 -2
  415. data/lib/plaid/models/document_risk_signals_object.rb +2 -2
  416. data/lib/plaid/models/document_risk_summary.rb +2 -2
  417. data/lib/plaid/models/document_status.rb +2 -2
  418. data/lib/plaid/models/documentary_verification.rb +2 -2
  419. data/lib/plaid/models/documentary_verification_document.rb +24 -2
  420. data/lib/plaid/models/earnings.rb +2 -2
  421. data/lib/plaid/models/earnings_breakdown.rb +24 -2
  422. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +2 -2
  423. data/lib/plaid/models/earnings_total.rb +2 -2
  424. data/lib/plaid/models/email.rb +2 -2
  425. data/lib/plaid/models/email_address_match_score.rb +2 -2
  426. data/lib/plaid/models/employee.rb +2 -2
  427. data/lib/plaid/models/employee_income_summary_field_string.rb +24 -2
  428. data/lib/plaid/models/employer.rb +2 -2
  429. data/lib/plaid/models/employer_income_summary_field_string.rb +24 -2
  430. data/lib/plaid/models/employer_verification.rb +2 -2
  431. data/lib/plaid/models/employers_search_request.rb +2 -2
  432. data/lib/plaid/models/employers_search_response.rb +2 -2
  433. data/lib/plaid/models/employment_details.rb +2 -2
  434. data/lib/plaid/models/employment_source_type.rb +2 -2
  435. data/lib/plaid/models/employment_verification.rb +24 -2
  436. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  437. data/lib/plaid/models/employment_verification_get_response.rb +2 -2
  438. data/lib/plaid/models/employment_verification_status.rb +2 -2
  439. data/lib/plaid/models/enhancements.rb +24 -2
  440. data/lib/plaid/models/enrich_transaction_direction.rb +2 -2
  441. data/lib/plaid/models/enrichments.rb +36 -3
  442. data/lib/plaid/models/entity_document.rb +24 -2
  443. data/lib/plaid/models/entity_document_type.rb +2 -2
  444. data/lib/plaid/models/entity_screening_hit_analysis.rb +24 -2
  445. data/lib/plaid/models/entity_screening_hit_data.rb +2 -2
  446. data/lib/plaid/models/entity_screening_hit_documents_items.rb +2 -2
  447. data/lib/plaid/models/entity_screening_hit_emails.rb +2 -2
  448. data/lib/plaid/models/entity_screening_hit_emails_items.rb +2 -2
  449. data/lib/plaid/models/entity_screening_hit_names.rb +24 -2
  450. data/lib/plaid/models/entity_screening_hit_names_items.rb +2 -2
  451. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +24 -2
  452. data/lib/plaid/models/entity_screening_hit_urls.rb +2 -2
  453. data/lib/plaid/models/entity_screening_hit_urls_items.rb +2 -2
  454. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +2 -2
  455. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +24 -2
  456. data/lib/plaid/models/entity_watchlist_code.rb +2 -2
  457. data/lib/plaid/models/entity_watchlist_program.rb +24 -2
  458. data/lib/plaid/models/entity_watchlist_screening.rb +24 -2
  459. data/lib/plaid/models/entity_watchlist_screening_hit.rb +24 -2
  460. data/lib/plaid/models/entity_watchlist_screening_review.rb +2 -2
  461. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +2 -2
  462. data/lib/plaid/models/entity_watchlist_search_terms.rb +2 -2
  463. data/lib/plaid/models/expiration_date.rb +2 -2
  464. data/lib/plaid/models/external_payment_initiation_consent_options.rb +2 -2
  465. data/lib/plaid/models/external_payment_options.rb +24 -2
  466. data/lib/plaid/models/external_payment_refund_details.rb +2 -2
  467. data/lib/plaid/models/external_payment_schedule_base.rb +24 -2
  468. data/lib/plaid/models/external_payment_schedule_get.rb +24 -2
  469. data/lib/plaid/models/external_payment_schedule_request.rb +24 -2
  470. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +24 -2
  471. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +24 -2
  472. data/lib/plaid/models/fdx_content_types.rb +2 -2
  473. data/lib/plaid/models/fdx_hateoas_link.rb +24 -2
  474. data/lib/plaid/models/fdx_hateoas_link_action.rb +2 -2
  475. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +24 -2
  476. data/lib/plaid/models/fdx_notification.rb +24 -2
  477. data/lib/plaid/models/fdx_notification_category.rb +2 -2
  478. data/lib/plaid/models/fdx_notification_payload.rb +24 -2
  479. data/lib/plaid/models/fdx_notification_payload_id_type.rb +2 -2
  480. data/lib/plaid/models/fdx_notification_priority.rb +2 -2
  481. data/lib/plaid/models/fdx_notification_severity.rb +2 -2
  482. data/lib/plaid/models/fdx_notification_type.rb +2 -2
  483. data/lib/plaid/models/fdx_party.rb +24 -2
  484. data/lib/plaid/models/fdx_party_registry.rb +2 -2
  485. data/lib/plaid/models/fdx_party_type.rb +2 -2
  486. data/lib/plaid/models/fdxfi_attribute.rb +2 -2
  487. data/lib/plaid/models/financial_institution_insights.rb +2 -2
  488. data/lib/plaid/models/form1099_type.rb +2 -2
  489. data/lib/plaid/models/fraud_amount.rb +24 -2
  490. data/lib/plaid/models/generic_screening_hit_location_items.rb +2 -2
  491. data/lib/plaid/models/health_incident.rb +2 -2
  492. data/lib/plaid/models/historical_balance.rb +2 -2
  493. data/lib/plaid/models/historical_update_webhook.rb +24 -2
  494. data/lib/plaid/models/holding.rb +3 -3
  495. data/lib/plaid/models/holdings_default_update_webhook.rb +24 -2
  496. data/lib/plaid/models/holdings_override.rb +26 -4
  497. data/lib/plaid/models/hosted_link_delivery_method.rb +2 -2
  498. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +317 -0
  499. data/lib/plaid/models/id_number_type.rb +2 -2
  500. data/lib/plaid/models/identity_default_update_webhook.rb +24 -2
  501. data/lib/plaid/models/identity_document.rb +229 -0
  502. data/lib/plaid/models/identity_document_metadata.rb +239 -0
  503. data/lib/plaid/models/identity_get_request.rb +2 -2
  504. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  505. data/lib/plaid/models/identity_get_response.rb +2 -2
  506. data/lib/plaid/models/identity_match_request.rb +2 -2
  507. data/lib/plaid/models/identity_match_request_options.rb +2 -2
  508. data/lib/plaid/models/identity_match_response.rb +2 -2
  509. data/lib/plaid/models/identity_match_user.rb +2 -2
  510. data/lib/plaid/models/identity_refresh_request.rb +2 -2
  511. data/lib/plaid/models/identity_refresh_response.rb +2 -2
  512. data/lib/plaid/models/identity_update_types.rb +2 -2
  513. data/lib/plaid/models/identity_verification.rb +24 -2
  514. data/lib/plaid/models/identity_verification_autofill_address.rb +356 -0
  515. data/lib/plaid/models/identity_verification_autofill_create_request.rb +246 -0
  516. data/lib/plaid/models/identity_verification_autofill_create_response.rb +272 -0
  517. data/lib/plaid/models/identity_verification_autofill_status.rb +39 -0
  518. data/lib/plaid/models/identity_verification_autofill_user_data.rb +241 -0
  519. data/lib/plaid/models/identity_verification_create_request.rb +2 -2
  520. data/lib/plaid/models/identity_verification_create_request_user.rb +2 -2
  521. data/lib/plaid/models/identity_verification_create_response.rb +24 -2
  522. data/lib/plaid/models/identity_verification_document_address_response.rb +2 -2
  523. data/lib/plaid/models/identity_verification_get_request.rb +3 -3
  524. data/lib/plaid/models/identity_verification_get_response.rb +24 -2
  525. data/lib/plaid/models/identity_verification_list_request.rb +3 -3
  526. data/lib/plaid/models/identity_verification_list_response.rb +2 -2
  527. data/lib/plaid/models/identity_verification_request_user.rb +2 -2
  528. data/lib/plaid/models/identity_verification_request_user_name.rb +2 -2
  529. data/lib/plaid/models/identity_verification_response_user_name.rb +2 -2
  530. data/lib/plaid/models/identity_verification_retried_webhook.rb +24 -2
  531. data/lib/plaid/models/identity_verification_retry_request.rb +24 -2
  532. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +2 -2
  533. data/lib/plaid/models/identity_verification_retry_response.rb +24 -2
  534. data/lib/plaid/models/identity_verification_status.rb +2 -2
  535. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +24 -2
  536. data/lib/plaid/models/identity_verification_step_status.rb +2 -2
  537. data/lib/plaid/models/identity_verification_step_summary.rb +24 -2
  538. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +24 -2
  539. data/lib/plaid/models/identity_verification_template_reference.rb +3 -3
  540. data/lib/plaid/models/identity_verification_user_address.rb +3 -3
  541. data/lib/plaid/models/identity_verification_user_data.rb +3 -3
  542. data/lib/plaid/models/image_quality.rb +2 -2
  543. data/lib/plaid/models/incident_update.rb +2 -2
  544. data/lib/plaid/models/income_breakdown.rb +24 -2
  545. data/lib/plaid/models/income_breakdown_type.rb +2 -2
  546. data/lib/plaid/models/income_override.rb +2 -2
  547. data/lib/plaid/models/income_summary.rb +2 -2
  548. data/lib/plaid/models/income_summary_field_number.rb +24 -2
  549. data/lib/plaid/models/income_summary_field_string.rb +24 -2
  550. data/lib/plaid/models/income_verification_create_request.rb +2 -2
  551. data/lib/plaid/models/income_verification_create_request_options.rb +2 -2
  552. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  553. data/lib/plaid/models/income_verification_doc_parsing_config.rb +3 -3
  554. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  555. data/lib/plaid/models/income_verification_payroll_flow_type.rb +2 -2
  556. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  557. data/lib/plaid/models/income_verification_paystubs_get_response.rb +2 -2
  558. data/lib/plaid/models/income_verification_precheck_confidence.rb +2 -2
  559. data/lib/plaid/models/income_verification_precheck_employer.rb +2 -2
  560. data/lib/plaid/models/income_verification_precheck_employer_address.rb +2 -2
  561. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +2 -2
  562. data/lib/plaid/models/income_verification_precheck_military_info.rb +2 -2
  563. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +2 -2
  564. data/lib/plaid/models/income_verification_precheck_request.rb +2 -2
  565. data/lib/plaid/models/income_verification_precheck_response.rb +24 -2
  566. data/lib/plaid/models/income_verification_precheck_user.rb +2 -2
  567. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +24 -2
  568. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +24 -2
  569. data/lib/plaid/models/income_verification_source_type.rb +2 -2
  570. data/lib/plaid/models/income_verification_status_webhook.rb +24 -2
  571. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  572. data/lib/plaid/models/income_verification_taxforms_get_response.rb +2 -2
  573. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  574. data/lib/plaid/models/individual_name.rb +2 -2
  575. data/lib/plaid/models/individual_screening_hit_names.rb +24 -2
  576. data/lib/plaid/models/individual_watchlist_code.rb +2 -2
  577. data/lib/plaid/models/individual_watchlist_program.rb +24 -2
  578. data/lib/plaid/models/inflow_model.rb +2 -2
  579. data/lib/plaid/models/initial_update_webhook.rb +24 -2
  580. data/lib/plaid/models/institution.rb +2 -2
  581. data/lib/plaid/models/institution_status.rb +2 -2
  582. data/lib/plaid/models/institution_status_alert_webhook.rb +24 -2
  583. data/lib/plaid/models/institution_supported_networks.rb +2 -2
  584. data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
  585. data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
  586. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  587. data/lib/plaid/models/institutions_get_request.rb +2 -2
  588. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  589. data/lib/plaid/models/institutions_get_response.rb +2 -2
  590. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  591. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +2 -2
  592. data/lib/plaid/models/institutions_search_request.rb +5 -5
  593. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  594. data/lib/plaid/models/institutions_search_response.rb +2 -2
  595. data/lib/plaid/models/investment_account_subtype.rb +2 -2
  596. data/lib/plaid/models/investment_filter.rb +2 -2
  597. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  598. data/lib/plaid/models/investment_transaction.rb +24 -2
  599. data/lib/plaid/models/investment_transaction_subtype.rb +2 -2
  600. data/lib/plaid/models/investment_transaction_type.rb +2 -2
  601. data/lib/plaid/models/investments_auth_get_numbers.rb +2 -2
  602. data/lib/plaid/models/investments_auth_get_request.rb +2 -2
  603. data/lib/plaid/models/investments_auth_get_request_options.rb +2 -2
  604. data/lib/plaid/models/investments_auth_get_response.rb +2 -2
  605. data/lib/plaid/models/investments_auth_owner.rb +2 -2
  606. data/lib/plaid/models/investments_default_update_webhook.rb +24 -2
  607. data/lib/plaid/models/investments_historical_update_webhook.rb +24 -2
  608. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  609. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  610. data/lib/plaid/models/investments_refresh_request.rb +2 -2
  611. data/lib/plaid/models/investments_refresh_response.rb +2 -2
  612. data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
  613. data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
  614. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  615. data/lib/plaid/models/investments_transactions_override.rb +2 -2
  616. data/lib/plaid/models/iso_currency_code.rb +2 -2
  617. data/lib/plaid/models/issuing_country.rb +2 -2
  618. data/lib/plaid/models/item.rb +2 -2
  619. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  620. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  621. data/lib/plaid/models/item_activity_list_request.rb +2 -2
  622. data/lib/plaid/models/item_activity_list_response.rb +2 -2
  623. data/lib/plaid/models/item_application_list_request.rb +2 -2
  624. data/lib/plaid/models/item_application_list_response.rb +2 -2
  625. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  626. data/lib/plaid/models/item_application_scopes_update_request.rb +24 -2
  627. data/lib/plaid/models/item_application_scopes_update_response.rb +2 -2
  628. data/lib/plaid/models/item_application_unlink_request.rb +2 -2
  629. data/lib/plaid/models/item_application_unlink_response.rb +2 -2
  630. data/lib/plaid/models/item_error_webhook.rb +24 -2
  631. data/lib/plaid/models/item_get_request.rb +2 -2
  632. data/lib/plaid/models/item_get_response.rb +2 -2
  633. data/lib/plaid/models/item_import_request.rb +2 -2
  634. data/lib/plaid/models/item_import_request_options.rb +2 -2
  635. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  636. data/lib/plaid/models/item_import_response.rb +2 -2
  637. data/lib/plaid/models/item_login_repaired_webhook.rb +24 -2
  638. data/lib/plaid/models/item_product_ready_webhook.rb +24 -2
  639. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  640. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  641. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  642. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  643. data/lib/plaid/models/item_remove_request.rb +2 -2
  644. data/lib/plaid/models/item_remove_response.rb +2 -2
  645. data/lib/plaid/models/item_status.rb +2 -2
  646. data/lib/plaid/models/item_status_investments.rb +2 -2
  647. data/lib/plaid/models/item_status_last_webhook.rb +2 -2
  648. data/lib/plaid/models/item_status_nullable.rb +2 -2
  649. data/lib/plaid/models/item_status_transactions.rb +2 -2
  650. data/lib/plaid/models/item_webhook_update_request.rb +2 -2
  651. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  652. data/lib/plaid/models/jwk_public_key.rb +2 -2
  653. data/lib/plaid/models/jwt_header.rb +2 -2
  654. data/lib/plaid/models/kyc_check_address_summary.rb +24 -2
  655. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +24 -2
  656. data/lib/plaid/models/kyc_check_details.rb +2 -2
  657. data/lib/plaid/models/kyc_check_id_number_summary.rb +24 -2
  658. data/lib/plaid/models/kyc_check_name_summary.rb +24 -2
  659. data/lib/plaid/models/kyc_check_phone_summary.rb +24 -2
  660. data/lib/plaid/models/last_data_access_times.rb +2 -2
  661. data/lib/plaid/models/liabilities_default_update_webhook.rb +24 -2
  662. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  663. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  664. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  665. data/lib/plaid/models/liabilities_object.rb +2 -2
  666. data/lib/plaid/models/liability_override.rb +2 -2
  667. data/lib/plaid/models/link_callback_metadata.rb +25 -3
  668. data/lib/plaid/models/link_delivery_account.rb +24 -2
  669. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  670. data/lib/plaid/models/link_delivery_communication_method.rb +24 -2
  671. data/lib/plaid/models/link_delivery_create_request.rb +2 -2
  672. data/lib/plaid/models/link_delivery_create_response.rb +2 -2
  673. data/lib/plaid/models/link_delivery_delivery_method.rb +2 -2
  674. data/lib/plaid/models/link_delivery_get_request.rb +2 -2
  675. data/lib/plaid/models/link_delivery_get_response.rb +24 -2
  676. data/lib/plaid/models/link_delivery_institution.rb +2 -2
  677. data/lib/plaid/models/link_delivery_metadata.rb +24 -2
  678. data/lib/plaid/models/link_delivery_options.rb +2 -2
  679. data/lib/plaid/models/link_delivery_recipient.rb +2 -2
  680. data/lib/plaid/models/link_delivery_session_status.rb +2 -2
  681. data/lib/plaid/models/link_delivery_verification_status.rb +5 -2
  682. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +2 -2
  683. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +2 -2
  684. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +2 -2
  685. data/lib/plaid/models/link_event.rb +20 -6
  686. data/lib/plaid/models/link_event_metadata.rb +2 -2
  687. data/lib/plaid/models/link_event_name.rb +2 -2
  688. data/lib/plaid/models/link_events_webhook.rb +2 -2
  689. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +2 -2
  690. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +2 -2
  691. data/lib/plaid/models/link_session_exit.rb +2 -2
  692. data/lib/plaid/models/link_session_exit_metadata.rb +2 -2
  693. data/lib/plaid/models/link_session_exit_metadata_institution.rb +2 -2
  694. data/lib/plaid/models/link_session_finished_webhook.rb +47 -11
  695. data/lib/plaid/models/link_session_success.rb +2 -2
  696. data/lib/plaid/models/link_session_success_metadata.rb +24 -2
  697. data/lib/plaid/models/link_session_success_metadata_account.rb +3 -3
  698. data/lib/plaid/models/link_session_success_metadata_institution.rb +2 -2
  699. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +2 -2
  700. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  701. data/lib/plaid/models/link_token_create_card_switch.rb +226 -0
  702. data/lib/plaid/models/link_token_create_credit_filter.rb +2 -2
  703. data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
  704. data/lib/plaid/models/link_token_create_hosted_link.rb +42 -8
  705. data/lib/plaid/models/link_token_create_identity.rb +233 -0
  706. data/lib/plaid/models/link_token_create_institution_data.rb +3 -3
  707. data/lib/plaid/models/link_token_create_investment_filter.rb +2 -2
  708. data/lib/plaid/models/link_token_create_loan_filter.rb +2 -2
  709. data/lib/plaid/models/link_token_create_request.rb +65 -7
  710. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  711. data/lib/plaid/models/link_token_create_request_auth.rb +13 -3
  712. data/lib/plaid/models/link_token_create_request_base_report.rb +2 -2
  713. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +259 -0
  714. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  715. data/lib/plaid/models/link_token_create_request_employment.rb +2 -2
  716. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +2 -2
  717. data/lib/plaid/models/link_token_create_request_identity_verification.rb +2 -3
  718. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  719. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +2 -2
  720. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +2 -2
  721. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  722. data/lib/plaid/models/link_token_create_request_statements.rb +3 -3
  723. data/lib/plaid/models/link_token_create_request_transfer.rb +2 -2
  724. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  725. data/lib/plaid/models/link_token_create_request_user.rb +3 -3
  726. data/lib/plaid/models/link_token_create_request_user_address.rb +5 -13
  727. data/lib/plaid/models/link_token_create_request_user_id_number.rb +24 -2
  728. data/lib/plaid/models/link_token_create_request_user_name.rb +2 -2
  729. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +24 -2
  730. data/lib/plaid/models/link_token_create_response.rb +3 -3
  731. data/lib/plaid/models/link_token_eu_config.rb +2 -2
  732. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  733. data/lib/plaid/models/link_token_get_request.rb +2 -2
  734. data/lib/plaid/models/link_token_get_response.rb +3 -3
  735. data/lib/plaid/models/link_token_get_sessions_response.rb +20 -8
  736. data/lib/plaid/models/link_token_investments.rb +2 -2
  737. data/lib/plaid/models/link_token_investments_auth.rb +2 -2
  738. data/lib/plaid/models/link_token_transactions.rb +249 -0
  739. data/lib/plaid/models/link_user_delivery_status_webhook.rb +3 -3
  740. data/lib/plaid/models/loan.rb +2 -2
  741. data/lib/plaid/models/loan_account_subtype.rb +2 -2
  742. data/lib/plaid/models/loan_filter.rb +2 -2
  743. data/lib/plaid/models/loan_identifier.rb +24 -2
  744. data/lib/plaid/models/loan_identifier_type.rb +2 -2
  745. data/lib/plaid/models/loan_identifiers.rb +2 -2
  746. data/lib/plaid/models/loans.rb +2 -2
  747. data/lib/plaid/models/location.rb +2 -2
  748. data/lib/plaid/models/match_summary.rb +24 -2
  749. data/lib/plaid/models/match_summary_code.rb +2 -2
  750. data/lib/plaid/models/merchant_insights.rb +2 -2
  751. data/lib/plaid/models/meta.rb +2 -2
  752. data/lib/plaid/models/mfa.rb +2 -2
  753. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  754. data/lib/plaid/models/mortgage_liability.rb +2 -2
  755. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  756. data/lib/plaid/models/multi_document_risk_signal.rb +2 -2
  757. data/lib/plaid/models/name_match_score.rb +2 -2
  758. data/lib/plaid/models/net_pay.rb +2 -2
  759. data/lib/plaid/models/new_accounts_available_webhook.rb +24 -2
  760. data/lib/plaid/models/numbers.rb +2 -2
  761. data/lib/plaid/models/numbers_acats.rb +2 -2
  762. data/lib/plaid/models/numbers_ach.rb +2 -2
  763. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  764. data/lib/plaid/models/numbers_aton.rb +2 -2
  765. data/lib/plaid/models/numbers_bacs.rb +2 -2
  766. data/lib/plaid/models/numbers_bacs_nullable.rb +2 -2
  767. data/lib/plaid/models/numbers_eft.rb +2 -2
  768. data/lib/plaid/models/numbers_eft_nullable.rb +2 -2
  769. data/lib/plaid/models/numbers_iban_nullable.rb +2 -2
  770. data/lib/plaid/models/numbers_international.rb +2 -2
  771. data/lib/plaid/models/numbers_international_iban.rb +2 -2
  772. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  773. data/lib/plaid/models/omittable_transfer_type.rb +2 -2
  774. data/lib/plaid/models/option_contract.rb +271 -0
  775. data/lib/plaid/models/originator.rb +24 -2
  776. data/lib/plaid/models/originator_expected_transfer_frequency.rb +2 -2
  777. data/lib/plaid/models/other_account_subtype.rb +2 -2
  778. data/lib/plaid/models/other_filter.rb +2 -2
  779. data/lib/plaid/models/override_account_type.rb +2 -2
  780. data/lib/plaid/models/override_accounts.rb +24 -2
  781. data/lib/plaid/models/owner.rb +17 -6
  782. data/lib/plaid/models/owner_override.rb +2 -2
  783. data/lib/plaid/models/ownership_type.rb +2 -2
  784. data/lib/plaid/models/parties.rb +2 -2
  785. data/lib/plaid/models/partner_customer_create_request.rb +16 -6
  786. data/lib/plaid/models/partner_customer_create_response.rb +2 -2
  787. data/lib/plaid/models/partner_customer_enable_request.rb +2 -2
  788. data/lib/plaid/models/partner_customer_enable_response.rb +2 -2
  789. data/lib/plaid/models/partner_customer_get_request.rb +2 -2
  790. data/lib/plaid/models/partner_customer_get_response.rb +2 -2
  791. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +2 -2
  792. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +24 -2
  793. data/lib/plaid/models/partner_customer_remove_request.rb +2 -2
  794. data/lib/plaid/models/partner_customer_remove_response.rb +2 -2
  795. data/lib/plaid/models/partner_end_customer.rb +24 -2
  796. data/lib/plaid/models/partner_end_customer_address.rb +2 -2
  797. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +2 -2
  798. data/lib/plaid/models/partner_end_customer_billing_contact.rb +2 -2
  799. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +2 -2
  800. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +2 -2
  801. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +2 -2
  802. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +2 -2
  803. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +24 -2
  804. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +2 -2
  805. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +24 -2
  806. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +2 -2
  807. data/lib/plaid/models/partner_end_customer_secrets.rb +2 -2
  808. data/lib/plaid/models/partner_end_customer_status.rb +2 -2
  809. data/lib/plaid/models/partner_end_customer_technical_contact.rb +2 -2
  810. data/lib/plaid/models/partner_end_customer_with_secrets.rb +24 -2
  811. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +2 -2
  812. data/lib/plaid/models/party.rb +2 -2
  813. data/lib/plaid/models/party_individual.rb +2 -2
  814. data/lib/plaid/models/party_role_type.rb +2 -2
  815. data/lib/plaid/models/pay.rb +2 -2
  816. data/lib/plaid/models/pay_frequency.rb +24 -2
  817. data/lib/plaid/models/pay_frequency_value.rb +2 -2
  818. data/lib/plaid/models/pay_period_details.rb +3 -16
  819. data/lib/plaid/models/pay_period_details_pay_frequency.rb +43 -0
  820. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +2 -2
  821. data/lib/plaid/models/pay_stub_deductions_total.rb +2 -2
  822. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +2 -2
  823. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +2 -2
  824. data/lib/plaid/models/pay_stub_earnings_total.rb +2 -2
  825. data/lib/plaid/models/pay_stub_pay_period_details.rb +24 -2
  826. data/lib/plaid/models/pay_stub_taxpayer_id.rb +2 -2
  827. data/lib/plaid/models/payment_amount.rb +24 -2
  828. data/lib/plaid/models/payment_amount_currency.rb +2 -2
  829. data/lib/plaid/models/payment_amount_nullable.rb +24 -2
  830. data/lib/plaid/models/payment_amount_refunded.rb +24 -2
  831. data/lib/plaid/models/payment_amount_to_refund.rb +24 -2
  832. data/lib/plaid/models/payment_channel.rb +2 -2
  833. data/lib/plaid/models/payment_consent_max_payment_amount.rb +24 -2
  834. data/lib/plaid/models/payment_consent_periodic_alignment.rb +2 -2
  835. data/lib/plaid/models/payment_consent_periodic_amount.rb +24 -2
  836. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +24 -2
  837. data/lib/plaid/models/payment_consent_periodic_interval.rb +2 -2
  838. data/lib/plaid/models/payment_consent_valid_date_time.rb +2 -2
  839. data/lib/plaid/models/payment_initiation_address.rb +2 -2
  840. data/lib/plaid/models/payment_initiation_consent.rb +24 -2
  841. data/lib/plaid/models/payment_initiation_consent_constraints.rb +2 -2
  842. data/lib/plaid/models/payment_initiation_consent_create_request.rb +2 -2
  843. data/lib/plaid/models/payment_initiation_consent_create_response.rb +24 -2
  844. data/lib/plaid/models/payment_initiation_consent_get_request.rb +2 -2
  845. data/lib/plaid/models/payment_initiation_consent_get_response.rb +24 -2
  846. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +52 -6
  847. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +24 -2
  848. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +2 -2
  849. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
  850. data/lib/plaid/models/payment_initiation_consent_scope.rb +2 -2
  851. data/lib/plaid/models/payment_initiation_consent_status.rb +2 -2
  852. data/lib/plaid/models/payment_initiation_metadata.rb +2 -2
  853. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +2 -2
  854. data/lib/plaid/models/payment_initiation_payment.rb +24 -2
  855. data/lib/plaid/models/payment_initiation_payment_create_request.rb +3 -3
  856. data/lib/plaid/models/payment_initiation_payment_create_response.rb +24 -2
  857. data/lib/plaid/models/payment_initiation_payment_create_status.rb +2 -2
  858. data/lib/plaid/models/payment_initiation_payment_get_request.rb +2 -2
  859. data/lib/plaid/models/payment_initiation_payment_get_response.rb +24 -2
  860. data/lib/plaid/models/payment_initiation_payment_list_request.rb +2 -2
  861. data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
  862. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +2 -2
  863. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +24 -2
  864. data/lib/plaid/models/payment_initiation_payment_status.rb +2 -2
  865. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +2 -2
  866. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  867. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  868. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  869. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  870. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +2 -2
  871. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  872. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +2 -2
  873. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +2 -2
  874. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  875. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -2
  876. data/lib/plaid/models/payment_meta.rb +2 -2
  877. data/lib/plaid/models/payment_profile_create_request.rb +2 -2
  878. data/lib/plaid/models/payment_profile_create_response.rb +2 -2
  879. data/lib/plaid/models/payment_profile_get_request.rb +2 -2
  880. data/lib/plaid/models/payment_profile_get_response.rb +24 -2
  881. data/lib/plaid/models/payment_profile_remove_request.rb +2 -2
  882. data/lib/plaid/models/payment_profile_remove_response.rb +2 -2
  883. data/lib/plaid/models/payment_profile_status.rb +2 -2
  884. data/lib/plaid/models/payment_schedule_interval.rb +2 -2
  885. data/lib/plaid/models/payment_scheme.rb +2 -2
  886. data/lib/plaid/models/payment_status_update_webhook.rb +24 -2
  887. data/lib/plaid/models/payroll_income_account_data.rb +2 -2
  888. data/lib/plaid/models/payroll_income_object.rb +2 -2
  889. data/lib/plaid/models/payroll_income_rate_of_pay.rb +2 -2
  890. data/lib/plaid/models/payroll_item.rb +2 -2
  891. data/lib/plaid/models/payroll_item_status.rb +2 -2
  892. data/lib/plaid/models/payroll_risk_signals_item.rb +2 -2
  893. data/lib/plaid/models/paystub.rb +2 -2
  894. data/lib/plaid/models/paystub_address.rb +2 -2
  895. data/lib/plaid/models/paystub_deduction.rb +2 -2
  896. data/lib/plaid/models/paystub_details.rb +24 -2
  897. data/lib/plaid/models/paystub_employer.rb +2 -2
  898. data/lib/plaid/models/paystub_override.rb +3 -3
  899. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +277 -0
  900. data/lib/plaid/models/paystub_override_employee.rb +2 -2
  901. data/lib/plaid/models/paystub_override_employee_address.rb +2 -2
  902. data/lib/plaid/models/paystub_override_employer.rb +2 -2
  903. data/lib/plaid/models/paystub_override_pay_period_details.rb +320 -0
  904. data/lib/plaid/models/paystub_pay_frequency.rb +2 -2
  905. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  906. data/lib/plaid/models/pending_expiration_webhook.rb +24 -2
  907. data/lib/plaid/models/personal_finance_category.rb +2 -2
  908. data/lib/plaid/models/phone_number.rb +2 -2
  909. data/lib/plaid/models/phone_number_match_score.rb +2 -2
  910. data/lib/plaid/models/phone_type.rb +2 -2
  911. data/lib/plaid/models/physical_document_category.rb +2 -2
  912. data/lib/plaid/models/physical_document_extracted_data.rb +24 -2
  913. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +24 -2
  914. data/lib/plaid/models/physical_document_images.rb +2 -2
  915. data/lib/plaid/models/plaid_error.rb +24 -2
  916. data/lib/plaid/models/plaid_error_type.rb +2 -2
  917. data/lib/plaid/models/platform_ids.rb +2 -2
  918. data/lib/plaid/models/po_box_status.rb +2 -2
  919. data/lib/plaid/models/prism_cash_score.rb +262 -0
  920. data/lib/plaid/models/prism_cash_score_metadata.rb +321 -0
  921. data/lib/plaid/models/prism_detect.rb +262 -0
  922. data/lib/plaid/models/prism_insights.rb +236 -0
  923. data/lib/plaid/models/prism_product.rb +39 -0
  924. data/lib/plaid/models/processor_account_get_request.rb +2 -2
  925. data/lib/plaid/models/processor_account_get_response.rb +2 -2
  926. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  927. data/lib/plaid/models/processor_auth_get_request.rb +2 -2
  928. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  929. data/lib/plaid/models/processor_balance_get_request.rb +2 -2
  930. data/lib/plaid/models/processor_balance_get_request_options.rb +3 -3
  931. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  932. data/lib/plaid/models/processor_bank_transfer_create_request.rb +24 -2
  933. data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
  934. data/lib/plaid/models/processor_default_update_webhook.rb +24 -2
  935. data/lib/plaid/models/processor_historical_update_webhook.rb +24 -2
  936. data/lib/plaid/models/processor_identity_get_request.rb +2 -2
  937. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  938. data/lib/plaid/models/processor_identity_match_request.rb +2 -2
  939. data/lib/plaid/models/processor_identity_match_response.rb +2 -2
  940. data/lib/plaid/models/processor_initial_update_webhook.rb +24 -2
  941. data/lib/plaid/models/processor_liabilities_get_request.rb +246 -0
  942. data/lib/plaid/models/processor_liabilities_get_response.rb +254 -0
  943. data/lib/plaid/models/processor_number.rb +2 -2
  944. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +24 -2
  945. data/lib/plaid/models/processor_signal_decision_report_request.rb +24 -2
  946. data/lib/plaid/models/processor_signal_decision_report_response.rb +2 -2
  947. data/lib/plaid/models/processor_signal_evaluate_request.rb +2 -2
  948. data/lib/plaid/models/processor_signal_evaluate_response.rb +2 -2
  949. data/lib/plaid/models/processor_signal_prepare_request.rb +2 -2
  950. data/lib/plaid/models/processor_signal_prepare_response.rb +2 -2
  951. data/lib/plaid/models/processor_signal_return_report_request.rb +2 -2
  952. data/lib/plaid/models/processor_signal_return_report_response.rb +2 -2
  953. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +2 -2
  954. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  955. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +24 -2
  956. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  957. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  958. data/lib/plaid/models/processor_token_permissions_get_request.rb +2 -2
  959. data/lib/plaid/models/processor_token_permissions_get_response.rb +2 -2
  960. data/lib/plaid/models/processor_token_permissions_set_request.rb +2 -2
  961. data/lib/plaid/models/processor_token_permissions_set_response.rb +2 -2
  962. data/lib/plaid/models/processor_token_webhook_update.rb +24 -2
  963. data/lib/plaid/models/processor_token_webhook_update_request.rb +2 -2
  964. data/lib/plaid/models/processor_token_webhook_update_response.rb +2 -2
  965. data/lib/plaid/models/processor_transactions_get_request.rb +2 -2
  966. data/lib/plaid/models/processor_transactions_get_request_options.rb +2 -2
  967. data/lib/plaid/models/processor_transactions_get_response.rb +2 -2
  968. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +2 -2
  969. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +2 -2
  970. data/lib/plaid/models/processor_transactions_refresh_request.rb +2 -2
  971. data/lib/plaid/models/processor_transactions_refresh_response.rb +2 -2
  972. data/lib/plaid/models/processor_transactions_removed_webhook.rb +24 -2
  973. data/lib/plaid/models/processor_transactions_sync_request.rb +2 -2
  974. data/lib/plaid/models/processor_transactions_sync_response.rb +2 -2
  975. data/lib/plaid/models/product_access.rb +2 -2
  976. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +24 -2
  977. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +24 -2
  978. data/lib/plaid/models/product_status.rb +2 -2
  979. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  980. data/lib/plaid/models/products.rb +5 -2
  981. data/lib/plaid/models/profile_get_request.rb +256 -0
  982. data/lib/plaid/models/{account_assets_all_of.rb → profile_get_response.rb} +38 -61
  983. data/lib/plaid/models/profile_identity.rb +275 -0
  984. data/lib/plaid/models/profile_identity_address.rb +276 -0
  985. data/lib/plaid/models/profile_identity_name.rb +229 -0
  986. data/lib/plaid/models/profile_item.rb +231 -0
  987. data/lib/plaid/models/program_name_sensitivity.rb +2 -2
  988. data/lib/plaid/models/projected_income_summary_field_number.rb +24 -2
  989. data/lib/plaid/models/proxy_type.rb +2 -2
  990. data/lib/plaid/models/pslf_status.rb +2 -2
  991. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  992. data/lib/plaid/models/recipient_bacs.rb +2 -2
  993. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  994. data/lib/plaid/models/recurrence.rb +24 -2
  995. data/lib/plaid/models/recurring_cancelled_webhook.rb +24 -2
  996. data/lib/plaid/models/recurring_frequency.rb +2 -2
  997. data/lib/plaid/models/recurring_insights_stream.rb +24 -2
  998. data/lib/plaid/models/recurring_new_transfer_webhook.rb +24 -2
  999. data/lib/plaid/models/recurring_transaction_frequency.rb +2 -2
  1000. data/lib/plaid/models/recurring_transactions.rb +2 -2
  1001. data/lib/plaid/models/recurring_transactions_update_webhook.rb +24 -2
  1002. data/lib/plaid/models/recurring_transfer.rb +24 -2
  1003. data/lib/plaid/models/recurring_transfer_nullable.rb +24 -2
  1004. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +24 -2
  1005. data/lib/plaid/models/removed_transaction.rb +2 -2
  1006. data/lib/plaid/models/report_type.rb +2 -2
  1007. data/lib/plaid/models/reporting_information.rb +2 -2
  1008. data/lib/plaid/models/risk_check_behavior.rb +24 -2
  1009. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +2 -2
  1010. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +2 -2
  1011. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +2 -2
  1012. data/lib/plaid/models/risk_check_details.rb +24 -2
  1013. data/lib/plaid/models/risk_check_device.rb +24 -2
  1014. data/lib/plaid/models/risk_check_email.rb +24 -2
  1015. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +2 -2
  1016. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +2 -2
  1017. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +2 -2
  1018. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +2 -2
  1019. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +2 -2
  1020. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +2 -2
  1021. data/lib/plaid/models/risk_check_linked_service.rb +2 -2
  1022. data/lib/plaid/models/risk_check_phone.rb +2 -2
  1023. data/lib/plaid/models/risk_check_stolen_identity.rb +2 -2
  1024. data/lib/plaid/models/risk_check_synthetic_identity.rb +2 -2
  1025. data/lib/plaid/models/risk_profile.rb +231 -0
  1026. data/lib/plaid/models/risk_reason.rb +231 -0
  1027. data/lib/plaid/models/risk_signal_document_reference.rb +24 -2
  1028. data/lib/plaid/models/risk_signal_document_status.rb +2 -2
  1029. data/lib/plaid/models/role.rb +2 -2
  1030. data/lib/plaid/models/role_detail.rb +24 -2
  1031. data/lib/plaid/models/roles.rb +2 -2
  1032. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +24 -2
  1033. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +2 -2
  1034. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +2 -2
  1035. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +24 -2
  1036. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  1037. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  1038. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  1039. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  1040. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +2 -2
  1041. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +2 -2
  1042. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +2 -2
  1043. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +2 -2
  1044. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  1045. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  1046. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  1047. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  1048. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  1049. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +2 -2
  1050. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +2 -2
  1051. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +2 -2
  1052. data/lib/plaid/models/sandbox_processor_token_create_request.rb +2 -2
  1053. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  1054. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  1055. data/lib/plaid/models/sandbox_public_token_create_request.rb +2 -2
  1056. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +2 -2
  1057. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  1058. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +2 -2
  1059. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +44 -6
  1060. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  1061. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +2 -2
  1062. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +2 -2
  1063. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +24 -2
  1064. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +2 -2
  1065. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +2 -2
  1066. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +2 -2
  1067. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +24 -2
  1068. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +2 -2
  1069. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +2 -2
  1070. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +2 -2
  1071. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +2 -2
  1072. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +2 -2
  1073. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
  1074. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +2 -2
  1075. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  1076. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +2 -2
  1077. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1078. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +2 -2
  1079. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +2 -2
  1080. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +2 -2
  1081. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1082. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +2 -2
  1083. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +2 -2
  1084. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +2 -2
  1085. data/lib/plaid/models/scopes.rb +2 -2
  1086. data/lib/plaid/models/scopes_context.rb +2 -2
  1087. data/lib/plaid/models/scopes_nullable.rb +2 -2
  1088. data/lib/plaid/models/screening_hit_analysis.rb +24 -2
  1089. data/lib/plaid/models/screening_hit_data.rb +2 -2
  1090. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +2 -2
  1091. data/lib/plaid/models/screening_hit_documents_items.rb +2 -2
  1092. data/lib/plaid/models/screening_hit_names_items.rb +2 -2
  1093. data/lib/plaid/models/screening_status_updated_webhook.rb +24 -2
  1094. data/lib/plaid/models/security.rb +29 -8
  1095. data/lib/plaid/models/security_override.rb +2 -2
  1096. data/lib/plaid/models/selfie_analysis.rb +24 -2
  1097. data/lib/plaid/models/selfie_analysis_document_comparison.rb +2 -2
  1098. data/lib/plaid/models/selfie_capture.rb +2 -2
  1099. data/lib/plaid/models/selfie_check.rb +24 -2
  1100. data/lib/plaid/models/selfie_check_selfie.rb +24 -2
  1101. data/lib/plaid/models/selfie_check_status.rb +2 -2
  1102. data/lib/plaid/models/selfie_status.rb +2 -2
  1103. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  1104. data/lib/plaid/models/service.rb +2 -2
  1105. data/lib/plaid/models/service_product_fulfillment.rb +2 -2
  1106. data/lib/plaid/models/service_product_fulfillment_detail.rb +24 -2
  1107. data/lib/plaid/models/service_product_fulfillment_identifier.rb +2 -2
  1108. data/lib/plaid/models/servicer_address_data.rb +2 -2
  1109. data/lib/plaid/models/services.rb +2 -2
  1110. data/lib/plaid/models/signal_address_data.rb +2 -2
  1111. data/lib/plaid/models/signal_decision_outcome.rb +2 -2
  1112. data/lib/plaid/models/signal_decision_report_request.rb +24 -2
  1113. data/lib/plaid/models/signal_decision_report_response.rb +2 -2
  1114. data/lib/plaid/models/signal_device.rb +3 -3
  1115. data/lib/plaid/models/signal_evaluate_core_attributes.rb +161 -7
  1116. data/lib/plaid/models/signal_evaluate_request.rb +43 -6
  1117. data/lib/plaid/models/signal_evaluate_response.rb +13 -3
  1118. data/lib/plaid/models/signal_payment_method.rb +2 -2
  1119. data/lib/plaid/models/signal_person_name.rb +2 -2
  1120. data/lib/plaid/models/signal_prepare_request.rb +2 -2
  1121. data/lib/plaid/models/signal_prepare_response.rb +2 -2
  1122. data/lib/plaid/models/signal_return_report_request.rb +2 -2
  1123. data/lib/plaid/models/signal_return_report_response.rb +2 -2
  1124. data/lib/plaid/models/signal_scores.rb +2 -2
  1125. data/lib/plaid/models/signal_user.rb +3 -3
  1126. data/lib/plaid/models/signal_warning.rb +2 -2
  1127. data/lib/plaid/models/simulated_transfer_sweep.rb +25 -3
  1128. data/lib/plaid/models/single_document_risk_signal.rb +2 -2
  1129. data/lib/plaid/models/source.rb +2 -2
  1130. data/lib/plaid/models/standalone_account_type.rb +2 -2
  1131. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  1132. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  1133. data/lib/plaid/models/statements_account.rb +49 -4
  1134. data/lib/plaid/models/statements_download_request.rb +2 -2
  1135. data/lib/plaid/models/statements_list_request.rb +2 -2
  1136. data/lib/plaid/models/statements_list_response.rb +2 -2
  1137. data/lib/plaid/models/statements_refresh_complete_result.rb +39 -0
  1138. data/lib/plaid/models/statements_refresh_complete_webhook.rb +306 -0
  1139. data/lib/plaid/models/statements_refresh_request.rb +276 -0
  1140. data/lib/plaid/models/statements_refresh_response.rb +226 -0
  1141. data/lib/plaid/models/statements_statement.rb +2 -2
  1142. data/lib/plaid/models/status.rb +2 -2
  1143. data/lib/plaid/models/statuses.rb +2 -2
  1144. data/lib/plaid/models/strategy.rb +2 -2
  1145. data/lib/plaid/models/student_loan.rb +2 -2
  1146. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  1147. data/lib/plaid/models/student_loan_status.rb +4 -4
  1148. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  1149. data/lib/plaid/models/sweep_status.rb +2 -2
  1150. data/lib/plaid/models/sweep_trigger.rb +2 -2
  1151. data/lib/plaid/models/sync_updates_available_webhook.rb +26 -4
  1152. data/lib/plaid/models/taxform.rb +2 -2
  1153. data/lib/plaid/models/taxpayer_id.rb +2 -2
  1154. data/lib/plaid/models/taxpayer_identifier.rb +24 -2
  1155. data/lib/plaid/models/taxpayer_identifier_type.rb +2 -2
  1156. data/lib/plaid/models/taxpayer_identifiers.rb +2 -2
  1157. data/lib/plaid/models/total.rb +24 -2
  1158. data/lib/plaid/models/total_canonical_description.rb +2 -2
  1159. data/lib/plaid/models/transaction.rb +2 -2
  1160. data/lib/plaid/models/transaction_all_of.rb +2 -2
  1161. data/lib/plaid/models/transaction_base.rb +2 -2
  1162. data/lib/plaid/models/transaction_code.rb +2 -2
  1163. data/lib/plaid/models/transaction_counterparty.rb +24 -2
  1164. data/lib/plaid/models/transaction_data.rb +2 -2
  1165. data/lib/plaid/models/transaction_override.rb +2 -2
  1166. data/lib/plaid/models/transaction_stream.rb +32 -10
  1167. data/lib/plaid/models/transaction_stream_amount.rb +2 -2
  1168. data/lib/plaid/models/transaction_stream_status.rb +2 -2
  1169. data/lib/plaid/models/transactions_category_rule.rb +2 -2
  1170. data/lib/plaid/models/transactions_enhance_get_request.rb +2 -2
  1171. data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
  1172. data/lib/plaid/models/transactions_enrich_request.rb +2 -2
  1173. data/lib/plaid/models/transactions_enrich_request_options.rb +2 -2
  1174. data/lib/plaid/models/transactions_enrich_response.rb +2 -2
  1175. data/lib/plaid/models/transactions_get_request.rb +2 -2
  1176. data/lib/plaid/models/transactions_get_request_options.rb +44 -6
  1177. data/lib/plaid/models/transactions_get_response.rb +2 -2
  1178. data/lib/plaid/models/transactions_recurring_create_input.rb +2 -2
  1179. data/lib/plaid/models/transactions_recurring_create_request.rb +2 -2
  1180. data/lib/plaid/models/transactions_recurring_create_response.rb +2 -2
  1181. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  1182. data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
  1183. data/lib/plaid/models/transactions_recurring_get_response.rb +2 -2
  1184. data/lib/plaid/models/transactions_recurring_merge_input.rb +2 -2
  1185. data/lib/plaid/models/transactions_recurring_merge_request.rb +2 -2
  1186. data/lib/plaid/models/transactions_recurring_merge_response.rb +2 -2
  1187. data/lib/plaid/models/transactions_recurring_update_input.rb +2 -2
  1188. data/lib/plaid/models/transactions_recurring_update_request.rb +2 -2
  1189. data/lib/plaid/models/transactions_recurring_update_response.rb +2 -2
  1190. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  1191. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  1192. data/lib/plaid/models/transactions_removed_webhook.rb +24 -2
  1193. data/lib/plaid/models/transactions_rule_details.rb +24 -2
  1194. data/lib/plaid/models/transactions_rule_field.rb +2 -2
  1195. data/lib/plaid/models/transactions_rule_type.rb +2 -2
  1196. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  1197. data/lib/plaid/models/transactions_rules_create_response.rb +2 -2
  1198. data/lib/plaid/models/transactions_rules_list_request.rb +2 -2
  1199. data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
  1200. data/lib/plaid/models/transactions_rules_remove_request.rb +2 -2
  1201. data/lib/plaid/models/transactions_rules_remove_response.rb +2 -2
  1202. data/lib/plaid/models/transactions_sync_request.rb +3 -3
  1203. data/lib/plaid/models/transactions_sync_request_options.rb +44 -6
  1204. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  1205. data/lib/plaid/models/transactions_user_insights_get_request.rb +2 -2
  1206. data/lib/plaid/models/transactions_user_insights_get_response.rb +2 -2
  1207. data/lib/plaid/models/transfer.rb +41 -5
  1208. data/lib/plaid/models/transfer_ach_network.rb +2 -2
  1209. data/lib/plaid/models/transfer_authorization.rb +24 -2
  1210. data/lib/plaid/models/transfer_authorization_create_request.rb +35 -4
  1211. data/lib/plaid/models/transfer_authorization_create_response.rb +2 -2
  1212. data/lib/plaid/models/transfer_authorization_decision.rb +2 -2
  1213. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +24 -2
  1214. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +2 -2
  1215. data/lib/plaid/models/transfer_authorization_device.rb +2 -2
  1216. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +2 -2
  1217. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +24 -2
  1218. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +2 -2
  1219. data/lib/plaid/models/transfer_authorization_payment_risk.rb +24 -2
  1220. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +40 -4
  1221. data/lib/plaid/models/transfer_authorization_risk_level.rb +2 -2
  1222. data/lib/plaid/models/transfer_authorization_user_in_request.rb +2 -2
  1223. data/lib/plaid/models/transfer_balance.rb +24 -2
  1224. data/lib/plaid/models/transfer_balance_get_request.rb +24 -2
  1225. data/lib/plaid/models/transfer_balance_get_response.rb +2 -2
  1226. data/lib/plaid/models/transfer_balance_type.rb +2 -2
  1227. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  1228. data/lib/plaid/models/transfer_cancel_response.rb +2 -2
  1229. data/lib/plaid/models/transfer_capabilities_get_request.rb +2 -2
  1230. data/lib/plaid/models/transfer_capabilities_get_response.rb +2 -2
  1231. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +2 -2
  1232. data/lib/plaid/models/transfer_configuration_get_request.rb +2 -2
  1233. data/lib/plaid/models/transfer_configuration_get_response.rb +2 -2
  1234. data/lib/plaid/models/transfer_create_request.rb +3 -3
  1235. data/lib/plaid/models/transfer_create_response.rb +2 -2
  1236. data/lib/plaid/models/transfer_credit_funds_source.rb +2 -2
  1237. data/lib/plaid/models/transfer_credit_usage_configuration.rb +24 -2
  1238. data/lib/plaid/models/transfer_debit_usage_configuration.rb +24 -2
  1239. data/lib/plaid/models/transfer_device.rb +2 -2
  1240. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +24 -2
  1241. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +2 -2
  1242. data/lib/plaid/models/transfer_diligence_status.rb +2 -2
  1243. data/lib/plaid/models/transfer_diligence_submit_request.rb +2 -2
  1244. data/lib/plaid/models/transfer_diligence_submit_response.rb +2 -2
  1245. data/lib/plaid/models/transfer_document_purpose.rb +2 -2
  1246. data/lib/plaid/models/transfer_event.rb +24 -2
  1247. data/lib/plaid/models/transfer_event_list_request.rb +24 -2
  1248. data/lib/plaid/models/transfer_event_list_response.rb +2 -2
  1249. data/lib/plaid/models/transfer_event_list_transfer_type.rb +2 -2
  1250. data/lib/plaid/models/transfer_event_sync_request.rb +2 -2
  1251. data/lib/plaid/models/transfer_event_sync_response.rb +2 -2
  1252. data/lib/plaid/models/transfer_event_type.rb +2 -2
  1253. data/lib/plaid/models/transfer_events_update_webhook.rb +24 -2
  1254. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +2 -2
  1255. data/lib/plaid/models/transfer_failure.rb +2 -2
  1256. data/lib/plaid/models/transfer_funding_account.rb +2 -2
  1257. data/lib/plaid/models/transfer_get_request.rb +2 -2
  1258. data/lib/plaid/models/transfer_get_response.rb +2 -2
  1259. data/lib/plaid/models/transfer_intent_authorization_decision.rb +2 -2
  1260. data/lib/plaid/models/transfer_intent_create.rb +24 -2
  1261. data/lib/plaid/models/transfer_intent_create_mode.rb +2 -2
  1262. data/lib/plaid/models/transfer_intent_create_network.rb +2 -2
  1263. data/lib/plaid/models/transfer_intent_create_request.rb +31 -9
  1264. data/lib/plaid/models/transfer_intent_create_response.rb +2 -2
  1265. data/lib/plaid/models/transfer_intent_get.rb +24 -2
  1266. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
  1267. data/lib/plaid/models/transfer_intent_get_request.rb +2 -2
  1268. data/lib/plaid/models/transfer_intent_get_response.rb +2 -2
  1269. data/lib/plaid/models/transfer_intent_status.rb +2 -2
  1270. data/lib/plaid/models/transfer_ledger_balance.rb +2 -2
  1271. data/lib/plaid/models/transfer_ledger_deposit_request.rb +24 -2
  1272. data/lib/plaid/models/transfer_ledger_deposit_response.rb +2 -2
  1273. data/lib/plaid/models/transfer_ledger_distribute_request.rb +2 -2
  1274. data/lib/plaid/models/transfer_ledger_distribute_response.rb +2 -2
  1275. data/lib/plaid/models/transfer_ledger_get_request.rb +2 -2
  1276. data/lib/plaid/models/transfer_ledger_get_response.rb +2 -2
  1277. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +2 -2
  1278. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +24 -2
  1279. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +2 -2
  1280. data/lib/plaid/models/transfer_list_request.rb +2 -2
  1281. data/lib/plaid/models/transfer_list_response.rb +2 -2
  1282. data/lib/plaid/models/transfer_metrics_get_request.rb +2 -2
  1283. data/lib/plaid/models/transfer_metrics_get_response.rb +2 -2
  1284. data/lib/plaid/models/transfer_migrate_account_request.rb +3 -3
  1285. data/lib/plaid/models/transfer_migrate_account_response.rb +2 -2
  1286. data/lib/plaid/models/transfer_network.rb +3 -2
  1287. data/lib/plaid/models/transfer_originator_address.rb +2 -2
  1288. data/lib/plaid/models/transfer_originator_create_request.rb +2 -2
  1289. data/lib/plaid/models/transfer_originator_create_response.rb +2 -2
  1290. data/lib/plaid/models/transfer_originator_diligence.rb +2 -2
  1291. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +2 -2
  1292. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +2 -2
  1293. data/lib/plaid/models/transfer_originator_get_request.rb +2 -2
  1294. data/lib/plaid/models/transfer_originator_get_response.rb +2 -2
  1295. data/lib/plaid/models/transfer_originator_list_request.rb +2 -2
  1296. data/lib/plaid/models/transfer_originator_list_response.rb +2 -2
  1297. data/lib/plaid/models/transfer_questionnaire_create_request.rb +2 -2
  1298. data/lib/plaid/models/transfer_questionnaire_create_response.rb +2 -2
  1299. data/lib/plaid/models/transfer_recurring_cancel_request.rb +2 -2
  1300. data/lib/plaid/models/transfer_recurring_cancel_response.rb +2 -2
  1301. data/lib/plaid/models/transfer_recurring_create_request.rb +24 -2
  1302. data/lib/plaid/models/transfer_recurring_create_response.rb +24 -2
  1303. data/lib/plaid/models/transfer_recurring_get_request.rb +2 -2
  1304. data/lib/plaid/models/transfer_recurring_get_response.rb +2 -2
  1305. data/lib/plaid/models/transfer_recurring_list_request.rb +2 -2
  1306. data/lib/plaid/models/transfer_recurring_list_response.rb +2 -2
  1307. data/lib/plaid/models/transfer_recurring_schedule.rb +24 -2
  1308. data/lib/plaid/models/transfer_recurring_status.rb +2 -2
  1309. data/lib/plaid/models/transfer_refund.rb +25 -3
  1310. data/lib/plaid/models/transfer_refund_cancel_request.rb +2 -2
  1311. data/lib/plaid/models/transfer_refund_cancel_response.rb +2 -2
  1312. data/lib/plaid/models/transfer_refund_create_request.rb +2 -2
  1313. data/lib/plaid/models/transfer_refund_create_response.rb +2 -2
  1314. data/lib/plaid/models/transfer_refund_failure.rb +2 -2
  1315. data/lib/plaid/models/transfer_refund_get_request.rb +2 -2
  1316. data/lib/plaid/models/transfer_refund_get_response.rb +2 -2
  1317. data/lib/plaid/models/transfer_refund_status.rb +2 -2
  1318. data/lib/plaid/models/transfer_repayment.rb +2 -2
  1319. data/lib/plaid/models/transfer_repayment_list_request.rb +2 -2
  1320. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  1321. data/lib/plaid/models/transfer_repayment_return.rb +2 -2
  1322. data/lib/plaid/models/transfer_repayment_return_list_request.rb +2 -2
  1323. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  1324. data/lib/plaid/models/transfer_schedule_interval_unit.rb +2 -2
  1325. data/lib/plaid/models/transfer_status.rb +2 -2
  1326. data/lib/plaid/models/transfer_sweep.rb +25 -3
  1327. data/lib/plaid/models/transfer_sweep_get_request.rb +2 -2
  1328. data/lib/plaid/models/transfer_sweep_get_response.rb +2 -2
  1329. data/lib/plaid/models/transfer_sweep_list_request.rb +24 -2
  1330. data/lib/plaid/models/transfer_sweep_list_response.rb +2 -2
  1331. data/lib/plaid/models/transfer_sweep_status.rb +2 -2
  1332. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  1333. data/lib/plaid/models/transfer_type.rb +2 -2
  1334. data/lib/plaid/models/transfer_user_address_in_request.rb +2 -2
  1335. data/lib/plaid/models/transfer_user_address_in_response.rb +2 -2
  1336. data/lib/plaid/models/transfer_user_in_request.rb +2 -2
  1337. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +2 -2
  1338. data/lib/plaid/models/transfer_user_in_response.rb +2 -2
  1339. data/lib/plaid/models/transfer_wire_details.rb +222 -0
  1340. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +2 -2
  1341. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +2 -2
  1342. data/lib/plaid/models/user_account_revoked_webhook.rb +317 -0
  1343. data/lib/plaid/models/user_address.rb +6 -14
  1344. data/lib/plaid/models/user_create_request.rb +2 -2
  1345. data/lib/plaid/models/user_create_response.rb +2 -2
  1346. data/lib/plaid/models/user_custom_password.rb +2 -2
  1347. data/lib/plaid/models/user_data_overview.rb +2 -2
  1348. data/lib/plaid/models/user_id_number.rb +24 -2
  1349. data/lib/plaid/models/user_permission_revoked_webhook.rb +25 -3
  1350. data/lib/plaid/models/user_stated_income_source_category.rb +2 -2
  1351. data/lib/plaid/models/user_stated_income_source_frequency.rb +2 -2
  1352. data/lib/plaid/models/user_stated_income_source_pay_type.rb +2 -2
  1353. data/lib/plaid/models/user_update_request.rb +2 -2
  1354. data/lib/plaid/models/user_update_response.rb +2 -2
  1355. data/lib/plaid/models/validation_source.rb +2 -2
  1356. data/lib/plaid/models/validation_sources.rb +2 -2
  1357. data/lib/plaid/models/verification_expired_webhook.rb +24 -2
  1358. data/lib/plaid/models/verification_of_asset.rb +2 -2
  1359. data/lib/plaid/models/verification_of_asset_response.rb +2 -2
  1360. data/lib/plaid/models/verification_refresh_status.rb +2 -2
  1361. data/lib/plaid/models/verification_status.rb +2 -2
  1362. data/lib/plaid/models/w2.rb +2 -2
  1363. data/lib/plaid/models/w2_box12.rb +2 -2
  1364. data/lib/plaid/models/w2_state_and_local_wages.rb +2 -2
  1365. data/lib/plaid/models/wallet.rb +24 -2
  1366. data/lib/plaid/models/wallet_balance.rb +21 -6
  1367. data/lib/plaid/models/wallet_create_request.rb +24 -2
  1368. data/lib/plaid/models/wallet_create_response.rb +24 -2
  1369. data/lib/plaid/models/wallet_get_request.rb +2 -2
  1370. data/lib/plaid/models/wallet_get_response.rb +24 -2
  1371. data/lib/plaid/models/wallet_iso_currency_code.rb +2 -2
  1372. data/lib/plaid/models/wallet_list_request.rb +24 -2
  1373. data/lib/plaid/models/wallet_list_response.rb +2 -2
  1374. data/lib/plaid/models/wallet_numbers.rb +2 -2
  1375. data/lib/plaid/models/wallet_payment_scheme.rb +2 -2
  1376. data/lib/plaid/models/wallet_status.rb +2 -2
  1377. data/lib/plaid/models/wallet_transaction.rb +2 -2
  1378. data/lib/plaid/models/wallet_transaction_amount.rb +24 -2
  1379. data/lib/plaid/models/wallet_transaction_counterparty.rb +2 -2
  1380. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
  1381. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +2 -2
  1382. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  1383. data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
  1384. data/lib/plaid/models/wallet_transaction_execute_response.rb +24 -2
  1385. data/lib/plaid/models/wallet_transaction_failure_reason.rb +2 -2
  1386. data/lib/plaid/models/wallet_transaction_get_request.rb +2 -2
  1387. data/lib/plaid/models/wallet_transaction_get_response.rb +2 -2
  1388. data/lib/plaid/models/wallet_transaction_list_request.rb +2 -2
  1389. data/lib/plaid/models/wallet_transaction_list_request_options.rb +2 -2
  1390. data/lib/plaid/models/wallet_transaction_list_response.rb +2 -2
  1391. data/lib/plaid/models/wallet_transaction_status.rb +2 -2
  1392. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +24 -2
  1393. data/lib/plaid/models/wallet_transactions_list_request.rb +2 -2
  1394. data/lib/plaid/models/warning.rb +2 -2
  1395. data/lib/plaid/models/watchlist_screening_audit_trail.rb +24 -2
  1396. data/lib/plaid/models/watchlist_screening_document.rb +24 -2
  1397. data/lib/plaid/models/watchlist_screening_document_type.rb +2 -2
  1398. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +2 -2
  1399. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +24 -2
  1400. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +2 -2
  1401. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +24 -2
  1402. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +2 -2
  1403. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +2 -2
  1404. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +2 -2
  1405. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +2 -2
  1406. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +24 -2
  1407. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +2 -2
  1408. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +2 -2
  1409. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +24 -2
  1410. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +2 -2
  1411. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +2 -2
  1412. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +2 -2
  1413. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +2 -2
  1414. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +2 -2
  1415. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +2 -2
  1416. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +24 -2
  1417. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +2 -2
  1418. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +24 -2
  1419. data/lib/plaid/models/watchlist_screening_hit.rb +24 -2
  1420. data/lib/plaid/models/watchlist_screening_hit_locations.rb +2 -2
  1421. data/lib/plaid/models/watchlist_screening_hit_status.rb +2 -2
  1422. data/lib/plaid/models/watchlist_screening_individual.rb +24 -2
  1423. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +2 -2
  1424. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +24 -2
  1425. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +2 -2
  1426. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +24 -2
  1427. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +2 -2
  1428. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +2 -2
  1429. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +2 -2
  1430. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +2 -2
  1431. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +24 -2
  1432. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +2 -2
  1433. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +2 -2
  1434. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +24 -2
  1435. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +2 -2
  1436. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +2 -2
  1437. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +2 -2
  1438. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +2 -2
  1439. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +2 -2
  1440. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +2 -2
  1441. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +24 -2
  1442. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +2 -2
  1443. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +24 -2
  1444. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +2 -2
  1445. data/lib/plaid/models/watchlist_screening_review.rb +2 -2
  1446. data/lib/plaid/models/watchlist_screening_search_terms.rb +2 -2
  1447. data/lib/plaid/models/watchlist_screening_status.rb +2 -2
  1448. data/lib/plaid/models/weak_alias_determination.rb +2 -2
  1449. data/lib/plaid/models/webhook_environment_values.rb +2 -2
  1450. data/lib/plaid/models/webhook_type.rb +2 -2
  1451. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +24 -2
  1452. data/lib/plaid/models/webhook_verification_key_get_request.rb +2 -2
  1453. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  1454. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +24 -2
  1455. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +24 -2
  1456. data/lib/plaid/version.rb +3 -3
  1457. data/lib/plaid.rb +75 -3
  1458. data/plaid.gemspec +2 -2
  1459. data/templates/ruby/api_client.mustache +5 -0
  1460. data/templates/ruby/api_client_faraday_partial.mustache +4 -2
  1461. data/templates/ruby/api_error.mustache +2 -1
  1462. data/templates/ruby/configuration.mustache +14 -2
  1463. data/templates/ruby/gemspec.mustache +1 -1
  1464. data/test/test_api_client.rb +28 -1
  1465. data/test/test_helper.rb +12 -3
  1466. metadata +75 -3
@@ -3,10 +3,10 @@
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.470.1
6
+ The version of the OpenAPI document: 2020-09-14_1.496.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 6.1.0
9
+ OpenAPI Generator version: 6.3.0
10
10
 
11
11
  =end
12
12
 
@@ -1651,8 +1651,76 @@ module Plaid
1651
1651
  return data, status_code, headers
1652
1652
  end
1653
1653
 
1654
+ # Get a Beacon Duplicate
1655
+ # Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the `beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`.
1656
+ # @param beacon_duplicate_get_request [BeaconDuplicateGetRequest]
1657
+ # @param [Hash] opts the optional parameters
1658
+ # @return [BeaconDuplicateGetResponse]
1659
+ def beacon_duplicate_get(beacon_duplicate_get_request, opts = {})
1660
+ data, _status_code, _headers = beacon_duplicate_get_with_http_info(beacon_duplicate_get_request, opts)
1661
+ data
1662
+ end
1663
+
1664
+ # Get a Beacon Duplicate
1665
+ # Returns a Beacon Duplicate for a given Beacon Duplicate id. A Beacon Duplicate represents a pair of similar Beacon Users within your organization. Two Beacon User revisions are returned for each Duplicate record in either the `beacon_user1` or `beacon_user2` response fields. The `analysis` field in the response indicates which fields matched between `beacon_user1` and `beacon_user2`.
1666
+ # @param beacon_duplicate_get_request [BeaconDuplicateGetRequest]
1667
+ # @param [Hash] opts the optional parameters
1668
+ # @return [Array<(BeaconDuplicateGetResponse, Integer, Hash)>] BeaconDuplicateGetResponse data, response status code and response headers
1669
+ def beacon_duplicate_get_with_http_info(beacon_duplicate_get_request, opts = {})
1670
+ if @api_client.config.debugging
1671
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_duplicate_get ...'
1672
+ end
1673
+ # verify the required parameter 'beacon_duplicate_get_request' is set
1674
+ if @api_client.config.client_side_validation && beacon_duplicate_get_request.nil?
1675
+ fail ArgumentError, "Missing the required parameter 'beacon_duplicate_get_request' when calling PlaidApi.beacon_duplicate_get"
1676
+ end
1677
+ # resource path
1678
+ local_var_path = '/beacon/duplicate/get'
1679
+
1680
+ # query parameters
1681
+ query_params = opts[:query_params] || {}
1682
+
1683
+ # header parameters
1684
+ header_params = opts[:header_params] || {}
1685
+ # HTTP header 'Accept' (if needed)
1686
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1687
+ # HTTP header 'Content-Type'
1688
+ content_type = @api_client.select_header_content_type(['application/json'])
1689
+ if !content_type.nil?
1690
+ header_params['Content-Type'] = content_type
1691
+ end
1692
+
1693
+ # form parameters
1694
+ form_params = opts[:form_params] || {}
1695
+
1696
+ # http body (model)
1697
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_duplicate_get_request)
1698
+
1699
+ # return_type
1700
+ return_type = opts[:debug_return_type] || 'BeaconDuplicateGetResponse'
1701
+
1702
+ # auth_names
1703
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1704
+
1705
+ new_options = opts.merge(
1706
+ :operation => :"PlaidApi.beacon_duplicate_get",
1707
+ :header_params => header_params,
1708
+ :query_params => query_params,
1709
+ :form_params => form_params,
1710
+ :body => post_body,
1711
+ :auth_names => auth_names,
1712
+ :return_type => return_type
1713
+ )
1714
+
1715
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1716
+ if @api_client.config.debugging
1717
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_duplicate_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1718
+ end
1719
+ return data, status_code, headers
1720
+ end
1721
+
1654
1722
  # Create a Beacon Report
1655
- # Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the `/beacon/user/create` endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs.
1723
+ # Create a fraud report for a given Beacon User.
1656
1724
  # @param beacon_report_create_request [BeaconReportCreateRequest]
1657
1725
  # @param [Hash] opts the optional parameters
1658
1726
  # @return [BeaconReportCreateResponse]
@@ -1662,7 +1730,7 @@ module Plaid
1662
1730
  end
1663
1731
 
1664
1732
  # Create a Beacon Report
1665
- # Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the &#x60;/beacon/user/create&#x60; endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs.
1733
+ # Create a fraud report for a given Beacon User.
1666
1734
  # @param beacon_report_create_request [BeaconReportCreateRequest]
1667
1735
  # @param [Hash] opts the optional parameters
1668
1736
  # @return [Array<(BeaconReportCreateResponse, Integer, Hash)>] BeaconReportCreateResponse data, response status code and response headers
@@ -1719,6 +1787,74 @@ module Plaid
1719
1787
  return data, status_code, headers
1720
1788
  end
1721
1789
 
1790
+ # Get a Beacon Report
1791
+ # Returns a Beacon report for a given Beacon report id.
1792
+ # @param beacon_report_get_request [BeaconReportGetRequest]
1793
+ # @param [Hash] opts the optional parameters
1794
+ # @return [BeaconReportGetResponse]
1795
+ def beacon_report_get(beacon_report_get_request, opts = {})
1796
+ data, _status_code, _headers = beacon_report_get_with_http_info(beacon_report_get_request, opts)
1797
+ data
1798
+ end
1799
+
1800
+ # Get a Beacon Report
1801
+ # Returns a Beacon report for a given Beacon report id.
1802
+ # @param beacon_report_get_request [BeaconReportGetRequest]
1803
+ # @param [Hash] opts the optional parameters
1804
+ # @return [Array<(BeaconReportGetResponse, Integer, Hash)>] BeaconReportGetResponse data, response status code and response headers
1805
+ def beacon_report_get_with_http_info(beacon_report_get_request, opts = {})
1806
+ if @api_client.config.debugging
1807
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_get ...'
1808
+ end
1809
+ # verify the required parameter 'beacon_report_get_request' is set
1810
+ if @api_client.config.client_side_validation && beacon_report_get_request.nil?
1811
+ fail ArgumentError, "Missing the required parameter 'beacon_report_get_request' when calling PlaidApi.beacon_report_get"
1812
+ end
1813
+ # resource path
1814
+ local_var_path = '/beacon/report/get'
1815
+
1816
+ # query parameters
1817
+ query_params = opts[:query_params] || {}
1818
+
1819
+ # header parameters
1820
+ header_params = opts[:header_params] || {}
1821
+ # HTTP header 'Accept' (if needed)
1822
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1823
+ # HTTP header 'Content-Type'
1824
+ content_type = @api_client.select_header_content_type(['application/json'])
1825
+ if !content_type.nil?
1826
+ header_params['Content-Type'] = content_type
1827
+ end
1828
+
1829
+ # form parameters
1830
+ form_params = opts[:form_params] || {}
1831
+
1832
+ # http body (model)
1833
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_get_request)
1834
+
1835
+ # return_type
1836
+ return_type = opts[:debug_return_type] || 'BeaconReportGetResponse'
1837
+
1838
+ # auth_names
1839
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1840
+
1841
+ new_options = opts.merge(
1842
+ :operation => :"PlaidApi.beacon_report_get",
1843
+ :header_params => header_params,
1844
+ :query_params => query_params,
1845
+ :form_params => form_params,
1846
+ :body => post_body,
1847
+ :auth_names => auth_names,
1848
+ :return_type => return_type
1849
+ )
1850
+
1851
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1852
+ if @api_client.config.debugging
1853
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1854
+ end
1855
+ return data, status_code, headers
1856
+ end
1857
+
1722
1858
  # List Beacon Reports for a Beacon User
1723
1859
  # Use the `/beacon/report/list` endpoint to view all Beacon Reports you created for a specific Beacon User. The reports returned by this endpoint are exclusively reports you created for a specific user. A Beacon User can only have one active report at a time, but a new report can be created if a previous report has been deleted. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
1724
1860
  # @param beacon_report_list_request [BeaconReportListRequest]
@@ -1787,6 +1923,74 @@ module Plaid
1787
1923
  return data, status_code, headers
1788
1924
  end
1789
1925
 
1926
+ # Get a Beacon Report Syndication
1927
+ # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
1928
+ # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest]
1929
+ # @param [Hash] opts the optional parameters
1930
+ # @return [BeaconReportSyndicationGetResponse]
1931
+ def beacon_report_syndication_get(beacon_report_syndication_get_request, opts = {})
1932
+ data, _status_code, _headers = beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts)
1933
+ data
1934
+ end
1935
+
1936
+ # Get a Beacon Report Syndication
1937
+ # Returns a Beacon Report Syndication for a given Beacon Report Syndication id.
1938
+ # @param beacon_report_syndication_get_request [BeaconReportSyndicationGetRequest]
1939
+ # @param [Hash] opts the optional parameters
1940
+ # @return [Array<(BeaconReportSyndicationGetResponse, Integer, Hash)>] BeaconReportSyndicationGetResponse data, response status code and response headers
1941
+ def beacon_report_syndication_get_with_http_info(beacon_report_syndication_get_request, opts = {})
1942
+ if @api_client.config.debugging
1943
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_syndication_get ...'
1944
+ end
1945
+ # verify the required parameter 'beacon_report_syndication_get_request' is set
1946
+ if @api_client.config.client_side_validation && beacon_report_syndication_get_request.nil?
1947
+ fail ArgumentError, "Missing the required parameter 'beacon_report_syndication_get_request' when calling PlaidApi.beacon_report_syndication_get"
1948
+ end
1949
+ # resource path
1950
+ local_var_path = '/beacon/report_syndication/get'
1951
+
1952
+ # query parameters
1953
+ query_params = opts[:query_params] || {}
1954
+
1955
+ # header parameters
1956
+ header_params = opts[:header_params] || {}
1957
+ # HTTP header 'Accept' (if needed)
1958
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1959
+ # HTTP header 'Content-Type'
1960
+ content_type = @api_client.select_header_content_type(['application/json'])
1961
+ if !content_type.nil?
1962
+ header_params['Content-Type'] = content_type
1963
+ end
1964
+
1965
+ # form parameters
1966
+ form_params = opts[:form_params] || {}
1967
+
1968
+ # http body (model)
1969
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_syndication_get_request)
1970
+
1971
+ # return_type
1972
+ return_type = opts[:debug_return_type] || 'BeaconReportSyndicationGetResponse'
1973
+
1974
+ # auth_names
1975
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1976
+
1977
+ new_options = opts.merge(
1978
+ :operation => :"PlaidApi.beacon_report_syndication_get",
1979
+ :header_params => header_params,
1980
+ :query_params => query_params,
1981
+ :form_params => form_params,
1982
+ :body => post_body,
1983
+ :auth_names => auth_names,
1984
+ :return_type => return_type
1985
+ )
1986
+
1987
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1988
+ if @api_client.config.debugging
1989
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_report_syndication_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1990
+ end
1991
+ return data, status_code, headers
1992
+ end
1993
+
1790
1994
  # List Beacon Report Syndications for a Beacon User
1791
1995
  # Use the `/beacon/report_syndication/list` endpoint to view all Beacon Reports that have been syndicated to a specific Beacon User. This endpoint returns Beacon Report Syndications which are references to Beacon Reports created either by you, or another Beacon customer, that matched the specified Beacon User. A Beacon User can have multiple active Beacon Report Syndications at once. The results from this endpoint are paginated; the `next_cursor` field will be populated if there is another page of results that can be retrieved. To fetch the next page, pass the `next_cursor` value as the `cursor` parameter in the next request.
1792
1996
  # @param beacon_report_syndication_list_request [BeaconReportSyndicationListRequest]
@@ -2059,6 +2263,74 @@ module Plaid
2059
2263
  return data, status_code, headers
2060
2264
  end
2061
2265
 
2266
+ # Update the identity data of a Beacon User
2267
+ # Update the identity data for a Beacon User in your Beacon Program. Similar to `/beacon/user/create`, several checks are performed immediately when you submit a change to `/beacon/user/update`: - The user's updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User's identity data before and after the update is retained as separate versions.
2268
+ # @param beacon_user_update_request [BeaconUserUpdateRequest]
2269
+ # @param [Hash] opts the optional parameters
2270
+ # @return [BeaconUserUpdateResponse]
2271
+ def beacon_user_update(beacon_user_update_request, opts = {})
2272
+ data, _status_code, _headers = beacon_user_update_with_http_info(beacon_user_update_request, opts)
2273
+ data
2274
+ end
2275
+
2276
+ # Update the identity data of a Beacon User
2277
+ # Update the identity data for a Beacon User in your Beacon Program. Similar to &#x60;/beacon/user/create&#x60;, several checks are performed immediately when you submit a change to &#x60;/beacon/user/update&#x60;: - The user&#39;s updated PII is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s updated PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud. Plaid maintains a version history for each Beacon User, so the Beacon User&#39;s identity data before and after the update is retained as separate versions.
2278
+ # @param beacon_user_update_request [BeaconUserUpdateRequest]
2279
+ # @param [Hash] opts the optional parameters
2280
+ # @return [Array<(BeaconUserUpdateResponse, Integer, Hash)>] BeaconUserUpdateResponse data, response status code and response headers
2281
+ def beacon_user_update_with_http_info(beacon_user_update_request, opts = {})
2282
+ if @api_client.config.debugging
2283
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_update ...'
2284
+ end
2285
+ # verify the required parameter 'beacon_user_update_request' is set
2286
+ if @api_client.config.client_side_validation && beacon_user_update_request.nil?
2287
+ fail ArgumentError, "Missing the required parameter 'beacon_user_update_request' when calling PlaidApi.beacon_user_update"
2288
+ end
2289
+ # resource path
2290
+ local_var_path = '/beacon/user/update'
2291
+
2292
+ # query parameters
2293
+ query_params = opts[:query_params] || {}
2294
+
2295
+ # header parameters
2296
+ header_params = opts[:header_params] || {}
2297
+ # HTTP header 'Accept' (if needed)
2298
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2299
+ # HTTP header 'Content-Type'
2300
+ content_type = @api_client.select_header_content_type(['application/json'])
2301
+ if !content_type.nil?
2302
+ header_params['Content-Type'] = content_type
2303
+ end
2304
+
2305
+ # form parameters
2306
+ form_params = opts[:form_params] || {}
2307
+
2308
+ # http body (model)
2309
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_update_request)
2310
+
2311
+ # return_type
2312
+ return_type = opts[:debug_return_type] || 'BeaconUserUpdateResponse'
2313
+
2314
+ # auth_names
2315
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2316
+
2317
+ new_options = opts.merge(
2318
+ :operation => :"PlaidApi.beacon_user_update",
2319
+ :header_params => header_params,
2320
+ :query_params => query_params,
2321
+ :form_params => form_params,
2322
+ :body => post_body,
2323
+ :auth_names => auth_names,
2324
+ :return_type => return_type
2325
+ )
2326
+
2327
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2328
+ if @api_client.config.debugging
2329
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_user_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2330
+ end
2331
+ return data, status_code, headers
2332
+ end
2333
+
2062
2334
  # Get categories
2063
2335
  # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
2064
2336
  # @param body [Object]
@@ -2195,6 +2467,74 @@ module Plaid
2195
2467
  return data, status_code, headers
2196
2468
  end
2197
2469
 
2470
+ # Retrieve cash flow insights from the bank accounts used for income verification
2471
+ # `/cra/partner_insights/get` returns cash flow insights for a specified user.
2472
+ # @param cra_partner_insights_get_request [CraPartnerInsightsGetRequest]
2473
+ # @param [Hash] opts the optional parameters
2474
+ # @return [CraPartnerInsightsGetResponse]
2475
+ def cra_partner_insights_get(cra_partner_insights_get_request, opts = {})
2476
+ data, _status_code, _headers = cra_partner_insights_get_with_http_info(cra_partner_insights_get_request, opts)
2477
+ data
2478
+ end
2479
+
2480
+ # Retrieve cash flow insights from the bank accounts used for income verification
2481
+ # &#x60;/cra/partner_insights/get&#x60; returns cash flow insights for a specified user.
2482
+ # @param cra_partner_insights_get_request [CraPartnerInsightsGetRequest]
2483
+ # @param [Hash] opts the optional parameters
2484
+ # @return [Array<(CraPartnerInsightsGetResponse, Integer, Hash)>] CraPartnerInsightsGetResponse data, response status code and response headers
2485
+ def cra_partner_insights_get_with_http_info(cra_partner_insights_get_request, opts = {})
2486
+ if @api_client.config.debugging
2487
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_partner_insights_get ...'
2488
+ end
2489
+ # verify the required parameter 'cra_partner_insights_get_request' is set
2490
+ if @api_client.config.client_side_validation && cra_partner_insights_get_request.nil?
2491
+ fail ArgumentError, "Missing the required parameter 'cra_partner_insights_get_request' when calling PlaidApi.cra_partner_insights_get"
2492
+ end
2493
+ # resource path
2494
+ local_var_path = '/cra/partner_insights/get'
2495
+
2496
+ # query parameters
2497
+ query_params = opts[:query_params] || {}
2498
+
2499
+ # header parameters
2500
+ header_params = opts[:header_params] || {}
2501
+ # HTTP header 'Accept' (if needed)
2502
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2503
+ # HTTP header 'Content-Type'
2504
+ content_type = @api_client.select_header_content_type(['application/json'])
2505
+ if !content_type.nil?
2506
+ header_params['Content-Type'] = content_type
2507
+ end
2508
+
2509
+ # form parameters
2510
+ form_params = opts[:form_params] || {}
2511
+
2512
+ # http body (model)
2513
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_partner_insights_get_request)
2514
+
2515
+ # return_type
2516
+ return_type = opts[:debug_return_type] || 'CraPartnerInsightsGetResponse'
2517
+
2518
+ # auth_names
2519
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2520
+
2521
+ new_options = opts.merge(
2522
+ :operation => :"PlaidApi.cra_partner_insights_get",
2523
+ :header_params => header_params,
2524
+ :query_params => query_params,
2525
+ :form_params => form_params,
2526
+ :body => post_body,
2527
+ :auth_names => auth_names,
2528
+ :return_type => return_type
2529
+ )
2530
+
2531
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2532
+ if @api_client.config.debugging
2533
+ @api_client.config.logger.debug "API called: PlaidApi#cra_partner_insights_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2534
+ end
2535
+ return data, status_code, headers
2536
+ end
2537
+
2198
2538
  # Create payment token
2199
2539
  # The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
2200
2540
  # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
@@ -3284,7 +3624,7 @@ module Plaid
3284
3624
  end
3285
3625
 
3286
3626
  # Retrieve fraud insights for a user's manually uploaded document(s).
3287
- # `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `fraud_risk`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
3627
+ # `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call `/link/token/create` with `parsing_config` set to include `risk_signals`, or call `/credit/payroll_income/parsing_config/update`. Once risk signal generation has been triggered, `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
3288
3628
  # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
3289
3629
  # @param [Hash] opts the optional parameters
3290
3630
  # @return [CreditPayrollIncomeRiskSignalsGetResponse]
@@ -3294,7 +3634,7 @@ module Plaid
3294
3634
  end
3295
3635
 
3296
3636
  # Retrieve fraud insights for a user&#39;s manually uploaded document(s).
3297
- # &#x60;/credit/payroll_income/risk_signals/get&#x60; can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call &#x60;/link/token/create&#x60; with &#x60;parsing_config&#x60; set to include &#x60;fraud_risk&#x60;, or call &#x60;/credit/payroll_income/parsing_config/update&#x60;. Once risk signal generation has been triggered, &#x60;/credit/payroll_income/risk_signals/get&#x60; can be called at any time after the &#x60;INCOME_VERIFICATION_RISK_SIGNALS&#x60; webhook has been fired. &#x60;/credit/payroll_income/risk_signals/get&#x60; is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
3637
+ # &#x60;/credit/payroll_income/risk_signals/get&#x60; can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. To trigger risk signal generation for an Item, call &#x60;/link/token/create&#x60; with &#x60;parsing_config&#x60; set to include &#x60;risk_signals&#x60;, or call &#x60;/credit/payroll_income/parsing_config/update&#x60;. Once risk signal generation has been triggered, &#x60;/credit/payroll_income/risk_signals/get&#x60; can be called at any time after the &#x60;INCOME_VERIFICATION_RISK_SIGNALS&#x60; webhook has been fired. &#x60;/credit/payroll_income/risk_signals/get&#x60; is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
3298
3638
  # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
3299
3639
  # @param [Hash] opts the optional parameters
3300
3640
  # @return [Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>] CreditPayrollIncomeRiskSignalsGetResponse data, response status code and response headers
@@ -4576,7 +4916,7 @@ module Plaid
4576
4916
  end
4577
4917
 
4578
4918
  # Refresh identity data
4579
- # `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/identity/#default_update). `/identity/refresh` is offered as an add-on to Identity 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.
4919
+ # `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur for any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/identity/#default_update). 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. `/identity/refresh` is offered as an add-on to Identity 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.
4580
4920
  # @param identity_refresh_request [IdentityRefreshRequest]
4581
4921
  # @param [Hash] opts the optional parameters
4582
4922
  # @return [IdentityRefreshResponse]
@@ -4586,7 +4926,7 @@ module Plaid
4586
4926
  end
4587
4927
 
4588
4928
  # Refresh identity data
4589
- # &#x60;/identity/refresh&#x60; is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling &#x60;/identity/refresh&#x60;, Plaid will fire a webhook [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/identity/#default_update). &#x60;/identity/refresh&#x60; is offered as an add-on to Identity 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.
4929
+ # &#x60;/identity/refresh&#x60; is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur for any Identity-enabled Item. If changes to Identity are discovered after calling &#x60;/identity/refresh&#x60;, Plaid will fire a webhook [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/identity/#default_update). 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;/identity/refresh&#x60; is offered as an add-on to Identity 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.
4590
4930
  # @param identity_refresh_request [IdentityRefreshRequest]
4591
4931
  # @param [Hash] opts the optional parameters
4592
4932
  # @return [Array<(IdentityRefreshResponse, Integer, Hash)>] IdentityRefreshResponse data, response status code and response headers
@@ -4643,7 +4983,75 @@ module Plaid
4643
4983
  return data, status_code, headers
4644
4984
  end
4645
4985
 
4646
- # Create a new identity verification
4986
+ # Create autofill for an Identity Verification
4987
+ # Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.
4988
+ # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
4989
+ # @param [Hash] opts the optional parameters
4990
+ # @return [IdentityVerificationAutofillCreateResponse]
4991
+ def identity_verification_autofill_create(identity_verification_autofill_create_request, opts = {})
4992
+ data, _status_code, _headers = identity_verification_autofill_create_with_http_info(identity_verification_autofill_create_request, opts)
4993
+ data
4994
+ end
4995
+
4996
+ # Create autofill for an Identity Verification
4997
+ # Try to autofill an Identity Verification based of the provided phone number, date of birth and country of residence.
4998
+ # @param identity_verification_autofill_create_request [IdentityVerificationAutofillCreateRequest]
4999
+ # @param [Hash] opts the optional parameters
5000
+ # @return [Array<(IdentityVerificationAutofillCreateResponse, Integer, Hash)>] IdentityVerificationAutofillCreateResponse data, response status code and response headers
5001
+ def identity_verification_autofill_create_with_http_info(identity_verification_autofill_create_request, opts = {})
5002
+ if @api_client.config.debugging
5003
+ @api_client.config.logger.debug 'Calling API: PlaidApi.identity_verification_autofill_create ...'
5004
+ end
5005
+ # verify the required parameter 'identity_verification_autofill_create_request' is set
5006
+ if @api_client.config.client_side_validation && identity_verification_autofill_create_request.nil?
5007
+ fail ArgumentError, "Missing the required parameter 'identity_verification_autofill_create_request' when calling PlaidApi.identity_verification_autofill_create"
5008
+ end
5009
+ # resource path
5010
+ local_var_path = '/identity_verification/autofill/create'
5011
+
5012
+ # query parameters
5013
+ query_params = opts[:query_params] || {}
5014
+
5015
+ # header parameters
5016
+ header_params = opts[:header_params] || {}
5017
+ # HTTP header 'Accept' (if needed)
5018
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5019
+ # HTTP header 'Content-Type'
5020
+ content_type = @api_client.select_header_content_type(['application/json'])
5021
+ if !content_type.nil?
5022
+ header_params['Content-Type'] = content_type
5023
+ end
5024
+
5025
+ # form parameters
5026
+ form_params = opts[:form_params] || {}
5027
+
5028
+ # http body (model)
5029
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_verification_autofill_create_request)
5030
+
5031
+ # return_type
5032
+ return_type = opts[:debug_return_type] || 'IdentityVerificationAutofillCreateResponse'
5033
+
5034
+ # auth_names
5035
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5036
+
5037
+ new_options = opts.merge(
5038
+ :operation => :"PlaidApi.identity_verification_autofill_create",
5039
+ :header_params => header_params,
5040
+ :query_params => query_params,
5041
+ :form_params => form_params,
5042
+ :body => post_body,
5043
+ :auth_names => auth_names,
5044
+ :return_type => return_type
5045
+ )
5046
+
5047
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5048
+ if @api_client.config.debugging
5049
+ @api_client.config.logger.debug "API called: PlaidApi#identity_verification_autofill_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5050
+ end
5051
+ return data, status_code, headers
5052
+ end
5053
+
5054
+ # Create a new Identity Verification
4647
5055
  # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
4648
5056
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
4649
5057
  # @param [Hash] opts the optional parameters
@@ -4653,7 +5061,7 @@ module Plaid
4653
5061
  data
4654
5062
  end
4655
5063
 
4656
- # Create a new identity verification
5064
+ # Create a new Identity Verification
4657
5065
  # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
4658
5066
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
4659
5067
  # @param [Hash] opts the optional parameters
@@ -4712,7 +5120,7 @@ module Plaid
4712
5120
  end
4713
5121
 
4714
5122
  # Retrieve Identity Verification
4715
- # Retrieve a previously created identity verification.
5123
+ # Retrieve a previously created Identity Verification.
4716
5124
  # @param identity_verification_get_request [IdentityVerificationGetRequest]
4717
5125
  # @param [Hash] opts the optional parameters
4718
5126
  # @return [IdentityVerificationGetResponse]
@@ -4722,7 +5130,7 @@ module Plaid
4722
5130
  end
4723
5131
 
4724
5132
  # Retrieve Identity Verification
4725
- # Retrieve a previously created identity verification.
5133
+ # Retrieve a previously created Identity Verification.
4726
5134
  # @param identity_verification_get_request [IdentityVerificationGetRequest]
4727
5135
  # @param [Hash] opts the optional parameters
4728
5136
  # @return [Array<(IdentityVerificationGetResponse, Integer, Hash)>] IdentityVerificationGetResponse data, response status code and response headers
@@ -4848,7 +5256,7 @@ module Plaid
4848
5256
  end
4849
5257
 
4850
5258
  # Retry an Identity Verification
4851
- # Allow a customer to retry their identity verification
5259
+ # Allow a customer to retry their Identity Verification
4852
5260
  # @param identity_verification_retry_request [IdentityVerificationRetryRequest]
4853
5261
  # @param [Hash] opts the optional parameters
4854
5262
  # @return [IdentityVerificationRetryResponse]
@@ -4858,7 +5266,7 @@ module Plaid
4858
5266
  end
4859
5267
 
4860
5268
  # Retry an Identity Verification
4861
- # Allow a customer to retry their identity verification
5269
+ # Allow a customer to retry their Identity Verification
4862
5270
  # @param identity_verification_retry_request [IdentityVerificationRetryRequest]
4863
5271
  # @param [Hash] opts the optional parameters
4864
5272
  # @return [Array<(IdentityVerificationRetryResponse, Integer, Hash)>] IdentityVerificationRetryResponse data, response status code and response headers
@@ -5596,7 +6004,7 @@ module Plaid
5596
6004
  end
5597
6005
 
5598
6006
  # Refresh investment data
5599
- # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a 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. `/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.
6007
+ # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment 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.
5600
6008
  # @param investments_refresh_request [InvestmentsRefreshRequest]
5601
6009
  # @param [Hash] opts the optional parameters
5602
6010
  # @return [InvestmentsRefreshResponse]
@@ -5606,7 +6014,7 @@ module Plaid
5606
6014
  end
5607
6015
 
5608
6016
  # Refresh investment data
5609
- # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a 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 [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 &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. \&quot;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. &#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.
6017
+ # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment 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 [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 &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. \&quot;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.
5610
6018
  # @param investments_refresh_request [InvestmentsRefreshRequest]
5611
6019
  # @param [Hash] opts the optional parameters
5612
6020
  # @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
@@ -8655,8 +9063,76 @@ module Plaid
8655
9063
  return data, status_code, headers
8656
9064
  end
8657
9065
 
9066
+ # Retrieve Liabilities data
9067
+ # 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.
9068
+ # @param processor_liabilities_get_request [ProcessorLiabilitiesGetRequest]
9069
+ # @param [Hash] opts the optional parameters
9070
+ # @return [ProcessorLiabilitiesGetResponse]
9071
+ def processor_liabilities_get(processor_liabilities_get_request, opts = {})
9072
+ data, _status_code, _headers = processor_liabilities_get_with_http_info(processor_liabilities_get_request, opts)
9073
+ data
9074
+ end
9075
+
9076
+ # Retrieve Liabilities data
9077
+ # The &#x60;/processor/liabilities/get&#x60; 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 &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/processor/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; 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.
9078
+ # @param processor_liabilities_get_request [ProcessorLiabilitiesGetRequest]
9079
+ # @param [Hash] opts the optional parameters
9080
+ # @return [Array<(ProcessorLiabilitiesGetResponse, Integer, Hash)>] ProcessorLiabilitiesGetResponse data, response status code and response headers
9081
+ def processor_liabilities_get_with_http_info(processor_liabilities_get_request, opts = {})
9082
+ if @api_client.config.debugging
9083
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_liabilities_get ...'
9084
+ end
9085
+ # verify the required parameter 'processor_liabilities_get_request' is set
9086
+ if @api_client.config.client_side_validation && processor_liabilities_get_request.nil?
9087
+ fail ArgumentError, "Missing the required parameter 'processor_liabilities_get_request' when calling PlaidApi.processor_liabilities_get"
9088
+ end
9089
+ # resource path
9090
+ local_var_path = '/processor/liabilities/get'
9091
+
9092
+ # query parameters
9093
+ query_params = opts[:query_params] || {}
9094
+
9095
+ # header parameters
9096
+ header_params = opts[:header_params] || {}
9097
+ # HTTP header 'Accept' (if needed)
9098
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9099
+ # HTTP header 'Content-Type'
9100
+ content_type = @api_client.select_header_content_type(['application/json'])
9101
+ if !content_type.nil?
9102
+ header_params['Content-Type'] = content_type
9103
+ end
9104
+
9105
+ # form parameters
9106
+ form_params = opts[:form_params] || {}
9107
+
9108
+ # http body (model)
9109
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_liabilities_get_request)
9110
+
9111
+ # return_type
9112
+ return_type = opts[:debug_return_type] || 'ProcessorLiabilitiesGetResponse'
9113
+
9114
+ # auth_names
9115
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9116
+
9117
+ new_options = opts.merge(
9118
+ :operation => :"PlaidApi.processor_liabilities_get",
9119
+ :header_params => header_params,
9120
+ :query_params => query_params,
9121
+ :form_params => form_params,
9122
+ :body => post_body,
9123
+ :auth_names => auth_names,
9124
+ :return_type => return_type
9125
+ )
9126
+
9127
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9128
+ if @api_client.config.debugging
9129
+ @api_client.config.logger.debug "API called: PlaidApi#processor_liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9130
+ end
9131
+ return data, status_code, headers
9132
+ end
9133
+
8658
9134
  # Report whether you initiated an ACH transaction
8659
- # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated.
9135
+ # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
8660
9136
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
8661
9137
  # @param [Hash] opts the optional parameters
8662
9138
  # @return [ProcessorSignalDecisionReportResponse]
@@ -8666,7 +9142,7 @@ module Plaid
8666
9142
  end
8667
9143
 
8668
9144
  # Report whether you initiated an ACH transaction
8669
- # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated.
9145
+ # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was initiated.
8670
9146
  # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
8671
9147
  # @param [Hash] opts the optional parameters
8672
9148
  # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
@@ -8860,7 +9336,7 @@ module Plaid
8860
9336
  end
8861
9337
 
8862
9338
  # Report a return for an ACH transaction
8863
- # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
9339
+ # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
8864
9340
  # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
8865
9341
  # @param [Hash] opts the optional parameters
8866
9342
  # @return [ProcessorSignalReturnReportResponse]
@@ -8870,7 +9346,7 @@ module Plaid
8870
9346
  end
8871
9347
 
8872
9348
  # Report a return for an ACH transaction
8873
- # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
9349
+ # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio. If you are using the [Plaid Transfer product](https://www.plaid.com/docs/transfer) to create transfers, it is not necessary to use this endpoint, as Plaid already knows whether the transfer was returned.
8874
9350
  # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
8875
9351
  # @param [Hash] opts the optional parameters
8876
9352
  # @return [Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>] ProcessorSignalReturnReportResponse data, response status code and response headers
@@ -9404,7 +9880,7 @@ module Plaid
9404
9880
  end
9405
9881
 
9406
9882
  # Refresh transaction data
9407
- # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on a processor token from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9883
+ # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on a processor token from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9408
9884
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
9409
9885
  # @param [Hash] opts the optional parameters
9410
9886
  # @return [ProcessorTransactionsRefreshResponse]
@@ -9414,7 +9890,7 @@ module Plaid
9414
9890
  end
9415
9891
 
9416
9892
  # Refresh transaction data
9417
- # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on a processor token from that institution. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9893
+ # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur one or more times per day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on a processor token from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
9418
9894
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
9419
9895
  # @param [Hash] opts the optional parameters
9420
9896
  # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
@@ -9539,6 +10015,74 @@ module Plaid
9539
10015
  return data, status_code, headers
9540
10016
  end
9541
10017
 
10018
+ # Retrieve a Profile
10019
+ # Returns user permissioned profile data including identity and item access tokens.
10020
+ # @param profile_get_request [ProfileGetRequest]
10021
+ # @param [Hash] opts the optional parameters
10022
+ # @return [ProfileGetResponse]
10023
+ def profile_get(profile_get_request, opts = {})
10024
+ data, _status_code, _headers = profile_get_with_http_info(profile_get_request, opts)
10025
+ data
10026
+ end
10027
+
10028
+ # Retrieve a Profile
10029
+ # Returns user permissioned profile data including identity and item access tokens.
10030
+ # @param profile_get_request [ProfileGetRequest]
10031
+ # @param [Hash] opts the optional parameters
10032
+ # @return [Array<(ProfileGetResponse, Integer, Hash)>] ProfileGetResponse data, response status code and response headers
10033
+ def profile_get_with_http_info(profile_get_request, opts = {})
10034
+ if @api_client.config.debugging
10035
+ @api_client.config.logger.debug 'Calling API: PlaidApi.profile_get ...'
10036
+ end
10037
+ # verify the required parameter 'profile_get_request' is set
10038
+ if @api_client.config.client_side_validation && profile_get_request.nil?
10039
+ fail ArgumentError, "Missing the required parameter 'profile_get_request' when calling PlaidApi.profile_get"
10040
+ end
10041
+ # resource path
10042
+ local_var_path = '/profile/get'
10043
+
10044
+ # query parameters
10045
+ query_params = opts[:query_params] || {}
10046
+
10047
+ # header parameters
10048
+ header_params = opts[:header_params] || {}
10049
+ # HTTP header 'Accept' (if needed)
10050
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10051
+ # HTTP header 'Content-Type'
10052
+ content_type = @api_client.select_header_content_type(['application/json'])
10053
+ if !content_type.nil?
10054
+ header_params['Content-Type'] = content_type
10055
+ end
10056
+
10057
+ # form parameters
10058
+ form_params = opts[:form_params] || {}
10059
+
10060
+ # http body (model)
10061
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(profile_get_request)
10062
+
10063
+ # return_type
10064
+ return_type = opts[:debug_return_type] || 'ProfileGetResponse'
10065
+
10066
+ # auth_names
10067
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10068
+
10069
+ new_options = opts.merge(
10070
+ :operation => :"PlaidApi.profile_get",
10071
+ :header_params => header_params,
10072
+ :query_params => query_params,
10073
+ :form_params => form_params,
10074
+ :body => post_body,
10075
+ :auth_names => auth_names,
10076
+ :return_type => return_type
10077
+ )
10078
+
10079
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10080
+ if @api_client.config.debugging
10081
+ @api_client.config.logger.debug "API called: PlaidApi#profile_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10082
+ end
10083
+ return data, status_code, headers
10084
+ end
10085
+
9542
10086
  # Manually fire a bank income webhook in sandbox
9543
10087
  # Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
9544
10088
  # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
@@ -9948,7 +10492,7 @@ module Plaid
9948
10492
  end
9949
10493
 
9950
10494
  # Set verification status for Sandbox account
9951
- # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
10495
+ # The `/sandbox/item/set_verification_status` endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
9952
10496
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
9953
10497
  # @param [Hash] opts the optional parameters
9954
10498
  # @return [SandboxItemSetVerificationStatusResponse]
@@ -9958,7 +10502,7 @@ module Plaid
9958
10502
  end
9959
10503
 
9960
10504
  # Set verification status for Sandbox account
9961
- # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. Note that not all Plaid developer accounts are enabled for micro-deposit based verification by default. Your account must be enabled for this feature in order to test it in Sandbox. To enable this features or check your status, contact your account manager or [submit a product access Support ticket](https://dashboard.plaid.com/support/new/product-and-development/product-troubleshooting/request-product-access). For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
10505
+ # The &#x60;/sandbox/item/set_verification_status&#x60; endpoint can be used to change the verification status of an Item in in the Sandbox in order to simulate the Automated Micro-deposit flow. For more information on testing Automated Micro-deposits in Sandbox, see [Auth full coverage testing](https://plaid.com/docs/auth/coverage/testing#).
9962
10506
  # @param sandbox_item_set_verification_status_request [SandboxItemSetVerificationStatusRequest]
9963
10507
  # @param [Hash] opts the optional parameters
9964
10508
  # @return [Array<(SandboxItemSetVerificationStatusResponse, Integer, Hash)>] SandboxItemSetVerificationStatusResponse data, response status code and response headers
@@ -11240,7 +11784,7 @@ module Plaid
11240
11784
  end
11241
11785
 
11242
11786
  # Opt-in an Item to Signal
11243
- # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account and routing number, call `/identity/get` to retrieve bank ownership details, then call `/signal/prepare` to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
11787
+ # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
11244
11788
  # @param signal_prepare_request [SignalPrepareRequest]
11245
11789
  # @param [Hash] opts the optional parameters
11246
11790
  # @return [SignalPrepareResponse]
@@ -11250,7 +11794,7 @@ module Plaid
11250
11794
  end
11251
11795
 
11252
11796
  # Opt-in an Item to Signal
11253
- # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account and routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, then call &#x60;/signal/prepare&#x60; to begin Signal data collection. Later, once you have obtained details about the proposed transaction from the user, call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](https://www.plaid.com/docs/link/initializing-products/#recommendations-for-initializing-link-with-specific-product-combinations). If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
11797
+ # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If run on an Item that is already initialized with Signal, this endpoint will return a 200 response and will not modify the Item.
11254
11798
  # @param signal_prepare_request [SignalPrepareRequest]
11255
11799
  # @param [Hash] opts the optional parameters
11256
11800
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -11511,6 +12055,74 @@ module Plaid
11511
12055
  return data, status_code, headers
11512
12056
  end
11513
12057
 
12058
+ # Refresh statements data.
12059
+ # `/statements/refresh` initiates an on-demand extraction to fetch the statements for the provided dates.
12060
+ # @param statements_refresh_request [StatementsRefreshRequest]
12061
+ # @param [Hash] opts the optional parameters
12062
+ # @return [StatementsRefreshResponse]
12063
+ def statements_refresh(statements_refresh_request, opts = {})
12064
+ data, _status_code, _headers = statements_refresh_with_http_info(statements_refresh_request, opts)
12065
+ data
12066
+ end
12067
+
12068
+ # Refresh statements data.
12069
+ # &#x60;/statements/refresh&#x60; initiates an on-demand extraction to fetch the statements for the provided dates.
12070
+ # @param statements_refresh_request [StatementsRefreshRequest]
12071
+ # @param [Hash] opts the optional parameters
12072
+ # @return [Array<(StatementsRefreshResponse, Integer, Hash)>] StatementsRefreshResponse data, response status code and response headers
12073
+ def statements_refresh_with_http_info(statements_refresh_request, opts = {})
12074
+ if @api_client.config.debugging
12075
+ @api_client.config.logger.debug 'Calling API: PlaidApi.statements_refresh ...'
12076
+ end
12077
+ # verify the required parameter 'statements_refresh_request' is set
12078
+ if @api_client.config.client_side_validation && statements_refresh_request.nil?
12079
+ fail ArgumentError, "Missing the required parameter 'statements_refresh_request' when calling PlaidApi.statements_refresh"
12080
+ end
12081
+ # resource path
12082
+ local_var_path = '/statements/refresh'
12083
+
12084
+ # query parameters
12085
+ query_params = opts[:query_params] || {}
12086
+
12087
+ # header parameters
12088
+ header_params = opts[:header_params] || {}
12089
+ # HTTP header 'Accept' (if needed)
12090
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
12091
+ # HTTP header 'Content-Type'
12092
+ content_type = @api_client.select_header_content_type(['application/json'])
12093
+ if !content_type.nil?
12094
+ header_params['Content-Type'] = content_type
12095
+ end
12096
+
12097
+ # form parameters
12098
+ form_params = opts[:form_params] || {}
12099
+
12100
+ # http body (model)
12101
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_refresh_request)
12102
+
12103
+ # return_type
12104
+ return_type = opts[:debug_return_type] || 'StatementsRefreshResponse'
12105
+
12106
+ # auth_names
12107
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
12108
+
12109
+ new_options = opts.merge(
12110
+ :operation => :"PlaidApi.statements_refresh",
12111
+ :header_params => header_params,
12112
+ :query_params => query_params,
12113
+ :form_params => form_params,
12114
+ :body => post_body,
12115
+ :auth_names => auth_names,
12116
+ :return_type => return_type
12117
+ )
12118
+
12119
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
12120
+ if @api_client.config.debugging
12121
+ @api_client.config.logger.debug "API called: PlaidApi#statements_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
12122
+ end
12123
+ return data, status_code, headers
12124
+ end
12125
+
11514
12126
  # enhance locally-held transaction data
11515
12127
  # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
11516
12128
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
@@ -11716,7 +12328,7 @@ module Plaid
11716
12328
  end
11717
12329
 
11718
12330
  # Fetch recurring transaction streams
11719
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
12331
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get` or `/transactions/sync`). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [`days_requested`](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
11720
12332
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
11721
12333
  # @param [Hash] opts the optional parameters
11722
12334
  # @return [TransactionsRecurringGetResponse]
@@ -11726,7 +12338,7 @@ module Plaid
11726
12338
  end
11727
12339
 
11728
12340
  # Fetch recurring transaction streams
11729
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
12341
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;). For optimal results, we strongly recommend customers using Recurring Transactions to request at least 180 days of history when initializing items with Transactions (using the [&#x60;days_requested&#x60;](https://plaid.com/docs/api/tokens/#link-token-create-request-transactions-days-requested) option). Once all historical transactions have been fetched, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
11730
12342
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
11731
12343
  # @param [Hash] opts the optional parameters
11732
12344
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -11784,7 +12396,7 @@ module Plaid
11784
12396
  end
11785
12397
 
11786
12398
  # Refresh transaction data
11787
- # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
12399
+ # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest 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 Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Note that the `/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. `/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
11788
12400
  # @param transactions_refresh_request [TransactionsRefreshRequest]
11789
12401
  # @param [Hash] opts the optional parameters
11790
12402
  # @return [TransactionsRefreshResponse]
@@ -11794,7 +12406,7 @@ module Plaid
11794
12406
  end
11795
12407
 
11796
12408
  # Refresh transaction data
11797
- # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on an Item from that institution. &#x60;/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
12409
+ # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for 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 Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Note that the &#x60;/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on an Item from that institution. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints (typically less than 10 seconds, but occasionally up to 30 seconds or more); if you encounter errors, you may find it necessary to adjust your timeout period when making requests. &#x60;/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
11798
12410
  # @param transactions_refresh_request [TransactionsRefreshRequest]
11799
12411
  # @param [Hash] opts the optional parameters
11800
12412
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
@@ -13484,7 +14096,7 @@ module Plaid
13484
14096
  end
13485
14097
 
13486
14098
  # Migrate account into Transfers
13487
- # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
14099
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. If you intend to create wire transfers on this account, you must provide `wire_routing_number`. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
13488
14100
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
13489
14101
  # @param [Hash] opts the optional parameters
13490
14102
  # @return [TransferMigrateAccountResponse]
@@ -13494,7 +14106,7 @@ module Plaid
13494
14106
  end
13495
14107
 
13496
14108
  # Migrate account into Transfers
13497
- # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
14109
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. If you intend to create wire transfers on this account, you must provide &#x60;wire_routing_number&#x60;. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
13498
14110
  # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
13499
14111
  # @param [Hash] opts the optional parameters
13500
14112
  # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers