plaid 37.0.0 → 53.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2295) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +1677 -0
  3. data/Dockerfile +4 -3
  4. data/Gemfile.lock +11 -17
  5. data/Makefile +1 -1
  6. data/README.md +8 -2
  7. data/lib/plaid/api/plaid_api.rb +8476 -4658
  8. data/lib/plaid/api_client.rb +4 -7
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +8 -1
  11. data/lib/plaid/models/aamva_analysis.rb +430 -0
  12. data/lib/plaid/models/aamva_detailed_match_result.rb +41 -0
  13. data/lib/plaid/models/aamva_match_result.rb +40 -0
  14. data/lib/plaid/models/account_access.rb +2 -2
  15. data/lib/plaid/models/account_assets.rb +19 -19
  16. data/lib/plaid/models/account_balance.rb +5 -5
  17. data/lib/plaid/models/account_base.rb +34 -12
  18. data/lib/plaid/models/account_base_nullable.rb +34 -12
  19. data/lib/plaid/models/account_filter.rb +1 -1
  20. data/lib/plaid/models/account_filters_response.rb +1 -1
  21. data/lib/plaid/models/account_holder_category.rb +1 -1
  22. data/lib/plaid/models/account_identity.rb +30 -12
  23. data/lib/plaid/models/account_identity_all_of.rb +41 -3
  24. data/lib/plaid/models/account_identity_document_upload.rb +31 -9
  25. data/lib/plaid/models/account_identity_document_upload_all_of.rb +2 -2
  26. data/lib/plaid/models/account_identity_match_score.rb +49 -15
  27. data/lib/plaid/models/account_identity_match_score_all_of.rb +60 -6
  28. data/lib/plaid/models/account_insights.rb +231 -0
  29. data/lib/plaid/models/account_product_access.rb +1 -1
  30. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  31. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  32. data/lib/plaid/models/account_subtype.rb +12 -1
  33. data/lib/plaid/models/account_type.rb +1 -1
  34. data/lib/plaid/models/account_verification_insights.rb +2 -2
  35. data/lib/plaid/models/account_verification_insights_account_number_format.rb +1 -1
  36. data/lib/plaid/models/account_verification_insights_network_status.rb +1 -1
  37. data/lib/plaid/models/account_verification_insights_previous_returns.rb +2 -2
  38. data/lib/plaid/models/accounts_balance_get_request.rb +6 -16
  39. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  40. data/lib/plaid/models/accounts_get_request.rb +2 -2
  41. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  42. data/lib/plaid/models/accounts_get_response.rb +2 -12
  43. data/lib/plaid/models/ach_class.rb +1 -1
  44. data/lib/plaid/models/action_state.rb +1 -1
  45. data/lib/plaid/models/activity.rb +2 -2
  46. data/lib/plaid/models/activity_type.rb +1 -1
  47. data/lib/plaid/models/address.rb +1 -1
  48. data/lib/plaid/models/address_data.rb +2 -6
  49. data/lib/plaid/models/address_data_not_required.rb +2 -1
  50. data/lib/plaid/models/address_data_nullable.rb +2 -6
  51. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +2 -1
  52. data/lib/plaid/models/address_data_override.rb +276 -0
  53. data/lib/plaid/models/address_match_score.rb +1 -1
  54. data/lib/plaid/models/address_nullable.rb +1 -1
  55. data/lib/plaid/models/address_override.rb +240 -0
  56. data/lib/plaid/models/address_purpose_label.rb +1 -1
  57. data/lib/plaid/models/affordability_insights.rb +231 -0
  58. data/lib/plaid/models/amount.rb +238 -0
  59. data/lib/plaid/models/amount_with_currency.rb +244 -0
  60. data/lib/plaid/models/amount_with_currency_with_monthly_average.rb +252 -0
  61. data/lib/plaid/models/application.rb +8 -8
  62. data/lib/plaid/models/application_get_request.rb +2 -2
  63. data/lib/plaid/models/application_get_response.rb +1 -1
  64. data/lib/plaid/models/{last_data_access_times.rb → application_last_data_access_times.rb} +29 -51
  65. data/lib/plaid/models/apr.rb +3 -3
  66. data/lib/plaid/models/asset.rb +1 -1
  67. data/lib/plaid/models/asset_detail.rb +154 -9
  68. data/lib/plaid/models/asset_holder.rb +1 -1
  69. data/lib/plaid/models/asset_holder_name.rb +1 -1
  70. data/lib/plaid/models/asset_holding.rb +378 -0
  71. data/lib/plaid/models/{transactions_enhance_get_response.rb → asset_holdings.rb} +16 -17
  72. data/lib/plaid/models/asset_investment_transaction_type.rb +45 -0
  73. data/lib/plaid/models/asset_owner.rb +1 -1
  74. data/lib/plaid/models/asset_owners.rb +2 -2
  75. data/lib/plaid/models/asset_report.rb +11 -2
  76. data/lib/plaid/models/asset_report_account_balance.rb +4 -4
  77. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
  79. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  80. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_pdf_get_request.rb +255 -0
  82. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  83. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  84. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  85. data/lib/plaid/models/asset_report_create_request_options.rb +3 -3
  86. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  87. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  88. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  89. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  90. data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
  91. data/lib/plaid/models/asset_report_freddie_get_response.rb +2 -2
  92. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  93. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  94. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  95. data/lib/plaid/models/asset_report_insights.rb +237 -0
  96. data/lib/plaid/models/asset_report_investment_holding.rb +41 -18
  97. data/lib/plaid/models/asset_report_investment_security.rb +2 -2
  98. data/lib/plaid/models/asset_report_investment_transaction.rb +5 -35
  99. data/lib/plaid/models/asset_report_investments.rb +1 -1
  100. data/lib/plaid/models/asset_report_item.rb +2 -2
  101. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  102. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  103. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  104. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  105. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  106. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  107. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  108. data/lib/plaid/models/asset_report_transaction.rb +4 -4
  109. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  110. data/lib/plaid/models/asset_report_type.rb +1 -1
  111. data/lib/plaid/models/asset_report_user.rb +3 -3
  112. data/lib/plaid/models/asset_transaction.rb +2 -2
  113. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  114. data/lib/plaid/models/asset_transaction_description.rb +2 -2
  115. data/lib/plaid/models/asset_transaction_detail.rb +34 -2
  116. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  117. data/lib/plaid/models/asset_transactions.rb +1 -1
  118. data/lib/plaid/models/asset_type.rb +1 -1
  119. data/lib/plaid/models/assets.rb +1 -1
  120. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  121. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  122. data/lib/plaid/models/auth_default_update_webhook.rb +2 -2
  123. data/lib/plaid/models/auth_get_numbers.rb +3 -3
  124. data/lib/plaid/models/auth_get_request.rb +2 -2
  125. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  126. data/lib/plaid/models/auth_get_response.rb +2 -2
  127. data/lib/plaid/models/auth_metadata.rb +1 -1
  128. data/lib/plaid/models/auth_supported_methods.rb +3 -3
  129. data/lib/plaid/models/auth_update_types.rb +4 -3
  130. data/lib/plaid/models/auth_verify_numbers_ach.rb +241 -0
  131. data/lib/plaid/models/auth_verify_request.rb +256 -0
  132. data/lib/plaid/models/auth_verify_request_numbers.rb +225 -0
  133. data/lib/plaid/models/auth_verify_response.rb +266 -0
  134. data/lib/plaid/models/authorization_guarantee_details.rb +264 -0
  135. data/lib/plaid/models/authorization_guarantee_schedule_item.rb +241 -0
  136. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  137. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  138. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  139. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  140. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +2 -2
  141. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +2 -2
  142. data/lib/plaid/models/bank_initiated_return_risk.rb +3 -3
  143. data/lib/plaid/models/bank_penalties_indicators.rb +311 -0
  144. data/lib/plaid/models/bank_transfer.rb +3 -3
  145. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  146. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  147. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  148. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  149. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  150. data/lib/plaid/models/bank_transfer_create_request.rb +3 -3
  151. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  152. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  153. data/lib/plaid/models/bank_transfer_event.rb +18 -8
  154. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  155. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  156. data/lib/plaid/models/bank_transfer_event_list_request.rb +2 -2
  157. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  158. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  159. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  160. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  161. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  162. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  163. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  164. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  165. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  166. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  167. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  168. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  169. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  170. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  171. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  172. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  173. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  174. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  175. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  176. data/lib/plaid/models/bank_transfer_user.rb +3 -3
  177. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  178. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +2 -2
  179. data/lib/plaid/models/base_report.rb +2 -2
  180. data/lib/plaid/models/base_report_account.rb +5 -5
  181. data/lib/plaid/models/base_report_account_balances.rb +5 -5
  182. data/lib/plaid/models/base_report_account_insights.rb +7 -7
  183. data/lib/plaid/models/base_report_account_metadata.rb +4 -4
  184. data/lib/plaid/models/base_report_attributes.rb +6 -6
  185. data/lib/plaid/models/base_report_average_flow_insights.rb +2 -2
  186. data/lib/plaid/models/base_report_average_monthly_balances.rb +1 -1
  187. data/lib/plaid/models/base_report_historical_balance.rb +2 -2
  188. data/lib/plaid/models/base_report_investment_holding.rb +342 -0
  189. data/lib/plaid/models/base_report_investment_security.rb +303 -0
  190. data/lib/plaid/models/{accounts_balance_get_request_payment_details.rb → base_report_investment_transaction.rb} +159 -76
  191. data/lib/plaid/models/base_report_investments.rb +262 -0
  192. data/lib/plaid/models/base_report_item.rb +2 -2
  193. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  194. data/lib/plaid/models/base_report_number_flow_insights.rb +2 -2
  195. data/lib/plaid/models/base_report_transaction.rb +27 -7
  196. data/lib/plaid/models/base_report_transaction_personal_finance_category.rb +289 -0
  197. data/lib/plaid/models/base_report_transaction_type.rb +1 -1
  198. data/lib/plaid/models/base_report_user_attributes.rb +5 -5
  199. data/lib/plaid/models/base_report_warning.rb +1 -1
  200. data/lib/plaid/models/base_report_warning_code.rb +1 -1
  201. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  202. data/lib/plaid/models/beacon_account_risk_attributes.rb +3 -3
  203. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +1 -1
  204. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +2 -2
  205. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +1 -1
  206. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +5 -5
  207. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +1 -1
  208. data/lib/plaid/models/beacon_account_risk_evaluate_response.rb +1 -1
  209. data/lib/plaid/models/beacon_audit_trail.rb +2 -2
  210. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  211. data/lib/plaid/models/beacon_bank_account_insights.rb +2 -2
  212. data/lib/plaid/models/beacon_bank_accounts.rb +1 -1
  213. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +1 -1
  214. data/lib/plaid/models/beacon_duplicate_get_request.rb +1 -1
  215. data/lib/plaid/models/beacon_duplicate_get_response.rb +1 -1
  216. data/lib/plaid/models/beacon_match_summary_analysis.rb +1 -1
  217. data/lib/plaid/models/beacon_match_summary_code.rb +1 -1
  218. data/lib/plaid/models/beacon_report.rb +1 -1
  219. data/lib/plaid/models/beacon_report_create_request.rb +1 -1
  220. data/lib/plaid/models/beacon_report_create_response.rb +1 -1
  221. data/lib/plaid/models/beacon_report_create_type.rb +1 -1
  222. data/lib/plaid/models/beacon_report_created_webhook.rb +1 -1
  223. data/lib/plaid/models/beacon_report_get_request.rb +1 -1
  224. data/lib/plaid/models/beacon_report_get_response.rb +1 -1
  225. data/lib/plaid/models/beacon_report_list_request.rb +1 -1
  226. data/lib/plaid/models/beacon_report_list_response.rb +1 -1
  227. data/lib/plaid/models/beacon_report_syndication.rb +1 -1
  228. data/lib/plaid/models/beacon_report_syndication_analysis.rb +1 -1
  229. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +1 -1
  230. data/lib/plaid/models/beacon_report_syndication_get_request.rb +1 -1
  231. data/lib/plaid/models/beacon_report_syndication_get_response.rb +1 -1
  232. data/lib/plaid/models/beacon_report_syndication_list_request.rb +1 -1
  233. data/lib/plaid/models/beacon_report_syndication_list_response.rb +1 -1
  234. data/lib/plaid/models/beacon_report_syndication_original_report.rb +1 -1
  235. data/lib/plaid/models/beacon_report_type.rb +1 -1
  236. data/lib/plaid/models/beacon_report_updated_webhook.rb +1 -1
  237. data/lib/plaid/models/beacon_syndicated_report_depository_account_match_analysis.rb +2 -2
  238. data/lib/plaid/models/beacon_user.rb +2 -2
  239. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +2 -2
  240. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +2 -2
  241. data/lib/plaid/models/beacon_user_address.rb +3 -3
  242. data/lib/plaid/models/beacon_user_create_request.rb +2 -2
  243. data/lib/plaid/models/beacon_user_create_response.rb +2 -2
  244. data/lib/plaid/models/beacon_user_data.rb +2 -2
  245. data/lib/plaid/models/beacon_user_depository_account.rb +2 -2
  246. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  247. data/lib/plaid/models/beacon_user_get_response.rb +2 -2
  248. data/lib/plaid/models/beacon_user_history_list_request.rb +1 -1
  249. data/lib/plaid/models/beacon_user_history_list_response.rb +1 -1
  250. data/lib/plaid/models/beacon_user_id_number.rb +2 -2
  251. data/lib/plaid/models/beacon_user_name.rb +1 -1
  252. data/lib/plaid/models/beacon_user_name_nullable.rb +1 -1
  253. data/lib/plaid/models/beacon_user_request_address.rb +3 -3
  254. data/lib/plaid/models/beacon_user_request_address_nullable.rb +3 -3
  255. data/lib/plaid/models/beacon_user_request_data.rb +2 -2
  256. data/lib/plaid/models/beacon_user_request_depository_account.rb +1 -1
  257. data/lib/plaid/models/beacon_user_review_request.rb +1 -1
  258. data/lib/plaid/models/beacon_user_revision.rb +1 -1
  259. data/lib/plaid/models/beacon_user_status.rb +1 -1
  260. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +1 -1
  261. data/lib/plaid/models/beacon_user_update_request.rb +1 -1
  262. data/lib/plaid/models/beacon_user_update_request_data.rb +2 -2
  263. data/lib/plaid/models/beacon_user_update_response.rb +2 -2
  264. data/lib/plaid/models/beta_cash_advance_income_insights_v1_get_request.rb +246 -0
  265. data/lib/plaid/models/beta_cash_advance_income_insights_v1_get_response.rb +289 -0
  266. data/lib/plaid/models/beta_ewa_report_v1_get_request.rb +246 -0
  267. data/lib/plaid/models/beta_ewa_report_v1_get_response.rb +266 -0
  268. data/lib/plaid/models/{link_delivery_get_request.rb → beta_issues_v1_get_request.rb} +16 -16
  269. data/lib/plaid/models/beta_issues_v1_get_response.rb +499 -0
  270. data/lib/plaid/models/beta_issues_v1_issue.rb +476 -0
  271. data/lib/plaid/models/beta_issues_v1_issue_attribution.rb +40 -0
  272. data/lib/plaid/models/beta_issues_v1_issue_behavior.rb +40 -0
  273. data/lib/plaid/models/beta_issues_v1_issue_impact.rb +239 -0
  274. data/lib/plaid/models/beta_issues_v1_issue_resolution_event.rb +261 -0
  275. data/lib/plaid/models/beta_issues_v1_issue_resolution_type.rb +39 -0
  276. data/lib/plaid/models/{balance_plus_risk_level.rb → beta_issues_v1_issue_severity.rb} +3 -4
  277. data/lib/plaid/models/beta_issues_v1_issue_status.rb +45 -0
  278. data/lib/plaid/models/{prism_product.rb → beta_issues_v1_issue_type.rb} +3 -4
  279. data/lib/plaid/models/beta_issues_v1_list_request.rb +246 -0
  280. data/lib/plaid/models/beta_issues_v1_list_response.rb +243 -0
  281. data/lib/plaid/models/beta_issues_v1_match_identifier_type.rb +41 -0
  282. data/lib/plaid/models/beta_issues_v1_match_request.rb +282 -0
  283. data/lib/plaid/models/{network_insights_item.rb → beta_issues_v1_match_response.rb} +37 -35
  284. data/lib/plaid/models/beta_issues_v1_subscribe_request.rb +261 -0
  285. data/lib/plaid/models/beta_issues_v1_subscribe_response.rb +226 -0
  286. data/lib/plaid/models/beta_issues_v1_unsubscribe_request.rb +246 -0
  287. data/lib/plaid/models/beta_issues_v1_unsubscribe_response.rb +226 -0
  288. data/lib/plaid/models/beta_partner_customer_v1_create_request.rb +404 -0
  289. data/lib/plaid/models/beta_partner_customer_v1_create_response.rb +230 -0
  290. data/lib/plaid/models/beta_partner_customer_v1_enable_request.rb +256 -0
  291. data/lib/plaid/models/beta_partner_customer_v1_enable_response.rb +282 -0
  292. data/lib/plaid/models/{network_insights_report_get_request.rb → beta_partner_customer_v1_get_request.rb} +15 -18
  293. data/lib/plaid/models/beta_partner_customer_v1_get_response.rb +230 -0
  294. data/lib/plaid/models/beta_partner_customer_v1_update_request.rb +283 -0
  295. data/lib/plaid/models/beta_partner_customer_v1_update_response.rb +230 -0
  296. data/lib/plaid/models/beta_partner_end_customer.rb +286 -0
  297. data/lib/plaid/models/beta_partner_end_customer_with_secrets.rb +303 -0
  298. data/lib/plaid/models/beta_webhook_events_list_request.rb +356 -0
  299. data/lib/plaid/models/beta_webhook_events_list_response.rb +273 -0
  300. data/lib/plaid/models/business_account.rb +422 -0
  301. data/lib/plaid/models/business_account_all_of.rb +260 -0
  302. data/lib/plaid/models/business_check_boolean_status.rb +40 -0
  303. data/lib/plaid/models/business_digital_presence_check.rb +328 -0
  304. data/lib/plaid/models/business_email_address.rb +222 -0
  305. data/lib/plaid/models/business_entity_type.rb +57 -0
  306. data/lib/plaid/models/business_field_match_summary.rb +247 -0
  307. data/lib/plaid/models/business_finance_category.rb +2 -2
  308. data/lib/plaid/models/business_industry_prediction.rb +241 -0
  309. data/lib/plaid/models/business_industry_prediction_nullable.rb +248 -0
  310. data/lib/plaid/models/business_kyb_check.rb +314 -0
  311. data/lib/plaid/models/business_kyb_match_details.rb +339 -0
  312. data/lib/plaid/models/{link_delivery_options.rb → business_phone_number.rb} +14 -12
  313. data/lib/plaid/models/business_risk_check.rb +272 -0
  314. data/lib/plaid/models/business_search_terms.rb +286 -0
  315. data/lib/plaid/models/business_verification_create_request.rb +256 -0
  316. data/lib/plaid/models/business_verification_create_request_business.rb +271 -0
  317. data/lib/plaid/models/business_verification_create_response.rb +384 -0
  318. data/lib/plaid/models/business_verification_get_request.rb +246 -0
  319. data/lib/plaid/models/business_verification_get_response.rb +384 -0
  320. data/lib/plaid/models/business_verification_status_kyb_check.rb +40 -0
  321. data/lib/plaid/models/business_verification_status_overall.rb +40 -0
  322. data/lib/plaid/models/business_verification_status_risk_check.rb +40 -0
  323. data/lib/plaid/models/business_verification_status_web_presence_check.rb +41 -0
  324. data/lib/plaid/models/business_website.rb +222 -0
  325. data/lib/plaid/models/business_website_analysis.rb +303 -0
  326. data/lib/plaid/models/business_website_build_status.rb +40 -0
  327. data/lib/plaid/models/business_website_ssl.rb +247 -0
  328. data/lib/plaid/models/business_whois_record.rb +255 -0
  329. data/lib/plaid/models/cash_advance_decision_outcome.rb +39 -0
  330. data/lib/plaid/models/cash_advance_feedback_type.rb +39 -0
  331. data/lib/plaid/models/cash_advance_income_category.rb +222 -0
  332. data/lib/plaid/models/cash_advance_income_stream.rb +275 -0
  333. data/lib/plaid/models/cash_advance_info.rb +244 -0
  334. data/lib/plaid/models/cash_advance_info_amount_approved.rb +245 -0
  335. data/lib/plaid/models/cash_advance_info_amount_due.rb +245 -0
  336. data/lib/plaid/models/{recurring_frequency.rb → cash_advance_pay_frequency.rb} +2 -3
  337. data/lib/plaid/models/cash_advance_repayment.rb +250 -0
  338. data/lib/plaid/models/cash_advance_repayment_amount_due.rb +245 -0
  339. data/lib/plaid/models/cash_advance_repayment_amount_paid.rb +245 -0
  340. data/lib/plaid/models/cash_advance_repayment_status.rb +40 -0
  341. data/lib/plaid/models/{link_delivery_delivery_method.rb → cash_advance_type.rb} +4 -4
  342. data/lib/plaid/models/cash_flow_insight.rb +41 -0
  343. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +41 -0
  344. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +2 -2
  345. data/lib/plaid/models/cash_flow_updates_insights_v2_webhook.rb +323 -0
  346. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +2 -2
  347. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +2 -2
  348. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +2 -2
  349. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +2 -2
  350. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +2 -2
  351. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +2 -2
  352. data/lib/plaid/models/cashflow_attributes_version.rb +3 -1
  353. data/lib/plaid/models/cashflow_report_account_insights.rb +245 -0
  354. data/lib/plaid/models/cashflow_report_get_request.rb +16 -7
  355. data/lib/plaid/models/cashflow_report_get_request_options.rb +223 -0
  356. data/lib/plaid/models/cashflow_report_get_response.rb +20 -5
  357. data/lib/plaid/models/{client_provided_enhanced_transaction.rb → cashflow_report_historical_balance.rb} +27 -49
  358. data/lib/plaid/models/cashflow_report_insights_get_request.rb +246 -0
  359. data/lib/plaid/models/cashflow_report_insights_get_response.rb +286 -0
  360. data/lib/plaid/models/cashflow_report_monthly_summary.rb +448 -0
  361. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +248 -0
  362. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +248 -0
  363. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +248 -0
  364. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +248 -0
  365. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +248 -0
  366. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +248 -0
  367. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +248 -0
  368. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +248 -0
  369. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +248 -0
  370. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +248 -0
  371. data/lib/plaid/models/cashflow_report_payment_meta.rb +299 -0
  372. data/lib/plaid/models/cashflow_report_refresh_request.rb +3 -3
  373. data/lib/plaid/models/cashflow_report_refresh_response.rb +2 -2
  374. data/lib/plaid/models/cashflow_report_transaction.rb +559 -0
  375. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +303 -0
  376. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +223 -0
  377. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +319 -0
  378. data/lib/plaid/models/categories_get_response.rb +1 -1
  379. data/lib/plaid/models/category.rb +1 -1
  380. data/lib/plaid/models/category_expenses.rb +275 -0
  381. data/lib/plaid/models/category_insight_details.rb +1 -1
  382. data/lib/plaid/models/category_insights.rb +1 -1
  383. data/lib/plaid/models/cause.rb +28 -4
  384. data/lib/plaid/models/cause_all_of.rb +1 -1
  385. data/lib/plaid/models/check_report_repairable_item.rb +303 -0
  386. data/lib/plaid/models/check_report_warning.rb +2 -2
  387. data/lib/plaid/models/check_report_warning_code.rb +1 -1
  388. data/lib/plaid/models/client_customization.rb +221 -0
  389. data/lib/plaid/models/client_provided_enriched_transaction.rb +17 -7
  390. data/lib/plaid/models/client_provided_transaction.rb +14 -4
  391. data/lib/plaid/models/client_provided_transaction_location.rb +3 -3
  392. data/lib/plaid/models/client_user_identity.rb +280 -0
  393. data/lib/plaid/models/client_user_identity_address.rb +296 -0
  394. data/lib/plaid/models/client_user_identity_email.rb +241 -0
  395. data/lib/plaid/models/client_user_identity_name.rb +241 -0
  396. data/lib/plaid/models/client_user_identity_phone_number.rb +241 -0
  397. data/lib/plaid/models/connected_application.rb +3 -3
  398. data/lib/plaid/models/consent_event.rb +5 -5
  399. data/lib/plaid/models/consent_event_code.rb +1 -1
  400. data/lib/plaid/models/consent_event_initiator.rb +1 -1
  401. data/lib/plaid/models/consent_event_type.rb +1 -1
  402. data/lib/plaid/models/consent_events_get_request.rb +2 -2
  403. data/lib/plaid/models/consent_events_get_response.rb +1 -1
  404. data/lib/plaid/models/consented_account.rb +2 -2
  405. data/lib/plaid/models/consumer_dispute.rb +1 -1
  406. data/lib/plaid/models/consumer_dispute_category.rb +1 -1
  407. data/lib/plaid/models/consumer_report_pdf_get_request.rb +2 -2
  408. data/lib/plaid/models/consumer_report_permissible_purpose.rb +2 -2
  409. data/lib/plaid/models/consumer_report_user_identity.rb +15 -4
  410. data/lib/plaid/models/counterparty.rb +19 -9
  411. data/lib/plaid/models/counterparty_insights.rb +3 -3
  412. data/lib/plaid/models/counterparty_numbers.rb +231 -0
  413. data/lib/plaid/models/counterparty_numbers_bacs.rb +233 -0
  414. data/lib/plaid/models/counterparty_numbers_international.rb +258 -0
  415. data/lib/plaid/models/counterparty_type.rb +1 -1
  416. data/lib/plaid/models/country_code.rb +1 -1
  417. data/lib/plaid/models/{link_delivery_recipient.rb → cra_annual_income_values.rb} +30 -22
  418. data/lib/plaid/models/cra_bank_income_account.rb +2 -2
  419. data/lib/plaid/models/cra_bank_income_account_metadata.rb +1 -1
  420. data/lib/plaid/models/cra_bank_income_bonus_type.rb +1 -1
  421. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  422. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  423. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +2 -2
  424. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  425. data/lib/plaid/models/cra_bank_income_error_webhook.rb +1 -1
  426. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  427. data/lib/plaid/models/cra_bank_income_income_provider.rb +241 -0
  428. data/lib/plaid/models/cra_bank_income_item.rb +15 -3
  429. data/lib/plaid/models/cra_bank_income_source.rb +25 -6
  430. data/lib/plaid/models/cra_bank_income_status.rb +40 -0
  431. data/lib/plaid/models/cra_bank_income_summary.rb +6 -6
  432. data/lib/plaid/models/cra_bank_income_transaction.rb +2 -2
  433. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  434. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  435. data/lib/plaid/models/cra_base_report_product.rb +275 -0
  436. data/lib/plaid/models/cra_base_report_product_config.rb +275 -0
  437. data/lib/plaid/models/cra_cashflow_insights_product.rb +275 -0
  438. data/lib/plaid/models/cra_cashflow_insights_report.rb +5 -15
  439. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +77 -15
  440. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +2 -2
  441. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +3 -13
  442. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +19 -9
  443. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +1 -1
  444. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +37 -6
  445. data/lib/plaid/models/cra_check_report_create_cashflow_insights_options.rb +243 -0
  446. data/lib/plaid/models/{cra_check_report_verification_get_voe_options.rb → cra_check_report_create_employment_refresh_options.rb} +6 -6
  447. data/lib/plaid/models/cra_check_report_create_income_insights_options.rb +253 -0
  448. data/lib/plaid/models/cra_check_report_create_lend_score_options.rb +243 -0
  449. data/lib/plaid/models/{recurrence.rb → cra_check_report_create_network_insights_options.rb} +13 -24
  450. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +231 -0
  451. data/lib/plaid/models/cra_check_report_create_request.rb +75 -12
  452. data/lib/plaid/models/cra_check_report_create_response.rb +1 -1
  453. data/lib/plaid/models/cra_check_report_failed_webhook.rb +64 -3
  454. data/lib/plaid/models/cra_check_report_failed_webhook_error.rb +384 -0
  455. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +1 -1
  456. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +1 -1
  457. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +1 -1
  458. data/lib/plaid/models/cra_check_report_gse_options.rb +228 -0
  459. data/lib/plaid/models/cra_check_report_home_lending_report_options.rb +238 -0
  460. data/lib/plaid/models/cra_check_report_income_insights_get_options.rb +253 -0
  461. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +46 -6
  462. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +1 -1
  463. data/lib/plaid/models/cra_check_report_lend_score_get_options.rb +243 -0
  464. data/lib/plaid/models/cra_check_report_lend_score_get_request.rb +271 -0
  465. data/lib/plaid/models/cra_check_report_lend_score_get_response.rb +252 -0
  466. data/lib/plaid/models/cra_check_report_network_insights_get_options.rb +243 -0
  467. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +33 -13
  468. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +2 -2
  469. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +4 -16
  470. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +231 -0
  471. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +61 -10
  472. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +2 -2
  473. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +23 -13
  474. data/lib/plaid/models/cra_check_report_permissible_purpose.rb +39 -0
  475. data/lib/plaid/models/cra_check_report_ready_webhook.rb +3 -3
  476. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +247 -0
  477. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +3 -2
  478. data/lib/plaid/models/cra_check_report_verification_get_request.rb +21 -11
  479. data/lib/plaid/models/cra_check_report_verification_get_response.rb +2 -2
  480. data/lib/plaid/models/cra_check_report_verification_pdf_get_request.rb +309 -0
  481. data/lib/plaid/models/cra_check_report_verification_pdf_report_type.rb +40 -0
  482. data/lib/plaid/models/cra_credit_profile_inquiry_type.rb +39 -0
  483. data/lib/plaid/models/cra_credit_profile_lend_score.rb +265 -0
  484. data/lib/plaid/models/cra_credit_profile_report.rb +330 -0
  485. data/lib/plaid/models/cra_credit_profile_report_get_request.rb +339 -0
  486. data/lib/plaid/models/cra_credit_profile_report_get_response.rb +267 -0
  487. data/lib/plaid/models/cra_credit_profile_report_metadata.rb +393 -0
  488. data/lib/plaid/models/cra_credit_profile_report_type.rb +38 -0
  489. data/lib/plaid/models/cra_credit_profile_report_version.rb +38 -0
  490. data/lib/plaid/models/cra_current_modeled_income.rb +239 -0
  491. data/lib/plaid/models/{cra_voe_report.rb → cra_employment_refresh_report.rb} +9 -9
  492. data/lib/plaid/models/{cra_voe_report_account.rb → cra_employment_refresh_report_account.rb} +8 -8
  493. data/lib/plaid/models/{cra_voe_report_item.rb → cra_employment_refresh_report_item.rb} +7 -7
  494. data/lib/plaid/models/{cra_voe_report_transaction.rb → cra_employment_refresh_report_transaction.rb} +5 -5
  495. data/lib/plaid/models/cra_home_lending_product.rb +275 -0
  496. data/lib/plaid/models/cra_income_category.rb +241 -0
  497. data/lib/plaid/models/cra_income_complete_bundle_product.rb +275 -0
  498. data/lib/plaid/models/cra_income_insights.rb +29 -2
  499. data/lib/plaid/models/cra_income_insights_product.rb +275 -0
  500. data/lib/plaid/models/cra_income_insights_product_config.rb +285 -0
  501. data/lib/plaid/models/cra_income_insights_user_summary.rb +228 -0
  502. data/lib/plaid/models/cra_income_metrics.rb +253 -0
  503. data/lib/plaid/models/cra_income_next_payment.rb +226 -0
  504. data/lib/plaid/models/cra_income_stream.rb +316 -0
  505. data/lib/plaid/models/cra_income_stream_insights.rb +295 -0
  506. data/lib/plaid/models/cra_income_transaction.rb +337 -0
  507. data/lib/plaid/models/cra_income_transaction_outlier.rb +237 -0
  508. data/lib/plaid/models/cra_lend_score_complete_bundle_product.rb +285 -0
  509. data/lib/plaid/models/cra_lend_score_product.rb +285 -0
  510. data/lib/plaid/models/{network_insights_report.rb → cra_lend_score_report.rb} +15 -37
  511. data/lib/plaid/models/cra_lend_score_variant.rb +42 -0
  512. data/lib/plaid/models/cra_loan_application.rb +1 -1
  513. data/lib/plaid/models/cra_loan_application_decision.rb +1 -1
  514. data/lib/plaid/models/cra_loan_closed_status.rb +1 -1
  515. data/lib/plaid/models/cra_loan_opened_status.rb +1 -1
  516. data/lib/plaid/models/cra_loan_payment_history.rb +2 -2
  517. data/lib/plaid/models/cra_loan_payment_schedule.rb +1 -1
  518. data/lib/plaid/models/cra_loan_register.rb +1 -1
  519. data/lib/plaid/models/cra_loan_register_application.rb +1 -1
  520. data/lib/plaid/models/cra_loan_status.rb +1 -1
  521. data/lib/plaid/models/cra_loan_status_history_update.rb +1 -1
  522. data/lib/plaid/models/cra_loan_type.rb +1 -1
  523. data/lib/plaid/models/cra_loan_unregister.rb +1 -1
  524. data/lib/plaid/models/cra_loan_unregister_response.rb +1 -1
  525. data/lib/plaid/models/cra_loan_update.rb +1 -1
  526. data/lib/plaid/models/cra_loans_applications_register_request.rb +1 -1
  527. data/lib/plaid/models/cra_loans_applications_register_response.rb +1 -1
  528. data/lib/plaid/models/cra_loans_register_request.rb +1 -1
  529. data/lib/plaid/models/cra_loans_register_response.rb +1 -1
  530. data/lib/plaid/models/cra_loans_unregister_request.rb +1 -1
  531. data/lib/plaid/models/cra_loans_update_request.rb +1 -1
  532. data/lib/plaid/models/cra_loans_update_response.rb +1 -1
  533. data/lib/plaid/models/cra_monitoring_insights_get_request.rb +22 -17
  534. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +2 -2
  535. data/lib/plaid/models/cra_monitoring_insights_item.rb +32 -2
  536. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +34 -19
  537. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +2 -2
  538. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +1 -1
  539. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +2 -2
  540. data/lib/plaid/models/cra_monthly_income_values.rb +241 -0
  541. data/lib/plaid/models/cra_network_insights_item.rb +1 -1
  542. data/lib/plaid/models/cra_network_insights_product.rb +275 -0
  543. data/lib/plaid/models/cra_network_insights_report.rb +4 -4
  544. data/lib/plaid/models/cra_partner_insights.rb +24 -2
  545. data/lib/plaid/models/cra_partner_insights_base_fico_score.rb +352 -0
  546. data/lib/plaid/models/cra_partner_insights_base_fico_score_version.rb +41 -0
  547. data/lib/plaid/models/cra_partner_insights_bureau.rb +40 -0
  548. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +1 -1
  549. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +1 -1
  550. data/lib/plaid/models/cra_partner_insights_fico_input.rb +258 -0
  551. data/lib/plaid/models/cra_partner_insights_fico_report_characteristics.rb +442 -0
  552. data/lib/plaid/models/cra_partner_insights_fico_results.rb +253 -0
  553. data/lib/plaid/models/cra_partner_insights_get_request.rb +38 -6
  554. data/lib/plaid/models/cra_partner_insights_get_response.rb +1 -1
  555. data/lib/plaid/models/cra_partner_insights_item.rb +3 -3
  556. data/lib/plaid/models/cra_partner_insights_item_account.rb +2 -2
  557. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +1 -1
  558. data/lib/plaid/models/cra_partner_insights_prism.rb +22 -2
  559. data/lib/plaid/models/cra_partner_insights_ultra_fico_score.rb +403 -0
  560. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_request.rb +281 -0
  561. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_result.rb +262 -0
  562. data/lib/plaid/models/cra_partner_insights_ultra_fico_score_version.rb +38 -0
  563. data/lib/plaid/models/cra_pdf_add_ons.rb +4 -2
  564. data/lib/plaid/models/cra_prediction_interval.rb +1 -1
  565. data/lib/plaid/models/cra_projected_modeled_income.rb +239 -0
  566. data/lib/plaid/models/cra_qualify_product.rb +275 -0
  567. data/lib/plaid/models/cra_qualify_product_config.rb +275 -0
  568. data/lib/plaid/models/cra_report_create_base_report_options.rb +222 -0
  569. data/lib/plaid/models/cra_report_create_base_report_product_config.rb +285 -0
  570. data/lib/plaid/models/cra_report_create_cashflow_insights_product_config.rb +275 -0
  571. data/lib/plaid/models/cra_report_create_home_lending_product_config.rb +275 -0
  572. data/lib/plaid/models/cra_report_create_income_complete_bundle_product_config.rb +285 -0
  573. data/lib/plaid/models/cra_report_create_income_complete_options.rb +221 -0
  574. data/lib/plaid/models/cra_report_create_income_insights_options.rb +221 -0
  575. data/lib/plaid/models/cra_report_create_income_insights_product_config.rb +285 -0
  576. data/lib/plaid/models/cra_report_create_lend_score_complete_bundle_product_config.rb +285 -0
  577. data/lib/plaid/models/cra_report_create_lend_score_complete_options.rb +223 -0
  578. data/lib/plaid/models/cra_report_create_lend_score_options.rb +223 -0
  579. data/lib/plaid/models/cra_report_create_lend_score_product_config.rb +285 -0
  580. data/lib/plaid/models/cra_report_create_network_insights_product_config.rb +275 -0
  581. data/lib/plaid/models/cra_report_create_qualify_product_config.rb +275 -0
  582. data/lib/plaid/models/cra_report_create_request.rb +465 -0
  583. data/lib/plaid/models/{network_insights_report_get_response.rb → cra_report_create_response.rb} +15 -15
  584. data/lib/plaid/models/cra_report_decision_stage.rb +40 -0
  585. data/lib/plaid/models/cra_report_error_code.rb +40 -0
  586. data/lib/plaid/models/cra_report_get_account_identity_match.rb +267 -0
  587. data/lib/plaid/models/cra_report_get_account_primary_account.rb +241 -0
  588. data/lib/plaid/models/cra_report_get_base_account.rb +309 -0
  589. data/lib/plaid/models/cra_report_get_base_item.rb +288 -0
  590. data/lib/plaid/models/cra_report_get_base_report_account.rb +454 -0
  591. data/lib/plaid/models/cra_report_get_base_report_account_account_insights.rb +350 -0
  592. data/lib/plaid/models/cra_report_get_base_report_account_attributes.rb +349 -0
  593. data/lib/plaid/models/{client_provided_raw_transaction.rb → cra_report_get_base_report_account_attributes_total_inflow_amount.rb} +29 -46
  594. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount30d.rb +254 -0
  595. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount60d.rb +254 -0
  596. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_inflow_amount90d.rb +254 -0
  597. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount.rb +254 -0
  598. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount30d.rb +254 -0
  599. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount60d.rb +254 -0
  600. data/lib/plaid/models/cra_report_get_base_report_account_attributes_total_outflow_amount90d.rb +254 -0
  601. data/lib/plaid/models/cra_report_get_base_report_account_balances.rb +305 -0
  602. data/lib/plaid/models/cra_report_get_base_report_account_identity_match.rb +267 -0
  603. data/lib/plaid/models/cra_report_get_base_report_account_insights.rb +344 -0
  604. data/lib/plaid/models/cra_report_get_base_report_attributes.rb +327 -0
  605. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount.rb +254 -0
  606. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount30d.rb +254 -0
  607. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount60d.rb +254 -0
  608. data/lib/plaid/models/cra_report_get_base_report_attributes_total_inflow_amount90d.rb +254 -0
  609. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount.rb +254 -0
  610. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount30d.rb +254 -0
  611. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount60d.rb +254 -0
  612. data/lib/plaid/models/cra_report_get_base_report_attributes_total_outflow_amount90d.rb +254 -0
  613. data/lib/plaid/models/cra_report_get_base_report_average_monthly_balance.rb +255 -0
  614. data/lib/plaid/models/cra_report_get_base_report_item.rb +288 -0
  615. data/lib/plaid/models/cra_report_get_base_report_longest_gap_insight.rb +252 -0
  616. data/lib/plaid/models/cra_report_get_base_report_metadata.rb +404 -0
  617. data/lib/plaid/models/cra_report_get_base_report_metadata_all_of.rb +337 -0
  618. data/lib/plaid/models/cra_report_get_base_report_response_product.rb +328 -0
  619. data/lib/plaid/models/cra_report_get_base_report_response_product_attributes.rb +333 -0
  620. data/lib/plaid/models/cra_report_get_base_report_transaction.rb +430 -0
  621. data/lib/plaid/models/cra_report_get_cashflow_insights_metadata.rb +389 -0
  622. data/lib/plaid/models/cra_report_get_cashflow_insights_response_product.rb +315 -0
  623. data/lib/plaid/models/cra_report_get_enriched_account.rb +354 -0
  624. data/lib/plaid/models/cra_report_get_enriched_account_all_of.rb +279 -0
  625. data/lib/plaid/models/cra_report_get_enriched_item.rb +296 -0
  626. data/lib/plaid/models/cra_report_get_enriched_item_all_of.rb +237 -0
  627. data/lib/plaid/models/cra_report_get_home_lending_attributes.rb +300 -0
  628. data/lib/plaid/models/cra_report_get_home_lending_category_income.rb +235 -0
  629. data/lib/plaid/models/cra_report_get_home_lending_income_by_categories.rb +250 -0
  630. data/lib/plaid/models/cra_report_get_home_lending_income_metrics.rb +243 -0
  631. data/lib/plaid/models/cra_report_get_home_lending_income_sources.rb +243 -0
  632. data/lib/plaid/models/cra_report_get_home_lending_metadata.rb +276 -0
  633. data/lib/plaid/models/cra_report_get_home_lending_response_product.rb +329 -0
  634. data/lib/plaid/models/cra_report_get_income_complete_attributes.rb +221 -0
  635. data/lib/plaid/models/cra_report_get_income_complete_metadata.rb +389 -0
  636. data/lib/plaid/models/cra_report_get_income_complete_response_product.rb +329 -0
  637. data/lib/plaid/models/cra_report_get_income_insights_attributes.rb +238 -0
  638. data/lib/plaid/models/cra_report_get_income_insights_metadata.rb +389 -0
  639. data/lib/plaid/models/cra_report_get_income_insights_response_product.rb +329 -0
  640. data/lib/plaid/models/cra_report_get_income_insights_stream.rb +304 -0
  641. data/lib/plaid/models/cra_report_get_lend_score_complete_attributes.rb +254 -0
  642. data/lib/plaid/models/cra_report_get_lend_score_complete_metadata.rb +389 -0
  643. data/lib/plaid/models/cra_report_get_lend_score_complete_metadata_all_of.rb +322 -0
  644. data/lib/plaid/models/cra_report_get_lend_score_complete_options.rb +223 -0
  645. data/lib/plaid/models/cra_report_get_lend_score_complete_response_product.rb +329 -0
  646. data/lib/plaid/models/cra_report_get_lend_score_metadata.rb +389 -0
  647. data/lib/plaid/models/cra_report_get_lend_score_metadata_all_of.rb +322 -0
  648. data/lib/plaid/models/cra_report_get_lend_score_options.rb +223 -0
  649. data/lib/plaid/models/cra_report_get_lend_score_response_product.rb +319 -0
  650. data/lib/plaid/models/cra_report_get_lend_score_variant_score.rb +286 -0
  651. data/lib/plaid/models/cra_report_get_network_insights_metadata.rb +389 -0
  652. data/lib/plaid/models/cra_report_get_network_insights_response_product.rb +315 -0
  653. data/lib/plaid/models/cra_report_get_product_base_metadata.rb +269 -0
  654. data/lib/plaid/models/cra_report_get_qualify_response_product.rb +318 -0
  655. data/lib/plaid/models/cra_report_get_report.rb +328 -0
  656. data/lib/plaid/models/cra_report_get_request.rb +352 -0
  657. data/lib/plaid/models/cra_report_get_request_product.rb +86 -0
  658. data/lib/plaid/models/cra_report_get_response.rb +283 -0
  659. data/lib/plaid/models/cra_report_get_response_product.rb +86 -0
  660. data/lib/plaid/models/cra_report_product.rb +86 -0
  661. data/lib/plaid/models/cra_report_ready_webhook.rb +393 -0
  662. data/lib/plaid/models/cra_report_scope.rb +39 -0
  663. data/lib/plaid/models/cra_report_updated_webhook.rb +409 -0
  664. data/lib/plaid/models/cra_servicing_subscription.rb +315 -0
  665. data/lib/plaid/models/cra_servicing_subscription_create_request.rb +340 -0
  666. data/lib/plaid/models/cra_servicing_subscription_create_response.rb +241 -0
  667. data/lib/plaid/models/cra_servicing_subscription_delete_request.rb +246 -0
  668. data/lib/plaid/models/cra_servicing_subscription_delete_response.rb +241 -0
  669. data/lib/plaid/models/cra_servicing_subscription_get_request.rb +246 -0
  670. data/lib/plaid/models/cra_servicing_subscription_get_response.rb +240 -0
  671. data/lib/plaid/models/cra_servicing_subscription_list_request.rb +246 -0
  672. data/lib/plaid/models/cra_servicing_subscription_list_response.rb +243 -0
  673. data/lib/plaid/models/cra_servicing_subscription_update_request.rb +281 -0
  674. data/lib/plaid/models/cra_servicing_subscription_update_request_resettable_field.rb +38 -0
  675. data/lib/plaid/models/cra_servicing_subscription_update_response.rb +241 -0
  676. data/lib/plaid/models/cra_subscription_cadence.rb +39 -0
  677. data/lib/plaid/models/cra_subscription_product_config.rb +74 -0
  678. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +1 -1
  679. data/lib/plaid/models/cra_user_check_report_failed_webhook.rb +353 -0
  680. data/lib/plaid/models/cra_user_check_report_ready_webhook.rb +329 -0
  681. data/lib/plaid/models/cra_user_tier.rb +40 -0
  682. data/lib/plaid/models/cra_verification_income_account.rb +323 -0
  683. data/lib/plaid/models/cra_verification_income_category.rb +241 -0
  684. data/lib/plaid/models/cra_verification_income_item.rb +288 -0
  685. data/lib/plaid/models/cra_verification_income_metrics.rb +243 -0
  686. data/lib/plaid/models/cra_verification_income_next_payment.rb +226 -0
  687. data/lib/plaid/models/cra_verification_income_pay_frequency.rb +43 -0
  688. data/lib/plaid/models/cra_verification_income_provider.rb +241 -0
  689. data/lib/plaid/models/cra_verification_income_report.rb +285 -0
  690. data/lib/plaid/models/cra_verification_income_status.rb +40 -0
  691. data/lib/plaid/models/cra_verification_income_stream.rb +316 -0
  692. data/lib/plaid/models/cra_verification_income_stream_insights.rb +295 -0
  693. data/lib/plaid/models/cra_verification_income_transaction.rb +337 -0
  694. data/lib/plaid/models/cra_verification_income_transaction_outlier.rb +237 -0
  695. data/lib/plaid/models/cra_verification_income_user_summary.rb +228 -0
  696. data/lib/plaid/models/cra_verification_income_values.rb +241 -0
  697. data/lib/plaid/models/cra_verification_modeled_income.rb +239 -0
  698. data/lib/plaid/models/cra_verification_report.rb +31 -11
  699. data/lib/plaid/models/cra_voa_report.rb +2 -2
  700. data/lib/plaid/models/cra_voa_report_account.rb +17 -7
  701. data/lib/plaid/models/cra_voa_report_account_balances.rb +5 -5
  702. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +1 -1
  703. data/lib/plaid/models/cra_voa_report_attributes.rb +1 -1
  704. data/lib/plaid/models/cra_voa_report_item.rb +2 -2
  705. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +1 -1
  706. data/lib/plaid/models/credit1099.rb +1 -1
  707. data/lib/plaid/models/credit1099_filer.rb +1 -1
  708. data/lib/plaid/models/credit1099_payer.rb +1 -1
  709. data/lib/plaid/models/credit1099_recipient.rb +3 -3
  710. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  711. data/lib/plaid/models/credit_ach_class.rb +1 -1
  712. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  713. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  714. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +2 -2
  715. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  716. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  717. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  718. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  719. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  720. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  721. data/lib/plaid/models/credit_bank_employment_get_request.rb +2 -2
  722. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  723. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  724. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  725. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  726. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  727. data/lib/plaid/models/credit_bank_income.rb +1 -1
  728. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  729. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  730. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  731. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  732. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  733. data/lib/plaid/models/credit_bank_income_get_request.rb +13 -3
  734. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  735. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  736. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  737. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  738. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  739. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +16 -11
  740. data/lib/plaid/models/credit_bank_income_refresh_request.rb +12 -3
  741. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  742. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  743. data/lib/plaid/models/credit_bank_income_source.rb +3 -3
  744. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  745. data/lib/plaid/models/credit_bank_income_transaction.rb +2 -2
  746. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  747. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  748. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  749. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +12 -3
  750. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  751. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  752. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  753. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  754. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  755. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  756. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  757. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  758. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +13 -8
  759. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +2 -2
  760. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  761. data/lib/plaid/models/credit_card_liability.rb +17 -6
  762. data/lib/plaid/models/credit_category.rb +1 -1
  763. data/lib/plaid/models/credit_document_metadata.rb +3 -3
  764. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  765. data/lib/plaid/models/credit_employment_get_request.rb +16 -11
  766. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  767. data/lib/plaid/models/credit_employment_item.rb +1 -1
  768. data/lib/plaid/models/credit_employment_verification.rb +2 -2
  769. data/lib/plaid/models/credit_filter.rb +1 -1
  770. data/lib/plaid/models/credit_freddie_mac_asset.rb +11 -2
  771. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +1 -1
  772. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +1 -1
  773. data/lib/plaid/models/credit_freddie_mac_assets.rb +1 -1
  774. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +1 -1
  775. data/lib/plaid/models/credit_freddie_mac_loan.rb +2 -2
  776. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +1 -1
  777. data/lib/plaid/models/credit_freddie_mac_loans.rb +1 -1
  778. data/lib/plaid/models/credit_freddie_mac_parties.rb +1 -1
  779. data/lib/plaid/models/credit_freddie_mac_party.rb +2 -2
  780. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +1 -1
  781. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +3 -3
  782. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +2 -2
  783. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  784. data/lib/plaid/models/credit_freddie_mac_service.rb +1 -1
  785. data/lib/plaid/models/credit_freddie_mac_services.rb +1 -1
  786. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +1 -1
  787. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +1 -1
  788. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +1 -1
  789. data/lib/plaid/models/credit_i20.rb +339 -0
  790. data/lib/plaid/models/credit_i20_student.rb +288 -0
  791. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  792. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  793. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  794. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  795. data/lib/plaid/models/credit_pay_stub_employee.rb +2 -2
  796. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  797. data/lib/plaid/models/credit_pay_stub_net_pay.rb +2 -2
  798. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  799. data/lib/plaid/models/credit_payroll_income_get_request.rb +13 -3
  800. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +2 -2
  801. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  802. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +14 -9
  803. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +2 -2
  804. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +12 -3
  805. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  806. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +13 -8
  807. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +2 -2
  808. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +2 -2
  809. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +16 -6
  810. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -2
  811. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  812. data/lib/plaid/models/credit_product.rb +240 -0
  813. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  814. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  815. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  816. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  817. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  818. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  819. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  820. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  821. data/lib/plaid/models/credit_session.rb +1 -1
  822. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  823. data/lib/plaid/models/credit_session_bank_employment_status.rb +3 -1
  824. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  825. data/lib/plaid/models/credit_session_bank_income_status.rb +3 -1
  826. data/lib/plaid/models/credit_session_document_income_result.rb +20 -5
  827. data/lib/plaid/models/credit_session_error.rb +1 -1
  828. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  829. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  830. data/lib/plaid/models/credit_session_results.rb +1 -1
  831. data/lib/plaid/models/credit_sessions_get_request.rb +16 -11
  832. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  833. data/lib/plaid/models/credit_w2.rb +5 -5
  834. data/lib/plaid/models/custom_sandbox_transaction.rb +291 -0
  835. data/lib/plaid/models/customer_initiated_return_risk.rb +3 -3
  836. data/lib/plaid/models/dashboard_user.rb +2 -2
  837. data/lib/plaid/models/dashboard_user_get_request.rb +2 -2
  838. data/lib/plaid/models/dashboard_user_get_response.rb +2 -2
  839. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  840. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  841. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  842. data/lib/plaid/models/data_sources.rb +1 -1
  843. data/lib/plaid/models/date_range.rb +1 -1
  844. data/lib/plaid/models/deductions.rb +1 -1
  845. data/lib/plaid/models/deductions_breakdown.rb +2 -2
  846. data/lib/plaid/models/deductions_total.rb +2 -2
  847. data/lib/plaid/models/default_update_webhook.rb +1 -1
  848. data/lib/plaid/models/depository_account_subtype.rb +2 -1
  849. data/lib/plaid/models/depository_filter.rb +17 -5
  850. data/lib/plaid/models/detailed_originator.rb +3 -3
  851. data/lib/plaid/models/detected_account.rb +1 -1
  852. data/lib/plaid/models/device_id.rb +2 -2
  853. data/lib/plaid/models/disconnected_application.rb +285 -0
  854. data/lib/plaid/models/distribution_breakdown.rb +2 -2
  855. data/lib/plaid/models/doc_type.rb +2 -1
  856. data/lib/plaid/models/document_analysis.rb +16 -6
  857. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  858. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  859. data/lib/plaid/models/document_metadata.rb +1 -1
  860. data/lib/plaid/models/document_name_match_code.rb +1 -1
  861. data/lib/plaid/models/document_risk_signal.rb +1 -1
  862. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  863. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  864. data/lib/plaid/models/document_risk_summary.rb +1 -1
  865. data/lib/plaid/models/document_status.rb +1 -1
  866. data/lib/plaid/models/documentary_verification.rb +3 -3
  867. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  868. data/lib/plaid/models/earnings.rb +1 -1
  869. data/lib/plaid/models/earnings_breakdown.rb +3 -3
  870. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  871. data/lib/plaid/models/earnings_total.rb +2 -2
  872. data/lib/plaid/models/email.rb +1 -1
  873. data/lib/plaid/models/email_address_match_score.rb +1 -1
  874. data/lib/plaid/models/employee.rb +1 -1
  875. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  876. data/lib/plaid/models/employer.rb +1 -1
  877. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  878. data/lib/plaid/models/employer_verification.rb +1 -1
  879. data/lib/plaid/models/employers_search_request.rb +1 -1
  880. data/lib/plaid/models/employers_search_response.rb +1 -1
  881. data/lib/plaid/models/employment_details.rb +1 -1
  882. data/lib/plaid/models/employment_source_type.rb +1 -1
  883. data/lib/plaid/models/employment_verification.rb +1 -1
  884. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  885. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  886. data/lib/plaid/models/employment_verification_status.rb +1 -1
  887. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  888. data/lib/plaid/models/enrichments.rb +6 -15
  889. data/lib/plaid/models/entity_document.rb +1 -1
  890. data/lib/plaid/models/entity_document_type.rb +1 -1
  891. data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
  892. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  893. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  894. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  895. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  896. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  897. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  898. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  899. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  900. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  901. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  902. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  903. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  904. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  905. data/lib/plaid/models/entity_watchlist_screening.rb +3 -3
  906. data/lib/plaid/models/entity_watchlist_screening_hit.rb +19 -2
  907. data/lib/plaid/models/entity_watchlist_screening_review.rb +2 -2
  908. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  909. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  910. data/lib/plaid/models/ewa_score.rb +241 -0
  911. data/lib/plaid/models/expenditure_insights.rb +280 -0
  912. data/lib/plaid/models/expenditure_insights_cash_flow.rb +251 -0
  913. data/lib/plaid/models/expenditure_summary.rb +288 -0
  914. data/lib/plaid/models/expiration_date.rb +1 -1
  915. data/lib/plaid/models/extended_recipient_metadata.rb +8 -8
  916. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +4 -4
  917. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  918. data/lib/plaid/models/external_payment_options.rb +1 -1
  919. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  920. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  921. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  922. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  923. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  924. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  925. data/lib/plaid/models/fdx_consent_grant.rb +331 -0
  926. data/lib/plaid/models/fdx_consent_grant_resource.rb +279 -0
  927. data/lib/plaid/models/{link_delivery_session_status.rb → fdx_consent_grant_status.rb} +4 -6
  928. data/lib/plaid/models/fdx_consent_resource_type.rb +40 -0
  929. data/lib/plaid/models/fdx_consent_revocation.rb +281 -0
  930. data/lib/plaid/models/fdx_consent_revocation_record.rb +290 -0
  931. data/lib/plaid/models/fdx_consent_revocations.rb +228 -0
  932. data/lib/plaid/models/fdx_content_types.rb +1 -1
  933. data/lib/plaid/models/fdx_data_cluster.rb +53 -0
  934. data/lib/plaid/models/fdx_error.rb +256 -0
  935. data/lib/plaid/models/fdx_event_status.rb +41 -0
  936. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  937. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  938. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +2 -24
  939. data/lib/plaid/models/fdx_lifecycle_event.rb +280 -0
  940. data/lib/plaid/models/fdx_notification.rb +14 -4
  941. data/lib/plaid/models/fdx_notification_category.rb +2 -1
  942. data/lib/plaid/models/fdx_notification_payload.rb +8 -10
  943. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  944. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  945. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  946. data/lib/plaid/models/fdx_notification_type.rb +15 -3
  947. data/lib/plaid/models/fdx_party.rb +1 -1
  948. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  949. data/lib/plaid/models/fdx_party_type.rb +1 -1
  950. data/lib/plaid/models/fdx_recipient_metadata.rb +6 -6
  951. data/lib/plaid/models/fdx_update_reason.rb +41 -0
  952. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  953. data/lib/plaid/models/financial_institution_insights.rb +1 -1
  954. data/lib/plaid/models/fixed_income.rb +1 -1
  955. data/lib/plaid/models/forecasted_monthly_income.rb +2 -6
  956. data/lib/plaid/models/form1099_type.rb +1 -1
  957. data/lib/plaid/models/forwarded_json_response.rb +1 -1
  958. data/lib/plaid/models/fraud_amount.rb +1 -1
  959. data/lib/plaid/models/fraud_analysis_details.rb +8 -23
  960. data/lib/plaid/models/fraud_check_outcome.rb +1 -1
  961. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +1 -1
  962. data/lib/plaid/models/gambling_indicators.rb +311 -0
  963. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  964. data/lib/plaid/models/get_consents_response.rb +228 -0
  965. data/lib/plaid/models/get_recipient_response.rb +5 -5
  966. data/lib/plaid/models/get_recipients_response.rb +1 -1
  967. data/lib/plaid/models/gse_report_type.rb +39 -0
  968. data/lib/plaid/models/health_incident.rb +1 -1
  969. data/lib/plaid/models/hidden_match_summary_code.rb +1 -1
  970. data/lib/plaid/models/historical_annual_income.rb +2 -6
  971. data/lib/plaid/models/historical_balance.rb +2 -2
  972. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  973. data/lib/plaid/models/holding.rb +19 -7
  974. data/lib/plaid/models/holding_tax_lot.rb +309 -0
  975. data/lib/plaid/models/holding_tax_lot_position_type.rb +39 -0
  976. data/lib/plaid/models/holdings_default_update_webhook.rb +12 -2
  977. data/lib/plaid/models/holdings_override.rb +2 -2
  978. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  979. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +3 -3
  980. data/lib/plaid/models/human_review.rb +1 -1
  981. data/lib/plaid/models/human_review_status.rb +1 -1
  982. data/lib/plaid/models/id_number_type.rb +2 -1
  983. data/lib/plaid/models/identity_default_update_webhook.rb +2 -2
  984. data/lib/plaid/models/identity_document_metadata.rb +1 -1
  985. data/lib/plaid/models/identity_document_upload.rb +1 -1
  986. data/lib/plaid/models/identity_document_upload_metadata.rb +1 -1
  987. data/lib/plaid/models/identity_document_upload_risk_insights.rb +1 -1
  988. data/lib/plaid/models/identity_document_upload_risk_signal.rb +2 -2
  989. data/lib/plaid/models/identity_document_upload_risk_summary.rb +1 -1
  990. data/lib/plaid/models/identity_documents_uploads_get_request.rb +2 -2
  991. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +1 -1
  992. data/lib/plaid/models/identity_documents_uploads_get_response.rb +1 -1
  993. data/lib/plaid/models/identity_get_request.rb +2 -2
  994. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  995. data/lib/plaid/models/identity_get_response.rb +1 -1
  996. data/lib/plaid/models/{enhancements.rb → identity_match_list_attempt.rb} +121 -104
  997. data/lib/plaid/models/identity_match_list_attempt_score.rb +278 -0
  998. data/lib/plaid/models/identity_match_list_outcome.rb +40 -0
  999. data/lib/plaid/models/identity_match_list_request.rb +309 -0
  1000. data/lib/plaid/models/identity_match_list_response.rb +269 -0
  1001. data/lib/plaid/models/identity_match_request.rb +2 -2
  1002. data/lib/plaid/models/identity_match_request_options.rb +2 -2
  1003. data/lib/plaid/models/identity_match_response.rb +1 -1
  1004. data/lib/plaid/models/identity_match_user.rb +1 -1
  1005. data/lib/plaid/models/identity_refresh_request.rb +2 -2
  1006. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  1007. data/lib/plaid/models/identity_update_types.rb +5 -5
  1008. data/lib/plaid/models/identity_verification.rb +30 -9
  1009. data/lib/plaid/models/identity_verification_autofill_address.rb +3 -3
  1010. data/lib/plaid/models/identity_verification_autofill_create_request.rb +1 -1
  1011. data/lib/plaid/models/identity_verification_autofill_create_response.rb +1 -1
  1012. data/lib/plaid/models/identity_verification_autofill_status.rb +1 -1
  1013. data/lib/plaid/models/identity_verification_autofill_user_data.rb +1 -1
  1014. data/lib/plaid/models/identity_verification_create_request.rb +48 -6
  1015. data/lib/plaid/models/identity_verification_create_request_user.rb +18 -7
  1016. data/lib/plaid/models/identity_verification_create_response.rb +26 -5
  1017. data/lib/plaid/models/identity_verification_document_address_response.rb +2 -2
  1018. data/lib/plaid/models/identity_verification_document_name_response.rb +1 -1
  1019. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  1020. data/lib/plaid/models/identity_verification_get_response.rb +26 -5
  1021. data/lib/plaid/models/identity_verification_language.rb +45 -0
  1022. data/lib/plaid/models/identity_verification_list_request.rb +15 -9
  1023. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  1024. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  1025. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  1026. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  1027. data/lib/plaid/models/identity_verification_retried_webhook.rb +2 -2
  1028. data/lib/plaid/models/identity_verification_retry_request.rb +3 -3
  1029. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +2 -2
  1030. data/lib/plaid/models/identity_verification_retry_response.rb +26 -5
  1031. data/lib/plaid/models/identity_verification_status.rb +1 -1
  1032. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  1033. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  1034. data/lib/plaid/models/identity_verification_step_summary.rb +2 -2
  1035. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  1036. data/lib/plaid/models/identity_verification_template_reference.rb +2 -2
  1037. data/lib/plaid/models/identity_verification_user_address.rb +3 -3
  1038. data/lib/plaid/models/identity_verification_user_data.rb +2 -2
  1039. data/lib/plaid/models/idv_protect_event.rb +264 -0
  1040. data/lib/plaid/models/image_quality.rb +1 -1
  1041. data/lib/plaid/models/image_quality_details.rb +4 -23
  1042. data/lib/plaid/models/image_quality_outcome.rb +1 -1
  1043. data/lib/plaid/models/incident_update.rb +1 -1
  1044. data/lib/plaid/models/income_breakdown.rb +1 -1
  1045. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  1046. data/lib/plaid/models/income_insights.rb +238 -0
  1047. data/lib/plaid/models/income_insights_filter.rb +240 -0
  1048. data/lib/plaid/models/income_insights_income_excluding_transfers.rb +251 -0
  1049. data/lib/plaid/models/income_insights_total_income.rb +251 -0
  1050. data/lib/plaid/models/income_insights_transfers_in.rb +251 -0
  1051. data/lib/plaid/models/income_insights_version.rb +38 -0
  1052. data/lib/plaid/models/income_override.rb +1 -1
  1053. data/lib/plaid/models/income_sources_counts.rb +2 -6
  1054. data/lib/plaid/models/income_summary.rb +1 -1
  1055. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  1056. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  1057. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  1058. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  1059. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  1060. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  1061. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  1062. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  1063. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  1064. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  1065. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  1066. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  1067. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  1068. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  1069. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  1070. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  1071. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  1072. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  1073. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  1074. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +1 -1
  1075. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +6 -1
  1076. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  1077. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  1078. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  1079. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  1080. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  1081. data/lib/plaid/models/individual_name.rb +2 -2
  1082. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  1083. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  1084. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  1085. data/lib/plaid/models/inflow_model.rb +9 -27
  1086. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  1087. data/lib/plaid/models/institution.rb +40 -4
  1088. data/lib/plaid/models/institution_connection_availability.rb +39 -0
  1089. data/lib/plaid/models/institution_status.rb +2 -2
  1090. data/lib/plaid/models/institution_status_alert_webhook.rb +1 -1
  1091. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  1092. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  1093. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  1094. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  1095. data/lib/plaid/models/institutions_get_request.rb +1 -1
  1096. data/lib/plaid/models/institutions_get_request_options.rb +3 -3
  1097. data/lib/plaid/models/institutions_get_response.rb +1 -1
  1098. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  1099. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  1100. data/lib/plaid/models/institutions_search_request.rb +2 -2
  1101. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  1102. data/lib/plaid/models/institutions_search_response.rb +1 -1
  1103. data/lib/plaid/models/investment_account.rb +410 -0
  1104. data/lib/plaid/models/investment_account_all_of.rb +262 -0
  1105. data/lib/plaid/models/investment_account_balance.rb +296 -0
  1106. data/lib/plaid/models/investment_account_balance_all_of.rb +221 -0
  1107. data/lib/plaid/models/investment_account_subtype.rb +10 -1
  1108. data/lib/plaid/models/investment_filter.rb +1 -1
  1109. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  1110. data/lib/plaid/models/investment_transaction.rb +17 -6
  1111. data/lib/plaid/models/investment_transaction_subtype.rb +1 -4
  1112. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  1113. data/lib/plaid/models/investments_auth401k_contribution_details.rb +1 -1
  1114. data/lib/plaid/models/investments_auth401k_fee_details.rb +1 -1
  1115. data/lib/plaid/models/investments_auth_account_details401k.rb +1 -1
  1116. data/lib/plaid/models/investments_auth_data_sources.rb +1 -1
  1117. data/lib/plaid/models/investments_auth_get_numbers.rb +2 -2
  1118. data/lib/plaid/models/investments_auth_get_request.rb +2 -2
  1119. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  1120. data/lib/plaid/models/investments_auth_get_response.rb +2 -2
  1121. data/lib/plaid/models/investments_auth_owner.rb +2 -2
  1122. data/lib/plaid/models/investments_default_update_webhook.rb +22 -12
  1123. data/lib/plaid/models/investments_historical_update_webhook.rb +23 -13
  1124. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  1125. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  1126. data/lib/plaid/models/investments_refresh_request.rb +2 -2
  1127. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  1128. data/lib/plaid/models/investments_transactions_get_request.rb +3 -3
  1129. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  1130. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  1131. data/lib/plaid/models/investments_transactions_override.rb +3 -3
  1132. data/lib/plaid/models/iso_currency_code.rb +1 -1
  1133. data/lib/plaid/models/issue.rb +2 -2
  1134. data/lib/plaid/models/issue_resolved_webhook.rb +1 -1
  1135. data/lib/plaid/models/issues_get_request.rb +1 -1
  1136. data/lib/plaid/models/issues_get_response.rb +2 -2
  1137. data/lib/plaid/models/issues_search_request.rb +1 -1
  1138. data/lib/plaid/models/issues_search_response.rb +3 -3
  1139. data/lib/plaid/models/issues_status.rb +1 -1
  1140. data/lib/plaid/models/issues_subscribe_request.rb +1 -1
  1141. data/lib/plaid/models/issues_subscribe_response.rb +2 -2
  1142. data/lib/plaid/models/issuing_country.rb +1 -1
  1143. data/lib/plaid/models/item.rb +21 -10
  1144. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  1145. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  1146. data/lib/plaid/models/item_activity_list_request.rb +2 -2
  1147. data/lib/plaid/models/item_activity_list_response.rb +2 -2
  1148. data/lib/plaid/models/item_add_result_webhook.rb +3 -3
  1149. data/lib/plaid/models/item_application_list_request.rb +2 -2
  1150. data/lib/plaid/models/item_application_list_response.rb +17 -5
  1151. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  1152. data/lib/plaid/models/item_application_scopes_update_request.rb +3 -3
  1153. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  1154. data/lib/plaid/models/item_application_unlink_request.rb +4 -4
  1155. data/lib/plaid/models/item_application_unlink_response.rb +1 -1
  1156. data/lib/plaid/models/item_auth_method.rb +2 -1
  1157. data/lib/plaid/models/item_consented_data_scope.rb +11 -4
  1158. data/lib/plaid/models/item_create_authentication.rb +1 -1
  1159. data/lib/plaid/models/item_error_webhook.rb +13 -3
  1160. data/lib/plaid/models/item_get_request.rb +2 -2
  1161. data/lib/plaid/models/item_get_response.rb +1 -1
  1162. data/lib/plaid/models/item_import_request.rb +16 -15
  1163. data/lib/plaid/models/item_import_request_options.rb +2 -2
  1164. data/lib/plaid/models/item_import_request_user_auth.rb +4 -9
  1165. data/lib/plaid/models/item_import_response.rb +2 -2
  1166. data/lib/plaid/models/item_login_repaired_webhook.rb +12 -2
  1167. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  1168. data/lib/plaid/models/item_products_terminate_request.rb +310 -0
  1169. data/lib/plaid/models/item_products_terminate_response.rb +226 -0
  1170. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  1171. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  1172. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  1173. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  1174. data/lib/plaid/models/item_remove_reason_code.rb +43 -0
  1175. data/lib/plaid/models/item_remove_request.rb +66 -6
  1176. data/lib/plaid/models/item_remove_response.rb +1 -1
  1177. data/lib/plaid/models/item_status.rb +1 -1
  1178. data/lib/plaid/models/item_status_investments.rb +1 -1
  1179. data/lib/plaid/models/item_status_last_webhook.rb +1 -2
  1180. data/lib/plaid/models/item_status_nullable.rb +2 -2
  1181. data/lib/plaid/models/item_status_transactions.rb +2 -2
  1182. data/lib/plaid/models/item_webhook_update_request.rb +2 -2
  1183. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  1184. data/lib/plaid/models/item_with_consent_fields.rb +20 -9
  1185. data/lib/plaid/models/item_with_consent_fields_all_of.rb +3 -3
  1186. data/lib/plaid/models/jwk_public_key.rb +1 -1
  1187. data/lib/plaid/models/jwt_header.rb +1 -1
  1188. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  1189. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  1190. data/lib/plaid/models/kyc_check_details.rb +3 -3
  1191. data/lib/plaid/models/kyc_check_details_international_address.rb +1 -1
  1192. data/lib/plaid/models/kyc_check_id_number_summary.rb +15 -5
  1193. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  1194. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  1195. data/lib/plaid/models/kyc_check_ssa_analysis.rb +258 -0
  1196. data/lib/plaid/models/kyc_check_ssa_match_status.rb +40 -0
  1197. data/lib/plaid/models/latest_scored_event.rb +274 -0
  1198. data/lib/plaid/models/layer_authentication_passed_webhook.rb +2 -2
  1199. data/lib/plaid/models/ledger_event_source_type.rb +40 -0
  1200. data/lib/plaid/models/{plaid_check_score.rb → lend_score.rb} +8 -8
  1201. data/lib/plaid/models/liabilities_default_update_webhook.rb +13 -3
  1202. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  1203. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  1204. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  1205. data/lib/plaid/models/liabilities_object.rb +32 -6
  1206. data/lib/plaid/models/liability_override.rb +379 -92
  1207. data/lib/plaid/models/liability_override_apr.rb +303 -0
  1208. data/lib/plaid/models/liability_override_apr_type.rb +42 -0
  1209. data/lib/plaid/models/liability_override_interest_rate.rb +278 -0
  1210. data/lib/plaid/models/liability_override_interest_rate_type.rb +39 -0
  1211. data/lib/plaid/models/limited_purpose_type.rb +38 -0
  1212. data/lib/plaid/models/line_of_credit_liability.rb +396 -0
  1213. data/lib/plaid/models/link_callback_metadata.rb +2 -2
  1214. data/lib/plaid/models/link_delivery_account.rb +1 -1
  1215. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  1216. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  1217. data/lib/plaid/models/link_delivery_metadata.rb +2 -2
  1218. data/lib/plaid/models/link_delivery_verification_status.rb +2 -1
  1219. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  1220. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  1221. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  1222. data/lib/plaid/models/link_event.rb +1 -1
  1223. data/lib/plaid/models/link_event_metadata.rb +3 -3
  1224. data/lib/plaid/models/link_event_name.rb +1 -1
  1225. data/lib/plaid/models/link_events_webhook.rb +42 -6
  1226. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  1227. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  1228. data/lib/plaid/models/link_session_bank_employment_result.rb +1 -1
  1229. data/lib/plaid/models/link_session_bank_income_result.rb +1 -1
  1230. data/lib/plaid/models/link_session_cra_document_upload_result.rb +2 -2
  1231. data/lib/plaid/models/link_session_cra_item_add_result.rb +1 -1
  1232. data/lib/plaid/models/link_session_cra_update_result.rb +253 -0
  1233. data/lib/plaid/models/link_session_exit.rb +2 -2
  1234. data/lib/plaid/models/link_session_exit_deprecated.rb +2 -2
  1235. data/lib/plaid/models/link_session_exit_metadata.rb +2 -2
  1236. data/lib/plaid/models/link_session_exit_metadata_institution.rb +2 -2
  1237. data/lib/plaid/models/link_session_finished_webhook.rb +15 -5
  1238. data/lib/plaid/models/link_session_item_add_result.rb +1 -1
  1239. data/lib/plaid/models/link_session_payroll_income_result.rb +1 -1
  1240. data/lib/plaid/models/link_session_results.rb +20 -3
  1241. data/lib/plaid/models/link_session_success.rb +2 -2
  1242. data/lib/plaid/models/link_session_success_metadata.rb +12 -2
  1243. data/lib/plaid/models/link_session_success_metadata_account.rb +4 -4
  1244. data/lib/plaid/models/link_session_success_metadata_institution.rb +2 -2
  1245. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  1246. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  1247. data/lib/plaid/models/link_token_cashflow_report.rb +1 -1
  1248. data/lib/plaid/models/link_token_create_card_switch.rb +1 -1
  1249. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  1250. data/lib/plaid/models/link_token_create_depository_filter.rb +17 -5
  1251. data/lib/plaid/models/link_token_create_hosted_link.rb +2 -2
  1252. data/lib/plaid/models/link_token_create_identity.rb +1 -1
  1253. data/lib/plaid/models/link_token_create_institution_data.rb +15 -5
  1254. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  1255. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  1256. data/lib/plaid/models/link_token_create_request.rb +43 -38
  1257. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  1258. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +1 -1
  1259. data/lib/plaid/models/link_token_create_request_auth.rb +3 -3
  1260. data/lib/plaid/models/link_token_create_request_base_report.rb +1 -1
  1261. data/lib/plaid/models/link_token_create_request_cra_options.rb +54 -16
  1262. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +38 -7
  1263. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +228 -0
  1264. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +2 -12
  1265. data/lib/plaid/models/link_token_create_request_cra_options_income_insights.rb +253 -0
  1266. data/lib/plaid/models/link_token_create_request_cra_options_lend_score.rb +243 -0
  1267. data/lib/plaid/models/link_token_create_request_cra_options_network_insights.rb +243 -0
  1268. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +16 -18
  1269. data/lib/plaid/models/link_token_create_request_cra_report_parameter.rb +380 -0
  1270. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +5 -17
  1271. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  1272. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  1273. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  1274. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  1275. data/lib/plaid/models/link_token_create_request_income_verification.rb +2 -2
  1276. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  1277. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  1278. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +1 -1
  1279. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  1280. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  1281. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  1282. data/lib/plaid/models/link_token_create_request_update.rb +4 -4
  1283. data/lib/plaid/models/link_token_create_request_user.rb +6 -6
  1284. data/lib/plaid/models/link_token_create_request_user_address.rb +3 -3
  1285. data/lib/plaid/models/link_token_create_request_user_id_number.rb +2 -2
  1286. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  1287. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  1288. data/lib/plaid/models/link_token_create_response.rb +15 -5
  1289. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  1290. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  1291. data/lib/plaid/models/link_token_get_request.rb +1 -1
  1292. data/lib/plaid/models/link_token_get_response.rb +12 -2
  1293. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  1294. data/lib/plaid/models/link_token_investments.rb +1 -1
  1295. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  1296. data/lib/plaid/models/link_token_transactions.rb +2 -2
  1297. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  1298. data/lib/plaid/models/loan.rb +1 -1
  1299. data/lib/plaid/models/loan_account_subtype.rb +4 -1
  1300. data/lib/plaid/models/loan_compounding_period.rb +44 -0
  1301. data/lib/plaid/models/loan_disbursements_indicators.rb +323 -0
  1302. data/lib/plaid/models/loan_filter.rb +1 -1
  1303. data/lib/plaid/models/loan_identifier.rb +1 -1
  1304. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  1305. data/lib/plaid/models/loan_identifiers.rb +1 -1
  1306. data/lib/plaid/models/{link_delivery_communication_method.rb → loan_interest_rate.rb} +21 -19
  1307. data/lib/plaid/models/loan_interest_rate_type.rb +39 -0
  1308. data/lib/plaid/models/loan_liability.rb +421 -0
  1309. data/lib/plaid/models/loan_payment_frequency.rb +44 -0
  1310. data/lib/plaid/models/loan_payments_counts.rb +2 -6
  1311. data/lib/plaid/models/loan_payments_indicators.rb +323 -0
  1312. data/lib/plaid/models/loan_payments_merchant_counts.rb +2 -6
  1313. data/lib/plaid/models/loans.rb +1 -1
  1314. data/lib/plaid/models/location.rb +2 -2
  1315. data/lib/plaid/models/match_summary.rb +1 -1
  1316. data/lib/plaid/models/match_summary_code.rb +1 -1
  1317. data/lib/plaid/models/merchant_insights.rb +2 -2
  1318. data/lib/plaid/models/meta.rb +18 -32
  1319. data/lib/plaid/models/mfa.rb +2 -22
  1320. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +1 -1
  1321. data/lib/plaid/models/monitoring_income_insights.rb +1 -1
  1322. data/lib/plaid/models/monitoring_income_source.rb +1 -1
  1323. data/lib/plaid/models/monitoring_insights.rb +1 -1
  1324. data/lib/plaid/models/monitoring_insights_item_status.rb +1 -1
  1325. data/lib/plaid/models/monitoring_insights_status.rb +1 -4
  1326. data/lib/plaid/models/monitoring_item_status_code.rb +1 -3
  1327. data/lib/plaid/models/monitoring_loan_insights.rb +1 -1
  1328. data/lib/plaid/models/monthly_average.rb +244 -0
  1329. data/lib/plaid/models/monthly_summary.rb +243 -0
  1330. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  1331. data/lib/plaid/models/mortgage_liability.rb +1 -1
  1332. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  1333. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  1334. data/lib/plaid/models/name_match_score.rb +2 -2
  1335. data/lib/plaid/models/negative_balance_insights.rb +255 -0
  1336. data/lib/plaid/models/negative_balance_occurrence.rb +243 -0
  1337. data/lib/plaid/models/net_pay.rb +2 -2
  1338. data/lib/plaid/models/network_insights_version.rb +38 -0
  1339. data/lib/plaid/models/network_status_get_request.rb +1 -1
  1340. data/lib/plaid/models/network_status_get_response.rb +1 -1
  1341. data/lib/plaid/models/network_status_get_response_layer.rb +1 -1
  1342. data/lib/plaid/models/network_status_get_response_network_status.rb +1 -1
  1343. data/lib/plaid/models/network_status_get_user.rb +1 -1
  1344. data/lib/plaid/models/new_accounts_available_webhook.rb +12 -2
  1345. data/lib/plaid/models/numbers.rb +4 -4
  1346. data/lib/plaid/models/numbers_acats.rb +2 -2
  1347. data/lib/plaid/models/numbers_ach.rb +3 -3
  1348. data/lib/plaid/models/numbers_ach_nullable.rb +3 -3
  1349. data/lib/plaid/models/numbers_aton.rb +2 -2
  1350. data/lib/plaid/models/numbers_bacs.rb +4 -4
  1351. data/lib/plaid/models/numbers_bacs_nullable.rb +4 -4
  1352. data/lib/plaid/models/numbers_eft.rb +1 -1
  1353. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  1354. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  1355. data/lib/plaid/models/numbers_international.rb +2 -2
  1356. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  1357. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  1358. data/lib/plaid/models/numbers_retirement401k.rb +1 -1
  1359. data/lib/plaid/models/o_auth_error_code.rb +43 -0
  1360. data/lib/plaid/models/{link_delivery_create_response.rb → o_auth_error_response.rb} +51 -30
  1361. data/lib/plaid/models/o_auth_grant_type.rb +40 -0
  1362. data/lib/plaid/models/o_auth_introspect_request.rb +256 -0
  1363. data/lib/plaid/models/o_auth_introspect_response.rb +331 -0
  1364. data/lib/plaid/models/o_auth_revoke_request.rb +256 -0
  1365. data/lib/plaid/models/o_auth_revoke_response.rb +226 -0
  1366. data/lib/plaid/models/o_auth_subject_token_type.rb +40 -0
  1367. data/lib/plaid/models/o_auth_token_request.rb +336 -0
  1368. data/lib/plaid/models/o_auth_token_response.rb +286 -0
  1369. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  1370. data/lib/plaid/models/option_contract.rb +2 -2
  1371. data/lib/plaid/models/originating_fund_source.rb +1 -1
  1372. data/lib/plaid/models/originator.rb +2 -2
  1373. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  1374. data/lib/plaid/models/other_account_subtype.rb +1 -1
  1375. data/lib/plaid/models/other_filter.rb +1 -1
  1376. data/lib/plaid/models/outlier_transactions_insights.rb +244 -0
  1377. data/lib/plaid/models/override_account_type.rb +1 -1
  1378. data/lib/plaid/models/override_accounts.rb +24 -53
  1379. data/lib/plaid/models/owner.rb +1 -1
  1380. data/lib/plaid/models/owner_override.rb +2 -17
  1381. data/lib/plaid/models/ownership_type.rb +1 -1
  1382. data/lib/plaid/models/parties.rb +1 -1
  1383. data/lib/plaid/models/partner_customer_create_request.rb +3 -3
  1384. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  1385. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  1386. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  1387. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  1388. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  1389. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  1390. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  1391. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  1392. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  1393. data/lib/plaid/models/partner_end_customer.rb +1 -1
  1394. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  1395. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  1396. data/lib/plaid/models/partner_end_customer_bank_addendum_acceptance.rb +241 -0
  1397. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  1398. data/lib/plaid/models/partner_end_customer_cra_purposes.rb +283 -0
  1399. data/lib/plaid/models/partner_end_customer_cra_questionnaire.rb +240 -0
  1400. data/lib/plaid/models/partner_end_customer_cra_use_case.rb +44 -0
  1401. data/lib/plaid/models/partner_end_customer_cra_use_cases.rb +223 -0
  1402. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +3 -2
  1403. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  1404. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +20 -8
  1405. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  1406. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  1407. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  1408. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  1409. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  1410. data/lib/plaid/models/partner_end_customer_questionnaires.rb +220 -0
  1411. data/lib/plaid/models/partner_end_customer_requirement_due.rb +46 -0
  1412. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  1413. data/lib/plaid/models/partner_end_customer_status.rb +2 -1
  1414. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  1415. data/lib/plaid/models/partner_end_customer_with_secrets.rb +2 -2
  1416. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  1417. data/lib/plaid/models/party.rb +2 -2
  1418. data/lib/plaid/models/party_individual.rb +1 -1
  1419. data/lib/plaid/models/party_role_type.rb +1 -1
  1420. data/lib/plaid/models/pay.rb +1 -1
  1421. data/lib/plaid/models/pay_frequency.rb +1 -1
  1422. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  1423. data/lib/plaid/models/pay_period_details.rb +1 -1
  1424. data/lib/plaid/models/pay_period_details_pay_frequency.rb +1 -1
  1425. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +2 -2
  1426. data/lib/plaid/models/pay_stub_deductions_total.rb +2 -2
  1427. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +2 -2
  1428. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +3 -3
  1429. data/lib/plaid/models/pay_stub_earnings_total.rb +2 -2
  1430. data/lib/plaid/models/pay_stub_pay_period_details.rb +2 -2
  1431. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  1432. data/lib/plaid/models/payment_amount.rb +1 -1
  1433. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  1434. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  1435. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  1436. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  1437. data/lib/plaid/models/payment_channel.rb +1 -1
  1438. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  1439. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  1440. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  1441. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  1442. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  1443. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  1444. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  1445. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  1446. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  1447. data/lib/plaid/models/payment_initiation_consent_create_request.rb +13 -3
  1448. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  1449. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  1450. data/lib/plaid/models/payment_initiation_consent_get_response.rb +2 -2
  1451. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +1 -1
  1452. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +2 -2
  1453. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +2 -2
  1454. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +15 -5
  1455. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +1 -1
  1456. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  1457. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +2 -2
  1458. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  1459. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  1460. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +1 -1
  1461. data/lib/plaid/models/payment_initiation_consent_type.rb +1 -1
  1462. data/lib/plaid/models/payment_initiation_metadata.rb +20 -10
  1463. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  1464. data/lib/plaid/models/payment_initiation_payment.rb +17 -7
  1465. data/lib/plaid/models/payment_initiation_payment_create_request.rb +13 -3
  1466. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  1467. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  1468. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  1469. data/lib/plaid/models/payment_initiation_payment_get_response.rb +14 -4
  1470. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  1471. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  1472. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +3 -3
  1473. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +2 -2
  1474. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  1475. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  1476. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  1477. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  1478. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  1479. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  1480. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  1481. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  1482. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  1483. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +71 -5
  1484. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +32 -5
  1485. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -6
  1486. data/lib/plaid/models/payment_meta.rb +2 -2
  1487. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  1488. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  1489. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  1490. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  1491. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  1492. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  1493. data/lib/plaid/models/payment_profile_status.rb +1 -1
  1494. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  1495. data/lib/plaid/models/payment_scheme.rb +1 -1
  1496. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  1497. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  1498. data/lib/plaid/models/payroll_income_object.rb +22 -5
  1499. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  1500. data/lib/plaid/models/payroll_item.rb +1 -1
  1501. data/lib/plaid/models/payroll_item_status.rb +1 -1
  1502. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  1503. data/lib/plaid/models/paystub.rb +1 -1
  1504. data/lib/plaid/models/paystub_address.rb +1 -1
  1505. data/lib/plaid/models/paystub_deduction.rb +2 -2
  1506. data/lib/plaid/models/paystub_details.rb +1 -1
  1507. data/lib/plaid/models/paystub_employer.rb +1 -1
  1508. data/lib/plaid/models/paystub_override.rb +1 -1
  1509. data/lib/plaid/models/paystub_override_deductions.rb +1 -1
  1510. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +1 -1
  1511. data/lib/plaid/models/paystub_override_deductions_total.rb +1 -1
  1512. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +1 -1
  1513. data/lib/plaid/models/paystub_override_earnings.rb +1 -1
  1514. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +2 -2
  1515. data/lib/plaid/models/paystub_override_earnings_total.rb +1 -1
  1516. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  1517. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  1518. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  1519. data/lib/plaid/models/paystub_override_employer_address.rb +1 -1
  1520. data/lib/plaid/models/paystub_override_net_pay.rb +1 -1
  1521. data/lib/plaid/models/paystub_override_pay_period_details.rb +2 -34
  1522. data/lib/plaid/models/paystub_override_taxpayer_id.rb +1 -1
  1523. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  1524. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  1525. data/lib/plaid/models/pending_disconnect_webhook.rb +28 -3
  1526. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +1 -1
  1527. data/lib/plaid/models/pending_expiration_webhook.rb +13 -3
  1528. data/lib/plaid/models/personal_finance_category.rb +39 -8
  1529. data/lib/plaid/models/personal_finance_category_version.rb +39 -0
  1530. data/lib/plaid/models/phone_number.rb +1 -1
  1531. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  1532. data/lib/plaid/models/phone_type.rb +1 -1
  1533. data/lib/plaid/models/physical_document_category.rb +1 -1
  1534. data/lib/plaid/models/physical_document_extracted_data.rb +15 -4
  1535. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  1536. data/lib/plaid/models/physical_document_images.rb +1 -1
  1537. data/lib/plaid/models/plaid_error.rb +32 -8
  1538. data/lib/plaid/models/plaid_error_type.rb +20 -1
  1539. data/lib/plaid/models/{plaid_check_score_version.rb → plaid_lend_score_version.rb} +3 -2
  1540. data/lib/plaid/models/platform_ids.rb +1 -1
  1541. data/lib/plaid/models/po_box_status.rb +1 -1
  1542. data/lib/plaid/models/prism_cash_score.rb +1 -1
  1543. data/lib/plaid/models/prism_cash_score_metadata.rb +1 -1
  1544. data/lib/plaid/models/prism_cash_score_version.rb +3 -1
  1545. data/lib/plaid/models/prism_detect.rb +268 -0
  1546. data/lib/plaid/models/prism_detect_version.rb +40 -0
  1547. data/lib/plaid/models/prism_extend.rb +268 -0
  1548. data/lib/plaid/models/prism_extend_version.rb +40 -0
  1549. data/lib/plaid/models/prism_first_detect.rb +1 -1
  1550. data/lib/plaid/models/prism_first_detect_version.rb +1 -1
  1551. data/lib/plaid/models/prism_insights.rb +14 -4
  1552. data/lib/plaid/models/prism_insights_version.rb +3 -1
  1553. data/lib/plaid/models/prism_versions.rb +22 -2
  1554. data/lib/plaid/models/prism_versions_deprecated.rb +283 -0
  1555. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  1556. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  1557. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  1558. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  1559. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  1560. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  1561. data/lib/plaid/models/processor_balance_get_request_options.rb +2 -2
  1562. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  1563. data/lib/plaid/models/processor_bank_transfer_create_request.rb +3 -3
  1564. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  1565. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  1566. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  1567. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  1568. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  1569. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  1570. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  1571. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  1572. data/lib/plaid/models/processor_investments_auth_get_request.rb +246 -0
  1573. data/lib/plaid/models/processor_investments_auth_get_response.rb +341 -0
  1574. data/lib/plaid/models/processor_investments_holdings_get_request.rb +1 -1
  1575. data/lib/plaid/models/processor_investments_holdings_get_response.rb +3 -8
  1576. data/lib/plaid/models/processor_investments_transactions_get_request.rb +2 -2
  1577. data/lib/plaid/models/processor_investments_transactions_get_response.rb +3 -3
  1578. data/lib/plaid/models/processor_liabilities_get_request.rb +1 -1
  1579. data/lib/plaid/models/processor_liabilities_get_response.rb +1 -1
  1580. data/lib/plaid/models/processor_number.rb +2 -2
  1581. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  1582. data/lib/plaid/models/processor_signal_decision_report_request.rb +3 -3
  1583. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  1584. data/lib/plaid/models/processor_signal_evaluate_request.rb +4 -4
  1585. data/lib/plaid/models/processor_signal_evaluate_response.rb +2 -2
  1586. data/lib/plaid/models/processor_signal_prepare_request.rb +1 -1
  1587. data/lib/plaid/models/processor_signal_prepare_response.rb +1 -1
  1588. data/lib/plaid/models/processor_signal_return_report_request.rb +2 -2
  1589. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  1590. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +3 -3
  1591. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  1592. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +2 -2
  1593. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  1594. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  1595. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  1596. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  1597. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  1598. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  1599. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  1600. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  1601. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  1602. data/lib/plaid/models/processor_transactions_get_request.rb +2 -2
  1603. data/lib/plaid/models/processor_transactions_get_request_options.rb +1 -1
  1604. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  1605. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  1606. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +34 -3
  1607. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  1608. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  1609. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  1610. data/lib/plaid/models/processor_transactions_sync_request.rb +2 -2
  1611. data/lib/plaid/models/processor_transactions_sync_response.rb +3 -7
  1612. data/lib/plaid/models/product_access.rb +7 -7
  1613. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  1614. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  1615. data/lib/plaid/models/product_status.rb +2 -2
  1616. data/lib/plaid/models/product_status_breakdown.rb +3 -3
  1617. data/lib/plaid/models/products.rb +8 -1
  1618. data/lib/plaid/models/products_terminate_reason_code.rb +50 -0
  1619. data/lib/plaid/models/profile_network_status_get_request.rb +1 -1
  1620. data/lib/plaid/models/profile_network_status_get_response.rb +1 -1
  1621. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  1622. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  1623. data/lib/plaid/models/protect_bank_account.rb +244 -0
  1624. data/lib/plaid/models/protect_cash_advance_decision_create_request.rb +365 -0
  1625. data/lib/plaid/models/{sandbox_transfer_repayment_simulate_response.rb → protect_cash_advance_decision_create_response.rb} +5 -5
  1626. data/lib/plaid/models/protect_cash_advance_feedback_upload_request.rb +262 -0
  1627. data/lib/plaid/models/protect_cash_advance_feedback_upload_response.rb +241 -0
  1628. data/lib/plaid/models/protect_cash_advance_repayment_create_request.rb +321 -0
  1629. data/lib/plaid/models/protect_cash_advance_repayment_create_response.rb +226 -0
  1630. data/lib/plaid/models/protect_compute_request.rb +291 -0
  1631. data/lib/plaid/models/protect_compute_response.rb +281 -0
  1632. data/lib/plaid/models/protect_compute_subscores.rb +288 -0
  1633. data/lib/plaid/models/protect_device_model_inputs.rb +247 -0
  1634. data/lib/plaid/models/protect_event.rb +275 -0
  1635. data/lib/plaid/models/protect_event_get_request.rb +246 -0
  1636. data/lib/plaid/models/protect_event_get_response.rb +289 -0
  1637. data/lib/plaid/models/protect_event_send_request.rb +271 -0
  1638. data/lib/plaid/models/protect_event_send_response.rb +264 -0
  1639. data/lib/plaid/models/protect_incident_amount.rb +239 -0
  1640. data/lib/plaid/models/protect_incident_event.rb +308 -0
  1641. data/lib/plaid/models/protect_incident_event_response.rb +298 -0
  1642. data/lib/plaid/models/protect_link_model_inputs.rb +257 -0
  1643. data/lib/plaid/models/protect_model_inputs.rb +231 -0
  1644. data/lib/plaid/models/protect_report.rb +347 -0
  1645. data/lib/plaid/models/protect_report_confidence.rb +39 -0
  1646. data/lib/plaid/models/protect_report_create_request.rb +347 -0
  1647. data/lib/plaid/models/protect_report_create_response.rb +241 -0
  1648. data/lib/plaid/models/protect_report_source.rb +44 -0
  1649. data/lib/plaid/models/protect_report_type.rb +56 -0
  1650. data/lib/plaid/models/protect_user.rb +231 -0
  1651. data/lib/plaid/models/protect_user_event_webhook.rb +355 -0
  1652. data/lib/plaid/models/protect_user_insights_get_request.rb +251 -0
  1653. data/lib/plaid/models/protect_user_insights_get_response.rb +263 -0
  1654. data/lib/plaid/models/provider_business_address.rb +296 -0
  1655. data/lib/plaid/models/provider_business_name.rb +237 -0
  1656. data/lib/plaid/models/proxy_type.rb +1 -1
  1657. data/lib/plaid/models/pslf_status.rb +1 -1
  1658. data/lib/plaid/models/reason_code.rb +1 -1
  1659. data/lib/plaid/models/recaptcha_required_error.rb +7 -26
  1660. data/lib/plaid/models/receiver_details.rb +222 -0
  1661. data/lib/plaid/models/recipient_bacs.rb +2 -2
  1662. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  1663. data/lib/plaid/models/recommendation_string.rb +1 -1
  1664. data/lib/plaid/models/recurring_cancelled_webhook.rb +3 -3
  1665. data/lib/plaid/models/recurring_insights_stream.rb +1 -1
  1666. data/lib/plaid/models/recurring_new_transfer_webhook.rb +3 -3
  1667. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  1668. data/lib/plaid/models/recurring_transactions.rb +1 -1
  1669. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  1670. data/lib/plaid/models/recurring_transfer.rb +6 -5
  1671. data/lib/plaid/models/recurring_transfer_nullable.rb +6 -5
  1672. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +2 -2
  1673. data/lib/plaid/models/refresh_result.rb +241 -0
  1674. data/lib/plaid/models/removed_transaction.rb +1 -1
  1675. data/lib/plaid/models/report_type.rb +1 -1
  1676. data/lib/plaid/models/reporting_information.rb +2 -2
  1677. data/lib/plaid/models/request_business_address.rb +289 -0
  1678. data/lib/plaid/models/response_business_address.rb +281 -0
  1679. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  1680. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  1681. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  1682. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  1683. data/lib/plaid/models/risk_check_details.rb +34 -6
  1684. data/lib/plaid/models/risk_check_device.rb +1 -1
  1685. data/lib/plaid/models/risk_check_email.rb +44 -2
  1686. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  1687. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  1688. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  1689. data/lib/plaid/models/risk_check_email_includes_date_of_birth.rb +40 -0
  1690. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  1691. data/lib/plaid/models/risk_check_email_is_edu.rb +40 -0
  1692. data/lib/plaid/models/risk_check_email_name.rb +43 -0
  1693. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  1694. data/lib/plaid/models/risk_check_facial_duplicate.rb +256 -0
  1695. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  1696. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  1697. data/lib/plaid/models/risk_check_network.rb +1 -1
  1698. data/lib/plaid/models/risk_check_phone.rb +1 -1
  1699. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  1700. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  1701. data/lib/plaid/models/risk_indicators.rb +261 -0
  1702. data/lib/plaid/models/risk_level.rb +1 -1
  1703. data/lib/plaid/models/risk_level_with_no_data.rb +1 -1
  1704. data/lib/plaid/models/risk_profile.rb +2 -2
  1705. data/lib/plaid/models/risk_reason.rb +2 -2
  1706. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  1707. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  1708. data/lib/plaid/models/risk_signal_document_type.rb +1 -1
  1709. data/lib/plaid/models/risk_signal_file_type.rb +1 -1
  1710. data/lib/plaid/models/role.rb +2 -2
  1711. data/lib/plaid/models/role_detail.rb +1 -1
  1712. data/lib/plaid/models/roles.rb +1 -1
  1713. data/lib/plaid/models/rule_details.rb +5 -41
  1714. data/lib/plaid/models/rule_result.rb +1 -1
  1715. data/lib/plaid/models/ruleset.rb +40 -4
  1716. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  1717. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  1718. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  1719. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  1720. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  1721. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  1722. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  1723. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  1724. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +30 -12
  1725. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +2 -2
  1726. data/lib/plaid/models/sandbox_cra_servicing_simulate_error_webhook_code.rb +42 -0
  1727. data/lib/plaid/models/sandbox_cra_servicing_simulate_request.rb +266 -0
  1728. data/lib/plaid/models/sandbox_cra_servicing_simulate_request_options.rb +254 -0
  1729. data/lib/plaid/models/sandbox_cra_servicing_simulate_response.rb +237 -0
  1730. data/lib/plaid/models/sandbox_fdx_consent_seed_request.rb +271 -0
  1731. data/lib/plaid/models/sandbox_fdx_consent_seed_response.rb +241 -0
  1732. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +5 -5
  1733. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  1734. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +5 -3
  1735. data/lib/plaid/models/sandbox_item_application_seed_request.rb +261 -0
  1736. data/lib/plaid/models/sandbox_item_application_seed_response.rb +241 -0
  1737. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +15 -6
  1738. data/lib/plaid/models/sandbox_item_fire_webhook_request_options.rb +238 -0
  1739. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  1740. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  1741. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  1742. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  1743. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  1744. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +2 -2
  1745. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  1746. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  1747. data/lib/plaid/models/sandbox_payment_simulate_request.rb +17 -2
  1748. data/lib/plaid/models/sandbox_payment_simulate_response.rb +1 -1
  1749. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  1750. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +3 -3
  1751. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  1752. data/lib/plaid/models/sandbox_public_token_create_request.rb +17 -7
  1753. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  1754. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +4 -3
  1755. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  1756. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +1 -1
  1757. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +4 -4
  1758. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  1759. data/lib/plaid/models/{transactions_enhance_get_request.rb → sandbox_transactions_create_request.rb} +18 -18
  1760. data/lib/plaid/models/sandbox_transactions_create_response.rb +226 -0
  1761. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  1762. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  1763. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +2 -2
  1764. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  1765. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +15 -4
  1766. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  1767. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +2 -2
  1768. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  1769. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +3 -3
  1770. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +1 -1
  1771. data/lib/plaid/models/sandbox_transfer_rfp_simulate_action.rb +39 -0
  1772. data/lib/plaid/models/sandbox_transfer_rfp_simulate_request.rb +292 -0
  1773. data/lib/plaid/models/sandbox_transfer_rfp_simulate_response.rb +226 -0
  1774. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +3 -3
  1775. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  1776. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  1777. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  1778. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +2 -2
  1779. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1780. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1781. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1782. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +2 -2
  1783. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1784. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1785. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1786. data/lib/plaid/models/sandbox_user_fire_webhook_code.rb +41 -0
  1787. data/lib/plaid/models/sandbox_user_fire_webhook_request.rb +316 -0
  1788. data/lib/plaid/models/sandbox_user_fire_webhook_response.rb +241 -0
  1789. data/lib/plaid/models/sandbox_user_fire_webhook_type.rb +38 -0
  1790. data/lib/plaid/models/sandbox_user_reset_login_request.rb +17 -12
  1791. data/lib/plaid/models/sandbox_user_reset_login_response.rb +1 -1
  1792. data/lib/plaid/models/scopes.rb +1 -1
  1793. data/lib/plaid/models/scopes_context.rb +1 -1
  1794. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1795. data/lib/plaid/models/screening_hit_analysis.rb +2 -2
  1796. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1797. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1798. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1799. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1800. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1801. data/lib/plaid/models/security.rb +38 -5
  1802. data/lib/plaid/models/security_override.rb +9 -4
  1803. data/lib/plaid/models/selfie_age_check.rb +288 -0
  1804. data/lib/plaid/models/selfie_age_check_status.rb +41 -0
  1805. data/lib/plaid/models/selfie_analysis.rb +12 -2
  1806. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1807. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +1 -1
  1808. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +1 -1
  1809. data/lib/plaid/models/selfie_analysis_liveness_check.rb +1 -1
  1810. data/lib/plaid/models/selfie_capture.rb +4 -4
  1811. data/lib/plaid/models/selfie_check.rb +2 -2
  1812. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1813. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1814. data/lib/plaid/models/selfie_status.rb +1 -1
  1815. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  1816. data/lib/plaid/models/service.rb +1 -1
  1817. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1818. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1819. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1820. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1821. data/lib/plaid/models/services.rb +1 -1
  1822. data/lib/plaid/models/session_token_create_request.rb +36 -6
  1823. data/lib/plaid/models/session_token_create_request_user.rb +7 -3
  1824. data/lib/plaid/models/session_token_create_response.rb +1 -1
  1825. data/lib/plaid/models/session_token_create_response_link.rb +15 -5
  1826. data/lib/plaid/models/signal_address_data.rb +1 -1
  1827. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1828. data/lib/plaid/models/signal_decision_report_request.rb +2 -2
  1829. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1830. data/lib/plaid/models/signal_device.rb +2 -2
  1831. data/lib/plaid/models/signal_evaluate_core_attributes.rb +23 -12
  1832. data/lib/plaid/models/signal_evaluate_request.rb +8 -8
  1833. data/lib/plaid/models/signal_evaluate_response.rb +2 -2
  1834. data/lib/plaid/models/signal_payment_method.rb +2 -3
  1835. data/lib/plaid/models/signal_person_name.rb +1 -1
  1836. data/lib/plaid/models/signal_prepare_request.rb +2 -2
  1837. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1838. data/lib/plaid/models/signal_return_report_request.rb +3 -3
  1839. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1840. data/lib/plaid/models/signal_schedule_default_payment_method.rb +1 -3
  1841. data/lib/plaid/models/signal_schedule_recommendation.rb +1 -1
  1842. data/lib/plaid/models/signal_schedule_request.rb +3 -3
  1843. data/lib/plaid/models/signal_schedule_response.rb +4 -4
  1844. data/lib/plaid/models/signal_scores.rb +2 -2
  1845. data/lib/plaid/models/signal_user.rb +2 -2
  1846. data/lib/plaid/models/signal_warning.rb +3 -3
  1847. data/lib/plaid/models/simulated_transfer_sweep.rb +14 -3
  1848. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1849. data/lib/plaid/models/sms_verification.rb +1 -1
  1850. data/lib/plaid/models/sms_verification_status.rb +1 -1
  1851. data/lib/plaid/models/source.rb +2 -1
  1852. data/lib/plaid/models/standalone_account_type.rb +12 -2
  1853. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1854. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1855. data/lib/plaid/models/statements_account.rb +1 -1
  1856. data/lib/plaid/models/statements_download_request.rb +3 -3
  1857. data/lib/plaid/models/statements_list_request.rb +2 -2
  1858. data/lib/plaid/models/statements_list_response.rb +1 -1
  1859. data/lib/plaid/models/statements_refresh_complete_result.rb +1 -1
  1860. data/lib/plaid/models/statements_refresh_complete_webhook.rb +1 -1
  1861. data/lib/plaid/models/statements_refresh_request.rb +2 -2
  1862. data/lib/plaid/models/statements_refresh_response.rb +1 -1
  1863. data/lib/plaid/models/statements_statement.rb +2 -2
  1864. data/lib/plaid/models/status.rb +2 -2
  1865. data/lib/plaid/models/statuses.rb +1 -1
  1866. data/lib/plaid/models/strategy.rb +1 -1
  1867. data/lib/plaid/models/student_loan.rb +3 -3
  1868. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1869. data/lib/plaid/models/student_loan_status.rb +1 -1
  1870. data/lib/plaid/models/student_repayment_plan.rb +3 -3
  1871. data/lib/plaid/models/sweep_failure.rb +1 -1
  1872. data/lib/plaid/models/sweep_status.rb +1 -1
  1873. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1874. data/lib/plaid/models/sync_updates_available_webhook.rb +12 -2
  1875. data/lib/plaid/models/synthetic_fraud.rb +1 -1
  1876. data/lib/plaid/models/taxform.rb +1 -1
  1877. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1878. data/lib/plaid/models/taxpayer_identifier.rb +2 -2
  1879. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1880. data/lib/plaid/models/taxpayer_identifiers.rb +2 -2
  1881. data/lib/plaid/models/total.rb +1 -1
  1882. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1883. data/lib/plaid/models/total_inflow_amount.rb +2 -2
  1884. data/lib/plaid/models/total_inflow_amount30d.rb +2 -2
  1885. data/lib/plaid/models/total_inflow_amount60d.rb +2 -2
  1886. data/lib/plaid/models/total_inflow_amount90d.rb +2 -2
  1887. data/lib/plaid/models/total_monthly_income_insights.rb +4 -8
  1888. data/lib/plaid/models/total_outflow_amount.rb +2 -2
  1889. data/lib/plaid/models/total_outflow_amount30d.rb +2 -2
  1890. data/lib/plaid/models/total_outflow_amount60d.rb +2 -2
  1891. data/lib/plaid/models/total_outflow_amount90d.rb +2 -2
  1892. data/lib/plaid/models/total_report_inflow_amount.rb +2 -2
  1893. data/lib/plaid/models/total_report_inflow_amount30d.rb +2 -2
  1894. data/lib/plaid/models/total_report_inflow_amount60d.rb +2 -2
  1895. data/lib/plaid/models/total_report_inflow_amount90d.rb +2 -2
  1896. data/lib/plaid/models/total_report_outflow_amount.rb +2 -2
  1897. data/lib/plaid/models/total_report_outflow_amount30d.rb +2 -2
  1898. data/lib/plaid/models/total_report_outflow_amount60d.rb +2 -2
  1899. data/lib/plaid/models/total_report_outflow_amount90d.rb +2 -2
  1900. data/lib/plaid/models/transaction.rb +45 -13
  1901. data/lib/plaid/models/transaction_all_of.rb +39 -7
  1902. data/lib/plaid/models/transaction_base.rb +7 -7
  1903. data/lib/plaid/models/transaction_code.rb +7 -1
  1904. data/lib/plaid/models/transaction_counterparty.rb +18 -8
  1905. data/lib/plaid/models/transaction_data.rb +1 -1
  1906. data/lib/plaid/models/transaction_override.rb +2 -2
  1907. data/lib/plaid/models/transaction_stream.rb +4 -12
  1908. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1909. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1910. data/lib/plaid/models/transactions_category_rule.rb +36 -16
  1911. data/lib/plaid/models/transactions_enrich_request.rb +1 -1
  1912. data/lib/plaid/models/transactions_enrich_request_options.rb +36 -5
  1913. data/lib/plaid/models/transactions_enrich_response.rb +1 -1
  1914. data/lib/plaid/models/transactions_get_request.rb +3 -3
  1915. data/lib/plaid/models/transactions_get_request_options.rb +34 -3
  1916. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1917. data/lib/plaid/models/transactions_recurring_create_input.rb +1 -1
  1918. data/lib/plaid/models/transactions_recurring_create_request.rb +3 -3
  1919. data/lib/plaid/models/transactions_recurring_create_response.rb +1 -1
  1920. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  1921. data/lib/plaid/models/transactions_recurring_get_request_options.rb +36 -5
  1922. data/lib/plaid/models/transactions_recurring_get_response.rb +34 -3
  1923. data/lib/plaid/models/transactions_recurring_merge_input.rb +2 -2
  1924. data/lib/plaid/models/transactions_recurring_merge_request.rb +3 -3
  1925. data/lib/plaid/models/transactions_recurring_merge_response.rb +1 -1
  1926. data/lib/plaid/models/transactions_recurring_update_input.rb +3 -3
  1927. data/lib/plaid/models/transactions_recurring_update_request.rb +3 -3
  1928. data/lib/plaid/models/transactions_recurring_update_response.rb +1 -1
  1929. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  1930. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1931. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1932. data/lib/plaid/models/transactions_rule_details.rb +2 -2
  1933. data/lib/plaid/models/transactions_rule_field.rb +2 -2
  1934. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1935. data/lib/plaid/models/transactions_rules_create_request.rb +41 -26
  1936. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1937. data/lib/plaid/models/transactions_rules_list_request.rb +18 -18
  1938. data/lib/plaid/models/transactions_rules_list_response.rb +2 -2
  1939. data/lib/plaid/models/transactions_rules_remove_request.rb +15 -15
  1940. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1941. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  1942. data/lib/plaid/models/transactions_sync_request_options.rb +35 -4
  1943. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  1944. data/lib/plaid/models/transactions_update_status.rb +1 -1
  1945. data/lib/plaid/models/transactions_user_insights_get_request.rb +2 -2
  1946. data/lib/plaid/models/transactions_user_insights_get_response.rb +1 -1
  1947. data/lib/plaid/models/transfer.rb +36 -11
  1948. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1949. data/lib/plaid/models/transfer_authorization.rb +18 -4
  1950. data/lib/plaid/models/transfer_authorization_cancel_request.rb +2 -2
  1951. data/lib/plaid/models/transfer_authorization_cancel_response.rb +1 -1
  1952. data/lib/plaid/models/transfer_authorization_create_request.rb +53 -11
  1953. data/lib/plaid/models/transfer_authorization_create_request_user_attributes.rb +256 -0
  1954. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1955. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1956. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1957. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +3 -1
  1958. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1959. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1960. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1961. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1962. data/lib/plaid/models/transfer_authorization_payment_risk.rb +4 -4
  1963. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +19 -4
  1964. data/lib/plaid/models/transfer_authorization_risk_level.rb +1 -1
  1965. data/lib/plaid/models/transfer_authorization_user_attributes.rb +250 -0
  1966. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1967. data/lib/plaid/models/transfer_balance.rb +2 -2
  1968. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1969. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1970. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1971. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  1972. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1973. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1974. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1975. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +27 -5
  1976. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1977. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1978. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1979. data/lib/plaid/models/transfer_create_request.rb +7 -7
  1980. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1981. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1982. data/lib/plaid/models/transfer_credit_usage_configuration.rb +5 -5
  1983. data/lib/plaid/models/transfer_debit_usage_configuration.rb +5 -5
  1984. data/lib/plaid/models/transfer_device.rb +1 -1
  1985. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1986. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1987. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1988. data/lib/plaid/models/transfer_diligence_submit_request.rb +2 -2
  1989. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1990. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1991. data/lib/plaid/models/transfer_event.rb +33 -11
  1992. data/lib/plaid/models/transfer_event_list_request.rb +3 -3
  1993. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1994. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1995. data/lib/plaid/models/transfer_event_sync_request.rb +7 -7
  1996. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1997. data/lib/plaid/models/transfer_event_type.rb +6 -1
  1998. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1999. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  2000. data/lib/plaid/models/transfer_failure.rb +5 -5
  2001. data/lib/plaid/models/transfer_funding_account.rb +2 -2
  2002. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +2 -2
  2003. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +1 -1
  2004. data/lib/plaid/models/transfer_get_request.rb +3 -3
  2005. data/lib/plaid/models/transfer_get_response.rb +1 -1
  2006. data/lib/plaid/models/transfer_guarantee_details.rb +243 -0
  2007. data/lib/plaid/models/transfer_guarantee_outcome.rb +41 -0
  2008. data/lib/plaid/models/transfer_guarantee_schedule_item.rb +260 -0
  2009. data/lib/plaid/models/transfer_guarantee_schedule_item_all_of.rb +221 -0
  2010. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  2011. data/lib/plaid/models/transfer_intent_create.rb +4 -4
  2012. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  2013. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  2014. data/lib/plaid/models/transfer_intent_create_request.rb +3 -3
  2015. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  2016. data/lib/plaid/models/transfer_intent_get.rb +4 -4
  2017. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  2018. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  2019. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  2020. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  2021. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  2022. data/lib/plaid/models/transfer_ledger_deposit_request.rb +3 -3
  2023. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  2024. data/lib/plaid/models/transfer_ledger_distribute_request.rb +1 -1
  2025. data/lib/plaid/models/transfer_ledger_distribute_response.rb +1 -1
  2026. data/lib/plaid/models/transfer_ledger_event.rb +364 -0
  2027. data/lib/plaid/models/transfer_ledger_event_list_request.rb +398 -0
  2028. data/lib/plaid/models/transfer_ledger_event_list_response.rb +257 -0
  2029. data/lib/plaid/models/transfer_ledger_get_request.rb +2 -2
  2030. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  2031. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +2 -1
  2032. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +3 -3
  2033. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  2034. data/lib/plaid/models/transfer_list_request.rb +1 -1
  2035. data/lib/plaid/models/transfer_list_response.rb +1 -1
  2036. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +1 -1
  2037. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  2038. data/lib/plaid/models/transfer_metrics_get_response.rb +3 -3
  2039. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +1 -1
  2040. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +1 -1
  2041. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  2042. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  2043. data/lib/plaid/models/transfer_network.rb +2 -1
  2044. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  2045. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  2046. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  2047. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  2048. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +1 -1
  2049. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +1 -1
  2050. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  2051. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  2052. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  2053. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  2054. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  2055. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  2056. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +1 -1
  2057. data/lib/plaid/models/transfer_platform_originator_create_request.rb +1 -1
  2058. data/lib/plaid/models/transfer_platform_originator_create_response.rb +1 -1
  2059. data/lib/plaid/models/transfer_platform_person_address.rb +1 -1
  2060. data/lib/plaid/models/transfer_platform_person_create_request.rb +16 -6
  2061. data/lib/plaid/models/transfer_platform_person_create_response.rb +1 -1
  2062. data/lib/plaid/models/transfer_platform_person_id_number.rb +1 -1
  2063. data/lib/plaid/models/transfer_platform_person_name.rb +1 -1
  2064. data/lib/plaid/models/transfer_platform_requirement.rb +2 -2
  2065. data/lib/plaid/models/transfer_platform_requirement_submission.rb +3 -3
  2066. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +2 -2
  2067. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +1 -1
  2068. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +1 -1
  2069. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  2070. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  2071. data/lib/plaid/models/transfer_recurring_cancel_request.rb +2 -2
  2072. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  2073. data/lib/plaid/models/transfer_recurring_create_request.rb +4 -4
  2074. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  2075. data/lib/plaid/models/transfer_recurring_get_request.rb +2 -2
  2076. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  2077. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  2078. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  2079. data/lib/plaid/models/transfer_recurring_network.rb +1 -1
  2080. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  2081. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  2082. data/lib/plaid/models/transfer_refund.rb +3 -3
  2083. data/lib/plaid/models/transfer_refund_cancel_request.rb +2 -2
  2084. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  2085. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  2086. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  2087. data/lib/plaid/models/transfer_refund_failure.rb +2 -2
  2088. data/lib/plaid/models/transfer_refund_get_request.rb +2 -2
  2089. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  2090. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  2091. data/lib/plaid/models/transfer_repayment.rb +1 -1
  2092. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  2093. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  2094. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  2095. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  2096. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  2097. data/lib/plaid/models/transfer_return_recover_request.rb +297 -0
  2098. data/lib/plaid/models/transfer_return_recover_response.rb +226 -0
  2099. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  2100. data/lib/plaid/models/transfer_status.rb +1 -1
  2101. data/lib/plaid/models/transfer_sweep.rb +14 -3
  2102. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  2103. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  2104. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  2105. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  2106. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  2107. data/lib/plaid/models/transfer_test_clock.rb +2 -2
  2108. data/lib/plaid/models/transfer_type.rb +1 -1
  2109. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  2110. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  2111. data/lib/plaid/models/transfer_user_in_request.rb +2 -2
  2112. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  2113. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  2114. data/lib/plaid/models/transfer_wire_details.rb +17 -6
  2115. data/lib/plaid/models/trust_index.rb +251 -0
  2116. data/lib/plaid/models/trust_index_subscore.rb +226 -0
  2117. data/lib/plaid/models/trust_index_subscores.rb +231 -0
  2118. data/lib/plaid/models/trusted_device_data.rb +1 -1
  2119. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  2120. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  2121. data/lib/plaid/models/user_account_identity.rb +4 -4
  2122. data/lib/plaid/models/user_account_identity_address.rb +1 -1
  2123. data/lib/plaid/models/user_account_identity_edit_counts.rb +261 -0
  2124. data/lib/plaid/models/user_account_identity_edit_history.rb +257 -0
  2125. data/lib/plaid/models/user_account_identity_name.rb +1 -1
  2126. data/lib/plaid/models/user_account_identity_official_document.rb +220 -0
  2127. data/lib/plaid/models/user_account_item.rb +2 -2
  2128. data/lib/plaid/models/user_account_revoked_webhook.rb +13 -3
  2129. data/lib/plaid/models/user_account_session_event.rb +251 -0
  2130. data/lib/plaid/models/user_account_session_event_send_request.rb +270 -0
  2131. data/lib/plaid/models/user_account_session_event_send_response.rb +226 -0
  2132. data/lib/plaid/models/user_account_session_get_request.rb +1 -1
  2133. data/lib/plaid/models/user_account_session_get_response.rb +33 -2
  2134. data/lib/plaid/models/user_address.rb +3 -3
  2135. data/lib/plaid/models/user_based_products.rb +50 -0
  2136. data/lib/plaid/models/user_create_request.rb +26 -6
  2137. data/lib/plaid/models/user_create_response.rb +3 -8
  2138. data/lib/plaid/models/user_custom_password.rb +37 -24
  2139. data/lib/plaid/models/user_data_overview.rb +1 -1
  2140. data/lib/plaid/models/user_financial_data_refresh_request.rb +246 -0
  2141. data/lib/plaid/models/user_financial_data_refresh_response.rb +242 -0
  2142. data/lib/plaid/models/user_get_request.rb +246 -0
  2143. data/lib/plaid/models/{link_delivery_get_response.rb → user_get_response.rb} +54 -81
  2144. data/lib/plaid/models/user_id_number.rb +3 -3
  2145. data/lib/plaid/models/{link_delivery_create_request.rb → user_identity_remove_request.rb} +16 -25
  2146. data/lib/plaid/models/user_identity_remove_response.rb +226 -0
  2147. data/lib/plaid/models/{monitoring_insights_webhook.rb → user_income_verification_refresh_reconnect_needed_webhook.rb} +9 -23
  2148. data/lib/plaid/models/user_income_verification_risk_signals_status_webhook.rb +317 -0
  2149. data/lib/plaid/models/user_income_verification_status_webhook.rb +317 -0
  2150. data/lib/plaid/models/user_items_associate_request.rb +263 -0
  2151. data/lib/plaid/models/user_items_associate_response.rb +226 -0
  2152. data/lib/plaid/models/user_items_get_request.rb +16 -11
  2153. data/lib/plaid/models/user_items_get_response.rb +1 -1
  2154. data/lib/plaid/models/user_items_remove_request.rb +268 -0
  2155. data/lib/plaid/models/user_items_remove_response.rb +226 -0
  2156. data/lib/plaid/models/user_permission_revoked_webhook.rb +13 -3
  2157. data/lib/plaid/models/user_products_terminate_request.rb +310 -0
  2158. data/lib/plaid/models/user_products_terminate_response.rb +226 -0
  2159. data/lib/plaid/models/user_remove_request.rb +13 -8
  2160. data/lib/plaid/models/user_remove_response.rb +1 -1
  2161. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  2162. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  2163. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  2164. data/lib/plaid/models/user_third_party_token_create_request.rb +17 -12
  2165. data/lib/plaid/models/user_third_party_token_create_response.rb +1 -1
  2166. data/lib/plaid/models/user_third_party_token_remove_request.rb +2 -2
  2167. data/lib/plaid/models/user_third_party_token_remove_response.rb +2 -2
  2168. data/lib/plaid/models/{sandbox_transfer_repayment_simulate_request.rb → user_transactions_refresh_request.rb} +21 -6
  2169. data/lib/plaid/models/user_transactions_refresh_response.rb +242 -0
  2170. data/lib/plaid/models/user_update_request.rb +23 -8
  2171. data/lib/plaid/models/user_update_response.rb +1 -1
  2172. data/lib/plaid/models/validation_source.rb +1 -1
  2173. data/lib/plaid/models/validation_sources.rb +1 -1
  2174. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  2175. data/lib/plaid/models/verification_of_asset.rb +1 -1
  2176. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  2177. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  2178. data/lib/plaid/models/verification_status.rb +1 -1
  2179. data/lib/plaid/models/verify_sms_details.rb +1 -1
  2180. data/lib/plaid/models/verify_sms_details_status.rb +1 -1
  2181. data/lib/plaid/models/w2.rb +5 -5
  2182. data/lib/plaid/models/w2_box12.rb +1 -1
  2183. data/lib/plaid/models/w2_box12_override.rb +2 -2
  2184. data/lib/plaid/models/w2_override.rb +18 -18
  2185. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  2186. data/lib/plaid/models/w2_state_and_local_wages_override.rb +5 -5
  2187. data/lib/plaid/models/wallet.rb +1 -1
  2188. data/lib/plaid/models/wallet_balance.rb +1 -1
  2189. data/lib/plaid/models/wallet_create_request.rb +1 -1
  2190. data/lib/plaid/models/wallet_create_response.rb +1 -1
  2191. data/lib/plaid/models/wallet_get_request.rb +1 -1
  2192. data/lib/plaid/models/wallet_get_response.rb +1 -1
  2193. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  2194. data/lib/plaid/models/wallet_list_request.rb +1 -1
  2195. data/lib/plaid/models/wallet_list_response.rb +1 -1
  2196. data/lib/plaid/models/wallet_numbers.rb +1 -1
  2197. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  2198. data/lib/plaid/models/wallet_status.rb +2 -1
  2199. data/lib/plaid/models/wallet_transaction.rb +27 -7
  2200. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  2201. data/lib/plaid/models/wallet_transaction_counterparty.rb +25 -6
  2202. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
  2203. data/lib/plaid/models/wallet_transaction_counterparty_holder_category.rb +39 -0
  2204. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  2205. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  2206. data/lib/plaid/models/wallet_transaction_execute_request.rb +14 -4
  2207. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  2208. data/lib/plaid/models/wallet_transaction_failure_reason.rb +3 -1
  2209. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  2210. data/lib/plaid/models/wallet_transaction_get_response.rb +27 -7
  2211. data/lib/plaid/models/wallet_transaction_list_request.rb +2 -2
  2212. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  2213. data/lib/plaid/models/wallet_transaction_list_response.rb +2 -2
  2214. data/lib/plaid/models/wallet_transaction_payee_verification_status.rb +42 -0
  2215. data/lib/plaid/models/wallet_transaction_relation.rb +2 -2
  2216. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  2217. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +22 -2
  2218. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  2219. data/lib/plaid/models/warning.rb +4 -4
  2220. data/lib/plaid/models/watchlist_screening_audit_trail.rb +2 -2
  2221. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  2222. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  2223. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +3 -3
  2224. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +3 -3
  2225. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  2226. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +3 -3
  2227. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  2228. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  2229. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  2230. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  2231. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +3 -3
  2232. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  2233. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  2234. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  2235. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  2236. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  2237. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +2 -2
  2238. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +2 -2
  2239. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  2240. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  2241. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +3 -3
  2242. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  2243. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +3 -3
  2244. data/lib/plaid/models/watchlist_screening_hit.rb +19 -2
  2245. data/lib/plaid/models/watchlist_screening_hit_locations.rb +2 -2
  2246. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  2247. data/lib/plaid/models/watchlist_screening_individual.rb +3 -3
  2248. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +2 -2
  2249. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +3 -3
  2250. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  2251. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +3 -3
  2252. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  2253. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  2254. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  2255. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  2256. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +4 -4
  2257. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  2258. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  2259. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  2260. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  2261. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  2262. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +2 -2
  2263. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +2 -2
  2264. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  2265. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  2266. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +3 -3
  2267. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  2268. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +3 -3
  2269. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  2270. data/lib/plaid/models/watchlist_screening_review.rb +2 -2
  2271. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  2272. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  2273. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  2274. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  2275. data/lib/plaid/models/{accounts_balance_get_response_payment_risk_assessment.rb → webhook_event.rb} +128 -81
  2276. data/lib/plaid/models/webhook_event_delivery_status.rb +40 -0
  2277. data/lib/plaid/models/webhook_type.rb +2 -1
  2278. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  2279. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  2280. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  2281. data/lib/plaid/models/yield_rate.rb +1 -1
  2282. data/lib/plaid/models/yield_rate_type.rb +1 -1
  2283. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  2284. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  2285. data/lib/plaid/version.rb +2 -2
  2286. data/lib/plaid.rb +547 -37
  2287. data/plaid.gemspec +3 -3
  2288. data/templates/ruby/api_client.mustache +2 -4
  2289. data/templates/ruby/api_client_faraday_partial.mustache +0 -1
  2290. data/templates/ruby/gemspec.mustache +1 -1
  2291. data/templates/ruby/partial_oneof_module.mustache +177 -0
  2292. data/test/test_api_client.rb +135 -0
  2293. data/test/test_liabilities.rb +1 -1
  2294. metadata +556 -45
  2295. data/lib/plaid/models/balance_plus_attributes.rb +0 -508
data/CHANGELOG.md CHANGED
@@ -1,5 +1,1682 @@
1
1
  See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2
2
 
3
+ # 53.0.0
4
+ - Isolate downloaded files per response to avoid sharing temporary files between concurrent requests.
5
+ - Updating to OAS 2020-09-14_1.778.0
6
+
7
+ ## Breaking changes in this version
8
+
9
+ - [BREAKING] Correct Asset Report investment data to match API behavior: remove `cost_basis` from holdings, and move `vested_quantity` and `vested_value` from investment transactions to holdings as nullable fields.
10
+ - [BREAKING] Correct the capitalization of the enum values in the Auth and Identity `DEFAULT_UPDATE` webhooks to match the values the API sends.
11
+ - [BREAKING] Correct Sandbox enum values to match the values the API accepts: replace `VERIFICATION_STATUS_PENDING_APPROVAL` with `VERIFICATION_STATUS_DOCUMENT_REJECTED` in `/sandbox/income/fire_webhook`, and remove `PRODUCT_GENERATION_ERROR` from `/sandbox/cra/servicing/simulate`.
12
+ - [BREAKING] Remove `/sandbox/transfer/repayment/simulate` and `/beta/transactions/v1/enhance` from the specification to match the API, which no longer serves either endpoint.
13
+ - [BREAKING] Correct field types in the custom Sandbox user configuration (`UserCustomPassword`) to match what the Sandbox accepts. Client library models for these objects change type:
14
+ - `version` is an integer, `1` or `2`.
15
+ - `holdings` and `investment_transactions` on an `override_accounts` entry are arrays.
16
+ - W2 amounts, including `box_12` and `state_and_local_wages` amounts, and `tax_year` in `income.w2s` are numbers, and `statutory_employee`, `retirement_plan`, and `third_party_sick_pay` are booleans.
17
+ - `liability.sequence_number` is a number, and `liability.servicer_address` is a flat address with `street`, `city`, `region`, `postal_code`, and `country`, without the `primary` and `data` wrapper.
18
+ - `inflow_model.payment_day_of_month` and `inflow_model.statement_day_of_month` take a whole number from 1 to 28 or the string `last`.
19
+ - The credit APR fields and the student loan `nominal_apr` take a value from 0 to 100, and `interest_capitalization_grace_period_months` is a non-negative integer.
20
+ - Remove `pay_frequency` from paystub `pay_period_details`. The Sandbox never read it.
21
+ - [BREAKING] In the custom Sandbox user configuration, mark as required only the fields the Sandbox requires: `type` and `subtype` on each account override; `type` on `mfa`, `liability`, and `inflow_model`; `names` on `identity`; `primary`, `data.city`, `data.street`, and `data.country` on each `identity.addresses` entry; `city`, `street`, and `country` on `liability.servicer_address`; and `currency` on a holding's or investment transaction's `security`. All top-level fields and all `meta` fields are optional.
22
+ - [BREAKING] Remove `primary_account`, `identity_match`, and `owners` from the accounts in the `cra_income_insights` product's `items` on `/cra/report/get`; Income Insights never populates them. Products that return identity data keep those fields.
23
+ - [BREAKING] Remove the public `options` object from `cra_home_lending` products on `/cra/report/create` and `cra_report_parameter.products` on `/link/token/create`, including the unsupported `reports_requested` and `employment_refresh_options` fields and their unused component schemas. Home Lending accepts no configuration today; omit `options`.
24
+ - [BREAKING] Require `scope` and `decision_stage` in `cra_report_parameter` on `/link/token/create`, matching `/cra/report/create`. Only `CLIENT_USER` is supported for `scope` on `/link/token/create`.
25
+ - [BREAKING] Require `scope` on `/cra/report/create`.
26
+
27
+ ## OpenAPI Schema Changes
28
+ ### 2020-09-14_1.778.0
29
+
30
+ - [Breaking for Go] Correct Payment Initiation institution metadata to match API behavior: `maximum_payment_amount` is no longer required, and `valid_standing_order_intervals` is nullable.
31
+ - Add enum values that the API already returns or accepts: `BLOCKED` for wallet status; `CRA_REPORT_ERROR` and `CRA_PARTNER_INSIGHTS_ERROR` for error type; `IDENTITY` for the `/sandbox/item/fire_webhook` webhook type; and `sweep.funds_available` for `/sandbox/transfer/ledger/deposit/simulate`.
32
+
33
+ ### 2020-09-14_1.777.0
34
+
35
+ - Add LendScore Complete (`cra_lend_score_complete`) and Income Complete (`cra_income_complete`) response entries to `/cra/report/get`. LendScore Complete bundles LendScore with the Cashflow Insights and Network Insights attributes it was computed from; Income Complete bundles Income Insights. Both products return the Items and accounts used to generate them.
36
+
37
+ ### 2020-09-14_1.776.0
38
+
39
+ - Document the `loan` and `line_of_credit` liability types for custom Sandbox accounts with their override fields, and `last_statement_balance` for `credit` liabilities.
40
+
41
+ ### 2020-09-14_1.775.1
42
+
43
+ - Document the Qualify product (`cra_qualify`) in the `/cra/report/get` request and response.
44
+
45
+ ### 2020-09-14_1.775.0
46
+
47
+ - Add the Base Report product (`cra_base_report`) to the `/cra/report/get` response. It returns the report's Items and accounts with balances, transactions, owners, primary account attributes, and identity match scores.
48
+
49
+ ### 2020-09-14_1.774.0
50
+
51
+
52
+ ### 2020-09-14_1.773.0
53
+
54
+ - Add `items` to the `cra_income_insights` and `cra_home_lending` products in the `/cra/report/get` response, listing the Items and accounts used to generate each product.
55
+
56
+ ### 2020-09-14_1.772.0
57
+
58
+
59
+ ### 2020-09-14_1.771.1
60
+
61
+ - Allow `/user/update` to be called with an OAuth2 access token that carries the `user:write` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
62
+
63
+ ### 2020-09-14_1.771.0
64
+
65
+ - Add `include_identity_match` to `/cra/report/create` and to `cra_report_parameter` on `/link/token/create`, which opts the report into including Identity Match results. Defaults to `false`.
66
+
67
+ ### 2020-09-14_1.770.0
68
+
69
+ - Add LendScore Complete (`cra_lend_score_complete`) and Income Complete (`cra_income_complete`) to the `products` unions of `/cra/report/create`, `/cra/report/get`, and `cra_report_parameter` on `/link/token/create`. LendScore Complete bundles LendScore with the Cashflow Insights and Network Insights attributes it was computed from and accepts the same `variants` option as `cra_lend_score`; Income Complete bundles Income Insights and accepts the same `income_insights_filter` option. Both products return the Items and accounts used to generate them.
70
+
71
+ ### 2020-09-14_1.769.0
72
+
73
+ - Add `description` and `transactions` to each `income_streams` entry of the Income Insights product on `/cra/report/get`. Both are populated only when the report `scope` is `CLIENT_USER`; otherwise `description` is `null` and `transactions` is empty.
74
+
75
+ ### 2020-09-14_1.768.2
76
+
77
+ - Update the `/cra/report/get` response example to use the `EXTENSION_OF_CREDIT` permissible purpose and to show LendScore (`cra_lend_score`), Cash Flow Insights (`cra_cashflow_insights`), and Network Insights (`cra_network_insights`) `V2` entries, and update the `/cra/report/create` response and `CRA_REPORT_READY` webhook examples to describe a separate report in which Base Report and Income Insights are generated and LendScore `V2` fails.
78
+ - On `/cra/report/create` and `/cra/report/get`, list only the `decision_stage` values and `consumer_report_permissible_purpose` values that the `decision_stage` description allows, including `INSURANCE_UNDERWRITING`.
79
+
80
+ ### 2020-09-14_1.768.1
81
+
82
+ - Add `anchorage` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Anchorage Digital integration.
83
+
84
+ ### 2020-09-14_1.768.0
85
+
86
+ - Add the hidden optional `institution_data.institution_id` field to `/link/token/create`, also returned in `/link/token/get` metadata, to highlight an institution in Link by its Plaid institution ID.
87
+
88
+ ### 2020-09-14_1.767.2
89
+
90
+ - Require `GENERALIST` in the `cra_lend_score` version `V2` `options.variants` on `/cra/report/get`, `/cra/report/create`, and `cra_report_parameter` in `/link/token/create` whenever variants are specified. Omitting or leaving `variants` empty still selects `GENERALIST`.
91
+
92
+ ### 2020-09-14_1.767.1
93
+
94
+ - Document the optional `user_attributes` object on `/transfer/authorization/create`, with `account_created_time` and `successful_payment_count`. Request and response shapes are unchanged.
95
+
96
+ ### 2020-09-14_1.767.0
97
+
98
+ - Add `variants` to the `cra_lend_score` options on `/cra/report/create` and on `cra_report_parameter` in `/link/token/create`, selecting which LendScore V2 variants to generate.
99
+
100
+ ### 2020-09-14_1.766.3
101
+
102
+ - Update Transactions descriptions to include loan accounts beyond mortgage and student loan accounts.
103
+
104
+ ### 2020-09-14_1.766.2
105
+
106
+ - Publicly document `/identity/match/list`, which returns a paginated history of Link-originated Identity Match attempts. Access requires Identity Match and separate enablement for this endpoint.
107
+
108
+ ### 2020-09-14_1.766.1
109
+
110
+ - `/protect/compute` may return `SESSION_NOT_READY` for device-session models until the Protect SDK has delivered device data for the session.
111
+
112
+ ### 2020-09-14_1.766.0
113
+
114
+ - Add `kyc_check.id_number.ssa_verification` with the SSA match result and `is_deceased` status in Identity Verification responses.
115
+
116
+ ### 2020-09-14_1.765.6
117
+
118
+ - Add `investment_account_type_count` to the Credit Profile and Income Insights report metadata on `/cra/report/get`, so every CRA report metadata object reports the number of investment accounts alongside the depository, credit, and other counts.
119
+
120
+ ### 2020-09-14_1.765.5
121
+
122
+ - Add `/beta/cash_advance/income_insights/v1/get`, which returns a user's top income streams, ranked by historical net monthly income, and the next payment of the highest-ranked stream. The endpoint is hidden from public documentation during beta.
123
+
124
+ ### 2020-09-14_1.765.4
125
+
126
+ - Clarify that `/user/products/terminate` removes Items containing Financial Management products and also removes the user when every associated Item contains a Financial Management product.
127
+
128
+ ### 2020-09-14_1.765.3
129
+
130
+ - Temporarily remove `/transfer/return/recover` from public API documentation while the broader Guarantee documentation is being developed. The endpoint remains available in the API and client libraries.
131
+
132
+ ### 2020-09-14_1.765.2
133
+
134
+ - Describe `/cra/report/create`, `/cra/report/get`, and the `CRA_REPORT` webhooks in terms of Consumer Reports, and list the accepted products on the `products` fields of `/cra/report/create`, `/cra/report/get`, and `cra_report_parameter`.
135
+ - Document how `scope` determines the Items used by `/cra/report/create`, and the permissible purposes allowed for each `decision_stage`.
136
+ - Describe `other_account_type_count` the same way on every CRA report metadata object: the number of accounts that are neither depository, credit, nor investment.
137
+ - Document that `/cra/report/get` callers should omit `report_id` when retrieving a report without a prior `/cra/report/create` or `/link/token/create` request, and omit LendScore `options` when retrieving a report generated by either.
138
+
139
+ ### 2020-09-14_1.765.1
140
+
141
+
142
+ ### 2020-09-14_1.765.0
143
+
144
+ - Add `paired_account_id` to the `Account` object. For accounts on Items created as part of a hybrid flow with both Plaid Inc and Plaid Check products, this is the `account_id` of the account that represents the same financial institution account on the paired Item. It is only returned for accounts on Items that have a paired Item, and is `null` when Plaid could not match the account to one on the paired Item.
145
+
146
+ ### 2020-09-14_1.764.4
147
+
148
+
149
+ ### 2020-09-14_1.764.3
150
+
151
+ - Add OAuth2 as an authentication option for the Support API endpoints (`/beta/issues/v1/*`), callable with a bearer token carrying the new `issues:read` (`/beta/issues/v1/get`, `/match`) or `issues:write` (`/beta/issues/v1/subscribe`, `/unsubscribe`) scope. Existing `client_id`/`secret` authentication is unchanged.
152
+
153
+
154
+ ### 2020-09-14_1.764.2
155
+
156
+ - Declare `minimum: 0` on `days_requested` for `/cra/report/create`, matching `cra_report_parameter` on `/link/token/create`, so negative values are rejected.
157
+
158
+ ### 2020-09-14_1.764.1
159
+
160
+ - Document the `loan` and `line_of_credit` liability objects on `/liabilities/get`, including the client library versions required to receive the new fields and expanded loan subtype values. Supported loan subtypes are `auto`, `commercial`, `commercial line of credit`, `consumer`, `home equity`, `home equity loan`, `line of credit`, `loan`, `mortgage`, and `student`.
161
+ - Document that `home equity loan` is normalized to `loan` and `commercial line of credit` is normalized to `line of credit` in plaid-go versions earlier than 10.1.0, plaid-java versions earlier than 44.0.0, plaid-python versions earlier than 8.3.0, and plaid-ruby versions earlier than 14.4.0.
162
+
163
+ ### 2020-09-14_1.764.0
164
+
165
+ - Add Network Insights (`cra_network_insights`) and Cashflow Insights (`cra_cashflow_insights`) response entries to `/cra/report/get`. Each response entry returns the product's `metadata`, `attributes`, and `errors`.
166
+
167
+ ### 2020-09-14_1.763.2
168
+
169
+ - Internal changes only.
170
+
171
+ ### 2020-09-14_1.763.1
172
+
173
+ - Describe `version` on the product entries of the `CRA_REPORT` webhooks as a `CraProductVersion`, matching the `/cra/report/create` and `/cra/report/get` product schemas. The wire type is unchanged.
174
+
175
+ ### 2020-09-14_1.763.0
176
+
177
+ - Add LendScore V2 variant selection and per-variant report results to the CRA `/cra/report/get` schemas.
178
+
179
+ ### 2020-09-14_1.762.1
180
+
181
+ - Document `report_id`, `client_report_id`, and `client_user_id` on `/cra/report/get`.
182
+
183
+ # 52.0.0
184
+ - Updating to OAS 2020-09-14_1.762.0
185
+
186
+ ## Breaking changes in this version
187
+
188
+ - [BREAKING] Remove the deprecated `/link_delivery/create` and `/link_delivery/get` methods and their models. Use `/link/token/create` with `hosted_link` to create Hosted Link sessions.
189
+ - [BREAKING] Remove the unlaunched `charge card` and `installment` account subtype enum values, and the never-populated `fund fee`, `loan payment`, and `rebalance` investment transaction subtype enum values. Remove references to those enum members when upgrading.
190
+ - [BREAKING] `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhook models now require `error`, `repairable_items`, and `failed_products`; update any manually constructed instances accordingly. Empty item/product lists are returned as `[]`.
191
+
192
+ ## OpenAPI Schema Changes
193
+ ### 2020-09-14_1.762.0
194
+
195
+ - Add the `CRA_REPORT_READY` webhook, fired when generation finishes for a CRA report requested via `/cra/report/create` or a Link session configured with `cra_report_parameter`. `successful_products` and `failed_products` list which products were generated, and `error_code`, a `CraReportErrorCode` enum, is populated when every product failed.
196
+
197
+ ### 2020-09-14_1.761.0
198
+
199
+ - Add `cra_lend_score` to `/cra/check_report/pdf/get` to include LendScore in the PDF alongside the required Base Report.
200
+
201
+ ### 2020-09-14_1.760.1
202
+
203
+ - `/sandbox/item/fire_webhook` accepts an optional `options.new_transactions` count for the `TRANSACTIONS` `DEFAULT_UPDATE` webhook, which previously always reported 0. The `SYNC_UPDATES_AVAILABLE` webhook it fires now derives `initial_update_complete` and `historical_update_complete` from the Item instead of always sending `true`.
204
+
205
+ ### 2020-09-14_1.760.0
206
+
207
+ - Document `/cra/report/get`, which retrieves a CRA report's products for a user.
208
+ - Add `cra_base_report`, `cra_lend_score`, `cra_cashflow_insights`, and `cra_network_insights` to the `/cra/report/get` request `products` union, matching the products `/cra/report/create` accepts.
209
+
210
+ ### 2020-09-14_1.759.0
211
+
212
+ - Internal changes only.
213
+
214
+ ### 2020-09-14_1.758.1
215
+
216
+ - Point the documentation links for the `/cra/check_report/*`, `/cra/servicing/subscription/*`, and `/cra/monitoring_insights/*` endpoints at the legacy Plaid Check reference page, which now hosts their documentation.
217
+
218
+ ### 2020-09-14_1.758.0
219
+
220
+ - Add the optional `cra_report_parameter` object to `/link/token/create`. It configures Plaid Check products for the Link session with the same parameters and `products` entries as `/cra/report/create`.
221
+
222
+ ### 2020-09-14_1.757.2
223
+
224
+ - Correct the `date_transacted` description for transactions in a custom Sandbox user's `override_accounts`: pending status is decided by `date_posted`, not `date_transacted`.
225
+
226
+ ### 2020-09-14_1.757.1
227
+
228
+ - `/sandbox/transactions/create` now works on every Sandbox Item, not only those created with `user_transactions_dynamic`. Previously a call on any other Item returned a 200 and the transactions never appeared. It also accepts dates up to 730 days in the past instead of 14.
229
+
230
+ ### 2020-09-14_1.757.0
231
+
232
+ - Add the hidden `idv_session_status` and `link_session_id` fields to `/user_account/session/get`. IDV status is optional and omitted when disabled or unavailable; when available in Sandbox, it reflects the simulated Identity Verification session.
233
+
234
+ ### 2020-09-14_1.756.1
235
+
236
+ - Allow `/cra/report/get` to be called with an OAuth2 access token that carries the `cra:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
237
+
238
+ ### 2020-09-14_1.756.0
239
+
240
+ - Add `/cra/report/create` for generating a CRA Report for a user. Each entry in the required `products` array is a `CraReportProduct` that names a Plaid Check product and its `version`, with optional product-specific `options`. The request also requires a `decision_stage` and a `consumer_report_permissible_purpose`, and the response returns the `report_id` of the report being generated.
241
+
242
+ ### 2020-09-14_1.755.0
243
+
244
+ - Internal changes only.
245
+
246
+ ### 2020-09-14_1.754.1
247
+
248
+ - Document Haitian Creole (`ht`) as a supported Link language.
249
+
250
+ ### 2020-09-14_1.754.0
251
+
252
+ - Add the optional `user_attributes` object to `/transfer/authorization/create`, with `account_created_time` for when the end user created their account on the customer's platform and `successful_payment_count` for their lifetime count of successful payments there. The object is hidden from public documentation until it is generally available.
253
+
254
+ ### 2020-09-14_1.753.2
255
+
256
+ - `/sandbox/transactions/create` accepts an optional `account_id` on each transaction so rows can target any account on the Item, as returned by `/accounts/get`. Without it, rows go to the Item's checking account. Rows that target a student loan account return `INVALID_ACCOUNT_ID`.
257
+
258
+ ### 2020-09-14_1.753.1
259
+
260
+ - Add `/protect/cash_advance/feedback/upload`, which accepts a `multipart/form-data` CSV of cash advance decision or repayment feedback for asynchronous processing and returns an `upload_id`. Each row is equivalent to one call to `/protect/cash_advance/decision/create` or `/protect/cash_advance/repayment/create`.
261
+
262
+ ### 2020-09-14_1.753.0
263
+
264
+ - [Breaking] Remove the deprecated `/link_delivery/create` and `/link_delivery/get` endpoints and their request, response, and supporting schemas. The generated client-library methods `linkDeliveryCreate` and `linkDeliveryGet` and their model classes are removed along with them, so upgrading to this version is a compile break for any integration that still references them. Use `/link/token/create` with the `hosted_link` object to create Hosted Link sessions.
265
+
266
+ ### 2020-09-14_1.752.6
267
+
268
+ - Rewrite the `/beta/webhook_events/list` description.
269
+
270
+ ### 2020-09-14_1.752.5
271
+
272
+ - Clarify that `failure_reason.description` describes the reason for a transfer adjustment event.
273
+
274
+ ### 2020-09-14_1.752.4
275
+
276
+ - Allow `/transactions/sync` to be called with an OAuth2 access token that carries the new `transactions:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
277
+
278
+ ### 2020-09-14_1.752.3
279
+
280
+ - Allow `/auth/get` to be called with an OAuth2 access token that carries the new `auth:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
281
+ - Allow `/accounts/balance/get` to be called with an OAuth2 access token that carries the new `accounts:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
282
+ - Allow `/identity/get` to be called with an OAuth2 access token that carries the new `identity:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
283
+ - Allow `/item/get` to be called with an OAuth2 access token that carries the `item:read` scope, including a delegated access token. The existing `client_id` and `secret` authentication continues to work.
284
+
285
+ ### 2020-09-14_1.752.2
286
+
287
+ - Add OAuth2 as an authentication option for `/item/public_token/exchange`, callable with a bearer token carrying the new `item:write` scope. Existing `client_id`/`secret` authentication is unchanged.
288
+
289
+ ### 2020-09-14_1.752.1
290
+
291
+ - Add `adjustment` to `TransferEventType` for adjustments due to rare activity, such as a dishonor. The `event_amount` field indicates the amount adjusted: positive amounts credit the ledger, and negative amounts debit the ledger.
292
+
293
+ ### 2020-09-14_1.751.1
294
+
295
+ - Update documentation `/beta/webhook_events/list`.
296
+
297
+ ### 2020-09-14_1.751.0
298
+
299
+ - Add `paired_item_id` to the `Item` object. For Items created as part of a hybrid flow with both Plaid Inc and Plaid Check products, the `paired_item_id` will indicate the Plaid Check Item that corresponds to a given Plaid Inc Item, or vice versa. It is `null` for Items that have no pairing.
300
+
301
+ ### 2020-09-14_1.750.1
302
+
303
+ - Add OAuth authentication with the `cra:read` scope to `/cra/check_report/verification/get` and `/cra/check_report/verification/pdf/get`.
304
+
305
+ ### 2020-09-14_1.750.0
306
+
307
+ - Add optional `language` to `/identity_verification/create` to select the starting language for an identity verification session.
308
+
309
+ ### 2020-09-14_1.749.0
310
+
311
+ - Add `connection_availability` to the `Institution` object returned by `/institutions/get`, `/institutions/get_by_id`, and `/institutions/search`. It is `NOT_SUPPORTED` when Plaid does not support new connections to the institution, which can only occur on `/institutions/get_by_id`, and `SUPPORTED` otherwise. Also document that `/institutions/get_by_id` still returns such institutions while `/institutions/get` and `/institutions/search` omit them.
312
+
313
+ ### 2020-09-14_1.748.2
314
+
315
+ - Add `roll_dates_forward` to the custom Sandbox user configuration (`UserCustomPassword`). When true, dates are shifted at Item creation so the most recent activity date falls on the creation day.
316
+
317
+ ### 2020-09-14_1.748.1
318
+
319
+ - Add `bitgo` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the BitGo integration.
320
+
321
+ ### 2020-09-14_1.748.0
322
+
323
+ - Add `client_user_id` to the `CRA_REPORT_UPDATED` webhook. It is always present and non-empty.
324
+
325
+ ### 2020-09-14_1.747.1
326
+
327
+ - Add `adyen_ca` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Adyen Canada integration.
328
+
329
+ ### 2020-09-14_1.747.0
330
+
331
+ - [Breaking] Remove the unlaunched `charge card` and `installment` values from generated account subtype enums. Plaid never returned either value to customers.
332
+
333
+ ### 2020-09-14_1.746.0
334
+
335
+ - Mark `error`, `repairable_items`, and `failed_products` as required on `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhooks. Empty `repairable_items` and `failed_products` lists are now returned as `[]` instead of being omitted.
336
+
337
+ ### 2020-09-14_1.745.2
338
+
339
+ - Mark `street` as nullable in the `AddressData` schema used by identity responses (`/identity/get`, `/identity/match`, `/processor/identity/get`, and Asset Report identity data). The API already returns `null` for `street` when the institution does not provide a street line for an address; the specification and generated client libraries declared it non-nullable, which caused client-side validation failures on such responses. This brings the specification in line with actual API behavior.
340
+
341
+ ### 2020-09-14_1.745.1
342
+
343
+ - Document `home equity loan` and `commercial line of credit` in the Accounts account type schema.
344
+
345
+ ### 2020-09-14_1.745.0
346
+
347
+ - Internal changes only.
348
+
349
+ ### 2020-09-14_1.744.2
350
+
351
+ ### 2020-09-14_1.744.1
352
+
353
+ ### 2020-09-14_1.744.0
354
+
355
+ - Add `supports_commercial_payment_consents` to `payment_initiation_metadata` on `/institutions/get`, `/institutions/get_by_id`, and `/institutions/search`, indicating whether the institution supports commercial variable recurring payment (cVRP) consents.
356
+
357
+ ### 2020-09-14_1.743.0
358
+
359
+ - Add the external `event_type`, when available, to `/protect/event/get` responses and document it in `/protect/event/get` and `/protect/user/insights/get` examples.
360
+
361
+ ### 2020-09-14_1.742.1
362
+
363
+ ### 2020-09-14_1.742.0
364
+
365
+ - Add the `cash_advance_limit` field to `CreditCardLiability` on `/liabilities/get`, hidden from public API docs until GA.
366
+
367
+ ### 2020-09-14_1.741.0
368
+
369
+ - [Breaking] Remove three never-populated investment transaction subtypes from the `InvestmentTransactionSubtype` enum — `fund fee`, `loan payment`, and `rebalance`. Plaid has never returned any of these values, so no response is affected.
370
+ - Deprecate the `stock distribution` investment transaction subtype: it is no longer shown in the API documentation (removed from the `cash` and `fee` transaction type schemas and hidden from the `subtype` value list), and Plaid no longer produces it. The value is retained in the `InvestmentTransactionSubtype` enum for backward compatibility, since historical transactions may still carry it. The "inflow of stock from a distribution" it described is represented by the `transfer` type's `spin off` subtype.
371
+
372
+ # 51.0.0
373
+ - Updating to OAS 2020-09-14_1.740.1
374
+
375
+ ## Breaking changes in this version
376
+
377
+ - [BREAKING] `/processor/token/create`: the `processor` enum value `paynote` is replaced by `seamlessach` (SeamlessChex rebranded Paynote to Seamless ACH). Send `seamlessach` instead. The API still accepts `paynote` during a transition period, and processor tokens already issued under `paynote` keep working and do not need to be regenerated.
378
+ - [BREAKING] `/protect/compute`: the generic `cash-advance-onboarding-1.0` and `cash-advance-ongoing-1.0` models are removed. Use the client-scoped model issued for your client: `cash-advance-onboarding-<client>-1.0` or `cash-advance-ongoing-<client>-1.0`.
379
+ - [BREAKING] `/protect/cash_advance/repayment/create`: the repayment status `DELIVERED` is replaced by `PARTIAL_PAYMENT`, which indicates a payment was made but an outstanding balance remains. `amount_paid` is no longer required and is now nullable; it is required only when `status` is `REPAID` or `PARTIAL_PAYMENT`.
380
+ - [BREAKING] `/protect/cash_advance/decision/create`: `is_taken` moves out of the `cash_advance` object to the top level of the request, and the `cash_advance` object schema is renamed from `CashAdvanceDetails` to `CashAdvanceInfo`. A new required `advance_type` field (`FIRST` / `REPEAT`) and an optional non-negative `previous_advance_count` field are added. `is_taken` must be `false` when the decision is `DECLINED`; when `true`, both `client_advance_id` and `cash_advance` are required. `advance_type` is required only when `is_taken` is `true`.
381
+ - [BREAKING] `/protect/event/send`: `protect_session_id` is renamed to `device_session_id`, both at the top level and within `event`.
382
+ - [BREAKING] `/protect/compute`: the `sdk` model inputs object is renamed to `device`, its `sdk_session_id` field is renamed to `device_session_id`, and the `ProtectSDKModelInputs` schema is now `ProtectDeviceModelInputs`.
383
+
384
+ ## OpenAPI Schema Changes
385
+ ### 2020-09-14_1.740.1
386
+
387
+ - Added the missing `PRODUCT_GENERATION_ERROR` enum value to `options.error_webhook_code` on `/sandbox/cra/servicing/simulate`. This change brings the OpenAPI specification in line with actual API behavior; the endpoint already accepted the value and emitted it on the resulting `CRA_REPORT_UPDATED` webhook.
388
+
389
+ ### 2020-09-14_1.740.0
390
+
391
+ ### 2020-09-14_1.739.0
392
+
393
+ - Document `options.transactions.days_requested` on `/sandbox/public_token/create`, which controls how much transaction history the Sandbox Item is created with, matching `transactions.days_requested` on `/link/token/create`. The field was already present in the client libraries; only its documentation visibility changes.
394
+ - Deprecate `options.transactions.start_date` and `options.transactions.end_date` on `/sandbox/public_token/create` in favor of `days_requested`, and remove them from the API reference. Both are still accepted and still have no effect on the history available on the Item.
395
+
396
+ ### 2020-09-14_1.738.0
397
+
398
+ - [Breaking] SeamlessChex has rebranded Paynote to Seamless ACH. On `/processor/token/create`, the `processor` enum value `paynote` is replaced by `seamlessach`. Client libraries no longer expose `paynote` as an enum member, so upgrading to this version requires sending `seamlessach` instead. The API still accepts `paynote` during a transition period, so integrations pinned to an older client library continue to work, but the value is retired and will stop being accepted. Processor tokens already issued under `paynote` keep working and do not need to be regenerated.
399
+
400
+ ### 2020-09-14_1.737.2
401
+
402
+ - Add `client_user_id` to the `/cra/report/get` response.
403
+
404
+ ### 2020-09-14_1.737.1
405
+
406
+ - Internal changes only.
407
+
408
+ ### 2020-09-14_1.737.0
409
+
410
+ - Document the `CRA_REPORT_UPDATED` webhook (`CRA_REPORT` type), fired when a subscribed CRA report is updated. The `successful_products`/`failed_products` fields indicate which products were updated, and `scope` indicates the data the report was computed over.
411
+
412
+ ### 2020-09-14_1.736.3
413
+
414
+ ### 2020-09-14_1.736.2
415
+
416
+ - [Breaking] Remove the generic `cash-advance-onboarding-1.0` and `cash-advance-ongoing-1.0` models from `/protect/compute`. Cash advance scoring now requires the client-scoped model issued for your client, named `cash-advance-onboarding-<client>-1.0` or `cash-advance-ongoing-<client>-1.0`.
417
+
418
+ ### 2020-09-14_1.736.1
419
+
420
+ - Hide `/beta/webhook_events/list` from public API docs until GA, and document its errors, mutually exclusive `cursor`/`start_time` behavior, and additional request/response examples. The request/response shapes are unchanged.
421
+
422
+ ### 2020-09-14_1.736.0
423
+
424
+ - [Breaking] Make `amount_paid` nullable on `/protect/cash_advance/repayment/create`; it is now required only when `status` is `REPAID` or `PARTIAL_PAYMENT`.
425
+ - Make `advance_type` optional on `/protect/cash_advance/decision/create`; it is now required only when `is_taken` is `true`.
426
+
427
+ ### 2020-09-14_1.735.0
428
+
429
+ - [Breaking] Add the required `advance_type` field (`FIRST` / `REPEAT`) and the optional non-negative `previous_advance_count` field to the `/protect/cash_advance/decision/create` request body.
430
+ - [Breaking] Replace the `DELIVERED` repayment status with `PARTIAL_PAYMENT` on `/protect/cash_advance/repayment/create`. `PARTIAL_PAYMENT` indicates a payment has been made but an outstanding balance remains.
431
+ - [Breaking] Move `is_taken` out of the `cash_advance` object to the top level of the `/protect/cash_advance/decision/create` request. It must be `false` when the decision is `DECLINED`, and when `true` both `client_advance_id` and `cash_advance` are required.
432
+ - [Breaking] Rename the `cash_advance` object schema from `CashAdvanceDetails` to `CashAdvanceInfo` on `/protect/cash_advance/decision/create`.
433
+
434
+ ### 2020-09-14_1.734.1
435
+
436
+ - Add `kikoff_enterprise` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kikoff Enterprise integration.
437
+
438
+ ### 2020-09-14_1.734.0
439
+
440
+ - Make `device_data` optional and deprecated on `/protect/client/session/start`. The field remains accepted for backward compatibility.
441
+
442
+ ### 2020-09-14_1.733.0
443
+
444
+ - Added a `running_balance` field to the Transaction object. It is the balance of the account after that transaction was applied, as reported by the financial institution, and is only present where the institution sends one.
445
+
446
+ ### 2020-09-14_1.732.0
447
+
448
+ - internal changes only
449
+
450
+ ### 2020-09-14_1.731.0
451
+
452
+ - Add the optional `holder_category` and `is_verified` fields to the counterparty on `/wallet/transaction/execute`. `holder_category` tells payee verification whether the counterparty is a person or a company, and `is_verified` lets you declare that you have already verified the counterparty so Plaid skips its own payee verification check. Both apply to GBP payouts and remain hidden from public documentation.
453
+ - `payee_verification_status` on e-wallet transactions is now also populated for GBP payouts.
454
+
455
+ ### 2020-09-14_1.730.4
456
+
457
+ - Clarify that client-specific Link session model requests can use a major-version alias and that `/protect/compute` responses return the exact minor version used.
458
+
459
+ ### 2020-09-14_1.730.3
460
+
461
+ ### 2020-09-14_1.730.2
462
+
463
+ - Hide the `require_extracted_data` field on Protect Link-session model inputs from the public API reference. The request contract is unchanged.
464
+
465
+ ### 2020-09-14_1.730.1
466
+
467
+ - Noted that `merchant_category_code` on the Transaction object is in beta.
468
+
469
+ ### 2020-09-14_1.730.0
470
+
471
+ - [Breaking] Renamed the `protect_session_id` field in the request of the deprecated `/protect/event/send` to `device_session_id`, both at the top level and within `event`.
472
+ - [Breaking] Renamed the `sdk` model inputs object in the request of `/protect/compute` to `device`, and its `sdk_session_id` field to `device_session_id`. The `ProtectSDKModelInputs` schema is now `ProtectDeviceModelInputs`.
473
+
474
+ # 50.0.0
475
+ - Updating to OAS 2020-09-14_1.729.1
476
+
477
+ ## OpenAPI Schema Changes
478
+ ### 2020-09-14_1.729.1
479
+
480
+ - Clarified the description of `merchant_category_code` on the Transaction object. The field is not populated for every transaction.
481
+
482
+ ### 2020-09-14_1.729.0
483
+
484
+ - Add the private `session_group_id` field to `SESSION_FINISHED` webhook payloads for related Layer sessions.
485
+
486
+ ### 2020-09-14_1.728.2
487
+
488
+ - Give `cra_income_insights` a typed attributes/metadata schema on `/cra/report/get`, matching `cra_home_lending`. Extract the fields common to every product's metadata into a shared schema, and make `generated_time` and the transaction/income-stream date fields nullable instead of defaulting to the Unix epoch when unset.
489
+ - Demote a non-ISO `iso_currency_code` to `unofficial_currency_code` on `cra_home_lending`'s `/cra/report/get` response too, matching the validation already applied to `cra_income_insights`.
490
+
491
+ ### 2020-09-14_1.728.1
492
+
493
+ - Document that `investment_transactions[].transaction_datetime` defaults its time component to `T00:00:00Z` when the institution provides only a date, and that this does not mean the order was initiated at midnight UTC.
494
+
495
+ ### 2020-09-14_1.728.0
496
+
497
+ - [Breaking] Remove the `access_token` field from the `/protect/cash_advance/decision/create` and `/protect/cash_advance/repayment/create` request bodies.
498
+
499
+ - Add `issue_error_type` and `issue_error_code` to beta issue objects so each issue can identify the API error customers may encounter.
500
+
501
+ ### 2020-09-14_1.727.4
502
+
503
+ - Add `apy` to the account override object on `/sandbox/public_token/create` and `/sandbox/item/reset_login`, allowing a custom Sandbox account to report a specific annual percentage yield.
504
+
505
+ ### 2020-09-14_1.727.3
506
+
507
+ - Expose the CRA servicing subscription endpoints (`/cra/servicing/subscription/create`, `/cra/servicing/subscription/delete`, `/cra/servicing/subscription/get`, `/cra/servicing/subscription/list`, `/cra/servicing/subscription/update`) and `/sandbox/cra/servicing/simulate` in public documentation, along with their request and response schemas. The `x-private-visibility` and `x-hidden-from-docs` flags set when these endpoints were added pre-GA are removed; their request/response shapes are unchanged.
508
+
509
+ ### 2020-09-14_1.727.2
510
+
511
+ ### 2020-09-14_1.727.1
512
+
513
+ ### 2020-09-14_1.727.0
514
+
515
+ - Add `loan` and `line_of_credit` liability objects to `/liabilities/get`.
516
+ - Add the `installment`, `charge card`, `home equity loan`, and `commercial line of credit` account subtypes.
517
+ - Add `penalty_apr` as a credit APR type.
518
+
519
+ ### 2020-09-14_1.726.0
520
+
521
+ - [Breaking] Remove the `CraProductConfig` union and replace it with `CraSubscriptionProductConfig`, which is discriminated on `product` over the same per-product models. The CRA servicing subscription endpoints that use it remain hidden from public documentation.
522
+
523
+ ### 2020-09-14_1.725.0
524
+
525
+ - Add per-product CRA product models in two forms: `Cra<Product>ProductConfig`, which carries the product, its version, and the options it is configured with, and `Cra<Product>Product`, which names the product and version alone. Both are collected into the `CraProductConfig` and `CraProduct` unions, discriminated on `product`. No endpoint references them yet.
526
+
527
+ ### 2020-09-14_1.724.0
528
+
529
+ - Add the hidden `session_group_id` field to Link success metadata for related Layer sessions.
530
+
531
+ ### 2020-09-14_1.723.0
532
+
533
+ - Add the hidden beta `/beta/issues/v1/list`, `/beta/issues/v1/match`, `/beta/issues/v1/subscribe`, and `/beta/issues/v1/unsubscribe` endpoints for discovering institution issues and managing resolution webhook subscriptions.
534
+
535
+ ### 2020-09-14_1.721.1
536
+
537
+ - Add `apy` to Account objects when the financial institution provides the annual percentage yield on an interest-bearing deposit account.
538
+
539
+ ### 2020-09-14_1.721.0
540
+
541
+ - Add `/protect/cash_advance/decision/create` and `/protect/cash_advance/repayment/create` for reporting Cash Advance Index decision and repayment feedback.
542
+
543
+ ### 2020-09-14_1.720.0
544
+
545
+ - Add `/identity/match/list` to return a paginated history of Link-originated Identity Match attempts with `PASS`, `FAIL`, and `UNKNOWN` outcomes.
546
+
547
+ ### 2020-09-14_1.719.1
548
+
549
+ - Added `TRANSFER_OUT` to the list of possible Virtual Account transaction types.
550
+
551
+ ### 2020-09-14_1.719.0
552
+
553
+ - `/item/import` no longer requires `products` or `user_auth.auth_token`. Neither was ever checked for callers who authenticate with `user_auth.user_id`. `user_auth.auth_token` and `options` are now deprecated, and `institution_id` documents when it needs to be sent. Existing integrations that send any of these fields continue to work.
554
+
555
+ ### 2020-09-14_1.718.1
556
+
557
+ - Add `webull` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Webull integration.
558
+
559
+ ### 2020-09-14_1.718.0
560
+
561
+ - Add `USER_INCOME_VERIFICATION` and `USER_INCOME_VERIFICATION_RISK_SIGNALS` to `/sandbox/income/fire_webhook` so New User API integrations can trigger test webhooks with a public `user_id`.
562
+
563
+ ### 2020-09-14_1.717.0
564
+
565
+ - [Breaking for Go] Allow `user_id` in place of `user_token` on `/credit/payroll_income/refresh` and `/credit/employment/get`. Existing integrations can continue to use `user_token`.
566
+
567
+ ### 2020-09-14_1.716.3
568
+
569
+ - Added `prediction market` as an investment account subtype.
570
+
571
+ ### 2020-09-14_1.716.2
572
+
573
+ - Document `/user/items/associate` in the public API reference, for associating Items with a `user_id`. Items already associated with a different `user_id` are reassociated with the target User, and a single request can associate up to 100 Items.
574
+
575
+ ### 2020-09-14_1.716.1
576
+
577
+ - Add `user_id` field to the `/payment_initiation/payment/create`, `/payment_initiation/consent/create` and `/wallet/transaction/execute` endpoints.
578
+
579
+ ### 2020-09-14_1.716.0
580
+
581
+ - [Breaking] Rename the `/beta/issues/v1/get` impact fields from `affected_new_connection_count` and `affected_existing_connection_count` to `affected_new_item_count` and `affected_existing_item_count`.
582
+
583
+ ### 2020-09-14_1.715.6
584
+
585
+ - internal changes only
586
+
587
+ ### 2020-09-14_1.715.5
588
+
589
+ - Add `merchant_category_code` to the Transaction object on `/transactions/get` and `/transactions/sync`. This is the merchant category code reported by the financial institution, normalized to four digits. It is populated only where the institution sends one, typically card purchases.
590
+
591
+ ### 2020-09-14_1.715.4
592
+
593
+ - Correct Investments sample responses so `cost_basis` represents total acquisition cost and vested assets are associated only with equities.
594
+
595
+ ### 2020-09-14_1.715.3
596
+
597
+ - Document the `USER_INCOME_VERIFICATION`, `USER_INCOME_VERIFICATION_RISK_SIGNALS`, and `USER_INCOME_VERIFICATION_REFRESH_RECONNECT_NEEDED` webhooks in the public OpenAPI schema for Income integrations using the User API.
598
+ - Add `bizcap` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the BizCap integration.
599
+
600
+ ### 2020-09-14_1.715.2
601
+
602
+ - Remove the obsolete `/protect/event/get` instruction from the `PROTECT_USER_EVENT` webhook description.
603
+
604
+ ### 2020-09-14_1.715.1
605
+
606
+ - internal changes only
607
+
608
+ ### 2020-09-14_1.715.0
609
+
610
+ - Add `/sandbox/user/fire_webhook` for firing test webhooks associated with a user rather than an Item. Identify the user with a `user_id` (or a `user_token`, for integrations that predate the [New User APIs](https://plaid.com/docs/api/users/user-apis)) and pass the destination URL as `webhook`. Supported `webhook_code` values are `USER_CHECK_REPORT_READY`, `USER_CHECK_REPORT_FAILED`, `CHECK_REPORT_READY`, and `CHECK_REPORT_FAILED`.
611
+
612
+ ### 2020-09-14_1.714.0
613
+
614
+ - [Breaking] Allow `user_id` in place of `user_token` on `/credit/sessions/get`, `/credit/bank_income/get`, `/credit/bank_income/pdf/get`, `/credit/bank_statements/uploads/get`, `/credit/payroll_income/get`, `/credit/payroll_income/risk_signals/get`, and `/credit/payroll_income/parsing_config/update`. Existing integrations can continue to use `user_token`.
615
+
616
+ ### 2020-09-14_1.713.2
617
+
618
+ - Restore the legacy nested `subscores` field on Protect `TrustIndex` and private Cognito responses.
619
+ - Add `cybrid` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Cybrid integration.
620
+
621
+ ### 2020-09-14_1.713.1
622
+
623
+ - Add `airwallex` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Airwallex integration.
624
+
625
+ ### 2020-09-14_1.713.0
626
+
627
+ - [Breaking] Remove the legacy nested `subscores` field from Protect `TrustIndex` responses. Per-amount-bucket subscores on `/protect/compute` are unchanged.
628
+
629
+ ### 2020-09-14_1.712.0
630
+
631
+ - [Breaking] Correct Identity Match score objects to be non-null, with nullable inner fields when matching data is unavailable.
632
+
633
+ ### 2020-09-14_1.711.0
634
+
635
+ - Add the hidden beta `/beta/issues/v1/get` endpoint for retrieving public institution issue details by issue ID.
636
+
637
+ ### 2020-09-14_1.710.0
638
+
639
+ - internal changes only
640
+
641
+ ### 2020-09-14_1.709.4
642
+ - Add `tax_lots` to investment holdings in `/cra/check_report/verification/get` responses, returning per-lot acquisition data when provided by the institution.
643
+
644
+ ### 2020-09-14_1.709.3
645
+ - Add `tax_lots` to investment holdings in `/asset_report/get` responses, returning per-lot acquisition data when provided by the institution.
646
+
647
+ ### 2020-09-14_1.709.2
648
+
649
+ - Expose `/fdx/recipients` and `/fdx/recipient/{recipientId}` in public documentation, and clarify their descriptions and example values. The `x-hidden-from-docs` flag set when these endpoints were added pre-GA is removed; their request/response shapes are unchanged.
650
+
651
+ ### 2020-09-14_1.709.1
652
+
653
+ - Clarify that `notes` are optional for `OTHER` Protect reports.
654
+
655
+ ### 2020-09-14_1.709.0
656
+
657
+ - internal changes only
658
+
659
+ ### 2020-09-14_1.708.3
660
+ - Add `cra_home_lending` to the `Products` enum.
661
+
662
+ ### 2020-09-14_1.708.2
663
+
664
+ - internal changes only
665
+
666
+ ### 2020-09-14_1.708.1
667
+
668
+ - Add `USER_INCOME_VERIFICATION`, `USER_INCOME_VERIFICATION_RISK_SIGNALS`, and `USER_INCOME_VERIFICATION_REFRESH_RECONNECT_NEEDED` webhooks for Income customers integrated with the new User APIs.
669
+
670
+ # 49.0.0
671
+ - Updating to OAS 2020-09-14_1.708.0
672
+
673
+ ## OpenAPI Schema Changes
674
+ ### 2020-09-14_1.708.0
675
+ - [Breaking] Preserve arbitrary JSON value types in `/cra/report/get` product `metadata` and `attributes` maps and scalar values in `/cra/credit_profile/report/get` cash flow and network insight attribute maps generated by client libraries.
676
+
677
+ ### 2020-09-14_1.707.1
678
+ - Add `increase` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Increase integration.
679
+
680
+ ### 2020-09-14_1.707.0
681
+ - Add hidden `user_id` request fields to `/credit/sessions/get` and `/credit/bank_statements/uploads/get`.
682
+
683
+ # 48.0.0
684
+ - Updating to OAS 2020-09-14_1.706.1
685
+
686
+ ## Breaking changes in this version
687
+ - [BREAKING] For `/cra/check_report/create`, replace `CraCheckReportCashflowInsightsGetOptions`, `CraCheckReportIncomeInsightsGetOptions`, `CraCheckReportLendScoreGetOptions`, `CraCheckReportNetworkInsightsGetOptions`, and `CraCheckReportVerificationGetEmploymentRefreshOptions` with the corresponding `CraCheckReportCreate*Options` classes. The old classes remain available for the deprecated `/get` options, and request JSON is unchanged. (OAS 2020-09-14_1.700.0)
688
+ - [BREAKING] Use `Plaid::ProductsTerminateReasonCode` for both Item and user product termination; the two endpoint-specific wrapper classes were removed. Accepted wire values are unchanged. (OAS 2020-09-14_1.701.1)
689
+ - [BREAKING] Manually constructed `CreditSessionDocumentIncomeResult`, `LinkEventsWebhook`, and `PayrollIncomeObject` models must now include `num_i20s_uploaded`, `environment`, and `i20s`, respectively, to pass generated validation. (OAS 2020-09-14_1.699.0, 1.699.5, and 1.703.0)
690
+ - [BREAKING] Use `"interest only"` instead of `"interest-only"` for `StudentRepaymentPlan.type`, matching the value returned by the API. (OAS 2020-09-14_1.699.1)
691
+ - `FDXInitiatorFiAttribute.value` is now typed as a string. Existing `Plaid::FDXPartyType::*` constants remain valid because their values are strings. This schema is not referenced by an endpoint. (OAS 2020-09-14_1.703.0)
692
+
693
+ ## OpenAPI Schema Changes
694
+ ### 2020-09-14_1.706.1
695
+ - Make product `metadata` and `attributes` nullable when unavailable in `/cra/report/get` responses.
696
+
697
+ ### 2020-09-14_1.706.0
698
+ - Add the `/transfer/return/recover` endpoint, which lets clients report that they have recovered some or all of the loss on a returned guaranteed transfer.
699
+ - Add the `guarantee_reimbursed`, `client_return_recovered`, and `plaid_return_recovered` transfer event types, and add a nullable signed `event_amount` field to the transfer event object.
700
+
701
+ ### 2020-09-14_1.705.4
702
+ - Mark superseded products, endpoints, and fields as `deprecated`: the Beacon product (`/beacon/*` endpoints and webhooks, plus the `beacon_user_id` field on Identity Verification responses); Bank Transfer (except the `/bank_transfer/event/*` endpoints, still used for Auth micro-deposits); `/employers/search`; the legacy Cash Flow Updates webhooks superseded by `CASH_FLOW_INSIGHTS_UPDATED`; and the `PaymentInitiationConsentScope`, `TransferCreditFundsSource`, and `RiskReason` schemas.
703
+ - Quote `type: string` certain enum values (Prism version number strings, Freddie Mac "yes/no" API string responses) that YAML parsers were coercing to numbers or booleans.
704
+ - Expose `/cra/report/get` and its request/response schemas in generated client libraries. The endpoint remains hidden from public documentation.
705
+
706
+ ### 2020-09-14_1.705.3
707
+ - Document the `ip_address` field on the `/identity_verification/create` `user` object: accepted only here (not via `/link/token/create`) and captured automatically by the Link SDK, for backend-only integrations that need IP-based risk checks.
708
+
709
+ ### 2020-09-14_1.705.2
710
+ - Clarified the `/oauth/token` response `token_type` description (it is `Bearer` for OAuth access tokens); dropped the inaccurate "always Bearer" wording.
711
+
712
+ ### 2020-09-14_1.705.1
713
+ - internal changes only
714
+
715
+ ### 2020-09-14_1.705.0
716
+ - Type the `product` field of the `CraReportUpdatedWebhook` (`CRA_REPORT`/`CRA_REPORT_UPDATED`) `successful_products`/`failed_products` entries against the `Products` enum instead of a free-form string, matching the sibling `/cra/report/get` product schemas.
717
+
718
+ ### 2020-09-14_1.704.2
719
+ - internal changes only
720
+
721
+ ### 2020-09-14_1.704.1
722
+ - internal changes only
723
+
724
+ ### 2020-09-14_1.704.0
725
+ - internal changes only
726
+
727
+ ### 2020-09-14_1.703.0
728
+ - Add the `environment` field to the `LinkEventsWebhook` (`LINK`/`EVENTS`) schema, matching actual behavior.
729
+ - Change `FDXInitiatorFiAttribute.value` from the `FDXPartyType` enum to a string, matching the sibling `FDXFiAttribute` (this schema is not referenced by any endpoint).
730
+ - Fixed a `TransactionsRuleDetails.query` description that referenced a nonexistent `NAME` field (the enum value is `MERCHANT_NAME`), and a `/cra/encompass/get_reports` example whose `report_status` was not a valid value and whose `generated_at` key should be `created_at`.
731
+ - Fixed additional example/consistency issues: `/transactions/get` and `/processor/transactions/get` examples now report the correct `total_transactions`; the Identity Verification `Strategy` note references the `watchlist_screening` step; the `US_SDN` watchlist code label is consistent; `SelfieCapture` examples reflect that only one of `image_url`/`video_url` is populated; the `/institutions/get_by_id` example nests `liabilities` correctly; the `/oauth/token` scope description calls `urn:plaid:params:oauth:user-token` a subject token type; and a `/cra/encompass/load/existing` example was corrected to match its schema.
732
+
733
+ ### 2020-09-14_1.702.4
734
+ - Add `hide_gse_details` to `/cra/check_report/verification/pdf/get`. When `true`, the GSE identifiers (the Report ID and `gse_reference_id`) are omitted from the returned Home Lending Report PDF. Defaults to `false`. These identifiers are always present in the `/cra/check_report/verification/get` JSON response regardless of this field.
735
+
736
+ ### 2020-09-14_1.702.3
737
+ - Add the `error`, `repairable_items`, and `failed_products` fields to the `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhooks.
738
+
739
+ ### 2020-09-14_1.702.2
740
+ - Add `tax_lots` to the `/investments/holdings/get` sample response, showing both a holding with per-lot detail and a holding with an empty `tax_lots` array.
741
+
742
+ ### 2020-09-14_1.702.1
743
+ - Update descriptions for the CRA `/get` endpoints.
744
+
745
+ ### 2020-09-14_1.702.0
746
+ - Add `timestamp` to `/protect/compute` responses to indicate when the Trust Index score and fraud attributes were computed.
747
+
748
+ ### 2020-09-14_1.701.4
749
+ - Add `ip_address` (optional, nullable) to the `user` object (`IdentityVerificationCreateRequestUser`) on `/identity_verification/create`. Lets backend-only integrations supply the end user's IP address for IP-based risk checks without launching the Link SDK.
750
+
751
+ ### 2020-09-14_1.701.3
752
+ - Add `exclusion_code` to the `CraPartnerInsightsUltraFicoScoreResult` object, exposing the FICO exclusion code that explains why an UltraFICO® score could not be computed due to consumer-data conditions (e.g. insufficient account history).
753
+
754
+ ### 2020-09-14_1.701.2
755
+ - Add private-visibility `error`, `repairable_items`, and `failed_products` to the `CHECK_REPORT_FAILED` and `USER_CHECK_REPORT_FAILED` webhooks.
756
+
757
+ ### 2020-09-14_1.701.1
758
+ - Add the nullable `receiver_details` field to the `BankTransferEvent` schema returned by `/bank_transfer/event/list` and `/bank_transfer/event/sync`, matching what the API already emits. Currently always `null`.
759
+ - [Breaking] Change the generated `reason_code` type for `/item/products/terminate` and `/user/products/terminate` from the unusable `ItemProductsTerminateReasonCode` and `UserProductsTerminateReasonCode` wrapper types to `ProductsTerminateReasonCode`. The accepted JSON values are unchanged.
760
+ - Make `home_lending_report_options` visible in the docs for `/cra/check_report/create` and `/link/token/create`.
761
+
762
+ ### 2020-09-14_1.701.0
763
+ - Add `figi` to the `Security` schema: the 12-character OpenFIGI identifier, which stays stable across most corporate actions (ticker/CUSIP/name changes) and is the preferred identifier for tracking a security across its lifecycle. Null until Plaid has enriched the security with FIGI data.
764
+
765
+ ### 2020-09-14_1.700.1
766
+ - Add the `/sandbox/fdx/consent/seed` endpoint for seeding a test FDX consent grant on Sandbox data partner accounts. Takes `customer_id` and `application_id` (and an optional `consent_id`) and returns the seeded `consent_id`.
767
+
768
+ ### 2020-09-14_1.700.0
769
+ - [Breaking] Rename the `/cra/check_report/create` request options schemas for `cashflow_insights`, `lend_score`, `network_insights`, `income_insights`, and the Home Lending Report's `employment_refresh_options` to `CraCheckReportCreate*Options`. The JSON request is unchanged.
770
+ - Deprecate the request-time generation config on the CRA `/get` endpoints (`options`, `partner_insights`, `employment_refresh_options`); no longer accepted for new clients (created on or after 2026-07-01).
771
+
772
+ ### 2020-09-14_1.699.6
773
+ - Add `cash advance`, `late fee`, `membership fee`, `returned item fee` to the `transaction_code` enum.
774
+
775
+ ### 2020-09-14_1.699.5
776
+ - Add `num_i20s_uploaded` to the `document_income_results` object in the `/credit/sessions/get` and `/link/token/get` responses
777
+
778
+ ### 2020-09-14_1.699.4
779
+ - Add private-visibility scaffolding for the `CRA_REPORT_UPDATED` webhook (`CRA_REPORT` type), fired when a subscribed CRA report is updated; lists the `successful_products` and `failed_products` for the update. Hidden from the public spec/docs until launch (customer-facing entry follows when `x-private-visibility` flips).
780
+
781
+ ### 2020-09-14_1.699.3
782
+ - Add `kick` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kick integration.
783
+
784
+ ### 2020-09-14_1.699.2
785
+ - Adds `DOCUMENT_TYPE_US_STUDENT_I20` enum value (Form I-20 student document) for document metadata
786
+ - Add `/fdx/consents`, `/fdx/consents/{consentId}`, and `/fdx/consents/{consentId}/revocation` for managing FDX consent grants. These endpoints remain hidden from public documentation.
787
+
788
+ ### 2020-09-14_1.699.1
789
+ - Additions and corrections of enum values returned by API but not mentioned in OpenAPI spec. No actual changes to API behavior.
790
+ - `PlaidErrorType`: add 13 error types (`ASSETS_ERROR`, `ENRICH_ERROR`, `STATEMENTS_ERROR`, `RECURRING_TRANSACTIONS_ERROR`, `CRA_MONITORING_ERROR`, `CREDIT_PROFILE_REPORT_ERROR`, `ENCOMPASS_ERROR`, `FRAUD_INSIGHTS_ERROR`, `FREDDIE_MAC_ERROR`, `LINK_DELIVERY_ERROR`, `PROFILE_ERROR`, `TRANSFER_RECURRING_ERROR`, `TRANSFER_REFUND_ERROR`
791
+ - Asset Report `warning_code`: add the 5 `BANK_INCOME_INSIGHTS_*` codes
792
+ - watchlist `source`: add `retro` enum value
793
+ - `TransferNetwork`: add `rfp` enum value (request for payment; closed beta, debit-only)
794
+ - `StudentRepaymentPlan.type`: `interest-only` → `interest only` (match the emitted value)
795
+
796
+ ### 2020-09-14_1.699.0
797
+ - Add support for the Form I-20 US immigration student document on `/credit/payroll_income/get`. This form now returns an `i20` array which extraction data on uploaded I-20 documents.
798
+
799
+ # 47.0.0
800
+ - Updating to OAS 2020-09-14_1.698.7
801
+
802
+ ## Breaking changes in this version
803
+ - [BREAKING] Remove `protect_results` from `LinkSessionResults` in `/link/token/get` responses. The API no longer populates this field. (OAS 2020-09-14_1.697.0)
804
+ - [BREAKING] `Recaptcha_RequiredError`: change `http_code` from `string` to `integer`. The API already returns an integer; only the spec was wrong. (OAS 2020-09-14_1.695.0)
805
+ - [BREAKING] Replace `report_requested` field with `reports_requested` array field in `/cra/check_report/verification/pdf/get`. (OAS 2020-09-14_1.691.0)
806
+ - [BREAKING] Remove `/item/handle_fraud_report` endpoint and its `ItemHandleFraudReportRequest` and `ItemHandleFraudReportResponse` schemas. The endpoint was never wired up for any customer. (OAS 2020-09-14_1.688.9)
807
+
808
+ ## OpenAPI Schema Changes
809
+ ### 2020-09-14_1.698.7
810
+ - Add `kanmon` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Kanmon integration.
811
+
812
+ ### 2020-09-14_1.698.6
813
+ - Add `natural` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Natural integration.
814
+
815
+ ### 2020-09-14_1.698.5
816
+ - Add `pay` to the `processor` enum on `/processor/token/create`, for creating processor tokens for the Pay.com integration.
817
+
818
+ ### 2020-09-14_1.698.4
819
+ - Remove the 1024-character `maxLength` constraint from `notes` on `/protect/report/create`.
820
+
821
+ ### 2020-09-14_1.698.3
822
+ - Add `FRAUD_TRANSACTION` to the `reason_code` enum (`ProductsTerminateReasonCode`) accepted by `/item/products/terminate` and `/user/products/terminate`, for terminating an Item due to transaction-level fraud (e.g. unauthorized transactions, card testing, chargebacks, ACH returns, or disputes).
823
+ - Add `/cra/report/get` endpoint with CRA report schemas (CraReportGetRequest, CraReportGetResponse, CraReportGetReport, CraReportGetResponseProduct, CraReportGetProductAttributes, CraReportGetProductMetadata).
824
+
825
+ ### 2020-09-14_1.698.2
826
+ - Correct stylization, acronym expansions, and factual errors in schema descriptions: "Bacs" (was "BACS"), "International Bank Account Number", "Business Identifier Code", "Government-Sponsored Enterprise" (was "Government Sponsored Entity"), "Registered Disability Savings Plan (RDSP)" (was "RSDP"), "FATCA" filing requirement (description only; was "FACTA"), "E.164" phone format (was "E. 164"), and "Social Security". Also clarified that `balances.available` and `balances.current` may both be `null` for limited-purpose checking accounts, and corrected an endpoint reference in a description (`/processor/stripe/bank_account_token/create`), and normalized two endpoint summaries to refer to the product as a singular "Consumer Report", and normalized "realtime" to the hyphenated "real-time" in balance descriptions. No changes to API behavior.
827
+
828
+ ### 2020-09-14_1.698.1
829
+ - Clarify that `/protect/report/create` requires either `user_id` or at least one supported `incident_event` identifier, and that contextual fields alone do not satisfy this requirement.
830
+
831
+ ### 2020-09-14_1.698.0
832
+ - Add `guarantee_details` (optional) to `Transfer` and `TransferAuthorization` schemas to surface adaptive guarantee settlement information. Introduces `TransferGuaranteeOutcome` enum, `AuthorizationGuaranteeScheduleItem` and `TransferGuaranteeScheduleItem` objects, `AuthorizationGuaranteeDetails` (outcome + schedule), and `TransferGuaranteeDetails` (guaranteed_amount + schedule). The authorization schedule omits `observation_window_expiration_time`, which is only meaningful on a created transfer. `guarantee_details` is `null` when no guarantee was attempted. The existing `guarantee_decision` and `guarantee_decision_rationale` fields are deprecated in favor of `guarantee_details`.
833
+ - Add `requested_amount` to the `proposed_transfer` object on the `/transfer/authorization/create` response. Surfaces the amount the client originally requested, which can differ from the proposed `amount` when only a partial amount is offered for an adaptive guarantee.
834
+
835
+ ### 2020-09-14_1.697.5
836
+ - Document support for UltraFICO® scores through the CRA Partner Insights product.
837
+
838
+ ### 2020-09-14_1.697.4
839
+ - Correct spec to reflect two missing enum values: add missing `in_epic` enum value to `IDNumberType` and add missing `IDEMPOTENCY_ERROR` enum value to `ErrorType` schema. No changes to actual API behavior.
840
+
841
+ ### 2020-09-14_1.697.4
842
+ - Update `Holding.tax_lots` description: remove stale "Absent from the response when the tax lots feature is not yet enabled" clause.
843
+
844
+ ### 2020-09-14_1.697.3
845
+ - Add `atomicfi` value to the `processor` enum on `/processor/token/create`.
846
+
847
+ ### 2020-09-14_1.697.2
848
+ - Add `payment` and `refund` values to the `transaction_code` enum, and update the field description to note that `transaction_code` is now populated for certain US institutions, in addition to European institutions.
849
+
850
+ ### 2020-09-14_1.697.1
851
+ - Add `sub_programs` (`array<string>`) to `WatchlistScreeningHit` and `EntityWatchlistScreeningHit`. Surfaces the sub-program designations published by the issuing authority (for example OFAC SDN program codes like `SDGT`, `SDNTK`, `IRAN`, `RUSSIA-EO14024`).
852
+
853
+ ### 2020-09-14_1.697.0
854
+ - [Breaking] Remove `protect_results` from `LinkSessionResults` in `/link/token/get` responses. The API no longer populates this field.
855
+
856
+ ### 2020-09-14_1.696.1
857
+ - Add `tax_lots` array field to `Holding` and introduce `HoldingTaxLot` schema with 7 fields: `institution_lot_id`, `original_purchase_datetime`, `quantity`, `purchase_price`, `cost_basis`, `current_value`, and `position_type`. Introduce `HoldingTaxLotPositionType` enum (`LONG`, `SHORT`).
858
+
859
+ ### 2020-09-14_1.696.0
860
+ - Add `ACCOUNT_FUNDING` and `AUTO_REFUND` values to the `WalletTransaction.type` enum. These transaction types are already returned for virtual-account unexpected-payment handling and were documented but missing from the spec.
861
+
862
+ ### 2020-09-14_1.695.0
863
+ - [Breaking] `Recaptcha_RequiredError`: change `http_code` from `string` to `integer`. The API already returns an integer; only the spec was wrong.
864
+ - Add `BASE_REPORT_ERROR` to the `error_type` enum (`PlaidErrorType`).
865
+ - `IncomeVerificationRiskSignalsStatusWebhook`: fix the `required` list to reference `risk_signals_status` instead of a non-existent `status` field.
866
+ - `Recaptcha_RequiredError`: mark `display_message` nullable and remove `link_user_experience`, `common_causes`, and `troubleshooting_steps` from `required`. This schema object is used for documentation only; describing these fields as required is misleading.
867
+ - Remove `database_insights_pending` from the `verification_status` description on product-endpoint account schemas — it is only returned in the Link `onSuccess` metadata, not by these endpoints.
868
+ - Add `STARTED` and `INTERNAL_ERROR` to the `CreditSessionBankIncomeStatus` enum.
869
+ - Add `STARTED` and `INTERNAL_ERROR` to the `CreditSessionBankEmploymentStatus` enum.
870
+ - Fix various webhook and error response examples to conform to their schemas.
871
+
872
+ ### 2020-09-14_1.694.0
873
+ - Add `custom_attributes` field to `TransferAuthorizationCreateRequest`.
874
+
875
+ ### 2020-09-14_1.693.0
876
+ - Add `reason_codes` array to `CraPartnerInsightsBaseFicoScore` and `negative_reason_codes` / `positive_reason_codes` arrays to `CraPartnerInsightsUltraFicoScore`. The corresponding individual `reason_code_1` through `reason_code_4` and `positive_reason_code_1` through `positive_reason_code_4` fields are now deprecated.
877
+
878
+ ### 2020-09-14_1.692.7
879
+ - Add `model_version` string field to `PrismInsights` and deprecate the integer `version` field. Required to surface Prism Insights v4.1 and any future non-integeter model versions.
880
+
881
+ ### 2020-09-14_1.692.6
882
+ - Add private-visibility scaffolding for `POST /fraud_insights/connection_event/send` (501 stub; customer-facing entry follows when `x-private-visibility` flips).
883
+
884
+ ### 2020-09-14_1.692.5
885
+ - Add `interchecks` value to the `processor` enum on `/processor/token/create`.
886
+
887
+ ### 2020-09-14_1.692.4
888
+ - Redeclare `name`, `official_name`, `mask`, and `verification_name` on the second `allOf` piece of `InvestmentAccount`, `BusinessAccount`, `AccountIdentity`, and `AccountIdentityMatchScore`. The fields are already declared on `AccountBase`; the redeclaration prevents the `plaid-python` SDK (>= 39.0.0) from routing them through its `additional_properties_type` handler, which upconverts date-shaped string values (e.g. an account literally named `"June - 529"`) into `datetime.date` objects in `to_dict()`. No change to the API response shape.
889
+
890
+ ### 2020-09-14_1.692.3
891
+ - Add private-visibility scaffolding for `POST /fraud_insights/connection_risk_score/get` (501 stub; customer-facing entry follows when `x-private-visibility` flips).
892
+
893
+ ### 2020-09-14_1.692.2
894
+ - Update `CraUserCheckReportFailedWebhook` (`USER_CHECK_REPORT_FAILED`) description to document that customers can call `/user/items/get` and inspect non-null `error` objects on the associated Items to retrieve error details, matching the existing guidance on `CraCheckReportFailedWebhook` (`CHECK_REPORT_FAILED`).
895
+
896
+ ### 2020-09-14_1.692.1
897
+ - Correct the `/statements/download` success response content type from `application/json` to `application/pdf` to match the binary PDF body the endpoint actually returns.
898
+
899
+ ### 2020-09-14_1.692.0
900
+ - `/cra/check_report/income_insights/get`: `income_streams` is now marked as required on `CraIncomeInsights` and is always present on the response. When there are no income streams for the report, it is returned as an empty array (`[]`) instead of being omitted.
901
+
902
+ ### 2020-09-14_1.691.2
903
+ - Update `/user/products/terminate` description to clarify which subscription bundles are terminated, the billing impact, and the CRA Monitoring carve-out.
904
+ - Restore the `/user/items/remove` description paragraph that points users to `/user/products/terminate` for stopping billing and to the Consumer Service Center for user-initiated data deletion.
905
+
906
+ ### 2020-09-14_1.691.1
907
+ - Add `frame` value to the `processor` enum on `/processor/token/create`.
908
+
909
+ ### 2020-09-14_1.691.0
910
+ - [Breaking] Replace `report_requested` field with `reports_requested` array field in `/cra/check_report/verification/pdf/get`.
911
+ - Add `income` value to `CraCheckReportVerificationPdfReportType`.
912
+
913
+ ### 2020-09-14_1.690.1
914
+ - Expose `/user/products/terminate` in the public OpenAPI spec (previously hidden from client libraries).
915
+
916
+ ### 2020-09-14_1.690.0
917
+ - Add an optional `subscores` object to the `/protect/compute` response and a new `ProtectComputeSubscores` schema. For cash-advance models, exposes per-bucket subscores (`cash_advance_bucket_0_25` through `cash_advance_bucket_400_500`) where each scored bucket is a 0-100 trust index score (higher = lower fraud risk). Both the wrapper `subscores` field and each individual bucket key are omitted from the response when not scored: models that do not produce subscores will not include the `subscores` key in the response at all, and partially-scored responses include only the bucket keys that were scored.
918
+
919
+ ### 2020-09-14_1.689.0
920
+ - Add optional `user_id` field to `CraCreditProfileReportGetResponse`.
921
+
922
+ ### 2020-09-14_1.688.10
923
+ - Add `reason_code` enum values to `/item/products/terminate` and `/user/products/terminate`
924
+
925
+ ### 2020-09-14_1.688.9
926
+ - [Breaking] Remove `/item/handle_fraud_report` endpoint and its `ItemHandleFraudReportRequest` and `ItemHandleFraudReportResponse` schemas. The endpoint was never wired up for any customer.
927
+
928
+ ### 2020-09-14_1.688.8
929
+ - Expose the `limited_purpose_types` filter on `LinkTokenCreateDepositoryFilter` and `DepositoryFilter`, and the `LimitedPurposeTypes` and `LimitedPurposeType` schemas, in the public OpenAPI spec (previously hidden from client libraries). Used in conjunction with the `limited purpose checking` depository subtype to restrict which kinds of limited purpose checking accounts may be connected in Link.
930
+
931
+ ### 2020-09-14_1.688.7
932
+ - Add income schema types (`CraVerificationIncome*`) to CRA Home Lending Verification Report
933
+ - Add `income` field to `CraVerificationReport`
934
+ - Add `INCOME` to `CraCheckReportVerificationGetReportType` enum
935
+ - Document that `/sandbox/transactions/create` only applies custom transactions to the depository account on `user_transactions_dynamic` Items
936
+
937
+ # 46.2.0
938
+ - Updating to OAS 2020-09-14_1.688.6
939
+
940
+ ## OpenAPI Schema Changes
941
+ ### 2020-09-14_1.688.6
942
+ - Updated `/user_account/session/get` sample response to include `identity_edit_history`
943
+
944
+ ### 2020-09-14_1.688.5
945
+ - Expose `/cra/credit_profile/report/get` and its request/response schemas in the public OpenAPI spec (previously hidden from client libraries)
946
+ - Mark `/credit/bank_income/refresh` as `deprecated: true`. The backend implementation was removed, and the endpoint returns `Unimplemented` at runtime. To refresh Bank Income data, send the user through Link Update Mode, or migrate to CRA Income Insights and call `/cra/check_report/create`.
947
+
948
+ ### 2020-09-14_1.688.4
949
+ - Document that `/transfer/metrics/get` returns static placeholder values in the Sandbox environment
950
+
951
+ ### 2020-09-14_1.688.3
952
+ - Mark `/protect/event/send` and `/protect/event/get` as `deprecated: true`
953
+
954
+ ### 2020-09-14_1.688.2
955
+ - Hide `/protect/event/send` and `/protect/event/get` endpoints from public API docs
956
+
957
+ ### 2020-09-14_1.688.1
958
+ - Add `/sandbox/item/application/seed` endpoint for seeding connected applications on Permissions Manager sandbox items
959
+
960
+ # 46.1.0
961
+ - Updating to OAS 2020-09-14_1.688.0
962
+
963
+ ## OpenAPI Schema Changes
964
+ ### 2020-09-14_1.688.0
965
+ - Add additional fields to CRA Partner Insights UltraFICO response (hidden from docs)
966
+
967
+ ### 2020-09-14_1.687.1
968
+ - Add `limited purpose checking` to `DepositoryAccountSubtype`, `DepositoryAccount`, and `AccountSubtype` schemas
969
+ - Add `limited_purpose_types` filter field to `DepositoryFilter` and `LinkTokenCreateDepositoryFilter` (hidden from docs)
970
+ - Add `LimitedPurposeTypes` and `LimitedPurposeType` schemas (hidden from docs)
971
+
972
+ ### 2020-09-14_1.687.0
973
+ - Add new field `disconnect_time` to `PendingDisconnectWebhook`
974
+
975
+ ### 2020-09-14_1.686.4
976
+ - Income Insights doc fixes
977
+
978
+ ### 2020-09-14_1.686.3
979
+ - Update `/cra/check_report/income_insights/get` sample response to V2 schema
980
+
981
+ ### 2020-09-14_1.686.2
982
+ - Unhide Income Insights V2 fields and hide Income Insights v1 fields
983
+
984
+ ### 2020-09-14_1.686.1
985
+ - Add `home_lending_report_options` to `CraCheckReportCreateBaseReportOptions` and `LinkTokenCreateRequestCraOptionsBaseReport` for configuring Home Lending Report generation (VOA, Employment Refresh) on base report creation
986
+
987
+ # 46.0.0
988
+ - Updating to OAS 2020-09-14_1.686.0
989
+
990
+ ## Breaking changes in this version
991
+ - [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions
992
+ - [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase`
993
+ - [Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value.
994
+ - [Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore.
995
+
996
+
997
+ ## OpenAPI Schema Changes
998
+ ### 2020-09-14_1.686.0
999
+ - Add Income Insights V2 schemas and fields to client libraries (hidden from docs)
1000
+ ### 2020-09-14_1.685.3
1001
+ - Add `cfi_code` field to the Investments `Security` schema.
1002
+
1003
+ ### 2020-09-14_1.685.2
1004
+ - Add `protect_transactions` to the public `Products` and `UserBasedProducts` enums and expose it in `/link/token/create` product array docs.
1005
+
1006
+ ### 2020-09-14_1.685.1
1007
+ - Add Item IDs to FAILED CHECK_REPORT webhooks for closed beta
1008
+
1009
+ ### 2020-09-14_1.685.0
1010
+ - [BREAKING] Remove deprecated beta `recurrence` field from `Enrichments` schema in `/transactions/enrich` response and remove `Recurrence` and `RecurringFrequency` schema definitions
1011
+
1012
+ ### 2020-09-14_1.684.1
1013
+ - Add missing investment account subtypes to `InvestmentAccountSubtype` and `InvestmentAccountSubtypeStandalone` schemas: `fhsa`, `line of credit`, `roth 403B`, `roth 457b`, `roth pension`, `roth profit sharing plan`, `roth thrift savings plan`, and `thrift savings plan`. Add these subtypes plus `qshr` to the `AccountSubtype` enum.
1014
+
1015
+ ### 2020-09-14_1.684.0
1016
+ - Add `InvestmentAccountBalance` and `InvestmentAccount` schemas to expose `margin_loan_amount` on investment endpoints
1017
+ - [BREAKING] Update `InvestmentsHoldingsGetResponse`, `InvestmentsTransactionsGetResponse`, `InvestmentsAuthGetResponse`, `ProcessorInvestmentsHoldingsGetResponse`, and `ProcessorInvestmentsTransactionsGetResponse` to use `InvestmentAccount` instead of `AccountBase`
1018
+
1019
+ ### 2020-09-14_1.683.2
1020
+
1021
+ ### 2020-09-14_1.683.1
1022
+ - Add version `4.1` to `PrismDetectVersion`, `PrismCashScoreVersion`, `PrismExtendVersion`, and `PrismInsightsVersion` enums for Prism v4.1 support in `/cra/check_report/partner_insights/get`.
1023
+
1024
+ ### 2020-09-14_1.683.0
1025
+ - Add OpenAPI spec for `/item/products/terminate` and `/item/handle_fraud_report` endpoints
1026
+
1027
+ ### 2020-09-14_1.683.0
1028
+ - Add `user_id` field to `CreditBankIncomeGetRequest`, `CreditBankIncomePDFGetRequest`, `CreditBankIncomeRefreshRequest`, `CreditBankIncomeWebhookUpdateRequest`, `CreditPayrollIncomeParsingConfigUpdateRequest`, `CreditPayrollIncomeRiskSignalsGetRequest`, `CreditPayrollIncomeGetRequest`, `CreditPayrollIncomePrecheckRequest`, and `CreditPayrollIncomeRefreshRequest`.
1029
+
1030
+ ### 2020-09-14_1.682.12
1031
+ - Update `with_guarantee` field in `/transfer/authorization/create` with clearer wording
1032
+
1033
+ ### 2020-09-14_1.682.11
1034
+ - Update `/user/items/remove` description with clearer wording
1035
+
1036
+ ### 2020-09-14_1.682.10
1037
+ - Add `cfi_code` to the Investments `Security` model.
1038
+
1039
+ ### 2020-09-14_1.682.9
1040
+ - Make `with_upgraded_user` field in `/user/create` visible in docs
1041
+
1042
+ ### 2020-09-14_1.682.8
1043
+ - Remove deprecated `prism_products` field from `CraCheckReportCreatePartnerInsightsOptions`, `CraCheckReportPartnerInsightsGetOptions`, `LinkTokenCreateRequestCraOptionsPartnerInsights`, and `LinkTokenCreateRequestCreditPartnerInsights` schemas. Remove deprecated `PrismProduct` enum. Use `prism_versions` instead.
1044
+
1045
+ ### 2020-09-14_1.682.7
1046
+ [Breaking] `CraPartnerInsightsPrism` is now nullable. The `prism` field will be omitted from `/cra/check_report/partner_insights/get` responses when Prism Data was not included in the request. Clients that always expect `prism` to be present should update to handle a null or missing value.
1047
+
1048
+ ### 2020-09-14_1.682.6
1049
+
1050
+ ### 2020-09-14_1.682.5
1051
+ Update copy for Layer email availability
1052
+
1053
+ ### 2020-09-14_1.682.4
1054
+ - Add `link_session_id` field to `ProtectUserEventWebhook`
1055
+ -
1056
+
1057
+ ### 2020-09-14_1.682.3
1058
+ [Breaking] Remove Plaid Check Score references from the API. Plaid Check Score is not in active use by customers and has been deprecated in favor of the Plaid LendScore.
1059
+
1060
+ # 45.4.0
1061
+ - Updating to OAS 2020-09-14_1.682.2
1062
+
1063
+ ## OpenAPI Schema Changes
1064
+ ### 2020-09-14_1.682.2
1065
+ - Add personal_finance_category to BaseReportTransaction model.
1066
+
1067
+ ### 2020-09-14_1.682.1
1068
+ - Update `ProtectComputeResponse`: promote `score` and `model` to top-level fields, rename `fraud_attributes` to `attributes`, and remove `trust_index` and `subscores`
1069
+ - Mark `ProtectComputeResponse.score` as nullable so it is omitted from the API response when no trust index score is present, preventing clients from seeing a spurious `"score": 0`
1070
+
1071
+ ### 2020-09-14_1.682.0
1072
+ - Add `has_null_available_balance` field to `OverrideAccounts` schema. When set to `true`, the Sandbox test account will always return `null` for its available balance. Cannot be set together with `force_available_balance`.
1073
+
1074
+ ### 2020-09-14_1.681.9
1075
+ - Add `fico` field to `CraCheckReportPartnerInsightsGetPartnerInsights`, `CraCheckReportCreatePartnerInsightsOptions`, and `LinkTokenCreateRequestCraOptionsPartnerInsights` schemas to support UltraFICO score generation; add new `CraPartnerInsightsFicoInput`, `CraPartnerInsightsUltraFicoScoreRequest`, `CraPartnerInsightsBaseFicoScore`, `CraPartnerInsightsUltraFicoScoreVersion`, `CraPartnerInsightsBureau`, and `CraPartnerInsightsBaseFicoScoreVersion` schemas
1076
+
1077
+ ### 2020-09-14_1.681.8
1078
+ - Update `beta/transactions/rules/v1` endpoints to use `client_user_id` instead of `access_token`
1079
+ - Split `personal_finance_category` into `pfc_primary_category` and `pfc_detailed_category` on rule request/response schemas; add optional `pfc_version` field
1080
+ - Rename `TransactionsRuleField` enum value `NAME` to `MERCHANT_NAME`
1081
+ - Add `updated_at` and `client_user_id` to `TransactionsCategoryRule`; replace `item_id` and `personal_finance_category`
1082
+
1083
+ ### 2020-09-14_1.681.7
1084
+ - Add `sdk` field to `ProtectModelInputs` on `ProtectComputeRequest`.
1085
+
1086
+ ### 2020-09-14_1.681.6
1087
+ - Clarify `/protect/compute` `model` field: version suffix is required and must be `major.minor` format; removed references to versionless model names
1088
+ - Expand `require_extracted_data` field description to document HTTP 400 / `FAILED_PRECONDITION` behavior when set to `true`
1089
+ - Add readiness error to `/protect/compute` endpoint description: for link-session models, calling the endpoint before the Link session is complete returns HTTP 400 with `error_type` = `INVALID_REQUEST` and `error_code` = `FAILED_PRECONDITION`
1090
+
1091
+ # 45.3.0
1092
+ - Updating to OAS 2020-09-14_1.681.5
1093
+
1094
+ ## OpenAPI Schema Changes
1095
+ ### 2020-09-14_1.681.5
1096
+ - Add `ELIGIBILITY_FOR_GOVT_BENEFITS` permissible purpose to `ConsumerReportPermissiblePurpose` schema
1097
+
1098
+ # 45.2.0
1099
+ - Updating to OAS 2020-09-14_1.681.4
1100
+
1101
+ ## OpenAPI Schema Changes
1102
+ ### 2020-09-14_1.681.4
1103
+ - Add `client_user_id` field to `ProtectUserEventWebhook`
1104
+
1105
+ ### 2020-09-14_1.681.2
1106
+ - Add `edits_current` field to `UserAccountIdentityEditCounts` schema. This field tracks the number of edits made to a specific identity field during the current session.
1107
+
1108
+ ### 2020-09-14_1.681.1
1109
+ - Add `user_id` field to the following webhook schemas: `SyncUpdatesAvailableWebhook`, `ItemPendingExpirationWebhook`, `ItemErrorWebhook`, `ItemLoginRepairedWebhook`, `InvestmentsTransactionsDefaultUpdateWebhook`, `InvestmentsTransactionsHistoricalUpdateWebhook`, `HoldingsDefaultUpdateWebhook`, `LiabilitiesDefaultUpdateWebhook`, `ItemPendingDisconnectWebhook`, `ItemUserPermissionRevokedWebhook`, `NewAccountsAvailableWebhook`, `UserAccountRevokedWebhook`, `LinkSessionFinishedWebhook`
1110
+
1111
+ ### 2020-09-14_1.681.0
1112
+ - Add `trust_index_score` field to `risk_check` schema for IDV endpoints.
1113
+
1114
+ ### 2020-09-14_1.680.9
1115
+ - Add `payee_verification_status` field to `WalletTransaction` schema. This field indicates the result of payee verification checks for EUR payouts.
1116
+
1117
+ # 45.1.0
1118
+ - Updating to OAS 2020-09-14_1.680.8
1119
+
1120
+ ## OpenAPI Schema Changes
1121
+ ### 2020-09-14_1.680.8
1122
+ - Add `cra_plaid_credit_score` value to Products enum. Note that this value is deprecated and is added only to reflect current API behavior, as it is present in the supported products array returned by insititutions endpoints. `cra_plaid_credit_score` should not be used in any requests to `/link/token/create` and is planned to be removed from the API.
1123
+
1124
+ ### 2020-09-14_1.680.7
1125
+ - Add `environment` field to `ProtectUserEventWebhook`
1126
+
1127
+ ### 2020-09-14_1.680.6
1128
+ - Add 'investment_auth' as an available product in the request to `/partner/customer/create`
1129
+
1130
+ ### 2020-09-14_1.680.6
1131
+ - Add `201` response to `/user/create`
1132
+
1133
+ ### 2020-09-14_1.680.5
1134
+ - Add `/user/items/remove` endpoint
1135
+
1136
+ ### 2020-09-14_1.680.4
1137
+ - (hidden) Add `/user/identity/remove` endpoint to allow customers to explicitly purge identity data
1138
+
1139
+ ### 2020-09-14_1.680.3
1140
+ - Mark `is_investments_fallback_item` as an optional rather than required parameter in the response schema for `/processor/investments/holdings/get` endpoint (not yet currently used in Production by any customers), to achieve consistency with `/investments/holdings/get`.
1141
+
1142
+ ### 2020-09-14_1.680.2
1143
+ - Add `/user_account/session/event/send` endpoint for Layer customer event tracking
1144
+
1145
+ ### 2020-09-14_1.680.1
1146
+ - Update /verification/pdf/get endpoint request attribute from `report_type` to `report_requested`.
1147
+
1148
+ # 45.0.0
1149
+ - Updating to OAS 2020-09-14_1.680.0
1150
+ ## Breaking changes in this version
1151
+ - [Breaking] make user_token not required for `cra/monitoring_insights/get`, `cra/check_report/create` and `cra/monitoring_insights/subscribe`
1152
+ - [BREAKING] Make Personal Financial Category version fields enums.
1153
+ - [Breaking] Remove `/user/items/list` endpoint (not used by or exposed to any customers)
1154
+
1155
+ ## OpenAPI Schema Changes
1156
+ ### 2020-09-14_1.680.0
1157
+ - Add Facial Duplicate data to IDV APIs.
1158
+
1159
+ ### 2020-09-14_1.679.1
1160
+ - Fix description and summary field for `/user/get`
1161
+
1162
+ ### 2020-09-14_1.679.0
1163
+ - Fix invalid OpenAPI syntax in `IdentityVerificationListRequest` schema object
1164
+ - Extensive documentation changes (including field re-ordering) to support new `user_id` and new user APIs
1165
+
1166
+ ### 2020-09-14_1.678.3
1167
+ - [Breaking] Remove `/user/items/list` endpoint (not used by or exposed to any customers)
1168
+
1169
+ ### 2020-09-14_1.678.2
1170
+ - Add `required_account_subtypes` and `provided_account_subtypes` to `Error` response object for NO_ACCOUNTS errors (currently only populated when `investments_auth` present in `enabled_products`)
1171
+
1172
+ ### 2020-09-14_1.678.1
1173
+ - Internal changes only
1174
+
1175
+ ### 2020-09-14_1.678.0
1176
+ - Add `request_guarantee` to `/transfer/authorization/create`
1177
+ - Mark `with_guarantee` deprecated in `/transfer/authorization/create`
1178
+
1179
+ ### 2020-09-14_1.677.3
1180
+ - Add user_id to `/link/token/get` response.
1181
+ - Remove beta from NewUserID description.
1182
+
1183
+ ### 2020-09-14_1.677.2
1184
+ - Add user_id to `/sandbox/public_token/create` request object
1185
+
1186
+ ### 2020-09-14_1.677.1
1187
+ - [BREAKING for Go] Add user_id to `/user/items/get` request object and make user_token optional.
1188
+
1189
+ ### 2020-09-14_1.677.0
1190
+ - [BREAKING for Go] (beta) Add user_id to `/sandbox/user/reset_login` request object and make user_token optional.
1191
+
1192
+ ### 2020-09-14_1.676.0
1193
+ - [BREAKING] Make Personal Financial Category version fields enums.
1194
+
1195
+ ### 2020-09-14_1.675.0
1196
+ - [Breaking for Go] make user_token not required for `sandbox/cra/cashflow_updates/update`
1197
+
1198
+ ### 2020-09-14_1.674.1
1199
+ - (beta) Add `/user/products/terminate` endpoint
1200
+
1201
+ ### 2020-09-14_1.674.0
1202
+ - [Breaking] make user_token not required for `cra/monitoring_insights/get`, `cra/check_report/create` and `cra/monitoring_insights/subscribe`
1203
+
1204
+ ### 2020-09-14_1.673.4
1205
+ - (beta) Remove unused IDENTITY_ERROR error type
1206
+
1207
+ ### 2020-09-14_1.673.3
1208
+ - Fix validation errors in OpenAPI spec
1209
+
1210
+ ### 2020-09-14_1.673.2
1211
+ - Add `network_insights` to `cra_options`
1212
+
1213
+ ### 2020-09-14_1.673.1
1214
+ - Add `income_provider` field to `bank_income_sources` objects returned by `/cra/check_report/income_insights/get`
1215
+
1216
+ ### 2020-09-14_1.673.0
1217
+ - Add `status` field to `/cra/check_report/income_insights/get`'s `bank_income_source` object
1218
+
1219
+ ### 2020-09-14_1.672.5
1220
+ - Add CRA User webhooks
1221
+
1222
+ ### 2020-09-14_1.672.5
1223
+ - (beta) Remove references to the `PLAID-NEW-USER-API-ENABLED` header in favor of the `with_upgraded_user` request field
1224
+
1225
+ ### 2020-09-14_1.672.4
1226
+ - Make `latest_scored_protect_event` visible on `/identity_verification/get`, `/identity_verification/create` and `/identity_verification/retry` response
1227
+ - Make `user_id` visible on `/link/token/create` response
1228
+
1229
+ ### 2020-09-14_1.672.3
1230
+ - (beta) removed `IdentityCreationResult` from `/user/create` and `/user/update`
1231
+
1232
+ ### 2020-09-14_1.672.2
1233
+ - (beta) Add new error type USER_ERROR
1234
+ - (beta) Add new error type IDENTITY_ERROR
1235
+
1236
+ ### 2020-09-14_1.672.1
1237
+ - Make `IncomeProvider` nullable in `/cra/check_report/income_insights/get`
1238
+
1239
+ ### 2020-09-14_1.672.0
1240
+ - Add sub-fields to new Account Insights (Europe only) object: `minimum_balance`, `transfers_in`, `total_income`, and `income_excluding_transfers`.
1241
+ - Fix `category_details` missing a `type` definition (`type: array`) within the `LoanDisbursementsIndicators` object.
1242
+ - Add document `issue_date` to Identity Verification endpoints
1243
+
1244
+ ### 2020-09-14_1.671.6
1245
+ - Add CFU V2 webhook object
1246
+
1247
+ ### 2020-09-14_1.671.5
1248
+
1249
+ ### 2020-09-14_1.671.4
1250
+
1251
+ ### 2020-09-14_1.671.4
1252
+ - (beta) Rename `require_upgraded_user` boolean field in `/user/create` to `with_upgraded_user`
1253
+
1254
+ ### 2020-09-14_1.671.3
1255
+ - Add `IncomeProvider` to `/cra/check_report/income_insights/get`
1256
+
1257
+ ### 2020-09-14_1.671.2
1258
+ - (beta) Add `require_upgraded_user` boolean field to the `/user/create` request
1259
+
1260
+ ### 2020-09-14_1.671.1
1261
+ - Remove PlaidError schema from irrelevant endpoints
1262
+
1263
+ ### 2020-09-14_1.671.0
1264
+ - Add missing PlaidError schema to all endpoints
1265
+
1266
+ # 44.1.0
1267
+ - Updating to OAS 2020-09-14_1.670.0
1268
+
1269
+ ## OpenAPI Schema Changes
1270
+ ### 2020-09-14_1.670.0
1271
+ - Add support for investments to `/cra/check_report/verification/get`
1272
+
1273
+ ### 2020-09-14_1.669.0
1274
+ - Add `AccountInsights` to `/asset_report/get`
1275
+
1276
+ ### 2020-09-14_1.668.3
1277
+ - Update `identity_creation_result` to be `null` for V0 `/user/create` routes
1278
+
1279
+ ### 2020-09-14_1.668.2
1280
+ - (beta) use user_id in `/user/third_party_token/create`
1281
+
1282
+ ### 2020-09-14_1.668.1
1283
+ - Add `options` for `network_insights` in `link/token/create`, `cra/check_report/create`, and `cra/check_report/network_insights/get`
1284
+
1285
+ ### 2020-09-14_1.668.0
1286
+
1287
+ - Add support for Cashflow Insights and LendScore, including adding `cra_cashflow_insights` and `cra_lend_score` to Products array and creating new `PlaidLendScoreVersion` schema object.
1288
+ - Documentation-only changes to support a single, shared Signal Rules-based integration path for Balance and Signal Transaction Scores using `/signal/evaluate`.
1289
+ - Documentation-only changes to support Transfer for Platforms.
1290
+
1291
+ ### 2020-09-14_1.667.6
1292
+ - (beta) new `/protect/report/create` endpoint
1293
+
1294
+ ### 2020-09-14_1.667.5
1295
+ - Publish `/transfer/platform/originator/create` to docs
1296
+ - Publish `/transfer/platform/person/create` to docs
1297
+ - Publish `/transfer/platform/requirement/submit` to docs
1298
+
1299
+ ### 2020-09-14_1.667.4
1300
+ - Fixed a broken documentation link
1301
+
1302
+ ### 2020-09-14_1.667.3
1303
+ - Add cra_partner_insights as possible add_ons for `cra/check_report/pdf/get`
1304
+
1305
+ ### 2020-09-14_1.667.2
1306
+ - (beta) updated street_1, city, region, and postal_code to no longer be required
1307
+
1308
+ ### 2020-09-14_1.667.1
1309
+ - (beta) Allow ClientUserIdentityName to be nullable
1310
+
1311
+ # 44.0.0
1312
+ - Updating to OAS 2020-09-14_1.667.0
1313
+
1314
+ ## Breaking changes in this version
1315
+ - (breaking) Remove `cra/check_report/plaid_credit_score/get`
1316
+ - [BREAKING] Add `item_id` to `/cra/monitoring_insights/subscribe` request
1317
+
1318
+ ## OpenAPI Schema Changes
1319
+ ### 2020-09-14_1.667.0
1320
+ - Add `errors` field to `institutions` objects in `/partner/customer/oauth_institutions/get` response
1321
+
1322
+ ### 2020-09-14_1.666.10
1323
+ - Add `cra_update_results` field to `results` objects in `/link/token/get` response
1324
+
1325
+ ### 2020-09-14_1.666.9
1326
+ - Updated `count` field from `TransferEventSyncRequest` to maximum of 500 and default of 100
1327
+
1328
+ ### 2020-09-14_1.666.8
1329
+ - Removed unused `id_numbers` field from `UserCreateRequest` (field was never processed by application logic)
1330
+ - (beta) updated `ClientUserIdentity.id_numbers` to use `UserIDNumber` from cognito.yml instead of the custom `ClientUserIdentityIdNumber` schema
1331
+
1332
+ ### 2020-09-14_1.666.7
1333
+ - (beta) remove `ClientUserIdentityAddressType` from `ClientUserIdentityAddress`
1334
+
1335
+ ### 2020-09-14_1.666.6
1336
+ - (beta) added `primary` boolean to `ClientUserIdentityEmail`, `ClientUserIdentityPhoneNumber`, and `ClientUserIdentityAddress`
1337
+
1338
+ ### 2020-09-14_1.666.5
1339
+ - (beta) added `SSN` to `ClientUserIdNumberType`
1340
+
1341
+ ### 2020-09-14_1.666.4
1342
+ - (beta) updated 'IdentityCreationResultType' enums to be capital
1343
+ - (beta) update `SSN_LAST_4` to `SSN_LAST_FOUR`
1344
+
1345
+ ### 2020-09-14_1.666.3
1346
+ - Updated `/user/get` `client_user_id` field properties to be nullable
1347
+ - Removed `/user/get` `updated_at` field nullable property
1348
+
1349
+ ### 2020-09-14_1.666.2
1350
+ - (beta) Add `cra_lend_score` support to `link/token/create`, `cra/check_report/create`, and `cra/check_report/lend_score/get`
1351
+ - (breaking) Remove `cra/check_report/plaid_credit_score/get`
1352
+
1353
+ ### 2020-09-14_1.666.1
1354
+ - (beta) updated `ErrorType` on `IdentityCreationResult` to be optional
1355
+
1356
+ ### 2020-09-14_1.666.0
1357
+ - (beta) Add `/user/get` endpoint to retrieve user identity and information.
1358
+
1359
+ ### 2020-09-14_1.665.6
1360
+ - (beta) Add new version of `/user/update`
1361
+
1362
+ ### 2020-09-14_1.665.5
1363
+ - Mark `expected_settlement_date` deprecated in `transfer`
1364
+
1365
+ ### 2020-09-14_1.665.4
1366
+ - (beta) updated `UserCreateRequest` to include `identity`
1367
+ - (beta) updated `UserCreateResponse` to include `identity_creation_result`
1368
+ - (beta) renamed `UserIdentity` to `ClientUserIdentity`
1369
+
1370
+ ### 2020-09-14_1.665.3
1371
+ - (beta) created `IdentityCreationResult` shared object
1372
+
1373
+ ### 2020-09-14_1.665.2
1374
+ - (beta) created `UserIdentity` shared object
1375
+
1376
+ ### 2020-09-14_1.665.1
1377
+ - Hide `cashflow_insights` references
1378
+
1379
+ ### 2020-09-14_1.665.0
1380
+ - [BREAKING] Add `item_id` to `/cra/monitoring_insights/subscribe` request
1381
+
1382
+ ### 2020-09-14_1.664.1
1383
+ - Deprecate baseline values in `/cra/monitoring_insights/get` response
1384
+
1385
+ # 43.1.0
1386
+ - Updating to OAS 2020-09-14_1.664.0
1387
+
1388
+ ## OpenAPI Schema Changes
1389
+ ### 2020-09-14_1.664.0
1390
+ - Add `investments_auth` to enum values for the `additional_consented_products` array in the `/link/token/create` request schema.
1391
+
1392
+ ### 2020-09-14_1.663.3
1393
+ - (beta) Add `cra_plaid_credit_score` support to `link/token/create`
1394
+ - (beta) Add `cra_plaid_credit_score` support to `cra/check_report/create`
1395
+ - (beta) Add `cra/check_report/plaid_credit_score/get` endpoint
1396
+
1397
+ ### 2020-09-14_1.663.2
1398
+ - Add `user_id` to `cra/*` endpoints
1399
+
1400
+ ### 2020-09-14_1.663.1
1401
+ - Add `overdraft` account type to the `LoanAccountSubtype` object, where it was erroneously missing
1402
+ - Correct missing and incorrect enum values for `ItemConsentedDataScope` object
1403
+
1404
+ ### 2020-09-14_1.663.0
1405
+ - (beta) Add `/user/items/associate` endpoint
1406
+
1407
+ ### 2020-09-14_1.662.1
1408
+ - Internal changes only
1409
+
1410
+ ### 2020-09-14_1.662.0
1411
+ - Add `balance_to_transaction_amount_ratio` to `/signal/evaluate`
1412
+
1413
+ ### 2020-09-14_1.661.0
1414
+ - Add `personal_finance_category_version` to `/transactions/get`, `/transactions/sync` and `/transactions/enrich` request options as well as version field in response.
1415
+
1416
+ ### 2020-09-14_1.660.0
1417
+ - Add `gse_options` to `base_report` options in `/link/token/create` and `cra/check_report/create`
1418
+
1419
+ ### 2020-09-14_1.659.0
1420
+ - Deprecate the `sedol` field in the Investments `Security` object.
1421
+ - Deprecate the `sedol` field in the Investments `SecurityOverride` object.
1422
+
1423
+ # 43.0.0
1424
+ - Updating to OAS 2020-09-14_1.658.0
1425
+
1426
+ ## Breaking changes in this version
1427
+
1428
+ - [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries.
1429
+
1430
+ ## OpenAPI Schema Changes
1431
+ ### 2020-09-14_1.658.0
1432
+ - (beta) Add `user_id` field to `/session/token/create` request.
1433
+ - [BREAKING for Go] (beta) Make `user` object optional in `/session/token/create` if `user_id` is included.
1434
+
1435
+ ### 2020-09-14_1.657.0
1436
+ Add Add `subtype` property to the `Security` model.
1437
+
1438
+ ### 2020-09-14_1.656.1
1439
+ - Renamed `protect_sdk_session_id` field in the request of `/protect/event/send` to `protect_session_id` for consistency across endpoints.
1440
+
1441
+ ### 2020-09-14_1.656.0
1442
+ - Added `aamva_verification` object in the responses of `documentary_verification.documents[].analysis`. This impacts the following endpoints:
1443
+ - `identity_verification/create`
1444
+ - `identity_verification/get`
1445
+ - `identity_verification/list`
1446
+ - `identity_verification/retry`
1447
+
1448
+ ### 2020-09-14_1.655.0
1449
+ - Add `max_amount` and `iso_currency_code` to `rfp` in `/transfer/capabilitied/get` response
1450
+
1451
+ ### 2020-09-14_1.654.0
1452
+ - [BREAKING] To improve consistency and resolve a bug in a third-party client library, changed `MonitoringConsumerReportPermissiblePurpose` schema object title from `ConsumerReportPermissiblePurpose` to `MonitoringConsumerReportPermissiblePurpose`. This may be a breaking change for certain client libraries.
1453
+
1454
+ ### 2020-09-14_1.653.0
1455
+ - (beta) Add optional `user_id` field to `identity_verification/create` and `identity_verification/list` requests. When `user_id` is present during creation and `client_user_id` is not, the `client_user_id` from the associated user will be set on the created identity verification. If `user_id` is present during creation, the `user` object may not also be present. Modifying user data should be done via the `user/update` endpoint.
1456
+ - [BREAKING for Go] (beta) Make `client_user_id` optional in `identity_verification/list` if `user_id` is included.
1457
+ - (beta) Add nullable `user_id` to the response of all of the identity verification endpoints:
1458
+ - `identity_verification/create`
1459
+ - `identity_verification/get`
1460
+ - `identity_verification/list`
1461
+ - `identity_verification/retry`
1462
+
1463
+ ### 2020-09-14_1.652.3
1464
+ - Added support for `cra_monitoring` to `Products` array.
1465
+
1466
+ ### 2020-09-14_1.652.2
1467
+ - (beta) Add `/user/items/list` endpoint
1468
+
1469
+ ### 2020-09-14_1.652.1
1470
+ - Add `/transfer/ledger/event/list` endpoint
1471
+
1472
+ # 42.0.0
1473
+ - Updating to OAS 2020-09-14_1.652.0
1474
+
1475
+ ## Breaking changes in this version
1476
+
1477
+ - [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create`
1478
+ - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh`
1479
+ - `voe_options` in the request is now `employment_refresh_options`
1480
+ - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe`
1481
+ - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh`
1482
+
1483
+ ## OpenAPI Schema Changes
1484
+ ### 2020-09-14_1.652.0
1485
+ - Add optional `cursor` and `count` fields to the `/payment_initiation/recipient/list` request and `next_cursor` to its response
1486
+
1487
+ ### 2020-09-14_1.651.2
1488
+ - (beta) Add `user_id` field to `link/token/create` request
1489
+ - [BREAKING for Go] (beta) Make `user` object optional in `link/token/create` if `user_id` is included
1490
+
1491
+ ### 2020-09-14_1.651.1
1492
+ - Add `error` field to `WALLET_TRANSACTION_STATUS_UPDATE` webhook and to responses of `/wallet/transaction/get` and `/wallet/transaction/list`, containing error details for failed transactions.
1493
+
1494
+ ### 2020-09-14_1.651.0
1495
+ - Rename all `/verify/client/*` routes to `/protect/client/*` and update request/response body and field names accordingly.
1496
+
1497
+ ### 2020-09-14_1.650.1
1498
+ - Update description for `days_required`
1499
+
1500
+ ### 2020-09-14_1.650.0
1501
+ - Add `account_numbers` to `Counterparty` in `/transaction/get` and `/transaction/sync`
1502
+
1503
+ ### 2020-09-14_1.649.2
1504
+ - Add `InsitutionID` and `InstitutionName` to `/cra/monitoring_insights/get` response
1505
+
1506
+ ### 2020-09-14_1.649.1
1507
+ - Update max value for `cra_options.days_requested` in `link/token/create` to 731 (2 years + 1 days for leap year)
1508
+ - Reduce max value for `cra_options.days_required` in `link/token/create` to 184 (most number of days in a 6 month period) from 730
1509
+ - Set max value for `days_required` in `cra/check_report/create` to 184 (most number of days in a 6 month period)
1510
+
1511
+ ### 2020-09-14_1.649.0
1512
+ - Add wire_return_fee to Transfer and Transfer Event objects
1513
+
1514
+ ### 2020-09-14_1.648.2
1515
+ - Docs-only change to add additional subtypes to the accounts schema
1516
+
1517
+ ### 2020-09-14_1.648.1
1518
+ - Add `last_successful_update_time` to `/cashflow_report/get`
1519
+
1520
+ ### 2020-09-14_1.648.0
1521
+ - Add `require_identity` to `cra_options.base_report` in `link/token/create` and `/cra/check_report/create` requests
1522
+
1523
+ ### 2020-09-14_1.647.1
1524
+ - Update `/transfer/ledger/distribute` summary
1525
+
1526
+ ### 2020-09-14_1.647.0
1527
+ - Add `webhook_codes` field to `/sandbox/cashflow_updates/update` request
1528
+
1529
+ ### 2020-09-14_1.646.0
1530
+ - [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create`
1531
+ - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh`
1532
+ - `voe_options` in the request is now `employment_refresh_options`
1533
+ - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe`
1534
+ - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh`
1535
+
1536
+ ### 2020-09-14_1.645.1
1537
+ - Update description of `/transfer/ledger/distribute`
1538
+
1539
+ # 41.0.0
1540
+ - Updating to OAS 2020-09-14_1.645.0
1541
+
1542
+ ## Breaking changes in this version
1543
+
1544
+ - [Breaking] For Signal, remove enum values `REAL_TIME_PAYMENTS` and `DEBIT_CARD` as these payment methods are not supported by the Signal product.
1545
+ - [Breaking] Rename client library `/cra/check_report/create`'s `partner_insights` object to type `CraCheckReportCreatePartnerInsightsOptions` instead of `CraCheckReportPartnerInsightsGetOptions`. All the object fields are identical.
1546
+ - [Breaking] Rename client library `/cra/check_report/partner_insights/get`'s `option.prism_versions` object to type `PrismVersionsDeprecated` instead of `PrismVersions`. All the object fields' are identical.
1547
+
1548
+ ## OpenAPI Schema Changes
1549
+ ### 2020-09-14_1.645.0
1550
+ - Removes the `payment_details` field from `/accounts/balance/get` request
1551
+ - Removes the `payment_risk_assessment` from `/accounts/balance/get` response
1552
+
1553
+ ### 2020-09-14_1.644.1
1554
+ - Fixed incorrect event type in example for `ProtectUserEventWebhook`.
1555
+
1556
+ ### 2020-09-14_1.644.0
1557
+ - [Breaking] For Signal, remove enum values `REAL_TIME_PAYMENTS` and `DEBIT_CARD` as these payment methods are not supported by the Signal product.
1558
+ - [Breaking] Rename client library `/cra/check_report/create`'s `partner_insights` object to type `CraCheckReportCreatePartnerInsightsOptions` instead of `CraCheckReportPartnerInsightsGetOptions`. All the object fields are identical.
1559
+ - [Breaking] Rename client library `/cra/check_report/partner_insights/get`'s `option.prism_versions` object to type `PrismVersionsDeprecated` instead of `PrismVersions`. All the object fields' are identical.
1560
+
1561
+ ### 2020-09-14_1.642.2
1562
+ - Added `ProtectUserEventWebhook`.
1563
+
1564
+ ### 2020-09-14_1.642.1
1565
+ - Deprecated `/link/token/create`'s `base_report`. Revert erroneous deprecation of `cra_options.base_report`.
1566
+
1567
+ ### 2020-09-14_1.642.0
1568
+ - Add `error` field to responses of `/payment_initiation/payment/get` and `/payment_initiation/consent/payment/execute` containing error details when the payment fails.
1569
+
1570
+ # 40.0.0
1571
+ - Updating to OAS 2020-09-14_1.641.1
1572
+
1573
+ ## Breaking changes in this version
1574
+ - [Breaking] Add /cashflow_report/transactions/get route, identital to /cashflow_report/get minus days_requested request parameter
1575
+
1576
+ ## OpenAPI Schema Changes
1577
+ ### 2020-09-14_1.641.1
1578
+ - Fix descriptions for BaseReportAccountMetadata
1579
+
1580
+ ### 2020-09-14_1.641.0
1581
+ - Deprecated `/link/token/create`'s `cra_options.base_report` object in favor of `cra_options.client_report_id`
1582
+
1583
+ ### 2020-09-14_1.640.0
1584
+ - [Breaking] Add /cashflow_report/transactions/get route, identital to /cashflow_report/get minus days_requested request parameter
1585
+ - Remove historical_balances from BusinessAccounts object
1586
+
1587
+ ### 2020-09-14_1.639.0
1588
+ - Add `webhook` field to `/session/token/create` request
1589
+
1590
+ ### 2020-09-14_1.638.6
1591
+ - Deprecate Prism Products field from Partner Insights generation and retrieval
1592
+
1593
+ ### 2020-09-14_1.638.5
1594
+ - Add client report id to partner insights
1595
+
1596
+ ### 2020-09-14_1.638.4
1597
+ - Remove unused enums for MonitoringInsightsStatus and MonitoringItemStatusCode
1598
+
1599
+ ### 2020-09-14_1.638.3
1600
+ - Add Prism Detect and Extend cashscores to CRA Partner Insights
1601
+
1602
+ ### 2020-09-14_1.638.2
1603
+ - (beta) expect a boolean instead of a string in generated client interfaces for PLAID-NEW-USER-API-ENABLED
1604
+
1605
+ ### 2020-09-14_1.638.1
1606
+ - Support for upcoming results in `link/token/get`.
1607
+
1608
+ ### 2020-09-14_1.638.0
1609
+ - (pre-release) Preparation for upcoming products.
1610
+
1611
+ ### 2020-09-14_1.637.6
1612
+ - Deprecate `report.items.accounts.account_insights` for `/cra/check_report/base_report/get`
1613
+
1614
+ # 39.0.0
1615
+ - Updating to OAS 2020-09-14_1.637.5
1616
+
1617
+ ## Breaking changes in this version
1618
+ - [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
1619
+
1620
+ ## OpenAPI Schema Changes
1621
+ ### 2020-09-14_1.637.5
1622
+ - Fix incorrect placement of `nullable: true` on `AccountBaseNullable` object, making the object actually `nullable`.
1623
+
1624
+ ### 2020-09-14_1.637.4
1625
+ - Add missing `unsent` value as a possible `verification_status` to reflect actual API behavior.
1626
+
1627
+ ### 2020-09-14_1.637.3
1628
+ - (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/create`. This header is only for the use of customers in the new user API beta; customers should *not* use this parameter unless they have been advised to do so by Plaid.
1629
+ - (beta) Add `PLAID-NEW-USER-API-ENABLED` as a header parameter to `/user/remove`. This header is only for the use of customers in the new user API beta; customers should *not* use this parameter unless they have been advised to do so by Plaid.
1630
+
1631
+ ### 2020-09-14_1.637.2
1632
+ - (beta) Add `user_id` to `/session/token/create` response
1633
+
1634
+ ### 2020-09-14_1.637.1
1635
+ - Add optional `institution_id` to `/item/import`
1636
+
1637
+ ### 2020-09-14_1.637.0
1638
+ - Add `android_package_name` to `/session/token/create`
1639
+
1640
+ ### 2020-09-14_1.636.0
1641
+ - Update `average_inflow_amount` to be positive.
1642
+
1643
+ ### 2020-09-14_1.635.4
1644
+ - [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
1645
+ - [BREAKING for Go] (beta) Updated `user_token` field in `UserRemoveRequest` to be optional.
1646
+ - Other hidden changes.
1647
+
1648
+ ### 2020-09-14_1.635.3
1649
+ - (beta) Add `user_id` to `/link/token/create` response
1650
+
1651
+ # 38.0.0
1652
+ - Updating to OAS 2020-09-14_1.635.2
1653
+
1654
+ ## Breaking changes in this version
1655
+ - [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
1656
+ - [BREAKING] `client_user_id` is now required for `/session/token/create`
1657
+
1658
+ ## OpenAPI Schema Changes
1659
+ ### 2020-09-14_1.635.2
1660
+ - Update description of `ruleset.outcome` in `/signal/evaluate` response
1661
+
1662
+ ### 2020-09-14_1.635.1
1663
+ - Fix description undeprecating `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
1664
+
1665
+ ### 2020-09-14_1.635.0
1666
+ - Add `expected_funds_available_date` to `transfer` and `sweep` objects in responses for `/transfer/create`, `/transfer/get`, `/transfer/list`, `/transfer/sweep/get`, `/transfer/sweep/list`
1667
+
1668
+ ### 2020-09-14_1.634.3
1669
+ - Undeprecated `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
1670
+
1671
+ ### 2020-09-14_1.634.2
1672
+ - Removed `deposit_switch` from the `products` field in the `/link/token/create` request
1673
+
1674
+ ### 2020-09-14_1.634.1
1675
+ - [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
1676
+
1677
+ ### 2020-09-14_1.634.0
1678
+ - [BREAKING] `client_user_id` is now required for `/session/token/create`
1679
+
3
1680
  # 37.0.0
4
1681
  - Updating to OAS 2020-09-14_1.633.1
5
1682