plaid 16.0.0 → 43.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (1887) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +3733 -82
  3. data/CONTRIBUTING.md +4 -1
  4. data/Dockerfile +3 -1
  5. data/Gemfile.lock +20 -30
  6. data/Makefile +1 -1
  7. data/README.md +130 -71
  8. data/lib/plaid/api/plaid_api.rb +12679 -2591
  9. data/lib/plaid/api_client.rb +29 -8
  10. data/lib/plaid/api_error.rb +4 -3
  11. data/lib/plaid/configuration.rb +27 -8
  12. data/lib/plaid/models/aamva_analysis.rb +430 -0
  13. data/lib/plaid/models/aamva_detailed_match_result.rb +41 -0
  14. data/lib/plaid/models/aamva_match_result.rb +40 -0
  15. data/lib/plaid/models/account_access.rb +3 -2
  16. data/lib/plaid/models/account_assets.rb +31 -19
  17. data/lib/plaid/models/account_balance.rb +5 -4
  18. data/lib/plaid/models/account_base.rb +51 -11
  19. data/lib/plaid/models/account_base_nullable.rb +391 -0
  20. data/lib/plaid/models/account_filter.rb +3 -2
  21. data/lib/plaid/models/account_filters_response.rb +3 -2
  22. data/lib/plaid/models/account_holder_category.rb +40 -0
  23. data/lib/plaid/models/account_identity.rb +49 -9
  24. data/lib/plaid/models/account_identity_all_of.rb +4 -3
  25. data/lib/plaid/models/account_identity_document_upload.rb +422 -0
  26. data/lib/plaid/models/account_identity_document_upload_all_of.rb +240 -0
  27. data/lib/plaid/models/account_identity_match_score.rb +48 -8
  28. data/lib/plaid/models/account_identity_match_score_all_of.rb +3 -2
  29. data/lib/plaid/models/account_product_access.rb +3 -2
  30. data/lib/plaid/models/account_product_access_nullable.rb +3 -2
  31. data/lib/plaid/models/account_selection_cardinality.rb +2 -2
  32. data/lib/plaid/models/account_subtype.rb +31 -34
  33. data/lib/plaid/models/account_type.rb +2 -2
  34. data/lib/plaid/models/account_verification_insights.rb +281 -0
  35. data/lib/plaid/models/account_verification_insights_account_number_format.rb +40 -0
  36. data/lib/plaid/models/account_verification_insights_network_status.rb +241 -0
  37. data/lib/plaid/models/account_verification_insights_previous_returns.rb +226 -0
  38. data/lib/plaid/models/accounts_balance_get_request.rb +3 -2
  39. data/lib/plaid/models/accounts_balance_get_request_options.rb +5 -4
  40. data/lib/plaid/models/accounts_get_request.rb +3 -2
  41. data/lib/plaid/models/accounts_get_request_options.rb +3 -2
  42. data/lib/plaid/models/accounts_get_response.rb +3 -2
  43. data/lib/plaid/models/ach_class.rb +2 -2
  44. data/lib/plaid/models/action_state.rb +42 -0
  45. data/lib/plaid/models/activity.rb +335 -0
  46. data/lib/plaid/models/activity_type.rb +47 -0
  47. data/lib/plaid/models/address.rb +3 -2
  48. data/lib/plaid/models/address_data.rb +4 -7
  49. data/lib/plaid/models/address_data_not_required.rb +265 -0
  50. data/lib/plaid/models/address_data_nullable.rb +4 -7
  51. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +272 -0
  52. data/lib/plaid/models/address_match_score.rb +5 -4
  53. data/lib/plaid/models/address_nullable.rb +3 -2
  54. data/lib/plaid/models/address_purpose_label.rb +2 -2
  55. data/lib/plaid/models/application.rb +4 -3
  56. data/lib/plaid/models/application_get_request.rb +4 -3
  57. data/lib/plaid/models/application_get_response.rb +3 -2
  58. data/lib/plaid/models/apr.rb +3 -2
  59. data/lib/plaid/models/asset.rb +4 -3
  60. data/lib/plaid/models/asset_detail.rb +177 -9
  61. data/lib/plaid/models/asset_holder.rb +4 -3
  62. data/lib/plaid/models/asset_holder_name.rb +4 -3
  63. data/lib/plaid/models/asset_holding.rb +378 -0
  64. data/lib/plaid/models/asset_holdings.rb +227 -0
  65. data/lib/plaid/models/asset_investment_transaction_type.rb +45 -0
  66. data/lib/plaid/models/asset_owner.rb +4 -3
  67. data/lib/plaid/models/asset_owners.rb +4 -3
  68. data/lib/plaid/models/asset_report.rb +3 -2
  69. data/lib/plaid/models/asset_report_account_balance.rb +288 -0
  70. data/lib/plaid/models/asset_report_add_ons.rb +39 -0
  71. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +3 -7
  72. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +3 -2
  73. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +3 -2
  74. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +3 -2
  75. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +3 -2
  76. data/lib/plaid/models/asset_report_create_request.rb +7 -15
  77. data/lib/plaid/models/asset_report_create_request_options.rb +32 -6
  78. data/lib/plaid/models/asset_report_create_response.rb +3 -2
  79. data/lib/plaid/models/asset_report_filter_request.rb +3 -2
  80. data/lib/plaid/models/asset_report_filter_response.rb +3 -2
  81. data/lib/plaid/models/asset_report_freddie.rb +4 -3
  82. data/lib/plaid/models/asset_report_freddie_get_request.rb +4 -3
  83. data/lib/plaid/models/asset_report_freddie_get_response.rb +22 -6
  84. data/lib/plaid/models/asset_report_get_request.rb +15 -9
  85. data/lib/plaid/models/asset_report_get_request_options.rb +4 -3
  86. data/lib/plaid/models/asset_report_get_response.rb +3 -2
  87. data/lib/plaid/models/asset_report_investment_holding.rb +341 -0
  88. data/lib/plaid/models/asset_report_investment_security.rb +259 -0
  89. data/lib/plaid/models/asset_report_investment_transaction.rb +440 -0
  90. data/lib/plaid/models/asset_report_investments.rb +247 -0
  91. data/lib/plaid/models/asset_report_item.rb +3 -2
  92. data/lib/plaid/models/asset_report_pdf_get_request.rb +3 -2
  93. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +3 -2
  94. data/lib/plaid/models/asset_report_refresh_request.rb +3 -2
  95. data/lib/plaid/models/asset_report_refresh_request_options.rb +3 -2
  96. data/lib/plaid/models/asset_report_refresh_response.rb +3 -2
  97. data/lib/plaid/models/asset_report_remove_request.rb +3 -2
  98. data/lib/plaid/models/asset_report_remove_response.rb +3 -2
  99. data/lib/plaid/models/asset_report_transaction.rb +132 -142
  100. data/lib/plaid/models/asset_report_transaction_type.rb +41 -0
  101. data/lib/plaid/models/asset_report_type.rb +39 -0
  102. data/lib/plaid/models/asset_report_user.rb +4 -3
  103. data/lib/plaid/models/asset_transaction.rb +4 -3
  104. data/lib/plaid/models/asset_transaction_category_type.rb +2 -2
  105. data/lib/plaid/models/asset_transaction_description.rb +4 -3
  106. data/lib/plaid/models/asset_transaction_detail.rb +61 -6
  107. data/lib/plaid/models/asset_transaction_type.rb +2 -2
  108. data/lib/plaid/models/asset_transactions.rb +4 -3
  109. data/lib/plaid/models/asset_type.rb +2 -2
  110. data/lib/plaid/models/assets.rb +5 -4
  111. data/lib/plaid/models/assets_error_webhook.rb +53 -6
  112. data/lib/plaid/models/assets_product_ready_webhook.rb +63 -7
  113. data/lib/plaid/models/auth_default_update_webhook.rb +336 -0
  114. data/lib/plaid/models/auth_get_numbers.rb +3 -2
  115. data/lib/plaid/models/auth_get_request.rb +3 -2
  116. data/lib/plaid/models/auth_get_request_options.rb +3 -2
  117. data/lib/plaid/models/auth_get_response.rb +3 -2
  118. data/lib/plaid/models/auth_metadata.rb +3 -2
  119. data/lib/plaid/models/auth_supported_methods.rb +22 -6
  120. data/lib/plaid/models/auth_update_types.rb +39 -0
  121. data/lib/plaid/models/auth_verify_numbers_ach.rb +241 -0
  122. data/lib/plaid/models/auth_verify_request.rb +256 -0
  123. data/lib/plaid/models/auth_verify_request_numbers.rb +225 -0
  124. data/lib/plaid/models/auth_verify_response.rb +266 -0
  125. data/lib/plaid/models/automatically_verified_webhook.rb +39 -6
  126. data/lib/plaid/models/bank_income_complete_result.rb +39 -0
  127. data/lib/plaid/models/bank_income_complete_webhook.rb +306 -0
  128. data/lib/plaid/models/bank_income_refresh_complete_result.rb +39 -0
  129. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +306 -0
  130. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +292 -0
  131. data/lib/plaid/models/bank_initiated_return_risk.rb +4 -3
  132. data/lib/plaid/models/bank_transfer.rb +26 -3
  133. data/lib/plaid/models/bank_transfer_balance.rb +3 -2
  134. data/lib/plaid/models/bank_transfer_balance_get_request.rb +3 -2
  135. data/lib/plaid/models/bank_transfer_balance_get_response.rb +3 -2
  136. data/lib/plaid/models/bank_transfer_cancel_request.rb +3 -2
  137. data/lib/plaid/models/bank_transfer_cancel_response.rb +3 -2
  138. data/lib/plaid/models/bank_transfer_create_request.rb +26 -3
  139. data/lib/plaid/models/bank_transfer_create_response.rb +3 -2
  140. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  141. data/lib/plaid/models/bank_transfer_event.rb +25 -2
  142. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +2 -2
  143. data/lib/plaid/models/bank_transfer_event_list_direction.rb +2 -2
  144. data/lib/plaid/models/bank_transfer_event_list_request.rb +25 -2
  145. data/lib/plaid/models/bank_transfer_event_list_response.rb +3 -2
  146. data/lib/plaid/models/bank_transfer_event_sync_request.rb +3 -2
  147. data/lib/plaid/models/bank_transfer_event_sync_response.rb +3 -2
  148. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  149. data/lib/plaid/models/bank_transfer_failure.rb +3 -2
  150. data/lib/plaid/models/bank_transfer_get_request.rb +3 -2
  151. data/lib/plaid/models/bank_transfer_get_response.rb +3 -2
  152. data/lib/plaid/models/bank_transfer_list_request.rb +25 -2
  153. data/lib/plaid/models/bank_transfer_list_response.rb +3 -2
  154. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +3 -2
  155. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +3 -2
  156. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  157. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  158. data/lib/plaid/models/bank_transfer_sweep.rb +3 -2
  159. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +3 -2
  160. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +3 -2
  161. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +5 -4
  162. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +3 -2
  163. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  164. data/lib/plaid/models/bank_transfer_user.rb +3 -2
  165. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +25 -2
  166. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +277 -0
  167. data/lib/plaid/models/base_report.rb +293 -0
  168. data/lib/plaid/models/base_report_account.rb +443 -0
  169. data/lib/plaid/models/base_report_account_balances.rb +311 -0
  170. data/lib/plaid/models/base_report_account_insights.rb +323 -0
  171. data/lib/plaid/models/base_report_account_metadata.rb +233 -0
  172. data/lib/plaid/models/base_report_attributes.rb +353 -0
  173. data/lib/plaid/models/base_report_average_flow_insights.rb +255 -0
  174. data/lib/plaid/models/base_report_average_monthly_balances.rb +255 -0
  175. data/lib/plaid/models/base_report_historical_balance.rb +263 -0
  176. data/lib/plaid/models/base_report_item.rb +288 -0
  177. data/lib/plaid/models/base_report_longest_gap_insights.rb +242 -0
  178. data/lib/plaid/models/base_report_number_flow_insights.rb +256 -0
  179. data/lib/plaid/models/base_report_transaction.rb +449 -0
  180. data/lib/plaid/models/base_report_transaction_type.rb +41 -0
  181. data/lib/plaid/models/base_report_user_attributes.rb +331 -0
  182. data/lib/plaid/models/base_report_warning.rb +272 -0
  183. data/lib/plaid/models/base_report_warning_code.rb +40 -0
  184. data/lib/plaid/models/base_reports_error_webhook.rb +302 -0
  185. data/lib/plaid/models/beacon_account_risk_attributes.rb +519 -0
  186. data/lib/plaid/models/beacon_account_risk_evaluate_account.rb +271 -0
  187. data/lib/plaid/models/beacon_account_risk_evaluate_account_attributes.rb +519 -0
  188. data/lib/plaid/models/beacon_account_risk_evaluate_evaluation_reason.rb +42 -0
  189. data/lib/plaid/models/beacon_account_risk_evaluate_request.rb +346 -0
  190. data/lib/plaid/models/beacon_account_risk_evaluate_request_options.rb +223 -0
  191. data/lib/plaid/models/{income_verification_refresh_response.rb → beacon_account_risk_evaluate_response.rb} +20 -16
  192. data/lib/plaid/models/beacon_audit_trail.rb +273 -0
  193. data/lib/plaid/models/beacon_audit_trail_source.rb +41 -0
  194. data/lib/plaid/models/beacon_bank_account_insights.rb +286 -0
  195. data/lib/plaid/models/beacon_bank_accounts.rb +242 -0
  196. data/lib/plaid/models/beacon_duplicate_detected_webhook.rb +292 -0
  197. data/lib/plaid/models/beacon_duplicate_get_request.rb +246 -0
  198. data/lib/plaid/models/beacon_duplicate_get_response.rb +283 -0
  199. data/lib/plaid/models/beacon_match_summary_analysis.rb +331 -0
  200. data/lib/plaid/models/beacon_match_summary_code.rb +41 -0
  201. data/lib/plaid/models/beacon_report.rb +342 -0
  202. data/lib/plaid/models/beacon_report_create_request.rb +307 -0
  203. data/lib/plaid/models/beacon_report_create_response.rb +357 -0
  204. data/lib/plaid/models/beacon_report_create_type.rb +43 -0
  205. data/lib/plaid/models/beacon_report_created_webhook.rb +292 -0
  206. data/lib/plaid/models/beacon_report_get_request.rb +246 -0
  207. data/lib/plaid/models/beacon_report_get_response.rb +357 -0
  208. data/lib/plaid/models/beacon_report_list_request.rb +257 -0
  209. data/lib/plaid/models/beacon_report_list_response.rb +253 -0
  210. data/lib/plaid/models/beacon_report_syndication.rb +269 -0
  211. data/lib/plaid/models/beacon_report_syndication_analysis.rb +347 -0
  212. data/lib/plaid/models/beacon_report_syndication_created_webhook.rb +292 -0
  213. data/lib/plaid/models/beacon_report_syndication_get_request.rb +246 -0
  214. data/lib/plaid/models/beacon_report_syndication_get_response.rb +284 -0
  215. data/lib/plaid/models/beacon_report_syndication_list_request.rb +257 -0
  216. data/lib/plaid/models/beacon_report_syndication_list_response.rb +253 -0
  217. data/lib/plaid/models/beacon_report_syndication_original_report.rb +299 -0
  218. data/lib/plaid/models/beacon_report_type.rb +43 -0
  219. data/lib/plaid/models/beacon_report_updated_webhook.rb +292 -0
  220. data/lib/plaid/models/{deposit_switch_target_account.rb → beacon_syndicated_report_depository_account_match_analysis.rb} +28 -55
  221. data/lib/plaid/models/beacon_user.rb +394 -0
  222. data/lib/plaid/models/beacon_user_account_insights_get_request.rb +261 -0
  223. data/lib/plaid/models/beacon_user_account_insights_get_response.rb +285 -0
  224. data/lib/plaid/models/beacon_user_address.rb +289 -0
  225. data/lib/plaid/models/beacon_user_create_request.rb +288 -0
  226. data/lib/plaid/models/beacon_user_create_response.rb +409 -0
  227. data/lib/plaid/models/beacon_user_data.rb +313 -0
  228. data/lib/plaid/models/beacon_user_depository_account.rb +256 -0
  229. data/lib/plaid/models/beacon_user_get_request.rb +246 -0
  230. data/lib/plaid/models/beacon_user_get_response.rb +409 -0
  231. data/lib/plaid/models/beacon_user_history_list_request.rb +257 -0
  232. data/lib/plaid/models/beacon_user_history_list_response.rb +253 -0
  233. data/lib/plaid/models/beacon_user_id_number.rb +262 -0
  234. data/lib/plaid/models/beacon_user_name.rb +241 -0
  235. data/lib/plaid/models/beacon_user_name_nullable.rb +241 -0
  236. data/lib/plaid/models/beacon_user_request_address.rb +289 -0
  237. data/lib/plaid/models/beacon_user_request_address_nullable.rb +289 -0
  238. data/lib/plaid/models/beacon_user_request_data.rb +299 -0
  239. data/lib/plaid/models/beacon_user_request_depository_account.rb +241 -0
  240. data/lib/plaid/models/beacon_user_review_request.rb +282 -0
  241. data/lib/plaid/models/beacon_user_revision.rb +241 -0
  242. data/lib/plaid/models/beacon_user_status.rb +40 -0
  243. data/lib/plaid/models/beacon_user_status_updated_webhook.rb +292 -0
  244. data/lib/plaid/models/beacon_user_update_request.rb +269 -0
  245. data/lib/plaid/models/beacon_user_update_request_data.rb +294 -0
  246. data/lib/plaid/models/beacon_user_update_response.rb +409 -0
  247. data/lib/plaid/models/business_account.rb +404 -0
  248. data/lib/plaid/models/business_account_all_of.rb +222 -0
  249. data/lib/plaid/models/business_finance_category.rb +252 -0
  250. data/lib/plaid/models/cash_flow_updates_event_webhook_codes.rb +41 -0
  251. data/lib/plaid/models/cash_flow_updates_expected_deposit_missed_webhook.rb +306 -0
  252. data/lib/plaid/models/cash_flow_updates_insights_webhook.rb +306 -0
  253. data/lib/plaid/models/cash_flow_updates_large_deposit_webhook.rb +306 -0
  254. data/lib/plaid/models/cash_flow_updates_low_balance_webhook.rb +306 -0
  255. data/lib/plaid/models/cash_flow_updates_new_income_stream_webhook.rb +306 -0
  256. data/lib/plaid/models/cash_flow_updates_new_loan_payment_webhook.rb +306 -0
  257. data/lib/plaid/models/cash_flow_updates_nsf_webhook.rb +306 -0
  258. data/lib/plaid/models/cashflow_attributes_version.rb +39 -0
  259. data/lib/plaid/models/cashflow_report_account_insights.rb +245 -0
  260. data/lib/plaid/models/cashflow_report_get_request.rb +348 -0
  261. data/lib/plaid/models/cashflow_report_get_request_options.rb +223 -0
  262. data/lib/plaid/models/cashflow_report_get_response.rb +334 -0
  263. data/lib/plaid/models/cashflow_report_historical_balance.rb +263 -0
  264. data/lib/plaid/models/cashflow_report_insights_get_request.rb +246 -0
  265. data/lib/plaid/models/cashflow_report_insights_get_response.rb +286 -0
  266. data/lib/plaid/models/cashflow_report_monthly_summary.rb +448 -0
  267. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_ending_balance.rb +248 -0
  268. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_inflow_amount.rb +248 -0
  269. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_net_cashflow_amount.rb +248 -0
  270. data/lib/plaid/models/cashflow_report_monthly_summary_average_daily_outflow_amount.rb +248 -0
  271. data/lib/plaid/models/cashflow_report_monthly_summary_ending_balance.rb +248 -0
  272. data/lib/plaid/models/cashflow_report_monthly_summary_starting_balance.rb +248 -0
  273. data/lib/plaid/models/cashflow_report_monthly_summary_total_loan_payment.rb +248 -0
  274. data/lib/plaid/models/cashflow_report_monthly_summary_total_payroll.rb +248 -0
  275. data/lib/plaid/models/cashflow_report_monthly_summary_total_revenue.rb +248 -0
  276. data/lib/plaid/models/cashflow_report_monthly_summary_total_variable_expense.rb +248 -0
  277. data/lib/plaid/models/cashflow_report_payment_meta.rb +299 -0
  278. data/lib/plaid/models/cashflow_report_refresh_request.rb +293 -0
  279. data/lib/plaid/models/cashflow_report_refresh_response.rb +226 -0
  280. data/lib/plaid/models/cashflow_report_transaction.rb +559 -0
  281. data/lib/plaid/models/cashflow_report_transactions_get_request.rb +303 -0
  282. data/lib/plaid/models/cashflow_report_transactions_get_request_options.rb +223 -0
  283. data/lib/plaid/models/cashflow_report_transactions_get_response.rb +319 -0
  284. data/lib/plaid/models/categories_get_response.rb +3 -2
  285. data/lib/plaid/models/category.rb +3 -2
  286. data/lib/plaid/models/category_insight_details.rb +283 -0
  287. data/lib/plaid/models/category_insights.rb +235 -0
  288. data/lib/plaid/models/cause.rb +19 -20
  289. data/lib/plaid/models/cause_all_of.rb +3 -2
  290. data/lib/plaid/models/check_report_warning.rb +272 -0
  291. data/lib/plaid/models/check_report_warning_code.rb +40 -0
  292. data/lib/plaid/models/client_customization.rb +221 -0
  293. data/lib/plaid/models/client_provided_enhanced_transaction.rb +3 -2
  294. data/lib/plaid/models/client_provided_enriched_transaction.rb +366 -0
  295. data/lib/plaid/models/client_provided_raw_transaction.rb +6 -5
  296. data/lib/plaid/models/client_provided_transaction.rb +386 -0
  297. data/lib/plaid/models/client_provided_transaction_location.rb +261 -0
  298. data/lib/plaid/models/connected_application.rb +5 -4
  299. data/lib/plaid/models/consent_event.rb +338 -0
  300. data/lib/plaid/models/consent_event_code.rb +42 -0
  301. data/lib/plaid/models/consent_event_initiator.rb +41 -0
  302. data/lib/plaid/models/consent_event_type.rb +40 -0
  303. data/lib/plaid/models/{income_verification_refresh_request.rb → consent_events_get_request.rb} +13 -19
  304. data/lib/plaid/models/consent_events_get_response.rb +243 -0
  305. data/lib/plaid/models/consented_account.rb +292 -0
  306. data/lib/plaid/models/consumer_dispute.rb +292 -0
  307. data/lib/plaid/models/consumer_dispute_category.rb +41 -0
  308. data/lib/plaid/models/consumer_report_pdf_get_request.rb +246 -0
  309. data/lib/plaid/models/consumer_report_permissible_purpose.rb +45 -0
  310. data/lib/plaid/models/consumer_report_user_identity.rb +348 -0
  311. data/lib/plaid/models/counterparty.rb +94 -6
  312. data/lib/plaid/models/counterparty_insights.rb +235 -0
  313. data/lib/plaid/models/counterparty_numbers.rb +231 -0
  314. data/lib/plaid/models/{asset_report_transaction_all_of.rb → counterparty_numbers_bacs.rb} +24 -21
  315. data/lib/plaid/models/counterparty_numbers_international.rb +258 -0
  316. data/lib/plaid/models/counterparty_type.rb +5 -3
  317. data/lib/plaid/models/country_code.rb +13 -2
  318. data/lib/plaid/models/cra_bank_income_account.rb +339 -0
  319. data/lib/plaid/models/cra_bank_income_account_metadata.rb +233 -0
  320. data/lib/plaid/models/cra_bank_income_bonus_type.rb +40 -0
  321. data/lib/plaid/models/cra_bank_income_cause.rb +292 -0
  322. data/lib/plaid/models/cra_bank_income_complete_result.rb +39 -0
  323. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +301 -0
  324. data/lib/plaid/models/cra_bank_income_employer.rb +222 -0
  325. data/lib/plaid/models/{deposit_switch_state_update_webhook.rb → cra_bank_income_error_webhook.rb} +59 -26
  326. data/lib/plaid/models/cra_bank_income_historical_summary.rb +254 -0
  327. data/lib/plaid/models/cra_bank_income_item.rb +285 -0
  328. data/lib/plaid/models/cra_bank_income_source.rb +424 -0
  329. data/lib/plaid/models/cra_bank_income_summary.rb +356 -0
  330. data/lib/plaid/models/cra_bank_income_transaction.rb +357 -0
  331. data/lib/plaid/models/cra_bank_income_warning.rb +260 -0
  332. data/lib/plaid/models/cra_bank_income_warning_code.rb +41 -0
  333. data/lib/plaid/models/cra_cashflow_insights_report.rb +261 -0
  334. data/lib/plaid/models/cra_check_report_base_report_get_request.rb +273 -0
  335. data/lib/plaid/models/cra_check_report_base_report_get_response.rb +257 -0
  336. data/lib/plaid/models/cra_check_report_cashflow_insights_get_options.rb +253 -0
  337. data/lib/plaid/models/cra_check_report_cashflow_insights_get_request.rb +270 -0
  338. data/lib/plaid/models/cra_check_report_cashflow_insights_get_response.rb +252 -0
  339. data/lib/plaid/models/cra_check_report_create_base_report_options.rb +243 -0
  340. data/lib/plaid/models/cra_check_report_create_partner_insights_options.rb +233 -0
  341. data/lib/plaid/models/cra_check_report_create_request.rb +461 -0
  342. data/lib/plaid/models/cra_check_report_create_response.rb +221 -0
  343. data/lib/plaid/models/cra_check_report_failed_webhook.rb +292 -0
  344. data/lib/plaid/models/cra_check_report_freddie_mac_get_request.rb +246 -0
  345. data/lib/plaid/models/cra_check_report_freddie_mac_get_response.rb +255 -0
  346. data/lib/plaid/models/cra_check_report_freddie_mac_verification_of_assets_deal.rb +253 -0
  347. data/lib/plaid/models/cra_check_report_gse_options.rb +228 -0
  348. data/lib/plaid/models/cra_check_report_income_insights_get_request.rb +260 -0
  349. data/lib/plaid/models/cra_check_report_income_insights_get_response.rb +247 -0
  350. data/lib/plaid/models/cra_check_report_network_insights_get_request.rb +260 -0
  351. data/lib/plaid/models/cra_check_report_network_insights_get_response.rb +252 -0
  352. data/lib/plaid/models/cra_check_report_partner_insights_get_options.rb +233 -0
  353. data/lib/plaid/models/cra_check_report_partner_insights_get_partner_insights.rb +221 -0
  354. data/lib/plaid/models/cra_check_report_partner_insights_get_request.rb +279 -0
  355. data/lib/plaid/models/cra_check_report_partner_insights_get_response.rb +247 -0
  356. data/lib/plaid/models/cra_check_report_pdf_get_request.rb +272 -0
  357. data/lib/plaid/models/cra_check_report_plaid_credit_score_get_options.rb +243 -0
  358. data/lib/plaid/models/cra_check_report_plaid_credit_score_get_request.rb +261 -0
  359. data/lib/plaid/models/cra_check_report_plaid_credit_score_get_response.rb +252 -0
  360. data/lib/plaid/models/cra_check_report_ready_webhook.rb +331 -0
  361. data/lib/plaid/models/cra_check_report_verification_get_employment_refresh_options.rb +247 -0
  362. data/lib/plaid/models/cra_check_report_verification_get_report_type.rb +39 -0
  363. data/lib/plaid/models/cra_check_report_verification_get_request.rb +277 -0
  364. data/lib/plaid/models/cra_check_report_verification_get_response.rb +257 -0
  365. data/lib/plaid/models/cra_employment_refresh_report.rb +258 -0
  366. data/lib/plaid/models/cra_employment_refresh_report_account.rb +315 -0
  367. data/lib/plaid/models/cra_employment_refresh_report_item.rb +288 -0
  368. data/lib/plaid/models/cra_employment_refresh_report_transaction.rb +286 -0
  369. data/lib/plaid/models/cra_income_insights.rb +285 -0
  370. data/lib/plaid/models/cra_loan_application.rb +311 -0
  371. data/lib/plaid/models/cra_loan_application_decision.rb +40 -0
  372. data/lib/plaid/models/cra_loan_closed_status.rb +262 -0
  373. data/lib/plaid/models/cra_loan_opened_status.rb +262 -0
  374. data/lib/plaid/models/cra_loan_payment_history.rb +276 -0
  375. data/lib/plaid/models/cra_loan_payment_schedule.rb +44 -0
  376. data/lib/plaid/models/cra_loan_register.rb +339 -0
  377. data/lib/plaid/models/cra_loan_register_application.rb +231 -0
  378. data/lib/plaid/models/cra_loan_status.rb +47 -0
  379. data/lib/plaid/models/cra_loan_status_history_update.rb +262 -0
  380. data/lib/plaid/models/cra_loan_type.rb +46 -0
  381. data/lib/plaid/models/cra_loan_unregister.rb +240 -0
  382. data/lib/plaid/models/cra_loan_unregister_response.rb +226 -0
  383. data/lib/plaid/models/cra_loan_update.rb +245 -0
  384. data/lib/plaid/models/cra_loans_applications_register_request.rb +248 -0
  385. data/lib/plaid/models/cra_loans_applications_register_response.rb +226 -0
  386. data/lib/plaid/models/{deposit_switch_get_request.rb → cra_loans_register_request.rb} +20 -17
  387. data/lib/plaid/models/cra_loans_register_response.rb +226 -0
  388. data/lib/plaid/models/cra_loans_unregister_request.rb +248 -0
  389. data/lib/plaid/models/cra_loans_update_request.rb +248 -0
  390. data/lib/plaid/models/cra_loans_update_response.rb +226 -0
  391. data/lib/plaid/models/{deposit_switch_alt_create_request.rb → cra_monitoring_insights_get_request.rb} +33 -54
  392. data/lib/plaid/models/cra_monitoring_insights_get_response.rb +258 -0
  393. data/lib/plaid/models/cra_monitoring_insights_item.rb +307 -0
  394. data/lib/plaid/models/cra_monitoring_insights_subscribe_request.rb +283 -0
  395. data/lib/plaid/models/cra_monitoring_insights_subscribe_response.rb +241 -0
  396. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_request.rb +246 -0
  397. data/lib/plaid/models/cra_monitoring_insights_unsubscribe_response.rb +226 -0
  398. data/lib/plaid/models/cra_network_insights_item.rb +256 -0
  399. data/lib/plaid/models/cra_network_insights_report.rb +273 -0
  400. data/lib/plaid/models/cra_partner_insights.rb +263 -0
  401. data/lib/plaid/models/cra_partner_insights_complete_webhook.rb +292 -0
  402. data/lib/plaid/models/cra_partner_insights_error_webhook.rb +292 -0
  403. data/lib/plaid/models/cra_partner_insights_get_request.rb +246 -0
  404. data/lib/plaid/models/cra_partner_insights_get_response.rb +237 -0
  405. data/lib/plaid/models/cra_partner_insights_item.rb +253 -0
  406. data/lib/plaid/models/cra_partner_insights_item_account.rb +339 -0
  407. data/lib/plaid/models/cra_partner_insights_item_account_metadata.rb +233 -0
  408. data/lib/plaid/models/cra_partner_insights_prism.rb +276 -0
  409. data/lib/plaid/models/cra_pdf_add_ons.rb +38 -0
  410. data/lib/plaid/models/cra_plaid_credit_score_report.rb +251 -0
  411. data/lib/plaid/models/cra_prediction_interval.rb +244 -0
  412. data/lib/plaid/models/cra_upgrade_failed_webhook.rb +309 -0
  413. data/lib/plaid/models/cra_verification_report.rb +257 -0
  414. data/lib/plaid/models/cra_voa_report.rb +272 -0
  415. data/lib/plaid/models/cra_voa_report_account.rb +396 -0
  416. data/lib/plaid/models/cra_voa_report_account_balances.rb +309 -0
  417. data/lib/plaid/models/cra_voa_report_account_historical_balance.rb +263 -0
  418. data/lib/plaid/models/cra_voa_report_attributes.rb +231 -0
  419. data/lib/plaid/models/cra_voa_report_item.rb +288 -0
  420. data/lib/plaid/models/cra_voa_report_transactions_insights.rb +250 -0
  421. data/lib/plaid/models/credit1099.rb +25 -2
  422. data/lib/plaid/models/credit1099_filer.rb +3 -2
  423. data/lib/plaid/models/credit1099_payer.rb +3 -2
  424. data/lib/plaid/models/credit1099_recipient.rb +3 -2
  425. data/lib/plaid/models/credit_account_subtype.rb +2 -2
  426. data/lib/plaid/models/credit_ach_class.rb +40 -0
  427. data/lib/plaid/models/credit_amount_with_currency.rb +248 -0
  428. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +8 -22
  429. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +4 -3
  430. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +3 -2
  431. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +3 -2
  432. data/lib/plaid/models/{deposit_switch_create_request_options.rb → credit_audit_copy_token_update_request.rb} +50 -38
  433. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +241 -0
  434. data/lib/plaid/models/credit_bank_employer.rb +226 -0
  435. data/lib/plaid/models/credit_bank_employment.rb +285 -0
  436. data/lib/plaid/models/credit_bank_employment_get_request.rb +246 -0
  437. data/lib/plaid/models/credit_bank_employment_get_response.rb +243 -0
  438. data/lib/plaid/models/credit_bank_employment_item.rb +305 -0
  439. data/lib/plaid/models/credit_bank_employment_report.rb +290 -0
  440. data/lib/plaid/models/credit_bank_employment_warning.rb +275 -0
  441. data/lib/plaid/models/credit_bank_employment_warning_type.rb +38 -0
  442. data/lib/plaid/models/credit_bank_income.rb +6 -5
  443. data/lib/plaid/models/credit_bank_income_account.rb +52 -3
  444. data/lib/plaid/models/credit_bank_income_account_type.rb +2 -2
  445. data/lib/plaid/models/credit_bank_income_category.rb +3 -2
  446. data/lib/plaid/models/credit_bank_income_cause.rb +50 -2
  447. data/lib/plaid/models/credit_bank_income_error_type.rb +2 -2
  448. data/lib/plaid/models/credit_bank_income_get_request.rb +3 -2
  449. data/lib/plaid/models/credit_bank_income_get_request_options.rb +3 -2
  450. data/lib/plaid/models/credit_bank_income_get_response.rb +3 -2
  451. data/lib/plaid/models/credit_bank_income_historical_summary.rb +19 -6
  452. data/lib/plaid/models/credit_bank_income_item.rb +3 -2
  453. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +3 -2
  454. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +3 -2
  455. data/lib/plaid/models/credit_bank_income_refresh_request.rb +3 -2
  456. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +7 -16
  457. data/lib/plaid/models/credit_bank_income_refresh_response.rb +3 -2
  458. data/lib/plaid/models/credit_bank_income_source.rb +25 -2
  459. data/lib/plaid/models/credit_bank_income_summary.rb +19 -6
  460. data/lib/plaid/models/credit_bank_income_transaction.rb +3 -2
  461. data/lib/plaid/models/credit_bank_income_warning.rb +25 -2
  462. data/lib/plaid/models/credit_bank_income_warning_code.rb +3 -2
  463. data/lib/plaid/models/credit_bank_income_warning_type.rb +2 -2
  464. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +261 -0
  465. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +226 -0
  466. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +236 -0
  467. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +266 -0
  468. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +297 -0
  469. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +255 -0
  470. data/lib/plaid/models/credit_bank_statement_upload_item.rb +263 -0
  471. data/lib/plaid/models/credit_bank_statement_upload_object.rb +270 -0
  472. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +255 -0
  473. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +255 -0
  474. data/lib/plaid/models/credit_bank_statements_uploads_get_request_options.rb +223 -0
  475. data/lib/plaid/models/{deposit_switch_create_response.rb → credit_bank_statements_uploads_get_response.rb} +20 -17
  476. data/lib/plaid/models/credit_card_liability.rb +3 -2
  477. data/lib/plaid/models/credit_category.rb +4 -3
  478. data/lib/plaid/models/credit_document_metadata.rb +33 -10
  479. data/lib/plaid/models/credit_employer_verification.rb +3 -2
  480. data/lib/plaid/models/credit_employment_get_request.rb +3 -2
  481. data/lib/plaid/models/credit_employment_get_response.rb +3 -2
  482. data/lib/plaid/models/credit_employment_item.rb +3 -2
  483. data/lib/plaid/models/credit_employment_verification.rb +3 -2
  484. data/lib/plaid/models/credit_filter.rb +3 -2
  485. data/lib/plaid/models/credit_freddie_mac_asset.rb +290 -0
  486. data/lib/plaid/models/credit_freddie_mac_asset_transaction.rb +242 -0
  487. data/lib/plaid/models/credit_freddie_mac_asset_transactions.rb +227 -0
  488. data/lib/plaid/models/credit_freddie_mac_assets.rb +228 -0
  489. data/lib/plaid/models/credit_freddie_mac_individual_name.rb +256 -0
  490. data/lib/plaid/models/credit_freddie_mac_loan.rb +240 -0
  491. data/lib/plaid/models/credit_freddie_mac_loan_identifiers.rb +227 -0
  492. data/lib/plaid/models/credit_freddie_mac_loans.rb +225 -0
  493. data/lib/plaid/models/credit_freddie_mac_parties.rb +227 -0
  494. data/lib/plaid/models/credit_freddie_mac_party.rb +253 -0
  495. data/lib/plaid/models/credit_freddie_mac_party_individual.rb +225 -0
  496. data/lib/plaid/models/credit_freddie_mac_reporting_information.rb +256 -0
  497. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +246 -0
  498. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +255 -0
  499. data/lib/plaid/models/credit_freddie_mac_service.rb +241 -0
  500. data/lib/plaid/models/credit_freddie_mac_services.rb +225 -0
  501. data/lib/plaid/models/credit_freddie_mac_verification_of_asset.rb +253 -0
  502. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response.rb +225 -0
  503. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal.rb +253 -0
  504. data/lib/plaid/models/credit_pay_stub.rb +3 -2
  505. data/lib/plaid/models/credit_pay_stub_address.rb +3 -2
  506. data/lib/plaid/models/credit_pay_stub_deductions.rb +3 -2
  507. data/lib/plaid/models/credit_pay_stub_earnings.rb +3 -2
  508. data/lib/plaid/models/credit_pay_stub_employee.rb +4 -3
  509. data/lib/plaid/models/credit_pay_stub_employer.rb +3 -2
  510. data/lib/plaid/models/credit_pay_stub_net_pay.rb +3 -2
  511. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +40 -0
  512. data/lib/plaid/models/credit_payroll_income_get_request.rb +16 -6
  513. data/lib/plaid/models/credit_payroll_income_get_request_options.rb +223 -0
  514. data/lib/plaid/models/credit_payroll_income_get_response.rb +3 -2
  515. data/lib/plaid/models/credit_payroll_income_parsing_config_update_request.rb +273 -0
  516. data/lib/plaid/models/credit_payroll_income_parsing_config_update_response.rb +226 -0
  517. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +3 -2
  518. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +25 -2
  519. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +21 -6
  520. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +233 -0
  521. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +3 -2
  522. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +4 -3
  523. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +4 -3
  524. data/lib/plaid/models/credit_platform_ids.rb +3 -2
  525. data/lib/plaid/models/credit_relay_create_request.rb +4 -3
  526. data/lib/plaid/models/credit_relay_create_response.rb +3 -2
  527. data/lib/plaid/models/credit_relay_get_request.rb +41 -6
  528. data/lib/plaid/models/credit_relay_pdf_get_request.rb +282 -0
  529. data/lib/plaid/models/credit_relay_refresh_request.rb +26 -3
  530. data/lib/plaid/models/credit_relay_refresh_response.rb +3 -2
  531. data/lib/plaid/models/credit_relay_remove_request.rb +3 -2
  532. data/lib/plaid/models/credit_relay_remove_response.rb +4 -3
  533. data/lib/plaid/models/credit_session.rb +22 -9
  534. data/lib/plaid/models/credit_session_bank_employment_result.rb +262 -0
  535. data/lib/plaid/models/credit_session_bank_employment_status.rb +40 -0
  536. data/lib/plaid/models/credit_session_bank_income_result.rb +28 -3
  537. data/lib/plaid/models/credit_session_bank_income_status.rb +3 -2
  538. data/lib/plaid/models/credit_session_document_income_result.rb +271 -0
  539. data/lib/plaid/models/credit_session_error.rb +252 -0
  540. data/lib/plaid/models/credit_session_item_add_result.rb +17 -13
  541. data/lib/plaid/models/credit_session_payroll_income_result.rb +251 -0
  542. data/lib/plaid/models/credit_session_results.rb +44 -7
  543. data/lib/plaid/models/credit_sessions_get_request.rb +3 -2
  544. data/lib/plaid/models/credit_sessions_get_response.rb +4 -2
  545. data/lib/plaid/models/credit_w2.rb +3 -2
  546. data/lib/plaid/models/custom_sandbox_transaction.rb +281 -0
  547. data/lib/plaid/models/customer_initiated_return_risk.rb +4 -3
  548. data/lib/plaid/models/dashboard_user.rb +27 -4
  549. data/lib/plaid/models/dashboard_user_get_request.rb +4 -3
  550. data/lib/plaid/models/dashboard_user_get_response.rb +27 -4
  551. data/lib/plaid/models/dashboard_user_list_request.rb +3 -2
  552. data/lib/plaid/models/dashboard_user_list_response.rb +3 -2
  553. data/lib/plaid/models/dashboard_user_status.rb +2 -2
  554. data/lib/plaid/models/data_sources.rb +40 -0
  555. data/lib/plaid/models/date_range.rb +3 -2
  556. data/lib/plaid/models/deductions.rb +3 -2
  557. data/lib/plaid/models/deductions_breakdown.rb +3 -2
  558. data/lib/plaid/models/deductions_total.rb +3 -2
  559. data/lib/plaid/models/default_update_webhook.rb +26 -3
  560. data/lib/plaid/models/depository_account_subtype.rb +2 -2
  561. data/lib/plaid/models/depository_filter.rb +3 -2
  562. data/lib/plaid/models/detailed_originator.rb +289 -0
  563. data/lib/plaid/models/detected_account.rb +308 -0
  564. data/lib/plaid/models/device_id.rb +230 -0
  565. data/lib/plaid/models/distribution_breakdown.rb +3 -2
  566. data/lib/plaid/models/doc_type.rb +2 -2
  567. data/lib/plaid/models/document_analysis.rb +70 -7
  568. data/lib/plaid/models/document_authenticity_match_code.rb +2 -2
  569. data/lib/plaid/models/document_date_of_birth_match_code.rb +3 -2
  570. data/lib/plaid/models/document_metadata.rb +27 -3
  571. data/lib/plaid/models/document_name_match_code.rb +3 -2
  572. data/lib/plaid/models/document_risk_signal.rb +20 -8
  573. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +3 -2
  574. data/lib/plaid/models/document_risk_signals_object.rb +4 -3
  575. data/lib/plaid/models/document_risk_summary.rb +222 -0
  576. data/lib/plaid/models/document_status.rb +2 -2
  577. data/lib/plaid/models/documentary_verification.rb +3 -2
  578. data/lib/plaid/models/documentary_verification_document.rb +41 -7
  579. data/lib/plaid/models/earnings.rb +3 -2
  580. data/lib/plaid/models/earnings_breakdown.rb +25 -2
  581. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +2 -2
  582. data/lib/plaid/models/earnings_total.rb +3 -2
  583. data/lib/plaid/models/email.rb +3 -2
  584. data/lib/plaid/models/email_address_match_score.rb +13 -12
  585. data/lib/plaid/models/employee.rb +3 -2
  586. data/lib/plaid/models/employee_income_summary_field_string.rb +25 -2
  587. data/lib/plaid/models/employer.rb +3 -2
  588. data/lib/plaid/models/employer_income_summary_field_string.rb +25 -2
  589. data/lib/plaid/models/employer_verification.rb +3 -2
  590. data/lib/plaid/models/employers_search_request.rb +3 -2
  591. data/lib/plaid/models/employers_search_response.rb +3 -2
  592. data/lib/plaid/models/employment_details.rb +3 -2
  593. data/lib/plaid/models/employment_source_type.rb +39 -0
  594. data/lib/plaid/models/employment_verification.rb +25 -2
  595. data/lib/plaid/models/employment_verification_get_request.rb +3 -2
  596. data/lib/plaid/models/employment_verification_get_response.rb +3 -2
  597. data/lib/plaid/models/employment_verification_status.rb +2 -2
  598. data/lib/plaid/models/enhancements.rb +28 -5
  599. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  600. data/lib/plaid/models/enrichments.rb +403 -0
  601. data/lib/plaid/models/entity_document.rb +26 -24
  602. data/lib/plaid/models/entity_document_type.rb +2 -2
  603. data/lib/plaid/models/entity_screening_hit_analysis.rb +26 -3
  604. data/lib/plaid/models/entity_screening_hit_data.rb +3 -2
  605. data/lib/plaid/models/entity_screening_hit_documents_items.rb +3 -2
  606. data/lib/plaid/models/entity_screening_hit_emails.rb +4 -3
  607. data/lib/plaid/models/entity_screening_hit_emails_items.rb +3 -2
  608. data/lib/plaid/models/entity_screening_hit_names.rb +25 -2
  609. data/lib/plaid/models/entity_screening_hit_names_items.rb +3 -2
  610. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +25 -2
  611. data/lib/plaid/models/entity_screening_hit_urls.rb +3 -2
  612. data/lib/plaid/models/entity_screening_hit_urls_items.rb +3 -2
  613. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +3 -2
  614. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +38 -11
  615. data/lib/plaid/models/entity_watchlist_code.rb +5 -2
  616. data/lib/plaid/models/entity_watchlist_program.rb +25 -23
  617. data/lib/plaid/models/entity_watchlist_screening.rb +27 -21
  618. data/lib/plaid/models/entity_watchlist_screening_hit.rb +25 -19
  619. data/lib/plaid/models/entity_watchlist_screening_review.rb +3 -19
  620. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +7 -61
  621. data/lib/plaid/models/entity_watchlist_search_terms.rb +6 -60
  622. data/lib/plaid/models/expiration_date.rb +2 -2
  623. data/lib/plaid/models/extended_recipient_metadata.rb +383 -0
  624. data/lib/plaid/models/extended_recipient_metadata_all_of.rb +255 -0
  625. data/lib/plaid/models/external_payment_initiation_consent_options.rb +6 -33
  626. data/lib/plaid/models/external_payment_options.rb +27 -32
  627. data/lib/plaid/models/external_payment_refund_details.rb +3 -2
  628. data/lib/plaid/models/external_payment_schedule_base.rb +25 -2
  629. data/lib/plaid/models/external_payment_schedule_get.rb +25 -2
  630. data/lib/plaid/models/external_payment_schedule_request.rb +25 -2
  631. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +318 -0
  632. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +318 -0
  633. data/lib/plaid/models/fdx_content_types.rb +2 -2
  634. data/lib/plaid/models/fdx_hateoas_link.rb +25 -2
  635. data/lib/plaid/models/fdx_hateoas_link_action.rb +2 -2
  636. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +251 -0
  637. data/lib/plaid/models/fdx_notification.rb +25 -7
  638. data/lib/plaid/models/fdx_notification_category.rb +2 -2
  639. data/lib/plaid/models/fdx_notification_payload.rb +29 -4
  640. data/lib/plaid/models/fdx_notification_payload_id_type.rb +2 -2
  641. data/lib/plaid/models/fdx_notification_priority.rb +2 -2
  642. data/lib/plaid/models/fdx_notification_severity.rb +2 -2
  643. data/lib/plaid/models/fdx_notification_type.rb +2 -2
  644. data/lib/plaid/models/fdx_party.rb +25 -2
  645. data/lib/plaid/models/fdx_party_registry.rb +2 -2
  646. data/lib/plaid/models/fdx_party_type.rb +2 -2
  647. data/lib/plaid/models/fdx_recipient_metadata.rb +330 -0
  648. data/lib/plaid/models/fdxfi_attribute.rb +13 -2
  649. data/lib/plaid/models/financial_institution_insights.rb +265 -0
  650. data/lib/plaid/models/fixed_income.rb +254 -0
  651. data/lib/plaid/models/forecasted_monthly_income.rb +241 -0
  652. data/lib/plaid/models/form1099_type.rb +2 -2
  653. data/lib/plaid/models/forwarded_json_response.rb +226 -0
  654. data/lib/plaid/models/fraud_amount.rb +262 -0
  655. data/lib/plaid/models/fraud_analysis_details.rb +331 -0
  656. data/lib/plaid/models/fraud_check_outcome.rb +39 -0
  657. data/lib/plaid/models/fraud_check_outcome_with_no_data.rb +40 -0
  658. data/lib/plaid/models/generic_screening_hit_location_items.rb +3 -2
  659. data/lib/plaid/models/get_recipient_response.rb +337 -0
  660. data/lib/plaid/models/get_recipients_response.rb +227 -0
  661. data/lib/plaid/models/gse_report_type.rb +39 -0
  662. data/lib/plaid/models/health_incident.rb +4 -2
  663. data/lib/plaid/models/hidden_match_summary_code.rb +42 -0
  664. data/lib/plaid/models/historical_annual_income.rb +241 -0
  665. data/lib/plaid/models/historical_balance.rb +4 -3
  666. data/lib/plaid/models/historical_update_webhook.rb +27 -4
  667. data/lib/plaid/models/holding.rb +32 -9
  668. data/lib/plaid/models/holdings_default_update_webhook.rb +25 -2
  669. data/lib/plaid/models/holdings_override.rb +4 -3
  670. data/lib/plaid/models/hosted_link_delivery_method.rb +39 -0
  671. data/lib/plaid/models/hosted_mmd_verification_webhook.rb +317 -0
  672. data/lib/plaid/models/human_review.rb +247 -0
  673. data/lib/plaid/models/human_review_status.rb +40 -0
  674. data/lib/plaid/models/id_number_type.rb +2 -2
  675. data/lib/plaid/models/identity_default_update_webhook.rb +26 -3
  676. data/lib/plaid/models/identity_document_metadata.rb +239 -0
  677. data/lib/plaid/models/identity_document_upload.rb +239 -0
  678. data/lib/plaid/models/identity_document_upload_metadata.rb +264 -0
  679. data/lib/plaid/models/identity_document_upload_risk_insights.rb +232 -0
  680. data/lib/plaid/models/identity_document_upload_risk_signal.rb +255 -0
  681. data/lib/plaid/models/identity_document_upload_risk_summary.rb +222 -0
  682. data/lib/plaid/models/identity_documents_uploads_get_request.rb +255 -0
  683. data/lib/plaid/models/identity_documents_uploads_get_request_options.rb +223 -0
  684. data/lib/plaid/models/identity_documents_uploads_get_response.rb +257 -0
  685. data/lib/plaid/models/identity_get_request.rb +3 -2
  686. data/lib/plaid/models/identity_get_request_options.rb +3 -2
  687. data/lib/plaid/models/identity_get_response.rb +3 -2
  688. data/lib/plaid/models/identity_match_request.rb +3 -2
  689. data/lib/plaid/models/identity_match_request_options.rb +3 -2
  690. data/lib/plaid/models/identity_match_response.rb +3 -2
  691. data/lib/plaid/models/identity_match_user.rb +6 -5
  692. data/lib/plaid/models/identity_refresh_request.rb +246 -0
  693. data/lib/plaid/models/identity_refresh_response.rb +226 -0
  694. data/lib/plaid/models/identity_update_types.rb +2 -2
  695. data/lib/plaid/models/identity_verification.rb +94 -29
  696. data/lib/plaid/models/identity_verification_autofill_address.rb +335 -0
  697. data/lib/plaid/models/identity_verification_autofill_create_request.rb +246 -0
  698. data/lib/plaid/models/identity_verification_autofill_create_response.rb +272 -0
  699. data/lib/plaid/models/identity_verification_autofill_status.rb +39 -0
  700. data/lib/plaid/models/identity_verification_autofill_user_data.rb +241 -0
  701. data/lib/plaid/models/identity_verification_create_request.rb +28 -11
  702. data/lib/plaid/models/identity_verification_create_request_user.rb +283 -0
  703. data/lib/plaid/models/identity_verification_create_response.rb +90 -25
  704. data/lib/plaid/models/identity_verification_document_address_response.rb +278 -0
  705. data/lib/plaid/models/identity_verification_document_name_response.rb +241 -0
  706. data/lib/plaid/models/identity_verification_get_request.rb +4 -3
  707. data/lib/plaid/models/identity_verification_get_response.rb +90 -25
  708. data/lib/plaid/models/identity_verification_list_request.rb +17 -32
  709. data/lib/plaid/models/identity_verification_list_response.rb +3 -2
  710. data/lib/plaid/models/identity_verification_request_user.rb +8 -44
  711. data/lib/plaid/models/identity_verification_request_user_name.rb +241 -0
  712. data/lib/plaid/models/{user_name.rb → identity_verification_response_user_name.rb} +6 -5
  713. data/lib/plaid/models/identity_verification_retried_webhook.rb +31 -4
  714. data/lib/plaid/models/identity_verification_retry_request.rb +49 -26
  715. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +4 -3
  716. data/lib/plaid/models/identity_verification_retry_response.rb +90 -25
  717. data/lib/plaid/models/identity_verification_status.rb +2 -2
  718. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +31 -4
  719. data/lib/plaid/models/identity_verification_step_status.rb +2 -2
  720. data/lib/plaid/models/identity_verification_step_summary.rb +25 -2
  721. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +32 -5
  722. data/lib/plaid/models/identity_verification_template_reference.rb +6 -5
  723. data/lib/plaid/models/identity_verification_user_address.rb +6 -26
  724. data/lib/plaid/models/identity_verification_user_data.rb +7 -6
  725. data/lib/plaid/models/image_quality.rb +2 -2
  726. data/lib/plaid/models/image_quality_details.rb +275 -0
  727. data/lib/plaid/models/image_quality_outcome.rb +39 -0
  728. data/lib/plaid/models/incident_update.rb +3 -2
  729. data/lib/plaid/models/income_breakdown.rb +25 -2
  730. data/lib/plaid/models/income_breakdown_type.rb +2 -2
  731. data/lib/plaid/models/income_override.rb +19 -6
  732. data/lib/plaid/models/income_sources_counts.rb +241 -0
  733. data/lib/plaid/models/income_summary.rb +3 -2
  734. data/lib/plaid/models/income_summary_field_number.rb +25 -2
  735. data/lib/plaid/models/income_summary_field_string.rb +25 -2
  736. data/lib/plaid/models/income_verification_create_request.rb +3 -2
  737. data/lib/plaid/models/income_verification_create_request_options.rb +4 -3
  738. data/lib/plaid/models/income_verification_create_response.rb +3 -2
  739. data/lib/plaid/models/income_verification_doc_parsing_config.rb +39 -0
  740. data/lib/plaid/models/income_verification_documents_download_request.rb +3 -2
  741. data/lib/plaid/models/income_verification_payroll_flow_type.rb +2 -2
  742. data/lib/plaid/models/income_verification_paystubs_get_request.rb +3 -2
  743. data/lib/plaid/models/income_verification_paystubs_get_response.rb +3 -2
  744. data/lib/plaid/models/income_verification_precheck_confidence.rb +2 -2
  745. data/lib/plaid/models/income_verification_precheck_employer.rb +3 -2
  746. data/lib/plaid/models/income_verification_precheck_employer_address.rb +3 -2
  747. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +3 -2
  748. data/lib/plaid/models/income_verification_precheck_military_info.rb +3 -2
  749. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +3 -2
  750. data/lib/plaid/models/income_verification_precheck_request.rb +3 -2
  751. data/lib/plaid/models/income_verification_precheck_response.rb +25 -2
  752. data/lib/plaid/models/income_verification_precheck_user.rb +3 -2
  753. data/lib/plaid/models/income_verification_refresh_reconnect_needed_webhook.rb +292 -0
  754. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +312 -0
  755. data/lib/plaid/models/income_verification_source_type.rb +2 -2
  756. data/lib/plaid/models/income_verification_status_webhook.rb +27 -4
  757. data/lib/plaid/models/income_verification_taxforms_get_request.rb +3 -2
  758. data/lib/plaid/models/income_verification_taxforms_get_response.rb +3 -2
  759. data/lib/plaid/models/income_verification_webhook_status.rb +3 -2
  760. data/lib/plaid/models/individual_name.rb +3 -2
  761. data/lib/plaid/models/individual_screening_hit_names.rb +25 -2
  762. data/lib/plaid/models/individual_watchlist_code.rb +6 -3
  763. data/lib/plaid/models/individual_watchlist_program.rb +25 -23
  764. data/lib/plaid/models/inflow_model.rb +3 -2
  765. data/lib/plaid/models/initial_update_webhook.rb +27 -4
  766. data/lib/plaid/models/institution.rb +22 -9
  767. data/lib/plaid/models/institution_status.rb +11 -2
  768. data/lib/plaid/models/institution_status_alert_webhook.rb +307 -0
  769. data/lib/plaid/models/institution_supported_networks.rb +239 -0
  770. data/lib/plaid/models/institutions_get_by_id_request.rb +4 -3
  771. data/lib/plaid/models/institutions_get_by_id_request_options.rb +3 -2
  772. data/lib/plaid/models/institutions_get_by_id_response.rb +3 -2
  773. data/lib/plaid/models/institutions_get_request.rb +4 -3
  774. data/lib/plaid/models/institutions_get_request_options.rb +7 -6
  775. data/lib/plaid/models/institutions_get_response.rb +3 -2
  776. data/lib/plaid/models/institutions_search_account_filter.rb +3 -2
  777. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +3 -2
  778. data/lib/plaid/models/institutions_search_request.rb +7 -6
  779. data/lib/plaid/models/institutions_search_request_options.rb +4 -3
  780. data/lib/plaid/models/institutions_search_response.rb +3 -2
  781. data/lib/plaid/models/investment_account_subtype.rb +3 -2
  782. data/lib/plaid/models/investment_filter.rb +3 -2
  783. data/lib/plaid/models/investment_holdings_get_request_options.rb +3 -2
  784. data/lib/plaid/models/investment_transaction.rb +26 -3
  785. data/lib/plaid/models/investment_transaction_subtype.rb +3 -2
  786. data/lib/plaid/models/investment_transaction_type.rb +2 -2
  787. data/lib/plaid/models/investments_auth401k_contribution_details.rb +318 -0
  788. data/lib/plaid/models/investments_auth401k_fee_details.rb +241 -0
  789. data/lib/plaid/models/investments_auth_account_details401k.rb +239 -0
  790. data/lib/plaid/models/investments_auth_data_sources.rb +260 -0
  791. data/lib/plaid/models/investments_auth_get_numbers.rb +244 -0
  792. data/lib/plaid/models/investments_auth_get_request.rb +255 -0
  793. data/lib/plaid/models/investments_auth_get_request_options.rb +223 -0
  794. data/lib/plaid/models/investments_auth_get_response.rb +348 -0
  795. data/lib/plaid/models/investments_auth_owner.rb +233 -0
  796. data/lib/plaid/models/investments_default_update_webhook.rb +25 -2
  797. data/lib/plaid/models/investments_historical_update_webhook.rb +332 -0
  798. data/lib/plaid/models/investments_holdings_get_request.rb +3 -2
  799. data/lib/plaid/models/investments_holdings_get_response.rb +17 -6
  800. data/lib/plaid/models/investments_refresh_request.rb +246 -0
  801. data/lib/plaid/models/investments_refresh_response.rb +226 -0
  802. data/lib/plaid/models/investments_transactions_get_request.rb +3 -2
  803. data/lib/plaid/models/investments_transactions_get_request_options.rb +19 -6
  804. data/lib/plaid/models/investments_transactions_get_response.rb +18 -7
  805. data/lib/plaid/models/investments_transactions_override.rb +3 -2
  806. data/lib/plaid/models/iso_currency_code.rb +38 -0
  807. data/lib/plaid/models/issue.rb +306 -0
  808. data/lib/plaid/models/issue_resolved_webhook.rb +316 -0
  809. data/lib/plaid/models/issues_get_request.rb +246 -0
  810. data/lib/plaid/models/issues_get_response.rb +230 -0
  811. data/lib/plaid/models/issues_search_request.rb +261 -0
  812. data/lib/plaid/models/issues_search_response.rb +233 -0
  813. data/lib/plaid/models/issues_status.rb +43 -0
  814. data/lib/plaid/models/issues_subscribe_request.rb +261 -0
  815. data/lib/plaid/models/issues_subscribe_response.rb +226 -0
  816. data/lib/plaid/models/issuing_country.rb +2 -2
  817. data/lib/plaid/models/item.rb +29 -7
  818. data/lib/plaid/models/item_access_token_invalidate_request.rb +3 -2
  819. data/lib/plaid/models/item_access_token_invalidate_response.rb +3 -2
  820. data/lib/plaid/models/item_activity_list_request.rb +288 -0
  821. data/lib/plaid/models/item_activity_list_response.rb +270 -0
  822. data/lib/plaid/models/item_add_result_webhook.rb +322 -0
  823. data/lib/plaid/models/item_application_list_request.rb +3 -2
  824. data/lib/plaid/models/item_application_list_response.rb +3 -2
  825. data/lib/plaid/models/item_application_list_user_auth.rb +3 -2
  826. data/lib/plaid/models/item_application_scopes_update_request.rb +26 -3
  827. data/lib/plaid/models/item_application_scopes_update_response.rb +3 -2
  828. data/lib/plaid/models/item_application_unlink_request.rb +261 -0
  829. data/lib/plaid/models/item_application_unlink_response.rb +226 -0
  830. data/lib/plaid/models/item_auth_method.rb +47 -0
  831. data/lib/plaid/models/item_consented_data_scope.rb +52 -0
  832. data/lib/plaid/models/item_create_authentication.rb +40 -0
  833. data/lib/plaid/models/item_error_webhook.rb +25 -2
  834. data/lib/plaid/models/item_get_request.rb +3 -2
  835. data/lib/plaid/models/item_get_response.rb +4 -3
  836. data/lib/plaid/models/item_import_request.rb +14 -3
  837. data/lib/plaid/models/item_import_request_options.rb +3 -2
  838. data/lib/plaid/models/item_import_request_user_auth.rb +3 -2
  839. data/lib/plaid/models/item_import_response.rb +3 -2
  840. data/lib/plaid/models/item_login_repaired_webhook.rb +292 -0
  841. data/lib/plaid/models/item_product_ready_webhook.rb +25 -2
  842. data/lib/plaid/models/item_public_token_create_request.rb +3 -2
  843. data/lib/plaid/models/item_public_token_create_response.rb +3 -2
  844. data/lib/plaid/models/item_public_token_exchange_request.rb +3 -2
  845. data/lib/plaid/models/item_public_token_exchange_response.rb +3 -2
  846. data/lib/plaid/models/item_remove_reason_code.rb +43 -0
  847. data/lib/plaid/models/item_remove_request.rb +67 -6
  848. data/lib/plaid/models/item_remove_response.rb +3 -2
  849. data/lib/plaid/models/item_status.rb +3 -2
  850. data/lib/plaid/models/item_status_investments.rb +3 -2
  851. data/lib/plaid/models/item_status_last_webhook.rb +3 -2
  852. data/lib/plaid/models/item_status_nullable.rb +3 -2
  853. data/lib/plaid/models/item_status_transactions.rb +5 -4
  854. data/lib/plaid/models/item_webhook_update_request.rb +3 -2
  855. data/lib/plaid/models/item_webhook_update_response.rb +3 -2
  856. data/lib/plaid/models/item_with_consent_fields.rb +439 -0
  857. data/lib/plaid/models/item_with_consent_fields_all_of.rb +244 -0
  858. data/lib/plaid/models/jwk_public_key.rb +5 -4
  859. data/lib/plaid/models/jwt_header.rb +35 -6
  860. data/lib/plaid/models/kyc_check_address_summary.rb +75 -6
  861. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +56 -6
  862. data/lib/plaid/models/kyc_check_details.rb +4 -3
  863. data/lib/plaid/models/kyc_check_details_international_address.rb +317 -0
  864. data/lib/plaid/models/kyc_check_id_number_summary.rb +25 -2
  865. data/lib/plaid/models/kyc_check_name_summary.rb +47 -6
  866. data/lib/plaid/models/kyc_check_phone_summary.rb +43 -6
  867. data/lib/plaid/models/last_data_access_times.rb +314 -0
  868. data/lib/plaid/models/latest_scored_event.rb +274 -0
  869. data/lib/plaid/models/layer_authentication_passed_webhook.rb +307 -0
  870. data/lib/plaid/models/ledger_event_source_type.rb +40 -0
  871. data/lib/plaid/models/liabilities_default_update_webhook.rb +26 -3
  872. data/lib/plaid/models/liabilities_get_request.rb +3 -2
  873. data/lib/plaid/models/liabilities_get_request_options.rb +3 -2
  874. data/lib/plaid/models/liabilities_get_response.rb +3 -2
  875. data/lib/plaid/models/liabilities_object.rb +3 -2
  876. data/lib/plaid/models/liability_override.rb +4 -3
  877. data/lib/plaid/models/link_callback_metadata.rb +302 -0
  878. data/lib/plaid/models/link_delivery_account.rb +302 -0
  879. data/lib/plaid/models/link_delivery_callback_webhook.rb +295 -0
  880. data/lib/plaid/models/link_delivery_communication_method.rb +252 -0
  881. data/lib/plaid/models/link_delivery_create_request.rb +11 -30
  882. data/lib/plaid/models/link_delivery_create_response.rb +5 -4
  883. data/lib/plaid/models/link_delivery_delivery_method.rb +2 -2
  884. data/lib/plaid/models/link_delivery_get_request.rb +4 -3
  885. data/lib/plaid/models/link_delivery_get_response.rb +57 -20
  886. data/lib/plaid/models/link_delivery_institution.rb +231 -0
  887. data/lib/plaid/models/link_delivery_metadata.rb +251 -0
  888. data/lib/plaid/models/link_delivery_options.rb +220 -0
  889. data/lib/plaid/models/link_delivery_recipient.rb +233 -0
  890. data/lib/plaid/models/link_delivery_session_status.rb +3 -2
  891. data/lib/plaid/models/link_delivery_verification_status.rb +46 -0
  892. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +40 -0
  893. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +39 -0
  894. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +39 -0
  895. data/lib/plaid/models/link_event.rb +270 -0
  896. data/lib/plaid/models/{error.rb → link_event_metadata.rb} +112 -105
  897. data/lib/plaid/models/link_event_name.rb +63 -0
  898. data/lib/plaid/models/link_events_webhook.rb +288 -0
  899. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +246 -0
  900. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +241 -0
  901. data/lib/plaid/models/link_session_bank_employment_result.rb +272 -0
  902. data/lib/plaid/models/link_session_bank_income_result.rb +272 -0
  903. data/lib/plaid/models/link_session_cra_document_upload_result.rb +226 -0
  904. data/lib/plaid/models/link_session_cra_item_add_result.rb +253 -0
  905. data/lib/plaid/models/link_session_exit.rb +231 -0
  906. data/lib/plaid/models/link_session_exit_deprecated.rb +231 -0
  907. data/lib/plaid/models/link_session_exit_metadata.rb +251 -0
  908. data/lib/plaid/models/link_session_exit_metadata_institution.rb +231 -0
  909. data/lib/plaid/models/link_session_finished_webhook.rb +344 -0
  910. data/lib/plaid/models/link_session_item_add_result.rb +253 -0
  911. data/lib/plaid/models/link_session_payroll_income_result.rb +251 -0
  912. data/lib/plaid/models/link_session_protect_result.rb +249 -0
  913. data/lib/plaid/models/link_session_results.rb +309 -0
  914. data/lib/plaid/models/link_session_success.rb +236 -0
  915. data/lib/plaid/models/link_session_success_metadata.rb +275 -0
  916. data/lib/plaid/models/link_session_success_metadata_account.rb +284 -0
  917. data/lib/plaid/models/link_session_success_metadata_institution.rb +231 -0
  918. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +40 -0
  919. data/lib/plaid/models/link_token_account_filters.rb +17 -7
  920. data/lib/plaid/models/link_token_cashflow_report.rb +249 -0
  921. data/lib/plaid/models/link_token_create_card_switch.rb +226 -0
  922. data/lib/plaid/models/link_token_create_credit_filter.rb +3 -2
  923. data/lib/plaid/models/link_token_create_depository_filter.rb +3 -2
  924. data/lib/plaid/models/link_token_create_hosted_link.rb +274 -0
  925. data/lib/plaid/models/link_token_create_identity.rb +245 -0
  926. data/lib/plaid/models/link_token_create_institution_data.rb +4 -3
  927. data/lib/plaid/models/link_token_create_investment_filter.rb +3 -2
  928. data/lib/plaid/models/link_token_create_loan_filter.rb +3 -2
  929. data/lib/plaid/models/link_token_create_request.rb +309 -24
  930. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +3 -2
  931. data/lib/plaid/models/link_token_create_request_appearance_mode.rb +41 -0
  932. data/lib/plaid/models/link_token_create_request_auth.rb +74 -13
  933. data/lib/plaid/models/link_token_create_request_base_report.rb +267 -0
  934. data/lib/plaid/models/link_token_create_request_cra_options.rb +332 -0
  935. data/lib/plaid/models/link_token_create_request_cra_options_base_report.rb +243 -0
  936. data/lib/plaid/models/link_token_create_request_cra_options_base_report_gse_options.rb +228 -0
  937. data/lib/plaid/models/link_token_create_request_cra_options_cashflow_insights.rb +253 -0
  938. data/lib/plaid/models/link_token_create_request_cra_options_partner_insights.rb +233 -0
  939. data/lib/plaid/models/link_token_create_request_cra_options_plaid_credit_score.rb +243 -0
  940. data/lib/plaid/models/link_token_create_request_credit_partner_insights.rb +259 -0
  941. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +4 -3
  942. data/lib/plaid/models/link_token_create_request_employment.rb +232 -0
  943. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +226 -0
  944. data/lib/plaid/models/link_token_create_request_identity_verification.rb +3 -3
  945. data/lib/plaid/models/link_token_create_request_income_verification.rb +6 -14
  946. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +39 -3
  947. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +36 -9
  948. data/lib/plaid/models/link_token_create_request_payment_configuration.rb +236 -0
  949. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +4 -46
  950. data/lib/plaid/models/link_token_create_request_statements.rb +241 -0
  951. data/lib/plaid/models/link_token_create_request_transfer.rb +21 -10
  952. data/lib/plaid/models/link_token_create_request_update.rb +43 -7
  953. data/lib/plaid/models/link_token_create_request_user.rb +38 -16
  954. data/lib/plaid/models/link_token_create_request_user_address.rb +287 -0
  955. data/lib/plaid/models/link_token_create_request_user_id_number.rb +268 -0
  956. data/lib/plaid/models/link_token_create_request_user_name.rb +247 -0
  957. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +25 -2
  958. data/lib/plaid/models/link_token_create_response.rb +28 -7
  959. data/lib/plaid/models/link_token_eu_config.rb +3 -2
  960. data/lib/plaid/models/link_token_get_metadata_response.rb +3 -2
  961. data/lib/plaid/models/link_token_get_request.rb +3 -2
  962. data/lib/plaid/models/link_token_get_response.rb +16 -3
  963. data/lib/plaid/models/link_token_get_sessions_response.rb +299 -0
  964. data/lib/plaid/models/link_token_investments.rb +17 -6
  965. data/lib/plaid/models/link_token_investments_auth.rb +263 -0
  966. data/lib/plaid/models/link_token_transactions.rb +249 -0
  967. data/lib/plaid/models/link_user_delivery_status_webhook.rb +285 -0
  968. data/lib/plaid/models/loan.rb +3 -2
  969. data/lib/plaid/models/loan_account_subtype.rb +3 -2
  970. data/lib/plaid/models/loan_filter.rb +3 -2
  971. data/lib/plaid/models/loan_identifier.rb +25 -2
  972. data/lib/plaid/models/loan_identifier_type.rb +2 -2
  973. data/lib/plaid/models/loan_identifiers.rb +3 -2
  974. data/lib/plaid/models/loan_payments_counts.rb +241 -0
  975. data/lib/plaid/models/loan_payments_merchant_counts.rb +241 -0
  976. data/lib/plaid/models/loans.rb +3 -2
  977. data/lib/plaid/models/location.rb +3 -2
  978. data/lib/plaid/models/match_summary.rb +25 -2
  979. data/lib/plaid/models/match_summary_code.rb +2 -2
  980. data/lib/plaid/models/merchant_insights.rb +315 -0
  981. data/lib/plaid/models/meta.rb +7 -24
  982. data/lib/plaid/models/mfa.rb +3 -2
  983. data/lib/plaid/models/monitoring_consumer_report_permissible_purpose.rb +39 -0
  984. data/lib/plaid/models/monitoring_income_insights.rb +284 -0
  985. data/lib/plaid/models/monitoring_income_source.rb +292 -0
  986. data/lib/plaid/models/monitoring_insights.rb +239 -0
  987. data/lib/plaid/models/monitoring_insights_item_status.rb +258 -0
  988. data/lib/plaid/models/monitoring_insights_status.rb +39 -0
  989. data/lib/plaid/models/monitoring_item_status_code.rb +40 -0
  990. data/lib/plaid/models/monitoring_loan_insights.rb +254 -0
  991. data/lib/plaid/models/mortgage_interest_rate.rb +3 -2
  992. data/lib/plaid/models/mortgage_liability.rb +4 -7
  993. data/lib/plaid/models/mortgage_property_address.rb +3 -2
  994. data/lib/plaid/models/multi_document_risk_signal.rb +3 -2
  995. data/lib/plaid/models/name_match_score.rb +6 -5
  996. data/lib/plaid/models/net_pay.rb +3 -2
  997. data/lib/plaid/models/network_insights_item.rb +256 -0
  998. data/lib/plaid/models/network_insights_report.rb +273 -0
  999. data/lib/plaid/models/network_insights_report_get_request.rb +248 -0
  1000. data/lib/plaid/models/network_insights_report_get_response.rb +240 -0
  1001. data/lib/plaid/models/network_status_get_request.rb +255 -0
  1002. data/lib/plaid/models/network_status_get_response.rb +272 -0
  1003. data/lib/plaid/models/network_status_get_response_layer.rb +226 -0
  1004. data/lib/plaid/models/network_status_get_response_network_status.rb +39 -0
  1005. data/lib/plaid/models/network_status_get_user.rb +226 -0
  1006. data/lib/plaid/models/new_accounts_available_webhook.rb +26 -3
  1007. data/lib/plaid/models/numbers.rb +4 -3
  1008. data/lib/plaid/models/numbers_acats.rb +258 -0
  1009. data/lib/plaid/models/numbers_ach.rb +43 -10
  1010. data/lib/plaid/models/numbers_ach_nullable.rb +43 -10
  1011. data/lib/plaid/models/numbers_aton.rb +241 -0
  1012. data/lib/plaid/models/numbers_bacs.rb +3 -2
  1013. data/lib/plaid/models/numbers_bacs_nullable.rb +3 -2
  1014. data/lib/plaid/models/numbers_eft.rb +3 -2
  1015. data/lib/plaid/models/numbers_eft_nullable.rb +3 -2
  1016. data/lib/plaid/models/numbers_iban_nullable.rb +3 -2
  1017. data/lib/plaid/models/numbers_international.rb +3 -2
  1018. data/lib/plaid/models/numbers_international_iban.rb +3 -2
  1019. data/lib/plaid/models/numbers_international_nullable.rb +3 -2
  1020. data/lib/plaid/models/numbers_retirement401k.rb +246 -0
  1021. data/lib/plaid/models/o_auth_error_code.rb +43 -0
  1022. data/lib/plaid/models/o_auth_error_response.rb +277 -0
  1023. data/lib/plaid/models/o_auth_grant_type.rb +40 -0
  1024. data/lib/plaid/models/o_auth_introspect_request.rb +256 -0
  1025. data/lib/plaid/models/o_auth_introspect_response.rb +331 -0
  1026. data/lib/plaid/models/o_auth_revoke_request.rb +256 -0
  1027. data/lib/plaid/models/o_auth_revoke_response.rb +226 -0
  1028. data/lib/plaid/models/o_auth_subject_token_type.rb +39 -0
  1029. data/lib/plaid/models/o_auth_token_request.rb +336 -0
  1030. data/lib/plaid/models/o_auth_token_response.rb +286 -0
  1031. data/lib/plaid/models/omittable_transfer_type.rb +39 -0
  1032. data/lib/plaid/models/option_contract.rb +271 -0
  1033. data/lib/plaid/models/originating_fund_source.rb +296 -0
  1034. data/lib/plaid/models/originator.rb +262 -0
  1035. data/lib/plaid/models/originator_expected_transfer_frequency.rb +41 -0
  1036. data/lib/plaid/models/other_account_subtype.rb +39 -0
  1037. data/lib/plaid/models/other_filter.rb +228 -0
  1038. data/lib/plaid/models/override_account_type.rb +2 -2
  1039. data/lib/plaid/models/override_accounts.rb +25 -2
  1040. data/lib/plaid/models/owner.rb +3 -2
  1041. data/lib/plaid/models/owner_override.rb +3 -2
  1042. data/lib/plaid/models/ownership_type.rb +2 -2
  1043. data/lib/plaid/models/parties.rb +3 -2
  1044. data/lib/plaid/models/partner_customer_create_request.rb +53 -17
  1045. data/lib/plaid/models/partner_customer_create_response.rb +3 -2
  1046. data/lib/plaid/models/partner_customer_enable_request.rb +245 -0
  1047. data/lib/plaid/models/partner_customer_enable_response.rb +231 -0
  1048. data/lib/plaid/models/partner_customer_get_request.rb +3 -2
  1049. data/lib/plaid/models/partner_customer_get_response.rb +3 -2
  1050. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +245 -0
  1051. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +273 -0
  1052. data/lib/plaid/models/partner_customer_remove_request.rb +246 -0
  1053. data/lib/plaid/models/partner_customer_remove_response.rb +221 -0
  1054. data/lib/plaid/models/partner_end_customer.rb +27 -3
  1055. data/lib/plaid/models/partner_end_customer_address.rb +3 -2
  1056. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +239 -0
  1057. data/lib/plaid/models/partner_end_customer_billing_contact.rb +4 -3
  1058. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +248 -0
  1059. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +41 -0
  1060. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +260 -0
  1061. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +42 -0
  1062. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +251 -0
  1063. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +42 -0
  1064. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +336 -0
  1065. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +40 -0
  1066. data/lib/plaid/models/partner_end_customer_secrets.rb +18 -17
  1067. data/lib/plaid/models/partner_end_customer_status.rb +4 -3
  1068. data/lib/plaid/models/partner_end_customer_technical_contact.rb +3 -2
  1069. data/lib/plaid/models/partner_end_customer_with_secrets.rb +36 -4
  1070. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +219 -0
  1071. data/lib/plaid/models/party.rb +3 -2
  1072. data/lib/plaid/models/party_individual.rb +4 -3
  1073. data/lib/plaid/models/party_role_type.rb +2 -2
  1074. data/lib/plaid/models/pay.rb +3 -2
  1075. data/lib/plaid/models/pay_frequency.rb +25 -2
  1076. data/lib/plaid/models/pay_frequency_value.rb +2 -2
  1077. data/lib/plaid/models/pay_period_details.rb +4 -16
  1078. data/lib/plaid/models/pay_period_details_pay_frequency.rb +43 -0
  1079. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +3 -2
  1080. data/lib/plaid/models/pay_stub_deductions_total.rb +3 -2
  1081. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +3 -2
  1082. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +3 -2
  1083. data/lib/plaid/models/pay_stub_earnings_total.rb +3 -2
  1084. data/lib/plaid/models/pay_stub_pay_period_details.rb +35 -3
  1085. data/lib/plaid/models/pay_stub_taxpayer_id.rb +3 -2
  1086. data/lib/plaid/models/payment_amount.rb +25 -2
  1087. data/lib/plaid/models/payment_amount_currency.rb +2 -4
  1088. data/lib/plaid/models/payment_amount_nullable.rb +283 -0
  1089. data/lib/plaid/models/payment_amount_refunded.rb +290 -0
  1090. data/lib/plaid/models/payment_amount_to_refund.rb +290 -0
  1091. data/lib/plaid/models/payment_channel.rb +2 -2
  1092. data/lib/plaid/models/payment_consent_max_payment_amount.rb +25 -2
  1093. data/lib/plaid/models/payment_consent_periodic_alignment.rb +2 -2
  1094. data/lib/plaid/models/payment_consent_periodic_amount.rb +25 -2
  1095. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +25 -2
  1096. data/lib/plaid/models/payment_consent_periodic_interval.rb +2 -2
  1097. data/lib/plaid/models/payment_consent_valid_date_time.rb +3 -2
  1098. data/lib/plaid/models/payment_initiation_address.rb +4 -3
  1099. data/lib/plaid/models/payment_initiation_consent.rb +49 -12
  1100. data/lib/plaid/models/payment_initiation_consent_constraints.rb +3 -2
  1101. data/lib/plaid/models/payment_initiation_consent_create_request.rb +52 -40
  1102. data/lib/plaid/models/payment_initiation_consent_create_response.rb +25 -2
  1103. data/lib/plaid/models/payment_initiation_consent_get_request.rb +3 -23
  1104. data/lib/plaid/models/payment_initiation_consent_get_response.rb +46 -9
  1105. data/lib/plaid/models/payment_initiation_consent_payer_details.rb +306 -0
  1106. data/lib/plaid/models/payment_initiation_consent_payer_numbers.rb +231 -0
  1107. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +85 -28
  1108. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +39 -6
  1109. data/lib/plaid/models/payment_initiation_consent_processing_mode.rb +39 -0
  1110. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +3 -23
  1111. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +3 -2
  1112. data/lib/plaid/models/payment_initiation_consent_scope.rb +2 -2
  1113. data/lib/plaid/models/payment_initiation_consent_status.rb +2 -2
  1114. data/lib/plaid/models/payment_initiation_consent_status_update_webhook.rb +345 -0
  1115. data/lib/plaid/models/payment_initiation_consent_type.rb +39 -0
  1116. data/lib/plaid/models/payment_initiation_metadata.rb +23 -7
  1117. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +3 -2
  1118. data/lib/plaid/models/payment_initiation_payment.rb +71 -7
  1119. data/lib/plaid/models/payment_initiation_payment_create_request.rb +4 -24
  1120. data/lib/plaid/models/payment_initiation_payment_create_response.rb +25 -2
  1121. data/lib/plaid/models/payment_initiation_payment_create_status.rb +2 -2
  1122. data/lib/plaid/models/payment_initiation_payment_get_request.rb +3 -23
  1123. data/lib/plaid/models/payment_initiation_payment_get_response.rb +67 -3
  1124. data/lib/plaid/models/payment_initiation_payment_list_request.rb +3 -19
  1125. data/lib/plaid/models/payment_initiation_payment_list_response.rb +3 -2
  1126. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +43 -33
  1127. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +25 -2
  1128. data/lib/plaid/models/payment_initiation_payment_status.rb +2 -2
  1129. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +3 -23
  1130. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +3 -2
  1131. data/lib/plaid/models/payment_initiation_recipient.rb +3 -2
  1132. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +3 -2
  1133. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +3 -2
  1134. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +3 -23
  1135. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +3 -2
  1136. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +3 -2
  1137. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +73 -6
  1138. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +34 -6
  1139. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +3 -2
  1140. data/lib/plaid/models/payment_meta.rb +4 -3
  1141. data/lib/plaid/models/payment_profile_create_request.rb +3 -2
  1142. data/lib/plaid/models/payment_profile_create_response.rb +14 -13
  1143. data/lib/plaid/models/payment_profile_get_request.rb +14 -13
  1144. data/lib/plaid/models/payment_profile_get_response.rb +37 -3
  1145. data/lib/plaid/models/payment_profile_remove_request.rb +14 -13
  1146. data/lib/plaid/models/payment_profile_remove_response.rb +3 -2
  1147. data/lib/plaid/models/payment_profile_status.rb +2 -2
  1148. data/lib/plaid/models/payment_schedule_interval.rb +2 -2
  1149. data/lib/plaid/models/payment_scheme.rb +4 -3
  1150. data/lib/plaid/models/payment_status_update_webhook.rb +37 -3
  1151. data/lib/plaid/models/payroll_income_account_data.rb +3 -2
  1152. data/lib/plaid/models/payroll_income_object.rb +3 -2
  1153. data/lib/plaid/models/payroll_income_rate_of_pay.rb +3 -2
  1154. data/lib/plaid/models/payroll_item.rb +34 -3
  1155. data/lib/plaid/models/payroll_item_status.rb +3 -2
  1156. data/lib/plaid/models/payroll_risk_signals_item.rb +5 -4
  1157. data/lib/plaid/models/paystub.rb +3 -2
  1158. data/lib/plaid/models/paystub_address.rb +3 -2
  1159. data/lib/plaid/models/paystub_deduction.rb +3 -2
  1160. data/lib/plaid/models/paystub_details.rb +25 -2
  1161. data/lib/plaid/models/paystub_employer.rb +3 -2
  1162. data/lib/plaid/models/paystub_override.rb +32 -4
  1163. data/lib/plaid/models/paystub_override_deductions.rb +231 -0
  1164. data/lib/plaid/models/paystub_override_deductions_breakdown.rb +255 -0
  1165. data/lib/plaid/models/paystub_override_deductions_total.rb +244 -0
  1166. data/lib/plaid/models/paystub_override_distribution_breakdown.rb +277 -0
  1167. data/lib/plaid/models/paystub_override_earnings.rb +231 -0
  1168. data/lib/plaid/models/paystub_override_earnings_breakdown.rb +309 -0
  1169. data/lib/plaid/models/paystub_override_earnings_total.rb +244 -0
  1170. data/lib/plaid/models/paystub_override_employee.rb +27 -6
  1171. data/lib/plaid/models/paystub_override_employee_address.rb +3 -2
  1172. data/lib/plaid/models/paystub_override_employer.rb +17 -6
  1173. data/lib/plaid/models/paystub_override_employer_address.rb +261 -0
  1174. data/lib/plaid/models/paystub_override_net_pay.rb +244 -0
  1175. data/lib/plaid/models/paystub_override_pay_period_details.rb +320 -0
  1176. data/lib/plaid/models/paystub_override_taxpayer_id.rb +233 -0
  1177. data/lib/plaid/models/paystub_pay_frequency.rb +2 -2
  1178. data/lib/plaid/models/paystub_ytd_details.rb +3 -2
  1179. data/lib/plaid/models/pending_disconnect_webhook.rb +306 -0
  1180. data/lib/plaid/models/pending_disconnect_webhook_reason.rb +39 -0
  1181. data/lib/plaid/models/pending_expiration_webhook.rb +27 -4
  1182. data/lib/plaid/models/personal_finance_category.rb +29 -7
  1183. data/lib/plaid/models/phone_number.rb +3 -2
  1184. data/lib/plaid/models/phone_number_match_score.rb +13 -12
  1185. data/lib/plaid/models/phone_type.rb +2 -2
  1186. data/lib/plaid/models/physical_document_category.rb +3 -2
  1187. data/lib/plaid/models/physical_document_extracted_data.rb +61 -28
  1188. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +25 -2
  1189. data/lib/plaid/models/physical_document_images.rb +4 -7
  1190. data/lib/plaid/models/plaid_check_score.rb +245 -0
  1191. data/lib/plaid/models/plaid_check_score_version.rb +39 -0
  1192. data/lib/plaid/models/plaid_credit_score.rb +245 -0
  1193. data/lib/plaid/models/plaid_error.rb +20 -28
  1194. data/lib/plaid/models/plaid_error_type.rb +58 -0
  1195. data/lib/plaid/models/platform_ids.rb +3 -2
  1196. data/lib/plaid/models/po_box_status.rb +2 -2
  1197. data/lib/plaid/models/prism_cash_score.rb +278 -0
  1198. data/lib/plaid/models/prism_cash_score_metadata.rb +321 -0
  1199. data/lib/plaid/models/prism_cash_score_version.rb +41 -0
  1200. data/lib/plaid/models/prism_detect.rb +268 -0
  1201. data/lib/plaid/models/prism_detect_version.rb +39 -0
  1202. data/lib/plaid/models/prism_extend.rb +268 -0
  1203. data/lib/plaid/models/prism_extend_version.rb +39 -0
  1204. data/lib/plaid/models/prism_first_detect.rb +278 -0
  1205. data/lib/plaid/models/prism_first_detect_version.rb +39 -0
  1206. data/lib/plaid/models/prism_insights.rb +246 -0
  1207. data/lib/plaid/models/prism_insights_version.rb +40 -0
  1208. data/lib/plaid/models/prism_product.rb +39 -0
  1209. data/lib/plaid/models/prism_versions.rb +283 -0
  1210. data/lib/plaid/models/prism_versions_deprecated.rb +283 -0
  1211. data/lib/plaid/models/processor_account_get_request.rb +246 -0
  1212. data/lib/plaid/models/processor_account_get_response.rb +255 -0
  1213. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +3 -2
  1214. data/lib/plaid/models/processor_auth_get_request.rb +3 -2
  1215. data/lib/plaid/models/processor_auth_get_response.rb +3 -2
  1216. data/lib/plaid/models/processor_balance_get_request.rb +3 -2
  1217. data/lib/plaid/models/processor_balance_get_request_options.rb +5 -4
  1218. data/lib/plaid/models/processor_balance_get_response.rb +3 -2
  1219. data/lib/plaid/models/processor_bank_transfer_create_request.rb +26 -3
  1220. data/lib/plaid/models/processor_bank_transfer_create_response.rb +3 -2
  1221. data/lib/plaid/models/processor_default_update_webhook.rb +317 -0
  1222. data/lib/plaid/models/processor_historical_update_webhook.rb +317 -0
  1223. data/lib/plaid/models/processor_identity_get_request.rb +3 -2
  1224. data/lib/plaid/models/processor_identity_get_response.rb +3 -2
  1225. data/lib/plaid/models/processor_identity_match_request.rb +255 -0
  1226. data/lib/plaid/models/{deposit_switch_alt_create_response.rb → processor_identity_match_response.rb} +17 -17
  1227. data/lib/plaid/models/processor_initial_update_webhook.rb +318 -0
  1228. data/lib/plaid/models/processor_investments_holdings_get_request.rb +246 -0
  1229. data/lib/plaid/models/processor_investments_holdings_get_response.rb +284 -0
  1230. data/lib/plaid/models/processor_investments_transactions_get_request.rb +285 -0
  1231. data/lib/plaid/models/processor_investments_transactions_get_response.rb +299 -0
  1232. data/lib/plaid/models/processor_liabilities_get_request.rb +246 -0
  1233. data/lib/plaid/models/processor_liabilities_get_response.rb +254 -0
  1234. data/lib/plaid/models/processor_number.rb +3 -2
  1235. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +292 -0
  1236. data/lib/plaid/models/processor_signal_decision_report_request.rb +387 -0
  1237. data/lib/plaid/models/processor_signal_decision_report_response.rb +226 -0
  1238. data/lib/plaid/models/processor_signal_evaluate_request.rb +378 -0
  1239. data/lib/plaid/models/processor_signal_evaluate_response.rb +267 -0
  1240. data/lib/plaid/models/processor_signal_prepare_request.rb +246 -0
  1241. data/lib/plaid/models/processor_signal_prepare_response.rb +226 -0
  1242. data/lib/plaid/models/processor_signal_return_report_request.rb +317 -0
  1243. data/lib/plaid/models/processor_signal_return_report_response.rb +226 -0
  1244. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +3 -2
  1245. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +3 -2
  1246. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +322 -0
  1247. data/lib/plaid/models/processor_token_create_request.rb +5 -4
  1248. data/lib/plaid/models/processor_token_create_response.rb +3 -2
  1249. data/lib/plaid/models/processor_token_permissions_get_request.rb +246 -0
  1250. data/lib/plaid/models/processor_token_permissions_get_response.rb +243 -0
  1251. data/lib/plaid/models/processor_token_permissions_set_request.rb +263 -0
  1252. data/lib/plaid/models/processor_token_permissions_set_response.rb +226 -0
  1253. data/lib/plaid/models/processor_token_webhook_update.rb +317 -0
  1254. data/lib/plaid/models/processor_token_webhook_update_request.rb +257 -0
  1255. data/lib/plaid/models/processor_token_webhook_update_response.rb +226 -0
  1256. data/lib/plaid/models/processor_transactions_get_request.rb +285 -0
  1257. data/lib/plaid/models/processor_transactions_get_request_options.rb +327 -0
  1258. data/lib/plaid/models/processor_transactions_get_response.rb +272 -0
  1259. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +255 -0
  1260. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +285 -0
  1261. data/lib/plaid/models/processor_transactions_refresh_request.rb +246 -0
  1262. data/lib/plaid/models/processor_transactions_refresh_response.rb +226 -0
  1263. data/lib/plaid/models/processor_transactions_removed_webhook.rb +319 -0
  1264. data/lib/plaid/models/{deposit_switch_create_request.rb → processor_transactions_sync_request.rb} +59 -70
  1265. data/lib/plaid/models/processor_transactions_sync_response.rb +353 -0
  1266. data/lib/plaid/models/product_access.rb +8 -7
  1267. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +292 -0
  1268. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +292 -0
  1269. data/lib/plaid/models/product_status.rb +3 -2
  1270. data/lib/plaid/models/product_status_breakdown.rb +4 -3
  1271. data/lib/plaid/models/products.rb +22 -3
  1272. data/lib/plaid/models/profile_network_status_get_request.rb +245 -0
  1273. data/lib/plaid/models/profile_network_status_get_response.rb +262 -0
  1274. data/lib/plaid/models/program_name_sensitivity.rb +2 -2
  1275. data/lib/plaid/models/projected_income_summary_field_number.rb +25 -2
  1276. data/lib/plaid/models/protect_event.rb +275 -0
  1277. data/lib/plaid/models/protect_event_get_request.rb +246 -0
  1278. data/lib/plaid/models/protect_event_get_response.rb +279 -0
  1279. data/lib/plaid/models/protect_event_send_request.rb +271 -0
  1280. data/lib/plaid/models/protect_event_send_response.rb +264 -0
  1281. data/lib/plaid/models/protect_user_event_webhook.rb +297 -0
  1282. data/lib/plaid/models/protect_user_insights_get_request.rb +251 -0
  1283. data/lib/plaid/models/protect_user_insights_get_response.rb +251 -0
  1284. data/lib/plaid/models/proxy_type.rb +42 -0
  1285. data/lib/plaid/models/pslf_status.rb +6 -5
  1286. data/lib/plaid/models/reason_code.rb +52 -0
  1287. data/lib/plaid/models/recaptcha_required_error.rb +5 -4
  1288. data/lib/plaid/models/recipient_bacs.rb +3 -2
  1289. data/lib/plaid/models/recipient_bacs_nullable.rb +3 -2
  1290. data/lib/plaid/models/recommendation_string.rb +40 -0
  1291. data/lib/plaid/models/recurrence.rb +254 -0
  1292. data/lib/plaid/models/recurring_cancelled_webhook.rb +292 -0
  1293. data/lib/plaid/models/recurring_frequency.rb +46 -0
  1294. data/lib/plaid/models/recurring_insights_stream.rb +401 -0
  1295. data/lib/plaid/models/recurring_new_transfer_webhook.rb +307 -0
  1296. data/lib/plaid/models/recurring_transaction_frequency.rb +3 -2
  1297. data/lib/plaid/models/recurring_transactions.rb +245 -0
  1298. data/lib/plaid/models/recurring_transactions_update_webhook.rb +26 -3
  1299. data/lib/plaid/models/recurring_transfer.rb +471 -0
  1300. data/lib/plaid/models/recurring_transfer_nullable.rb +478 -0
  1301. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +330 -0
  1302. data/lib/plaid/models/refresh_result.rb +241 -0
  1303. data/lib/plaid/models/removed_transaction.rb +27 -6
  1304. data/lib/plaid/models/report_type.rb +3 -4
  1305. data/lib/plaid/models/reporting_information.rb +4 -3
  1306. data/lib/plaid/models/risk_check_behavior.rb +284 -0
  1307. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +40 -0
  1308. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +40 -0
  1309. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +41 -0
  1310. data/lib/plaid/models/risk_check_details.rb +314 -0
  1311. data/lib/plaid/models/risk_check_device.rb +286 -0
  1312. data/lib/plaid/models/risk_check_email.rb +397 -0
  1313. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +40 -0
  1314. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +40 -0
  1315. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +40 -0
  1316. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +40 -0
  1317. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +40 -0
  1318. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +231 -0
  1319. data/lib/plaid/models/risk_check_linked_service.rb +127 -0
  1320. data/lib/plaid/models/risk_check_network.rb +264 -0
  1321. data/lib/plaid/models/risk_check_phone.rb +283 -0
  1322. data/lib/plaid/models/risk_check_stolen_identity.rb +257 -0
  1323. data/lib/plaid/models/risk_check_synthetic_identity.rb +277 -0
  1324. data/lib/plaid/models/risk_level.rb +40 -0
  1325. data/lib/plaid/models/risk_level_with_no_data.rb +41 -0
  1326. data/lib/plaid/models/risk_profile.rb +231 -0
  1327. data/lib/plaid/models/risk_reason.rb +241 -0
  1328. data/lib/plaid/models/risk_signal_document_reference.rb +58 -6
  1329. data/lib/plaid/models/risk_signal_document_status.rb +42 -0
  1330. data/lib/plaid/models/risk_signal_document_type.rb +49 -0
  1331. data/lib/plaid/models/risk_signal_file_type.rb +45 -0
  1332. data/lib/plaid/models/role.rb +4 -3
  1333. data/lib/plaid/models/role_detail.rb +26 -3
  1334. data/lib/plaid/models/roles.rb +4 -3
  1335. data/lib/plaid/models/rule_details.rb +231 -0
  1336. data/lib/plaid/models/rule_result.rb +40 -0
  1337. data/lib/plaid/models/ruleset.rb +277 -0
  1338. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +291 -0
  1339. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +226 -0
  1340. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +39 -0
  1341. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +257 -0
  1342. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +3 -2
  1343. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +3 -2
  1344. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +3 -2
  1345. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +3 -2
  1346. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_request.rb +268 -0
  1347. data/lib/plaid/models/sandbox_cra_cashflow_updates_update_response.rb +226 -0
  1348. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +20 -10
  1349. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +3 -2
  1350. data/lib/plaid/models/sandbox_income_webhook_fire_request_webhook_code.rb +39 -0
  1351. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +5 -4
  1352. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +3 -2
  1353. data/lib/plaid/models/sandbox_item_reset_login_request.rb +3 -2
  1354. data/lib/plaid/models/sandbox_item_reset_login_response.rb +3 -2
  1355. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +3 -2
  1356. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +3 -2
  1357. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +3 -2
  1358. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +246 -0
  1359. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +241 -0
  1360. data/lib/plaid/models/sandbox_payment_simulate_request.rb +276 -0
  1361. data/lib/plaid/models/sandbox_payment_simulate_response.rb +276 -0
  1362. data/lib/plaid/models/sandbox_processor_token_create_request.rb +3 -2
  1363. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +3 -2
  1364. data/lib/plaid/models/sandbox_processor_token_create_response.rb +3 -2
  1365. data/lib/plaid/models/sandbox_public_token_create_request.rb +3 -2
  1366. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +221 -0
  1367. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +26 -6
  1368. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +232 -0
  1369. data/lib/plaid/models/sandbox_public_token_create_request_options_statements.rb +241 -0
  1370. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +45 -6
  1371. data/lib/plaid/models/sandbox_public_token_create_response.rb +3 -2
  1372. data/lib/plaid/models/sandbox_transactions_create_request.rb +263 -0
  1373. data/lib/plaid/models/sandbox_transactions_create_response.rb +226 -0
  1374. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +3 -2
  1375. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +3 -2
  1376. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +292 -0
  1377. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +226 -0
  1378. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +274 -0
  1379. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +226 -0
  1380. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +292 -0
  1381. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +226 -0
  1382. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +292 -0
  1383. data/lib/plaid/models/sandbox_transfer_refund_simulate_response.rb +226 -0
  1384. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +3 -2
  1385. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +3 -2
  1386. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +30 -8
  1387. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +3 -2
  1388. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +28 -6
  1389. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +3 -2
  1390. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +261 -0
  1391. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +226 -0
  1392. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +242 -0
  1393. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +240 -0
  1394. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +246 -0
  1395. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +240 -0
  1396. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +321 -0
  1397. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +242 -0
  1398. data/lib/plaid/models/sandbox_user_reset_login_request.rb +259 -0
  1399. data/lib/plaid/models/sandbox_user_reset_login_response.rb +226 -0
  1400. data/lib/plaid/models/scopes.rb +3 -2
  1401. data/lib/plaid/models/scopes_context.rb +2 -2
  1402. data/lib/plaid/models/scopes_nullable.rb +3 -2
  1403. data/lib/plaid/models/screening_hit_analysis.rb +26 -3
  1404. data/lib/plaid/models/screening_hit_data.rb +3 -2
  1405. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +3 -2
  1406. data/lib/plaid/models/screening_hit_documents_items.rb +3 -2
  1407. data/lib/plaid/models/screening_hit_names_items.rb +3 -2
  1408. data/lib/plaid/models/screening_status_updated_webhook.rb +31 -4
  1409. data/lib/plaid/models/security.rb +79 -14
  1410. data/lib/plaid/models/security_override.rb +7 -6
  1411. data/lib/plaid/models/selfie_analysis.rb +271 -0
  1412. data/lib/plaid/models/selfie_analysis_document_comparison.rb +40 -0
  1413. data/lib/plaid/models/selfie_analysis_facial_analysis.rb +401 -0
  1414. data/lib/plaid/models/selfie_analysis_facial_analysis_outcome.rb +39 -0
  1415. data/lib/plaid/models/selfie_analysis_liveness_check.rb +39 -0
  1416. data/lib/plaid/models/selfie_capture.rb +233 -0
  1417. data/lib/plaid/models/selfie_check.rb +264 -0
  1418. data/lib/plaid/models/selfie_check_selfie.rb +290 -0
  1419. data/lib/plaid/models/selfie_check_status.rb +39 -0
  1420. data/lib/plaid/models/selfie_status.rb +39 -0
  1421. data/lib/plaid/models/sender_bacs_nullable.rb +3 -2
  1422. data/lib/plaid/models/service.rb +3 -2
  1423. data/lib/plaid/models/service_product_fulfillment.rb +3 -2
  1424. data/lib/plaid/models/service_product_fulfillment_detail.rb +26 -3
  1425. data/lib/plaid/models/service_product_fulfillment_identifier.rb +3 -2
  1426. data/lib/plaid/models/servicer_address_data.rb +3 -2
  1427. data/lib/plaid/models/services.rb +3 -2
  1428. data/lib/plaid/models/session_token_create_request.rb +294 -0
  1429. data/lib/plaid/models/session_token_create_request_user.rb +236 -0
  1430. data/lib/plaid/models/session_token_create_response.rb +235 -0
  1431. data/lib/plaid/models/session_token_create_response_link.rb +251 -0
  1432. data/lib/plaid/models/signal_address_data.rb +3 -2
  1433. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  1434. data/lib/plaid/models/signal_decision_report_request.rb +73 -9
  1435. data/lib/plaid/models/signal_decision_report_response.rb +3 -2
  1436. data/lib/plaid/models/signal_device.rb +4 -3
  1437. data/lib/plaid/models/signal_evaluate_core_attributes.rb +195 -7
  1438. data/lib/plaid/models/signal_evaluate_request.rb +54 -26
  1439. data/lib/plaid/models/signal_evaluate_response.rb +44 -10
  1440. data/lib/plaid/models/signal_payment_method.rb +42 -0
  1441. data/lib/plaid/models/signal_person_name.rb +3 -2
  1442. data/lib/plaid/models/signal_prepare_request.rb +3 -2
  1443. data/lib/plaid/models/signal_prepare_response.rb +3 -2
  1444. data/lib/plaid/models/signal_return_report_request.rb +20 -8
  1445. data/lib/plaid/models/signal_return_report_response.rb +3 -2
  1446. data/lib/plaid/models/signal_schedule_default_payment_method.rb +40 -0
  1447. data/lib/plaid/models/signal_schedule_recommendation.rb +263 -0
  1448. data/lib/plaid/models/signal_schedule_request.rb +352 -0
  1449. data/lib/plaid/models/signal_schedule_response.rb +271 -0
  1450. data/lib/plaid/models/signal_scores.rb +3 -2
  1451. data/lib/plaid/models/signal_user.rb +4 -3
  1452. data/lib/plaid/models/signal_warning.rb +241 -0
  1453. data/lib/plaid/models/simulated_transfer_sweep.rb +118 -7
  1454. data/lib/plaid/models/single_document_risk_signal.rb +21 -6
  1455. data/lib/plaid/models/sms_verification.rb +336 -0
  1456. data/lib/plaid/models/sms_verification_status.rb +41 -0
  1457. data/lib/plaid/models/source.rb +2 -2
  1458. data/lib/plaid/models/standalone_account_type.rb +20 -9
  1459. data/lib/plaid/models/standalone_currency_code_list.rb +3 -2
  1460. data/lib/plaid/models/standalone_investment_transaction_type.rb +3 -2
  1461. data/lib/plaid/models/statements_account.rb +318 -0
  1462. data/lib/plaid/models/statements_download_request.rb +261 -0
  1463. data/lib/plaid/models/statements_list_request.rb +246 -0
  1464. data/lib/plaid/models/statements_list_response.rb +287 -0
  1465. data/lib/plaid/models/statements_refresh_complete_result.rb +39 -0
  1466. data/lib/plaid/models/statements_refresh_complete_webhook.rb +306 -0
  1467. data/lib/plaid/models/statements_refresh_request.rb +276 -0
  1468. data/lib/plaid/models/statements_refresh_response.rb +226 -0
  1469. data/lib/plaid/models/statements_statement.rb +288 -0
  1470. data/lib/plaid/models/status.rb +4 -3
  1471. data/lib/plaid/models/statuses.rb +3 -2
  1472. data/lib/plaid/models/strategy.rb +2 -2
  1473. data/lib/plaid/models/student_loan.rb +18 -6
  1474. data/lib/plaid/models/student_loan_repayment_model.rb +3 -2
  1475. data/lib/plaid/models/student_loan_status.rb +5 -4
  1476. data/lib/plaid/models/student_repayment_plan.rb +5 -4
  1477. data/lib/plaid/models/sweep_failure.rb +233 -0
  1478. data/lib/plaid/models/sweep_status.rb +44 -0
  1479. data/lib/plaid/models/sweep_trigger.rb +41 -0
  1480. data/lib/plaid/models/sync_updates_available_webhook.rb +28 -5
  1481. data/lib/plaid/models/synthetic_fraud.rb +247 -0
  1482. data/lib/plaid/models/taxform.rb +3 -2
  1483. data/lib/plaid/models/taxpayer_id.rb +3 -2
  1484. data/lib/plaid/models/taxpayer_identifier.rb +26 -3
  1485. data/lib/plaid/models/taxpayer_identifier_type.rb +2 -2
  1486. data/lib/plaid/models/taxpayer_identifiers.rb +4 -3
  1487. data/lib/plaid/models/total.rb +25 -2
  1488. data/lib/plaid/models/total_canonical_description.rb +2 -2
  1489. data/lib/plaid/models/total_inflow_amount.rb +248 -0
  1490. data/lib/plaid/models/total_inflow_amount30d.rb +248 -0
  1491. data/lib/plaid/models/total_inflow_amount60d.rb +248 -0
  1492. data/lib/plaid/models/total_inflow_amount90d.rb +248 -0
  1493. data/lib/plaid/models/total_monthly_income_insights.rb +241 -0
  1494. data/lib/plaid/models/total_outflow_amount.rb +248 -0
  1495. data/lib/plaid/models/total_outflow_amount30d.rb +248 -0
  1496. data/lib/plaid/models/total_outflow_amount60d.rb +248 -0
  1497. data/lib/plaid/models/total_outflow_amount90d.rb +248 -0
  1498. data/lib/plaid/models/total_report_inflow_amount.rb +248 -0
  1499. data/lib/plaid/models/total_report_inflow_amount30d.rb +248 -0
  1500. data/lib/plaid/models/total_report_inflow_amount60d.rb +248 -0
  1501. data/lib/plaid/models/total_report_inflow_amount90d.rb +248 -0
  1502. data/lib/plaid/models/total_report_outflow_amount.rb +248 -0
  1503. data/lib/plaid/models/total_report_outflow_amount30d.rb +248 -0
  1504. data/lib/plaid/models/total_report_outflow_amount60d.rb +248 -0
  1505. data/lib/plaid/models/total_report_outflow_amount90d.rb +248 -0
  1506. data/lib/plaid/models/transaction.rb +214 -138
  1507. data/lib/plaid/models/transaction_all_of.rb +77 -23
  1508. data/lib/plaid/models/transaction_base.rb +130 -107
  1509. data/lib/plaid/models/transaction_code.rb +2 -2
  1510. data/lib/plaid/models/transaction_counterparty.rb +316 -0
  1511. data/lib/plaid/models/transaction_data.rb +3 -2
  1512. data/lib/plaid/models/transaction_override.rb +3 -2
  1513. data/lib/plaid/models/transaction_stream.rb +79 -28
  1514. data/lib/plaid/models/transaction_stream_amount.rb +3 -2
  1515. data/lib/plaid/models/transaction_stream_status.rb +2 -2
  1516. data/lib/plaid/models/transactions_category_rule.rb +4 -3
  1517. data/lib/plaid/models/transactions_enhance_get_request.rb +3 -2
  1518. data/lib/plaid/models/transactions_enhance_get_response.rb +4 -3
  1519. data/lib/plaid/models/transactions_enrich_request.rb +272 -0
  1520. data/lib/plaid/models/transactions_enrich_request_options.rb +233 -0
  1521. data/lib/plaid/models/transactions_enrich_response.rb +238 -0
  1522. data/lib/plaid/models/transactions_get_request.rb +3 -2
  1523. data/lib/plaid/models/transactions_get_request_options.rb +70 -9
  1524. data/lib/plaid/models/transactions_get_response.rb +3 -2
  1525. data/lib/plaid/models/transactions_recurring_create_input.rb +223 -0
  1526. data/lib/plaid/models/transactions_recurring_create_request.rb +263 -0
  1527. data/lib/plaid/models/transactions_recurring_create_response.rb +252 -0
  1528. data/lib/plaid/models/transactions_recurring_get_request.rb +4 -8
  1529. data/lib/plaid/models/transactions_recurring_get_request_options.rb +18 -7
  1530. data/lib/plaid/models/transactions_recurring_get_response.rb +14 -3
  1531. data/lib/plaid/models/transactions_recurring_merge_input.rb +228 -0
  1532. data/lib/plaid/models/transactions_recurring_merge_request.rb +263 -0
  1533. data/lib/plaid/models/transactions_recurring_merge_response.rb +240 -0
  1534. data/lib/plaid/models/transactions_recurring_update_input.rb +243 -0
  1535. data/lib/plaid/models/transactions_recurring_update_request.rb +263 -0
  1536. data/lib/plaid/models/transactions_recurring_update_response.rb +240 -0
  1537. data/lib/plaid/models/transactions_refresh_request.rb +3 -2
  1538. data/lib/plaid/models/transactions_refresh_response.rb +3 -2
  1539. data/lib/plaid/models/transactions_removed_webhook.rb +26 -3
  1540. data/lib/plaid/models/transactions_rule_details.rb +26 -3
  1541. data/lib/plaid/models/transactions_rule_field.rb +2 -2
  1542. data/lib/plaid/models/transactions_rule_type.rb +2 -2
  1543. data/lib/plaid/models/transactions_rules_create_request.rb +4 -3
  1544. data/lib/plaid/models/transactions_rules_create_response.rb +3 -2
  1545. data/lib/plaid/models/transactions_rules_list_request.rb +3 -2
  1546. data/lib/plaid/models/transactions_rules_list_response.rb +3 -2
  1547. data/lib/plaid/models/transactions_rules_remove_request.rb +3 -2
  1548. data/lib/plaid/models/transactions_rules_remove_response.rb +3 -2
  1549. data/lib/plaid/models/transactions_sync_request.rb +4 -3
  1550. data/lib/plaid/models/transactions_sync_request_options.rb +79 -8
  1551. data/lib/plaid/models/transactions_sync_response.rb +62 -8
  1552. data/lib/plaid/models/transactions_update_status.rb +41 -0
  1553. data/lib/plaid/models/transactions_user_insights_get_request.rb +246 -0
  1554. data/lib/plaid/models/transactions_user_insights_get_response.rb +252 -0
  1555. data/lib/plaid/models/transfer.rb +186 -18
  1556. data/lib/plaid/models/transfer_ach_network.rb +39 -0
  1557. data/lib/plaid/models/transfer_authorization.rb +37 -4
  1558. data/lib/plaid/models/transfer_authorization_cancel_request.rb +246 -0
  1559. data/lib/plaid/models/transfer_authorization_cancel_response.rb +226 -0
  1560. data/lib/plaid/models/transfer_authorization_create_request.rb +145 -32
  1561. data/lib/plaid/models/transfer_authorization_create_response.rb +3 -2
  1562. data/lib/plaid/models/transfer_authorization_decision.rb +3 -2
  1563. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +25 -2
  1564. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +5 -3
  1565. data/lib/plaid/models/transfer_authorization_device.rb +6 -5
  1566. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +2 -2
  1567. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +25 -2
  1568. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +2 -2
  1569. data/lib/plaid/models/transfer_authorization_payment_risk.rb +334 -0
  1570. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +87 -17
  1571. data/lib/plaid/models/transfer_authorization_risk_level.rb +42 -0
  1572. data/lib/plaid/models/transfer_authorization_user_in_request.rb +7 -6
  1573. data/lib/plaid/models/transfer_balance.rb +272 -0
  1574. data/lib/plaid/models/transfer_balance_get_request.rb +273 -0
  1575. data/lib/plaid/models/transfer_balance_get_response.rb +240 -0
  1576. data/lib/plaid/models/transfer_balance_type.rb +39 -0
  1577. data/lib/plaid/models/transfer_cancel_request.rb +49 -6
  1578. data/lib/plaid/models/transfer_cancel_response.rb +3 -2
  1579. data/lib/plaid/models/transfer_capabilities_get_request.rb +271 -0
  1580. data/lib/plaid/models/transfer_capabilities_get_response.rb +240 -0
  1581. data/lib/plaid/models/transfer_capabilities_get_rf_p.rb +245 -0
  1582. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +223 -0
  1583. data/lib/plaid/models/{deposit_switch_token_create_request.rb → transfer_configuration_get_request.rb} +16 -19
  1584. data/lib/plaid/models/transfer_configuration_get_response.rb +361 -0
  1585. data/lib/plaid/models/transfer_create_request.rb +42 -19
  1586. data/lib/plaid/models/transfer_create_response.rb +3 -2
  1587. data/lib/plaid/models/transfer_credit_funds_source.rb +41 -0
  1588. data/lib/plaid/models/transfer_credit_usage_configuration.rb +309 -0
  1589. data/lib/plaid/models/transfer_debit_usage_configuration.rb +309 -0
  1590. data/lib/plaid/models/transfer_device.rb +241 -0
  1591. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +277 -0
  1592. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +226 -0
  1593. data/lib/plaid/models/transfer_diligence_status.rb +43 -0
  1594. data/lib/plaid/models/transfer_diligence_submit_request.rb +260 -0
  1595. data/lib/plaid/models/transfer_diligence_submit_response.rb +226 -0
  1596. data/lib/plaid/models/transfer_document_purpose.rb +38 -0
  1597. data/lib/plaid/models/transfer_event.rb +101 -27
  1598. data/lib/plaid/models/transfer_event_list_request.rb +54 -9
  1599. data/lib/plaid/models/transfer_event_list_response.rb +19 -3
  1600. data/lib/plaid/models/transfer_event_list_transfer_type.rb +2 -2
  1601. data/lib/plaid/models/transfer_event_sync_request.rb +3 -2
  1602. data/lib/plaid/models/transfer_event_sync_response.rb +19 -3
  1603. data/lib/plaid/models/transfer_event_type.rb +17 -2
  1604. data/lib/plaid/models/transfer_events_update_webhook.rb +26 -3
  1605. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +241 -0
  1606. data/lib/plaid/models/transfer_failure.rb +15 -3
  1607. data/lib/plaid/models/transfer_funding_account.rb +241 -0
  1608. data/lib/plaid/models/transfer_funding_account_with_display_name.rb +259 -0
  1609. data/lib/plaid/models/transfer_funding_account_with_display_name_all_of.rb +220 -0
  1610. data/lib/plaid/models/transfer_get_request.rb +28 -11
  1611. data/lib/plaid/models/transfer_get_response.rb +3 -2
  1612. data/lib/plaid/models/transfer_intent_authorization_decision.rb +2 -2
  1613. data/lib/plaid/models/transfer_intent_create.rb +55 -11
  1614. data/lib/plaid/models/transfer_intent_create_mode.rb +2 -2
  1615. data/lib/plaid/models/transfer_intent_create_network.rb +40 -0
  1616. data/lib/plaid/models/transfer_intent_create_request.rb +57 -17
  1617. data/lib/plaid/models/transfer_intent_create_response.rb +3 -2
  1618. data/lib/plaid/models/transfer_intent_get.rb +54 -10
  1619. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +3 -2
  1620. data/lib/plaid/models/transfer_intent_get_request.rb +3 -2
  1621. data/lib/plaid/models/transfer_intent_get_response.rb +3 -2
  1622. data/lib/plaid/models/transfer_intent_status.rb +2 -2
  1623. data/lib/plaid/models/transfer_ledger_balance.rb +241 -0
  1624. data/lib/plaid/models/transfer_ledger_deposit_request.rb +379 -0
  1625. data/lib/plaid/models/transfer_ledger_deposit_response.rb +240 -0
  1626. data/lib/plaid/models/transfer_ledger_distribute_request.rb +322 -0
  1627. data/lib/plaid/models/transfer_ledger_distribute_response.rb +226 -0
  1628. data/lib/plaid/models/transfer_ledger_event.rb +364 -0
  1629. data/lib/plaid/models/transfer_ledger_event_list_request.rb +398 -0
  1630. data/lib/plaid/models/transfer_ledger_event_list_response.rb +257 -0
  1631. data/lib/plaid/models/transfer_ledger_get_request.rb +253 -0
  1632. data/lib/plaid/models/transfer_ledger_get_response.rb +285 -0
  1633. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +41 -0
  1634. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +379 -0
  1635. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +240 -0
  1636. data/lib/plaid/models/transfer_list_request.rb +32 -9
  1637. data/lib/plaid/models/transfer_list_response.rb +3 -2
  1638. data/lib/plaid/models/transfer_metrics_get_authorization_usage.rb +251 -0
  1639. data/lib/plaid/models/transfer_metrics_get_request.rb +242 -0
  1640. data/lib/plaid/models/transfer_metrics_get_response.rb +336 -0
  1641. data/lib/plaid/models/transfer_metrics_get_return_rates.rb +221 -0
  1642. data/lib/plaid/models/transfer_metrics_get_return_rates_over_interval.rb +241 -0
  1643. data/lib/plaid/models/transfer_migrate_account_request.rb +4 -3
  1644. data/lib/plaid/models/transfer_migrate_account_response.rb +3 -2
  1645. data/lib/plaid/models/transfer_network.rb +4 -2
  1646. data/lib/plaid/models/{deposit_switch_address_data.rb → transfer_originator_address.rb} +36 -35
  1647. data/lib/plaid/models/transfer_originator_create_request.rb +267 -0
  1648. data/lib/plaid/models/{deposit_switch_token_create_response.rb → transfer_originator_create_response.rb} +28 -27
  1649. data/lib/plaid/models/transfer_originator_diligence.rb +370 -0
  1650. data/lib/plaid/models/transfer_originator_funding_account_create_request.rb +260 -0
  1651. data/lib/plaid/models/transfer_originator_funding_account_create_response.rb +236 -0
  1652. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +260 -0
  1653. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +226 -0
  1654. data/lib/plaid/models/transfer_originator_get_request.rb +246 -0
  1655. data/lib/plaid/models/transfer_originator_get_response.rb +240 -0
  1656. data/lib/plaid/models/transfer_originator_list_request.rb +300 -0
  1657. data/lib/plaid/models/transfer_originator_list_response.rb +242 -0
  1658. data/lib/plaid/models/transfer_platform_onboarding_update_webhook.rb +292 -0
  1659. data/lib/plaid/models/transfer_platform_originator_create_request.rb +285 -0
  1660. data/lib/plaid/models/transfer_platform_originator_create_response.rb +226 -0
  1661. data/lib/plaid/models/transfer_platform_person_address.rb +296 -0
  1662. data/lib/plaid/models/transfer_platform_person_create_request.rb +359 -0
  1663. data/lib/plaid/models/transfer_platform_person_create_response.rb +241 -0
  1664. data/lib/plaid/models/transfer_platform_person_id_number.rb +262 -0
  1665. data/lib/plaid/models/transfer_platform_person_name.rb +241 -0
  1666. data/lib/plaid/models/transfer_platform_requirement.rb +232 -0
  1667. data/lib/plaid/models/transfer_platform_requirement_submission.rb +251 -0
  1668. data/lib/plaid/models/transfer_platform_requirement_submit_request.rb +285 -0
  1669. data/lib/plaid/models/transfer_platform_requirement_submit_response.rb +226 -0
  1670. data/lib/plaid/models/transfer_platform_tos_acceptance_metadata.rb +256 -0
  1671. data/lib/plaid/models/transfer_questionnaire_create_request.rb +261 -0
  1672. data/lib/plaid/models/transfer_questionnaire_create_response.rb +241 -0
  1673. data/lib/plaid/models/transfer_recurring_cancel_request.rb +246 -0
  1674. data/lib/plaid/models/transfer_recurring_cancel_response.rb +226 -0
  1675. data/lib/plaid/models/transfer_recurring_create_request.rb +466 -0
  1676. data/lib/plaid/models/transfer_recurring_create_response.rb +281 -0
  1677. data/lib/plaid/models/transfer_recurring_get_request.rb +246 -0
  1678. data/lib/plaid/models/transfer_recurring_get_response.rb +240 -0
  1679. data/lib/plaid/models/transfer_recurring_list_request.rb +331 -0
  1680. data/lib/plaid/models/transfer_recurring_list_response.rb +242 -0
  1681. data/lib/plaid/models/transfer_recurring_network.rb +40 -0
  1682. data/lib/plaid/models/transfer_recurring_schedule.rb +303 -0
  1683. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  1684. data/lib/plaid/models/transfer_refund.rb +339 -0
  1685. data/lib/plaid/models/transfer_refund_cancel_request.rb +246 -0
  1686. data/lib/plaid/models/transfer_refund_cancel_response.rb +226 -0
  1687. data/lib/plaid/models/transfer_refund_create_request.rb +297 -0
  1688. data/lib/plaid/models/transfer_refund_create_response.rb +240 -0
  1689. data/lib/plaid/models/transfer_refund_failure.rb +243 -0
  1690. data/lib/plaid/models/transfer_refund_get_request.rb +246 -0
  1691. data/lib/plaid/models/transfer_refund_get_response.rb +240 -0
  1692. data/lib/plaid/models/transfer_refund_status.rb +43 -0
  1693. data/lib/plaid/models/transfer_repayment.rb +3 -2
  1694. data/lib/plaid/models/transfer_repayment_list_request.rb +5 -4
  1695. data/lib/plaid/models/transfer_repayment_list_response.rb +3 -2
  1696. data/lib/plaid/models/transfer_repayment_return.rb +3 -2
  1697. data/lib/plaid/models/transfer_repayment_return_list_request.rb +3 -2
  1698. data/lib/plaid/models/transfer_repayment_return_list_response.rb +3 -2
  1699. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  1700. data/lib/plaid/models/transfer_status.rb +3 -2
  1701. data/lib/plaid/models/transfer_sweep.rb +118 -7
  1702. data/lib/plaid/models/transfer_sweep_get_request.rb +4 -3
  1703. data/lib/plaid/models/transfer_sweep_get_response.rb +3 -2
  1704. data/lib/plaid/models/transfer_sweep_list_request.rb +95 -8
  1705. data/lib/plaid/models/transfer_sweep_list_response.rb +3 -2
  1706. data/lib/plaid/models/transfer_sweep_status.rb +2 -2
  1707. data/lib/plaid/models/transfer_test_clock.rb +241 -0
  1708. data/lib/plaid/models/transfer_type.rb +2 -2
  1709. data/lib/plaid/models/transfer_user_address_in_request.rb +4 -3
  1710. data/lib/plaid/models/transfer_user_address_in_response.rb +3 -2
  1711. data/lib/plaid/models/transfer_user_in_request.rb +4 -3
  1712. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +3 -14
  1713. data/lib/plaid/models/transfer_user_in_response.rb +3 -2
  1714. data/lib/plaid/models/transfer_wire_details.rb +233 -0
  1715. data/lib/plaid/models/trust_index.rb +251 -0
  1716. data/lib/plaid/models/trust_index_subscore.rb +226 -0
  1717. data/lib/plaid/models/trust_index_subscores.rb +231 -0
  1718. data/lib/plaid/models/trusted_device_data.rb +229 -0
  1719. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +10 -90
  1720. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +5 -55
  1721. data/lib/plaid/models/{deposit_switch_target_user.rb → user_account_identity.rb} +58 -62
  1722. data/lib/plaid/models/user_account_identity_address.rb +277 -0
  1723. data/lib/plaid/models/user_account_identity_name.rb +229 -0
  1724. data/lib/plaid/models/user_account_item.rb +231 -0
  1725. data/lib/plaid/models/user_account_revoked_webhook.rb +307 -0
  1726. data/lib/plaid/models/user_account_session_get_request.rb +246 -0
  1727. data/lib/plaid/models/user_account_session_get_response.rb +252 -0
  1728. data/lib/plaid/models/user_address.rb +11 -47
  1729. data/lib/plaid/models/user_create_request.rb +84 -7
  1730. data/lib/plaid/models/user_create_response.rb +3 -7
  1731. data/lib/plaid/models/user_custom_password.rb +4 -3
  1732. data/lib/plaid/models/{account_assets_all_of.rb → user_data_overview.rb} +71 -45
  1733. data/lib/plaid/models/user_financial_data_refresh_request.rb +246 -0
  1734. data/lib/plaid/models/user_financial_data_refresh_response.rb +242 -0
  1735. data/lib/plaid/models/user_id_number.rb +26 -3
  1736. data/lib/plaid/models/user_items_associate_request.rb +263 -0
  1737. data/lib/plaid/models/user_items_associate_response.rb +226 -0
  1738. data/lib/plaid/models/user_items_get_request.rb +246 -0
  1739. data/lib/plaid/models/user_items_get_response.rb +242 -0
  1740. data/lib/plaid/models/user_items_list_request.rb +285 -0
  1741. data/lib/plaid/models/user_items_list_response.rb +254 -0
  1742. data/lib/plaid/models/user_permission_revoked_webhook.rb +26 -3
  1743. data/lib/plaid/models/user_remove_request.rb +251 -0
  1744. data/lib/plaid/models/user_remove_response.rb +226 -0
  1745. data/lib/plaid/models/user_stated_income_source_category.rb +2 -2
  1746. data/lib/plaid/models/user_stated_income_source_frequency.rb +2 -2
  1747. data/lib/plaid/models/user_stated_income_source_pay_type.rb +2 -2
  1748. data/lib/plaid/models/user_third_party_token_create_request.rb +272 -0
  1749. data/lib/plaid/models/user_third_party_token_create_response.rb +241 -0
  1750. data/lib/plaid/models/user_third_party_token_remove_request.rb +246 -0
  1751. data/lib/plaid/models/user_third_party_token_remove_response.rb +241 -0
  1752. data/lib/plaid/models/user_transactions_refresh_request.rb +246 -0
  1753. data/lib/plaid/models/user_transactions_refresh_response.rb +242 -0
  1754. data/lib/plaid/models/user_update_request.rb +256 -0
  1755. data/lib/plaid/models/user_update_response.rb +226 -0
  1756. data/lib/plaid/models/validation_source.rb +6 -5
  1757. data/lib/plaid/models/validation_sources.rb +5 -4
  1758. data/lib/plaid/models/verification_expired_webhook.rb +39 -6
  1759. data/lib/plaid/models/verification_of_asset.rb +4 -3
  1760. data/lib/plaid/models/verification_of_asset_response.rb +4 -3
  1761. data/lib/plaid/models/verification_refresh_status.rb +2 -2
  1762. data/lib/plaid/models/verification_status.rb +2 -2
  1763. data/lib/plaid/models/verify_sms_details.rb +264 -0
  1764. data/lib/plaid/models/verify_sms_details_status.rb +39 -0
  1765. data/lib/plaid/models/w2.rb +3 -2
  1766. data/lib/plaid/models/w2_box12.rb +3 -2
  1767. data/lib/plaid/models/w2_box12_override.rb +233 -0
  1768. data/lib/plaid/models/w2_override.rb +438 -0
  1769. data/lib/plaid/models/w2_state_and_local_wages.rb +3 -2
  1770. data/lib/plaid/models/w2_state_and_local_wages_override.rb +288 -0
  1771. data/lib/plaid/models/wallet.rb +43 -6
  1772. data/lib/plaid/models/wallet_balance.rb +22 -6
  1773. data/lib/plaid/models/wallet_create_request.rb +25 -2
  1774. data/lib/plaid/models/wallet_create_response.rb +40 -3
  1775. data/lib/plaid/models/wallet_get_request.rb +3 -2
  1776. data/lib/plaid/models/wallet_get_response.rb +40 -3
  1777. data/lib/plaid/models/wallet_iso_currency_code.rb +2 -2
  1778. data/lib/plaid/models/wallet_list_request.rb +30 -7
  1779. data/lib/plaid/models/wallet_list_response.rb +3 -2
  1780. data/lib/plaid/models/wallet_numbers.rb +3 -2
  1781. data/lib/plaid/models/wallet_payment_scheme.rb +41 -0
  1782. data/lib/plaid/models/wallet_status.rb +40 -0
  1783. data/lib/plaid/models/wallet_transaction.rb +93 -9
  1784. data/lib/plaid/models/wallet_transaction_amount.rb +30 -7
  1785. data/lib/plaid/models/wallet_transaction_counterparty.rb +28 -6
  1786. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +3 -2
  1787. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +3 -2
  1788. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +3 -2
  1789. data/lib/plaid/models/wallet_transaction_execute_request.rb +23 -12
  1790. data/lib/plaid/models/wallet_transaction_execute_response.rb +25 -2
  1791. data/lib/plaid/models/wallet_transaction_failure_reason.rb +42 -0
  1792. data/lib/plaid/models/wallet_transaction_get_request.rb +3 -2
  1793. data/lib/plaid/models/wallet_transaction_get_response.rb +90 -6
  1794. data/lib/plaid/models/wallet_transaction_list_request.rb +342 -0
  1795. data/lib/plaid/models/wallet_transaction_list_request_options.rb +231 -0
  1796. data/lib/plaid/models/{wallet_transactions_list_response.rb → wallet_transaction_list_response.rb} +8 -7
  1797. data/lib/plaid/models/wallet_transaction_relation.rb +265 -0
  1798. data/lib/plaid/models/wallet_transaction_status.rb +2 -2
  1799. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +57 -3
  1800. data/lib/plaid/models/wallet_transactions_list_request.rb +19 -8
  1801. data/lib/plaid/models/warning.rb +7 -10
  1802. data/lib/plaid/models/watchlist_screening_audit_trail.rb +26 -3
  1803. data/lib/plaid/models/watchlist_screening_document.rb +26 -24
  1804. data/lib/plaid/models/watchlist_screening_document_type.rb +2 -2
  1805. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +4 -20
  1806. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +27 -21
  1807. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +3 -2
  1808. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +27 -21
  1809. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +3 -2
  1810. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +3 -2
  1811. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +3 -2
  1812. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +3 -2
  1813. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +27 -21
  1814. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +3 -2
  1815. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +3 -2
  1816. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +25 -23
  1817. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +3 -2
  1818. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +3 -2
  1819. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +3 -19
  1820. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +3 -19
  1821. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +3 -2
  1822. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +3 -2
  1823. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +27 -21
  1824. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +2 -2
  1825. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +27 -21
  1826. data/lib/plaid/models/watchlist_screening_hit.rb +25 -19
  1827. data/lib/plaid/models/watchlist_screening_hit_locations.rb +3 -23
  1828. data/lib/plaid/models/watchlist_screening_hit_status.rb +2 -2
  1829. data/lib/plaid/models/watchlist_screening_individual.rb +27 -21
  1830. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +4 -20
  1831. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +27 -21
  1832. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +3 -2
  1833. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +27 -21
  1834. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +3 -2
  1835. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +3 -2
  1836. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +3 -2
  1837. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +3 -2
  1838. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +27 -21
  1839. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +3 -2
  1840. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +3 -2
  1841. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +25 -23
  1842. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +3 -2
  1843. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +3 -2
  1844. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +3 -19
  1845. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +3 -19
  1846. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +3 -2
  1847. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +3 -2
  1848. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +27 -21
  1849. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +2 -2
  1850. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +27 -21
  1851. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +5 -59
  1852. data/lib/plaid/models/watchlist_screening_review.rb +3 -19
  1853. data/lib/plaid/models/watchlist_screening_search_terms.rb +6 -60
  1854. data/lib/plaid/models/watchlist_screening_status.rb +2 -2
  1855. data/lib/plaid/models/weak_alias_determination.rb +2 -2
  1856. data/lib/plaid/models/webhook_environment_values.rb +2 -3
  1857. data/lib/plaid/models/webhook_type.rb +3 -2
  1858. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +25 -2
  1859. data/lib/plaid/models/webhook_verification_key_get_request.rb +3 -2
  1860. data/lib/plaid/models/webhook_verification_key_get_response.rb +3 -2
  1861. data/lib/plaid/models/yield_rate.rb +258 -0
  1862. data/lib/plaid/models/yield_rate_type.rb +42 -0
  1863. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +25 -2
  1864. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +25 -2
  1865. data/lib/plaid/version.rb +3 -3
  1866. data/lib/plaid.rb +1856 -945
  1867. data/plaid.gemspec +6 -5
  1868. data/templates/ruby/api_client.mustache +10 -0
  1869. data/templates/ruby/api_client_faraday_partial.mustache +18 -6
  1870. data/templates/ruby/api_error.mustache +2 -1
  1871. data/templates/ruby/configuration.mustache +21 -4
  1872. data/templates/ruby/configuration_tls_faraday_partial.mustache +35 -0
  1873. data/templates/ruby/gemspec.mustache +4 -3
  1874. data/test/test_accounts.rb +1 -1
  1875. data/test/test_api_client.rb +30 -1
  1876. data/test/test_configuration.rb +7 -6
  1877. data/test/test_enrich.rb +60 -0
  1878. data/test/test_helper.rb +12 -3
  1879. data/test/test_identity_verification.rb +8 -3
  1880. data/test/test_item.rb +1 -0
  1881. data/test/test_liabilities.rb +1 -1
  1882. data/test/test_payment_initiation.rb +2 -2
  1883. data/test/test_sandbox.rb +31 -0
  1884. data/test/test_statements.rb +77 -0
  1885. metadata +967 -33
  1886. data/lib/plaid/models/deposit_switch_get_response.rb +0 -448
  1887. data/test/test_deposit_switch.rb +0 -73
data/CHANGELOG.md CHANGED
@@ -1,10 +1,3498 @@
1
1
  See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2
2
 
3
+ # 43.1.0
4
+ - Updating to OAS 2020-09-14_1.664.0
5
+
6
+ ## OpenAPI Schema Changes
7
+ ### 2020-09-14_1.664.0
8
+ - Add `investments_auth` to enum values for the `additional_consented_products` array in the `/link/token/create` request schema.
9
+
10
+ ### 2020-09-14_1.663.3
11
+ - (beta) Add `cra_plaid_credit_score` support to `link/token/create`
12
+ - (beta) Add `cra_plaid_credit_score` support to `cra/check_report/create`
13
+ - (beta) Add `cra/check_report/plaid_credit_score/get` endpoint
14
+
15
+ ### 2020-09-14_1.663.2
16
+ - Add `user_id` to `cra/*` endpoints
17
+
18
+ ### 2020-09-14_1.663.1
19
+ - Add `overdraft` account type to the `LoanAccountSubtype` object, where it was erroneously missing
20
+ - Correct missing and incorrect enum values for `ItemConsentedDataScope` object
21
+
22
+ ### 2020-09-14_1.663.0
23
+ - (beta) Add `/user/items/associate` endpoint
24
+
25
+ ### 2020-09-14_1.662.1
26
+ - Internal changes only
27
+
28
+ ### 2020-09-14_1.662.0
29
+ - Add `balance_to_transaction_amount_ratio` to `/signal/evaluate`
30
+
31
+ ### 2020-09-14_1.661.0
32
+ - Add `personal_finance_category_version` to `/transactions/get`, `/transactions/sync` and `/transactions/enrich` request options as well as version field in response.
33
+
34
+ ### 2020-09-14_1.660.0
35
+ - Add `gse_options` to `base_report` options in `/link/token/create` and `cra/check_report/create`
36
+
37
+ ### 2020-09-14_1.659.0
38
+ - Deprecate the `sedol` field in the Investments `Security` object.
39
+ - Deprecate the `sedol` field in the Investments `SecurityOverride` object.
40
+
41
+ # 43.0.0
42
+ - Updating to OAS 2020-09-14_1.658.0
43
+
44
+ ## Breaking changes in this version
45
+
46
+ - [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.
47
+
48
+ ## OpenAPI Schema Changes
49
+ ### 2020-09-14_1.658.0
50
+ - (beta) Add `user_id` field to `/session/token/create` request.
51
+ - [BREAKING for Go] (beta) Make `user` object optional in `/session/token/create` if `user_id` is included.
52
+
53
+ ### 2020-09-14_1.657.0
54
+ Add Add `subtype` property to the `Security` model.
55
+
56
+ ### 2020-09-14_1.656.1
57
+ - Renamed `protect_sdk_session_id` field in the request of `/protect/event/send` to `protect_session_id` for consistency across endpoints.
58
+
59
+ ### 2020-09-14_1.656.0
60
+ - Added `aamva_verification` object in the responses of `documentary_verification.documents[].analysis`. This impacts the following endpoints:
61
+ - `identity_verification/create`
62
+ - `identity_verification/get`
63
+ - `identity_verification/list`
64
+ - `identity_verification/retry`
65
+
66
+ ### 2020-09-14_1.655.0
67
+ - Add `max_amount` and `iso_currency_code` to `rfp` in `/transfer/capabilitied/get` response
68
+
69
+ ### 2020-09-14_1.654.0
70
+ - [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.
71
+
72
+ ### 2020-09-14_1.653.0
73
+ - (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.
74
+ - [BREAKING for Go] (beta) Make `client_user_id` optional in `identity_verification/list` if `user_id` is included.
75
+ - (beta) Add nullable `user_id` to the response of all of the identity verification endpoints:
76
+ - `identity_verification/create`
77
+ - `identity_verification/get`
78
+ - `identity_verification/list`
79
+ - `identity_verification/retry`
80
+
81
+ ### 2020-09-14_1.652.3
82
+ - Added support for `cra_monitoring` to `Products` array.
83
+
84
+ ### 2020-09-14_1.652.2
85
+ - (beta) Add `/user/items/list` endpoint
86
+
87
+ ### 2020-09-14_1.652.1
88
+ - Add `/transfer/ledger/event/list` endpoint
89
+
90
+ # 42.0.0
91
+ - Updating to OAS 2020-09-14_1.652.0
92
+
93
+ ## Breaking changes in this version
94
+
95
+ - [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create`
96
+ - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh`
97
+ - `voe_options` in the request is now `employment_refresh_options`
98
+ - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe`
99
+ - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh`
100
+
101
+ ## OpenAPI Schema Changes
102
+ ### 2020-09-14_1.652.0
103
+ - Add optional `cursor` and `count` fields to the `/payment_initiation/recipient/list` request and `next_cursor` to its response
104
+
105
+ ### 2020-09-14_1.651.2
106
+ - (beta) Add `user_id` field to `link/token/create` request
107
+ - [BREAKING for Go] (beta) Make `user` object optional in `link/token/create` if `user_id` is included
108
+
109
+ ### 2020-09-14_1.651.1
110
+ - 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.
111
+
112
+ ### 2020-09-14_1.651.0
113
+ - Rename all `/verify/client/*` routes to `/protect/client/*` and update request/response body and field names accordingly.
114
+
115
+ ### 2020-09-14_1.650.1
116
+ - Update description for `days_required`
117
+
118
+ ### 2020-09-14_1.650.0
119
+ - Add `account_numbers` to `Counterparty` in `/transaction/get` and `/transaction/sync`
120
+
121
+ ### 2020-09-14_1.649.2
122
+ - Add `InsitutionID` and `InstitutionName` to `/cra/monitoring_insights/get` response
123
+
124
+ ### 2020-09-14_1.649.1
125
+ - Update max value for `cra_options.days_requested` in `link/token/create` to 731 (2 years + 1 days for leap year)
126
+ - 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
127
+ - Set max value for `days_required` in `cra/check_report/create` to 184 (most number of days in a 6 month period)
128
+
129
+ ### 2020-09-14_1.649.0
130
+ - Add wire_return_fee to Transfer and Transfer Event objects
131
+
132
+ ### 2020-09-14_1.648.2
133
+ - Docs-only change to add additional subtypes to the accounts schema
134
+
135
+ ### 2020-09-14_1.648.1
136
+ - Add `last_successful_update_time` to `/cashflow_report/get`
137
+
138
+ ### 2020-09-14_1.648.0
139
+ - Add `require_identity` to `cra_options.base_report` in `link/token/create` and `/cra/check_report/create` requests
140
+
141
+ ### 2020-09-14_1.647.1
142
+ - Update `/transfer/ledger/distribute` summary
143
+
144
+ ### 2020-09-14_1.647.0
145
+ - Add `webhook_codes` field to `/sandbox/cashflow_updates/update` request
146
+
147
+ ### 2020-09-14_1.646.0
148
+ - [Breaking] Replacing `voe` references to instead be `employment_refresh` in `/cra/check_report/verification/get` and `/cra/check_report/create`
149
+ - `/cra/check_report/verification/get`'s `reports_requested` options are now `VOA` and `employment_refresh`
150
+ - `voe_options` in the request is now `employment_refresh_options`
151
+ - `/cra/check_report/verification/get`'s response now has `report.employment_refresh` instead of `report.voe`
152
+ - `gse_options.report_type` in `/cra/check_report/create` are now `VOA` and `employment_refresh`
153
+
154
+ ### 2020-09-14_1.645.1
155
+ - Update description of `/transfer/ledger/distribute`
156
+
157
+ # 41.0.0
158
+ - Updating to OAS 2020-09-14_1.645.0
159
+
160
+ ## Breaking changes in this version
161
+
162
+ - [Breaking] For Signal, remove enum values `REAL_TIME_PAYMENTS` and `DEBIT_CARD` as these payment methods are not supported by the Signal product.
163
+ - [Breaking] Rename client library `/cra/check_report/create`'s `partner_insights` object to type `CraCheckReportCreatePartnerInsightsOptions` instead of `CraCheckReportPartnerInsightsGetOptions`. All the object fields are identical.
164
+ - [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.
165
+
166
+ ## OpenAPI Schema Changes
167
+ ### 2020-09-14_1.645.0
168
+ - Removes the `payment_details` field from `/accounts/balance/get` request
169
+ - Removes the `payment_risk_assessment` from `/accounts/balance/get` response
170
+
171
+ ### 2020-09-14_1.644.1
172
+ - Fixed incorrect event type in example for `ProtectUserEventWebhook`.
173
+
174
+ ### 2020-09-14_1.644.0
175
+ - [Breaking] For Signal, remove enum values `REAL_TIME_PAYMENTS` and `DEBIT_CARD` as these payment methods are not supported by the Signal product.
176
+ - [Breaking] Rename client library `/cra/check_report/create`'s `partner_insights` object to type `CraCheckReportCreatePartnerInsightsOptions` instead of `CraCheckReportPartnerInsightsGetOptions`. All the object fields are identical.
177
+ - [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.
178
+
179
+ ### 2020-09-14_1.642.2
180
+ - Added `ProtectUserEventWebhook`.
181
+
182
+ ### 2020-09-14_1.642.1
183
+ - Deprecated `/link/token/create`'s `base_report`. Revert erroneous deprecation of `cra_options.base_report`.
184
+
185
+ ### 2020-09-14_1.642.0
186
+ - Add `error` field to responses of `/payment_initiation/payment/get` and `/payment_initiation/consent/payment/execute` containing error details when the payment fails.
187
+
188
+ # 40.0.0
189
+ - Updating to OAS 2020-09-14_1.641.1
190
+
191
+ ## Breaking changes in this version
192
+ - [Breaking] Add /cashflow_report/transactions/get route, identital to /cashflow_report/get minus days_requested request parameter
193
+
194
+ ## OpenAPI Schema Changes
195
+ ### 2020-09-14_1.641.1
196
+ - Fix descriptions for BaseReportAccountMetadata
197
+
198
+ ### 2020-09-14_1.641.0
199
+ - Deprecated `/link/token/create`'s `cra_options.base_report` object in favor of `cra_options.client_report_id`
200
+
201
+ ### 2020-09-14_1.640.0
202
+ - [Breaking] Add /cashflow_report/transactions/get route, identital to /cashflow_report/get minus days_requested request parameter
203
+ - Remove historical_balances from BusinessAccounts object
204
+
205
+ ### 2020-09-14_1.639.0
206
+ - Add `webhook` field to `/session/token/create` request
207
+
208
+ ### 2020-09-14_1.638.6
209
+ - Deprecate Prism Products field from Partner Insights generation and retrieval
210
+
211
+ ### 2020-09-14_1.638.5
212
+ - Add client report id to partner insights
213
+
214
+ ### 2020-09-14_1.638.4
215
+ - Remove unused enums for MonitoringInsightsStatus and MonitoringItemStatusCode
216
+
217
+ ### 2020-09-14_1.638.3
218
+ - Add Prism Detect and Extend cashscores to CRA Partner Insights
219
+
220
+ ### 2020-09-14_1.638.2
221
+ - (beta) expect a boolean instead of a string in generated client interfaces for PLAID-NEW-USER-API-ENABLED
222
+
223
+ ### 2020-09-14_1.638.1
224
+ - Support for upcoming results in `link/token/get`.
225
+
226
+ ### 2020-09-14_1.638.0
227
+ - (pre-release) Preparation for upcoming products.
228
+
229
+ ### 2020-09-14_1.637.6
230
+ - Deprecate `report.items.accounts.account_insights` for `/cra/check_report/base_report/get`
231
+
232
+ # 39.0.0
233
+ - Updating to OAS 2020-09-14_1.637.5
234
+
235
+ ## Breaking changes in this version
236
+ - [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
237
+
238
+ ## OpenAPI Schema Changes
239
+ ### 2020-09-14_1.637.5
240
+ - Fix incorrect placement of `nullable: true` on `AccountBaseNullable` object, making the object actually `nullable`.
241
+
242
+ ### 2020-09-14_1.637.4
243
+ - Add missing `unsent` value as a possible `verification_status` to reflect actual API behavior.
244
+
245
+ ### 2020-09-14_1.637.3
246
+ - (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.
247
+ - (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.
248
+
249
+ ### 2020-09-14_1.637.2
250
+ - (beta) Add `user_id` to `/session/token/create` response
251
+
252
+ ### 2020-09-14_1.637.1
253
+ - Add optional `institution_id` to `/item/import`
254
+
255
+ ### 2020-09-14_1.637.0
256
+ - Add `android_package_name` to `/session/token/create`
257
+
258
+ ### 2020-09-14_1.636.0
259
+ - Update `average_inflow_amount` to be positive.
260
+
261
+ ### 2020-09-14_1.635.4
262
+ - [BREAKING] (beta) Updated `user_token` field in `UserCreateResponse` to be optional.
263
+ - [BREAKING for Go] (beta) Updated `user_token` field in `UserRemoveRequest` to be optional.
264
+ - Other hidden changes.
265
+
266
+ ### 2020-09-14_1.635.3
267
+ - (beta) Add `user_id` to `/link/token/create` response
268
+
269
+ # 38.0.0
270
+ - Updating to OAS 2020-09-14_1.635.2
271
+
272
+ ## Breaking changes in this version
273
+ - [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
274
+ - [BREAKING] `client_user_id` is now required for `/session/token/create`
275
+
276
+ ## OpenAPI Schema Changes
277
+ ### 2020-09-14_1.635.2
278
+ - Update description of `ruleset.outcome` in `/signal/evaluate` response
279
+
280
+ ### 2020-09-14_1.635.1
281
+ - Fix description undeprecating `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
282
+
283
+ ### 2020-09-14_1.635.0
284
+ - 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`
285
+
286
+ ### 2020-09-14_1.634.3
287
+ - Undeprecated `report.items.accounts.attributes` after it was mistakenly deprecated for `/cra/check_report/base_report/get`
288
+
289
+ ### 2020-09-14_1.634.2
290
+ - Removed `deposit_switch` from the `products` field in the `/link/token/create` request
291
+
292
+ ### 2020-09-14_1.634.1
293
+ - [BREAKING] Move `result` from `triggered_rule_details` to `ruleset` in response of `/signal/evaluate`
294
+
295
+ ### 2020-09-14_1.634.0
296
+ - [BREAKING] `client_user_id` is now required for `/session/token/create`
297
+
298
+ # 37.0.0
299
+ - Updating to OAS 2020-09-14_1.633.1
300
+
301
+ ## Breaking changes in this version
302
+ - [BREAKING] Update `account` object to nullable in `/processor/transactions/sync` response
303
+ - [BREAKING] Update `webhook` field in `IssuesSubscribeRequest` to be required
304
+ - [BREAKING] Correct the schema object returned by `AssetReport` `investments` field -- it is now correctly represented as an `AssetReportInvestments` object, not an `AssetReportInvestmentsTransaction` object, to accurately reflect the API behavior.
305
+ - [BREAKING] Date of birth is now required within consumer report user identity for `user/create` and `user/update`
306
+ - [BREAKING] Update `posted_date` field on `/statements/list` response to be nullable
307
+ - [BREAKING] Updated the `investments` schema returned by `/asset_report/get` (`AssetReportInvestments`) to accurately reflect the actual API behavior, including renaming the schema object
308
+ - [BREAKING] Changed `score` in `PlaidCheckScore` from a float to an integer
309
+
310
+ ## OpenAPI Schema Changes
311
+ ### 2020-09-14_1.633.1
312
+ - [BREAKING] Update `account` object to nullable in `/processor/transactions/sync` response
313
+
314
+ ### 2020-09-14_1.633.0
315
+ - Move `user_id` field of `/session/token/create` request to be within `user`
316
+
317
+ ### 2020-09-14_1.632.6
318
+ - Update descriptions for `CashFlowUpdatesLowBalanceWebhook` and `CashFlowUpdatesLargeDepositWebhook`
319
+
320
+ ### 2020-09-14_1.632.5
321
+ - Add new `CashFlowUpdatesInsightsWebhook` for Cash Flow Updates
322
+
323
+ ### 2020-09-14_1.632.4
324
+ - Add `triggered_rule_details` to `/signal/evaluate` response
325
+
326
+ ### 2020-09-14_1.632.3
327
+ - [BREAKING] Update `webhook` field in `IssuesSubscribeRequest` to be required
328
+
329
+ ### 2020-09-14_1.632.2
330
+ - Update the `warnings` field in `/cra/check_report/verification/get` response to be required
331
+
332
+ ### 2020-09-14_1.632.1
333
+ - Add `AT` and `FI` to the list of available countries
334
+
335
+ ### 2020-09-14_1.632.0
336
+ - Add `user_id` field to `/session/token/create` request
337
+
338
+ ### 2020-09-14_1.631.0
339
+ - [BREAKING] Correct the schema object returned by `AssetReport` `investments` field -- it is now correctly represented as an `AssetReportInvestments` object, not an `AssetReportInvestmentsTransaction` object, to accurately reflect the API behavior.
340
+
341
+ ### 2020-09-14_1.630.0
342
+ - Add optional `income_categories` param to `/cra/monitoring_insights/subscribe` request
343
+
344
+ ### 2020-09-14_1.629.0
345
+ - [Breaking] Date of birth is now required within consumer report user identity for `user/create` and `user/update`
346
+
347
+ ### 2020-09-14_1.628.4
348
+ - Renamed CRA Cash Flow Updates webhook types
349
+
350
+ ### 2020-09-14_1.628.3
351
+ - Adde `warnings` to responses for `cra/check_report/income_insights/get`, `cra/check_report/network_insights/get`, `cra/check_report/cashflow_insights/get`, and `cra/check_report/partner_insights/get`
352
+
353
+ ### 2020-09-14_1.628.2
354
+ - Update description for the `options.add_ons` field in `asset_reports/create`
355
+
356
+ ### 2020-09-14_1.628.1
357
+ - Add `client_report_id` field to `cra/check_report/create` request and deprecate `base_report.client_report_id` field in `cra/check_report/create`.
358
+ - Add `client_report_id` field to `LinkTokenCreateRequestCraOptions` field
359
+ - Deprecate `client_report_id` field in `LinkTokenCreateRequestBaseReport`
360
+ - Add `client_report_id` field to `CraIncomeInsights`
361
+
362
+ ### 2020-09-14_1.628.0
363
+ - Add `redirect_uri` field to `/session/token/create` request
364
+
365
+ ### 2020-09-14_1.627.1
366
+ - Update description of `transfer_id` field on `TransferEvent` schema to be empty string for Plaid Ledger Sweep events
367
+
368
+ ### 2020-09-14_1.627.0
369
+ - [BREAKING] Update `posted_date` field on `/statements/list` response to be nullable
370
+
371
+ ### 2020-09-14_1.626.0
372
+ - Add reason_code field to /transfer/cancel request
373
+
374
+ ### 2020-09-14_1.625.2
375
+ - Add `USER_PERMISSION_REVOKED` and `USER_ACCOUNT_REVOKED` webhook codes to `WebhookCodeEnum` in `SandboxItemFireWebhookRequest` to reflect actual API behavior.
376
+
377
+ ### 2020-09-14_1.625.1
378
+ - Add new `verification_name` field to `Account`
379
+
380
+ ### 2020-09-14_1.625.0
381
+ - Add new `posted_date` field to `/statements/list` response
382
+
383
+ ### 2020-09-14_1.624.0
384
+ - (pre-release) Add `human_review` object to the `analysis` object within each `documentary_verification.documents` object. This change affects the response of all of the identity verification endpoints:
385
+ - `identity_verification/create`
386
+ - `identity_verification/get`
387
+ - `identity_verification/list`
388
+ - `identity_verification/retry`
389
+
390
+ ### 2020-09-14_1.623.0
391
+
392
+ ### 2020-09-14_1.622.0
393
+ - [BREAKING] Updated the `investments` schema returned by `/asset_report/get` (`AssetReportInvestments`) to accurately reflect the actual API behavior, including renaming the schema object
394
+ - Updated the Auth descriptions to reflect the fact that the preferred method to enable database and micro-deposit-based Auth verification flows is now the Dashboard, and that Database Insights has been deprecated and replaced by the similar product Database Auth.
395
+
396
+ ### 2020-09-14_1.621.0
397
+ - [BREAKING] Changed `score` in `PlaidCheckScore` from a float to an integer
398
+
399
+ # 36.1.0
400
+ - Updating to OAS 2020-09-14_1.620.0
401
+
402
+ ## OpenAPI Schema Changes
403
+ ### 2020-09-14_1.620.0
404
+ - Add `intent_id` field to `/transfer/event/sync` response
405
+
406
+ ### 2020-09-14_1.619.1
407
+ - Add new `cashflow_updates` webhook triggers
408
+ - Remove `reason` field from `MonitoringInsightsWebhook`
409
+
410
+ ### 2020-09-14_1.619.0
411
+ - Add `/session/token/create` endpoint
412
+
413
+ ### 2020-09-14_1.618.2
414
+ - Add `beacon_user_id` to `/beacon/report_syndication/get` and `/beacon/report_syndication/list` response
415
+
416
+ ### 2020-09-14_1.618.1
417
+ - `/cashflow_report/get` endpoint is added. This includes defining the `CashflowReportGetRequest` and `CashflowReportGetResponse` fields. Adding `access_token` as required field in `CashflowReportRefreshRequest`.
418
+
419
+ ### 2020-09-14_1.618.0
420
+ - Add `attributes` object to `BaseReport` definition.
421
+
422
+ ### 2020-09-14_1.617.6
423
+ - `/cashflow_report/refresh` endpoint is added. This includes defining the `CashflowReportRefreshRequest` and `CashflowReportRefreshResponse` fields.
424
+
425
+ ### 2020-09-14_1.617.5
426
+ - `submitted_at` is added as an optional field to `/signal/decision/report`.
427
+
428
+ ### 2020-09-14_1.617.4
429
+ - `persistentId` and `isTokenizedAccountNumber` fields now only populated for select institutions in sandbox related to TAN-based institutions (ins_13, ins_56) or the default testing OAuth institution (ins_127287)
430
+
431
+ ### 2020-09-14_1.617.3
432
+ - Modified how contribution transactions are summed up in `account_details_401k.contribution_details` object in `/investments/auth/get` endpoint.
433
+
434
+ ### 2020-09-14_1.617.2
435
+ - Updated PrismCashScore and PrismFirstDetect to allow Score in /cra/check_report/partner_insights/get to be nullable
436
+
437
+ # 36.0.0
438
+ - Updating to OAS 2020-09-14_1.617.1
439
+
440
+ ## Breaking changes in this version
441
+ - [Breaking] Removed the deprecated longest_gap_between_transactions, average_inflow_amount, and average_outflow_amount fields from the BaseReportAccountInsights object in the /cra/check_report/base_report/get response.
442
+
443
+ ## OpenAPI Schema Changes
444
+ ### 2020-09-14_1.617.1
445
+ - For Plaid Check: `date_of_birth` is now required within the `consumer_report_user_identity` object when creating or updating a user token.
446
+
447
+ ### 2020-09-14_1.617.0
448
+ - [Breaking] Removed the deprecated longest_gap_between_transactions, average_inflow_amount, and average_outflow_amount fields from the BaseReportAccountInsights object in the /cra/check_report/base_report/get response.
449
+
450
+ ### 2020-09-14_1.616.0
451
+ - Add `originating_fund_source` to `/wallet/transaction/execute` endpoint.
452
+
453
+ ### 2020-09-14_1.615.0
454
+ - Add `account_details_401k` objects to `/investments/auth/get` endpoint.
455
+
456
+ # 35.1.0
457
+ - Updating to OAS 2020-09-14_1.614.1
458
+
459
+ ## OpenAPI Schema Changes
460
+ ### 2020-09-14_1.614.1
461
+ - Update `owners` field description for empty case
462
+
463
+ ### 2020-09-14_1.614.0
464
+ - Add model for the new `retirement_401k` numbers object to the `InvestmentsAuthGetNumbers` schema.
465
+
466
+ ### 2020-09-14_1.613.0
467
+ - Add `POST /signal/schedule` endpoint
468
+
469
+ ### 2025-01-27_1.611.0
470
+ - Add `end_to_end_id` to `/payment_initiation/payment/get`
471
+
472
+ ### 2020-09-14_1.611.0
473
+ - Add RfP to /transfer/capabilities/get
474
+
475
+ ### 2020-09-14_1.610.2
476
+ - Update `cashflow_updates` docs to reflect proper cadence
477
+
478
+ # 35.0.0
479
+ - Updating to OAS 2020-09-14_1.610.1
480
+
481
+ ## Breaking changes in this version
482
+ - [Breaking] Update the minimum Ruby version to 3.1.0
483
+
484
+ ## OpenAPI Schema Changes
485
+ ### 2020-09-14_1.610.1
486
+ - Add `funds_available` sweep status and event type
487
+
488
+ ### 2020-09-14_1.610.0
489
+ - Add `PaymentInitiationConsentStatusUpdateWebhook` definition.
490
+
491
+ ### 2020-09-14_1.609.0
492
+ - Remove `/profile/get` and `/link/profile/eligibility/check` endpoints
493
+
494
+ ### 2020-09-14_1.608.0
495
+ - Remove erroneous UserToken object from LinkTokenGetMetadataResponse, as the specification was incorrect and the object was never returned as part of the response.
496
+
497
+ ### 2020-09-14_1.607.0
498
+ - Add failure_code and description fields to `/transfer/sweep/get` and `transfer/sweep/list` endpoints. Deprecated `ach_return_code` field of the TransferFailure and TransferRefundFailure objects.
499
+
500
+ ### 2020-09-14_1.606.1
501
+ - Updated description to `funding_account_id` field of `transfer/ledger/deposit` and `transfer/ledger/withdraw`
502
+
503
+ ### 2020-09-14_1.606.0
504
+ - Add `sandbox/payment/simulate` endpoint to enable testing of payment status transitions.
505
+
506
+ ### 2020-09-14_1.605.0
507
+ - Add `nsf_overdraft_transactions_count_30d/60d/90d` fields to `attributes` field of `cra/check_report/base_report/get`
508
+
509
+ ### 2020-09-14_1.604.1
510
+ - Add `account_id` to `/transactions/sync` request `options` object.
511
+
512
+ ### 2020-09-14_1.603.2
513
+ - Fix incorrect `USER_ACCOUNT_REVOKED` schema and example
514
+
515
+ ### 2020-09-14_1.603.1
516
+ - Internal changes only
517
+
518
+ ### 2020-09-14_1.603.0
519
+ - (pre-release) Add `fraud_analysis_details` and `image_quality_details` objects to the `analysis` object within each `documentary_verification.documents` object. These changes affect the response of all of the identity verification endpoints:
520
+ - `identity_verification/create`
521
+ - `identity_verification/get`
522
+ - `identity_verification/list`
523
+ - `identity_verification/retry`
524
+
525
+ ### 2020-09-14_1.602.1
526
+ - Documentation-only change to `/cra/monitoring_insights/subscribe` for cadence
527
+
528
+ ### 2020-09-14_1.602.0
529
+ - Added `payer_details` field to `payment_initiation/consent/get` response
530
+
531
+ ### 2020-09-14_1.601.2
532
+ - Documentation-only change to Investments `Security` object for new Fixed Income fields and sandbox availability
533
+
534
+ ### 2020-09-14_1.601.1
535
+ - Update descriptions for `/network/status/get` request fields
536
+
537
+ ### 2020-09-14_1.601.0
538
+ - Clean up legacy `/cra/base_report/*` endpoints from libraries in favor of `/cra/check_report/*`
539
+ endpoints.
540
+
541
+ ### 2020-09-14_1.600.2
542
+ - Update descriptions for `/network/status/get` request and response fields
543
+ - Add `nullable: true` to mortgage `account_number` field in the `MortgageLiability` schema to reflect actual behavior.
544
+ - Add `transactions_refresh` to `Products` array to reflect actual behavior; this field is not accepted as input to `/link/token/create` but can be part of supported products array in the `Institution` object.
545
+
546
+ ### 2020-09-14_1.600.1
547
+ - `depository`+`cash management` Accounts are now eligible for Auth data for certain institutions
548
+
549
+ ### 2020-09-14_1.600.0
550
+ - Added `is_tokenized_account_number` to the `numbers.ach` object
551
+
552
+ ### 2020-09-14_1.599.0
553
+ - Added `auth_method` field to `Item` object
554
+
555
+ ### 2020-09-14_1.598.0
556
+ - Add `user_insights_id` to `/cra/monitoring_insights/get` response
557
+ -
558
+ ### 2020-09-14_1.597.0
559
+ - (beta) Add /network/status/get endpoint
560
+
561
+ ### 2020-09-14_1.596.0
562
+ - Unhide `/sandbox/cra/cashflow_updates/update`
563
+
564
+ ### 2020-09-14_1.595.0
565
+ - Add `ruleset_key` to `/transfer/authorization/create` request
566
+
567
+ ### 2020-09-14_1.594.0
568
+ - Deprecated `consumer_dispute_id` field on consumer dispute object
569
+
570
+ ### 2020-09-14_1.593.0
571
+ - Add `fixed_income` object (which contains the `yield_rate`, `maturity_date`, `issue_date`, and `face_value` fields) to the Security object (Investments)
572
+
573
+ ### 2020-09-14_1.592.1
574
+
575
+ ### 2020-09-14_1.592.0
576
+ - Add `/sandbox/cra/cashflow_updates/update` endpoint
577
+
578
+ ### 2020-09-14_1.591.1
579
+ - Hide `TransferMigratedFundingAccountIDRequest` from docs
580
+
581
+ ### 2020-09-14_1.591.0
582
+ - (pre-release) Add overall `risk_level`, and in some cases `factors` to each type of `risk_check` object. Also add `first_party_synthentic_fraud` and `third_party_synthentic_fraud` objects to`risk_check.identity_abuse_signals.synthetic_identity`. These changes affect the response of all of the identity verification endpoints:
583
+ - `identity_verification/create`
584
+ - `identity_verification/get`
585
+ - `identity_verification/list`
586
+ - `identity_verification/retry`
587
+
588
+ ### 2020-09-14_1.590.0
589
+ - Add `webhook` field to `TransferPlatformOriginatorCreateRequest`
590
+
591
+ ### 2020-09-14_1.589.0
592
+ - Add `PLATFORM_ONBOARDING_UPDATE` webhook for transfer
593
+
594
+ ### 2020-09-14_1.588.0
595
+ - Add `/processor/investments/transactions/get` endpoint
596
+
597
+ ### 2020-09-14_1.587.1
598
+ - Add `institution_name` field in the `Item` object
599
+
600
+ ### 2020-09-14_1.587.0
601
+ - Add `/processor/investments/holdings/get` endpoint
602
+
603
+ # 34.0.0
604
+ - Updating to OAS 2020-09-14_1.586.4
605
+
606
+ ## Breaking changes in this version
607
+ - [Breaking] Changed the type returned by `/item/get` from `Item` to `ItemWithConsentFields`.
608
+ - [Breaking] Changed `ConsentEventCode` enum values. Replaced `PLAID_END_USER_PRIVACY_POLICY` with `USER_AGREEMENT`
609
+ - [Breaking] Created `ItemWithConsentFields`, a new object definition that extends the `Item` object to include 1033-related consent fields.
610
+ - [Breaking] Removed the 1033-related consent fields from the `Item` object, ensuring that these fields now only appear in the `ItemWithConsentFields` object within the `/item/get` response.
611
+
612
+ ## OpenAPI Schema Changes
613
+ ### 2020-09-14_1.586.4
614
+ - Update `cause` and make it nullable
615
+
616
+ ### 2020-09-14_1.586.3
617
+ - Update `email` description in `/user_account/session/get` response
618
+
619
+ ### 2020-09-14_1.586.2
620
+ - Update `event_type` description of `/sandbox/transfer/simulate`. Added `funds_available` to status list
621
+
622
+ ### 2020-09-14_1.586.1
623
+ - [Breaking] Changed `ConsentEventCode` enum values. Replaced `PLAID_END_USER_PRIVACY_POLICY` with `USER_AGREEMENT`
624
+
625
+ ### 2020-09-14_1.586.0
626
+ - Add `webhook` field to requests for `/sandbox/transfer/simulate`, `/sandbox/transfer/refund/simulate`, `/sandbox/transfer/ledger/simulate_available` and `/sandbox/transfer/sweep/simulate`.
627
+
628
+ ### 2020-09-14_1.585.5
629
+ - Correct a typo in /link/token/create description
630
+
631
+ ### 2020-09-14_1.585.4
632
+ - Updated transition date to move away from deprecated fields in CRA Base Report API
633
+
634
+ ### 2020-09-14_1.585.3
635
+ - Fixed erroneous missing `last_statement_balance` field in `StudentLoan` object -- field was returned in API but not in specification.
636
+
637
+ ### 2020-09-14_1.585.2
638
+ - Remove minimum length for `end_customer` in `user/create`
639
+
640
+ ### 2020-09-14_1.585.1
641
+ - Deprecate `options` in `payment_initiation/consent/create`
642
+
643
+ ### 2020-09-14_1.585.0
644
+ - [Breaking] Created `ItemWithConsentFields`, a new object definition that extends the `Item` object to include 1033-related consent fields.
645
+ - [Breaking] Removed the 1033-related consent fields from the `Item` object, ensuring that these fields now only appear in the `ItemWithConsentFields` object within the `/item/get` response.
646
+
647
+ ### 2020-09-14_1.584.1
648
+ - Deprecated `version` in `cra/check_report/partner_insights/get` in favor of `model_version`
649
+
650
+ ### 2020-09-14_1.584.0
651
+ - Made total inflow/outflow amount fields in the `cra/check_report/base_report/get` response nullable
652
+
653
+ ### 2020-09-14_1.583.1
654
+ - Updated `description` field in `payment_configuration` object in `/link/token/create` to be optional
655
+
656
+ ### 2020-09-14_1.583.0
657
+ - Added total inflow/outflow amount fields to `attributes` object in the `cra/check_report/base_report/get` response
658
+
659
+ ### 2020-09-14_1.582.0
660
+ - Added a new field in `/link/token/create`
661
+
662
+ ### 2020-09-14_1.581.0
663
+ - Update `verify_sms` object in the response of all of the identity verification endpoints to add `redacted_at` timestamp:
664
+ - `identity_verification/create`
665
+ - `identity_verification/get`
666
+ - `identity_verification/list`
667
+ - `identity_verification/retry`
668
+
669
+ ### 2020-09-14_1.580.4
670
+ - Fixed an incorrect example response in `/user_account/session/get`
671
+
672
+ ### 2020-09-14_1.580.3
673
+ - Fix wrong nullable annotation in `/signal/evaluate` response
674
+
675
+ ### 2020-09-14_1.580.2
676
+ - Make `scores` nullable in `/signal/evaluate` and `/processor/signal/evaluate` response
677
+
678
+ ### 2020-09-14_1.580.1
679
+ - Add new `payer_details` field to `payment_initiation/consent/create` in preparation to new account restrictions
680
+
681
+ ### 2020-09-14_1.579.1
682
+ - Add new `type` field to `payment_initiation/consent/create` and deprecate the `scopes` field
683
+
684
+ ### 2020-09-14_1.578.1
685
+ - Update `verify_sms` object in the response of all of the identity verification endpoints to support nullable `verification.phone_number` and expand allowed statuses for `verification.status`:
686
+ - `identity_verification/create`
687
+ - `identity_verification/get`
688
+ - `identity_verification/list`
689
+ - `identity_verification/retry`
690
+
691
+ ### 2020-09-14_1.578.0
692
+ - Add `verify_sms` object in the response of all of the identity verification endpoints:
693
+ - `identity_verification/create`
694
+ - `identity_verification/get`
695
+ - `identity_verification/list`
696
+ - `identity_verification/retry`
697
+
698
+ ### 2020-09-14_1.577.1
699
+ - Added support for `signal` to `required_if_supported_products`.
700
+ - Added support for `cra_network_insights` to `Products` array.
701
+ - Define `MonitoringInsightsWebhook`
702
+ - Fix definition for JWTHeader object
703
+
704
+ ### 2020-09-14_1.577.0
705
+ - Updated description for the `is_primary_account` field of base reports
706
+
707
+ ### 2020-09-14_1.576.0
708
+ - Expose beacon_user_id in `/identity_verification/*` endpoints
709
+ - Added new optional parameter `days_required` to `cra_options` in `/link/token/create` and to `/cra/check_report/create`
710
+ - Added new metadata object with `start_date` and `end_date` in the responses for:
711
+ - `/cra/check_report/base_report/get`
712
+ - `/cra/check_report/income_insights/get`
713
+ - `/cra/check_report/partner_insights/get`
714
+
715
+ ### 2020-09-14_1.575.1
716
+ - Update `date_of_birth` field description in `user/create`
717
+
718
+ # 33.0.0
719
+ - Updating to OAS 2020-09-14_1.575.0
720
+
721
+ ## Breaking changes in this version
722
+ - [BREAKING] removed `products` field from `cra/check_report/create` request
723
+
724
+ ## OpenAPI Schema Changes
725
+ ### 2020-09-14_1.575.0
726
+ - Add `primary_account_score` and `is_primary_account` fields to the `cra/check_report/base_report/get` response
727
+
728
+ ### 2020-09-14_1.574.1
729
+ - Add `FAILED` enum for Monitoring
730
+
731
+ ### 2020-09-14_1.574.0
732
+ - Make `MonitoringInsights` nullable
733
+
734
+ ### 2020-09-14_1.573.2
735
+ - Update session results array fields in `/link/token/get` response to be required
736
+
737
+ ### 2020-09-14_1.573.1
738
+ - mark `category_id` in BaseReport transaction as nullable
739
+ - Update `date_of_birth` description in `user/create`
740
+
741
+ ### 2020-09-14_1.573.0
742
+ - Removed `is_missing_income` from `/cra/monitoring_insights/get`
743
+
744
+ ### 2020-09-14_1.572.0
745
+ - Add `uuid` validation for `subscription_id` in `/cra/monitoring_insights/get`
746
+ - Add `ConsumerReportPermissiblePurpose` to `CraMonitoringInsightsGetRequest`
747
+ - Add `HistoricalAnnualIncome` insight
748
+
749
+ ### 2020-09-14_1.571.0
750
+ - Add `attributes` and `nsf_overdraft_transactions_count` to `cra/check_report/base_report/get`
751
+
752
+ ### 2020-09-14_1.570.3
753
+ - Update product list for `/partner/customer/create`
754
+
755
+ ### 2020-09-14_1.570.2
756
+ - Add `predicted_next_date` field to `/transactions/recurring/get`
757
+
758
+ ### 2020-09-14_1.570.1
759
+ - Add `end_customer` hidden field to `user/create` for client RealPage
760
+
761
+ ### 2020-09-14_1.569.5
762
+ - Show `date_of_birth` on the open API doc
763
+
764
+ ### 2020-09-14_1.569.4
765
+ - Add `ssn_last_4` to ConsumerReportUserIdentity
766
+
767
+ ### 2020-09-14_1.569.3
768
+ - Add `USER_FRAUD_ALERT` to BaseReportWarningCode
769
+
770
+ ### 2020-09-14_1.569.2
771
+ - Removed erroneous `required` attribute from `request_id` field in LinkMetadataEvent object.
772
+
773
+ ### 2020-09-14_1.569.1
774
+ - Add `processing_mode` field to the `PaymentInitiationConsentPaymentExecuteRequest` object for the `/payment_initiation/consent/payment/execute` endpoint
775
+
776
+ ### 2020-09-14_1.568.1
777
+ - Updated description of CRA Base Report API fields with new deprecation date
778
+
779
+ ### 2020-09-14_1.568.0
780
+ - Add `name` object to the `extracted_data` within each `documentary_verification.documents` object in the response of all of the identity verification endpoints:
781
+ - `identity_verification/create`
782
+ - `identity_verification/get`
783
+ - `identity_verification/list`
784
+ - `identity_verification/retry`
785
+
786
+ ### 2020-09-14_1.567.5
787
+ - Add `error_reason` to `/cra/check_report/partner_insights/get`
788
+
789
+ ### 2020-09-14_1.567.4
790
+ - [internal only] Hiding plaid_check_score_version from docs
791
+
792
+ ### 2020-09-14_1.567.3
793
+ - Update description for `email` field in `/identity_verification/create` and `/identity_verification/retry` to include link to RFC specification on email format
794
+
795
+ ### 2020-09-14_1.567.2
796
+ - Publish processor Paynote
797
+
798
+ ### 2020-09-14_1.567.1
799
+ - Update description for `add_ons` field in `/asset_report/create`
800
+
801
+ ### 2020-09-14_1.567.0
802
+ - [BREAKING] removed `products` field from `cra/check_report/create` request
803
+
804
+ ### 2020-09-14_1.566.0
805
+ - Added `status` to the `MonitoringInsightsWebhook` object
806
+ - Changed `webhook_code` to be deterministic
807
+
808
+ ### 2020-09-14_1.565.1
809
+ - Update `days_available` field description for Asset Reports and CRA Base Reports.
810
+
811
+ # 32.0.0
812
+ - Updating to OAS 2020-09-14_1.565.0
813
+
814
+ ## Breaking changes in this version
815
+ ### 2020-09-14_1.156.2
816
+ - [BREAKING] Remove `from_client_id` and `to_client_id` from `/transfer/ledger/distribute` request
817
+ - Add `from_ledger_id` and `to_ledger_id` to `/transfer/ledger/distribute` request
818
+ - Add `ledger_id` in transfer routes response examples
819
+
820
+ ### 2020-09-14_1.561.0
821
+ - [BREAKING] Add `authorization_id` to /transfer/get request and make `transfer_id` optional.
822
+
823
+ ### 2020-09-14_1.559.0
824
+ - Add `name`, `is_default` to /transfer/ledger/get response
825
+ - [BREAKING] Move `ledger_id` from nested `balance` struct to top level in /transfer/ledger/get response
826
+
827
+ ## OpenAPI Schema Changes
828
+ ### 2020-09-14_1.565.0
829
+ - Removed `deposit_switch` from the `products` field in the `/link/token/create` request
830
+ - Deprecated DepositSwitch endpoints, requests and response
831
+
832
+ ### 2020-09-14_1.564.0
833
+ - add `/issues/get`, `/issues/search`, and `/issues/subscribe` for Support API endpoints.
834
+
835
+ ### 2020-09-14_1.563.0
836
+ - Update fields on `item` object in `/item/get` response
837
+ - Add `consented_use_cases` field
838
+ - Add `consented_data_scopes` field
839
+ - Add `created_at` field
840
+ - Update descriptions for `consented_products` and `consent_expiration_time` fields
841
+ - Add `/consent/events/get` endpoint
842
+
843
+ ### 2020-09-14_1.157.1
844
+ - Internal changes
845
+
846
+ ### 2020-09-14_1.157.0
847
+ - (pre-release) Add `facial_analysis` to the `analysis` within each `selfie_check.selfies` object in the response of all of the identity verification endpoints:
848
+ - `identity_verification/create`
849
+ - `identity_verification/get`
850
+ - `identity_verification/list`
851
+ - `identity_verification/retry`
852
+
853
+ ### 2020-09-14_1.156.1
854
+ - Update `account type schema` link to reference the correct URL.
855
+
856
+ ### 2020-09-14_1.562.0
857
+ - Add `data_sources` object to the `/investments/auth/get` response
858
+ - `data_sources` object contains the `numbers`, `owners`, and `holdings` fields
859
+
860
+ ### 2020-09-14_1.560.0
861
+ - Add `pay_by_bank` to product enum list
862
+
863
+ ### 2020-09-14_1.558.0
864
+ - Add `liveness_check` to the `analysis` within each `selfie_check.selfies` object in the response of all of the identity verification endpoints:
865
+ - `identity_verification/create`
866
+ - `identity_verification/get`
867
+ - `identity_verification/list`
868
+ - `identity_verification/retry`
869
+
870
+ ### 2020-09-14_1.557.2
871
+ - Internal changes only
872
+
873
+ ### 2020-09-14_1.557.1
874
+ - Internal changes only
875
+
876
+ ### 2020-09-14_1.557.0
877
+ - Add `ledger_id` to /transfer/ledger/get response
878
+
879
+ # 31.0.0
880
+ - Updating to OAS 2020-09-14_1.556.0
881
+
882
+ ## Breaking changes in this version
883
+
884
+ ### 2020-09-14_1.548.0
885
+ - [BREAKING] Changed fields of `CraMonitoringGetResponse` to be simple `objects` instead of `arrays`
886
+ - [BREAKING] Moved `income_sources` to the `income` module in the response
887
+
888
+ ### 2020-09-14_1.545.0
889
+ - [BREAKING] Rename network attributes to network insights in the `cra/check_report/network_insights/get` schemas
890
+
891
+ ### 2020-09-14_1.543.2
892
+ - [Breaking] Added `data_breach` report type to BeaconReport response object
893
+
894
+ ### 2020-09-14_1.540.2
895
+ - [Breaking] Updated `document_status` field in `identity/document/upload` to include parsing_type
896
+
897
+ ## OpenAPI Schema Changes
898
+ ### 2020-09-14_1.556.0
899
+ - Added plural named array fields to `BaseReportAccountInsights` in /cra/base_report/get
900
+
901
+ ### 2020-09-14_1.555.0
902
+ - Add `require_all_items` field to /asset_report/create
903
+
904
+ ### 2020-09-14_1.554.0
905
+ - Add `sector` and `industry` properties to the `Security` model.
906
+
907
+ ### 2020-09-14_1.553.0
908
+ - Add `ISSUE_RESOLVED` webhook
909
+
910
+ ### 2020-09-14_1.552.0
911
+ - Add `ytd_amount` to `PaystubOverrideEarningsTotal` in /credit/payroll_income/get
912
+
913
+ ### 2020-09-14_1.551.0
914
+ - Internal changes only
915
+
916
+ ### 2020-09-14_1.550.0
917
+ - Add `/fdx/recipient` and `/fdx/recipients` endpoints
918
+
919
+ ### 2020-09-14_1.549.0
920
+ - Made fields required instead of omitempty for CRA Income Insights Transactions
921
+
922
+ ### 2020-09-14_1.548.4
923
+ - Set CreditAmountWithCurrency fields as required
924
+
925
+ ### 2020-09-14_1.548.3
926
+ - Added missing `LOGIN_REPAIRED` enum value to possible webhook codes for `/sandbox/item/fire_webhook` request in order to match endpoint description.
927
+
928
+ ### 2020-09-14_1.548.2
929
+ - [BREAKING] Moved `forecasted_monthly_income` to be a level higher.
930
+
931
+ ### 2020-09-14_1.548.1
932
+ - Made the fields in account_insights array fields as required.
933
+
934
+ ### 2020-09-14_1.548.0
935
+ - [BREAKING] Changed fields of `CraMonitoringGetResponse` to be simple `objects` instead of `arrays`
936
+ - [BREAKING] Moved `income_sources` to the `income` module in the response
937
+
938
+ ### 2020-09-14_1.547.2
939
+ - Add `cra_item_add_results` field to `results` object in `/link/token/get` response.
940
+
941
+ ### 2020-09-14_1.547.1
942
+ - Increase `/wallet/transactions/list` cursor size to 1024 characters.
943
+
944
+ ### 2020-09-14_1.547.0
945
+ - Add `ledger_id` to the request and response of a number of transfer endpoints.
946
+
947
+ ### 2020-09-14_1.546.0
948
+ - Added `WalletTransactionRelation` object.
949
+ - Added `related_transactions` field to WalletTransaction object.
950
+
951
+ ### 2020-09-14_1.545.3
952
+ - Some description updates to CRA Base Report fields
953
+
954
+ ### 2020-09-14_1.545.2
955
+ - Updated phone number examples in Identity Verification endpoints.
956
+
957
+ ### 2020-09-14_1.545.1
958
+ - Add `update.item_ids` field to `/link/token/create` request.
959
+
960
+ ### 2020-09-14_1.545.0
961
+ - [BREAKING] Rename network attributes to network insights in the `cra/check_report/network_insights/get` schemas
962
+
963
+ ### 2020-09-14_1.544.0
964
+ - Added `is_shareable` field to the `/identity_verification/retry` endpoint
965
+
966
+ ### 2020-09-14_1.543.2
967
+ - [Breaking] Added `data_breach` report type to BeaconReport response object
968
+
969
+ ### 2020-09-14_1.543.1
970
+ - Added `consumer_statement` field to `Account` in `BaseReport`
971
+ - make `warnings` for BaseReportGetResponse required
972
+
973
+ ### 2020-09-14_1.543.0
974
+ - Add `/network_insights/report/get`
975
+
976
+ ### 2020-09-14_1.542.0
977
+ - Added `error_code_reason` field to plaidError
978
+
979
+ ### 2020-09-14_1.541.1
980
+ - Add `update.user` field to `/link/token/create` request.
981
+
982
+ ### 2020-09-14_1.541.0
983
+ - (pre-release) Add `reauthorization_enabled` field to /link/token/create request
984
+
985
+ ### 2020-09-14_1.540.2
986
+ - [Breaking] Updated `document_status` field in `identity/document/upload` to include parsing_type
987
+
988
+ ### 2020-09-14_1.540.1
989
+ - Added `MonitoringInsightsWebhook`
990
+ - Added `webhook` field in `cra/monitoring_insights/subscribe`
991
+
992
+ ### 2020-09-14_1.540.0
993
+ - Added `file_type` field to `/credit/payroll_income/risk_signals/get`
994
+
995
+ ### 2020-09-14_1.539.0
996
+ - Add `authorization_usage` field to the `transfer/metrics/get` response
997
+
998
+ ### 2020-09-14_1.538.0
999
+ - Added cra/monitoring_insights/subscribe
1000
+ - Added cra/monitoring_insights/unsubscribe
1001
+ - Added cra/monitoring_insights/get
1002
+
1003
+ ### 2020-09-14_1.537.0
1004
+ - Added depository_accounts to Beacon
1005
+ - Added event_date to BeaconReports
1006
+
1007
+ ### 2020-09-14_1.536.0
1008
+ - Internal changes only
1009
+
1010
+ ### 2020-09-14_1.535.3
1011
+
1012
+ - Added missing values to `PlaidErrorType` enum.
1013
+
1014
+ ### 2020-09-14_1.535.2
1015
+ - Make some `CraBankIncomeSummary` fields visible.
1016
+ -
1017
+ ### 2020-09-14_1.535.1
1018
+
1019
+ ### 2020-09-14_1.535.0
1020
+ - [Breaking for Go] Updated `consumer_report_user_identity` field in `/user/update` to be required to reflect actual API behavior.
1021
+
1022
+ ### 2020-09-14_1.534.7
1023
+ - Add `stated_account_number_enabled` to `investments_auth` in `LinkTokenCreateRequest`
1024
+
1025
+ ### 2020-09-14_1.534.6
1026
+ - [Breaking] Updated base report endpoints and objects to include `cra` prefix
1027
+
1028
+ ### 2020-09-14_1.534.5
1029
+ - Add `enable_multi_item_link` field to `/link/token/create`
1030
+
1031
+ ### 2020-09-14_1.534.4
1032
+ - Undeprecate `/identity/match`'s `legal_name.is_business_name_detected`
1033
+
1034
+ # 30.0.0
1035
+ - Updating to OAS 2020-09-14_1.534.3
1036
+
1037
+ ## Breaking changes in this version
1038
+ ### 2020-09-14_1.532.2
1039
+ - [Breaking] Rename `/cra/check_report/network_attributes/get` to `/cra/check_report/network_insights/get`
1040
+
1041
+ ### 2020-09-14_1.528.0
1042
+ - [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
1043
+
1044
+ ### 2020-09-14_1.527.0
1045
+ - [Breaking] Removed `development.plaid.com` as a valid server and updated docs to remove references to Development, due to the decomissioning of the Development environment
1046
+
1047
+ ### 2020-09-14_1.526.0
1048
+ - [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
1049
+
1050
+ ## OpenAPI Schema Changes
1051
+ ### 2020-09-14_1.534.3
1052
+ - Add 'Beacon' to product enum list and make available in `/link/token/create` products
1053
+
1054
+ ### 2020-09-14_1.534.2
1055
+ - Mark some `BaseReportAccountInsights` fields as optional.
1056
+
1057
+ ### 2020-09-14_1.534.1
1058
+
1059
+ - Internal changes only
1060
+
1061
+ ### 2020-09-14_1.533.1
1062
+ - Add `user_action_required` to transfer authorization's `decision` enum.
1063
+ - Add `authorization_id` to transfer object in `/link/token/create` request.
1064
+
1065
+ ### 2020-09-14_1.533.0
1066
+ - Made `user` request field optional in `beacon/user/update`
1067
+
1068
+ ### 2020-09-14_1.532.4
1069
+ - fix `/cra/check_report/pdf/get` external doc url
1070
+
1071
+ ### 2020-09-14_1.532.3
1072
+ - Docs updates
1073
+
1074
+ ### 2020-09-14_1.532.2
1075
+ - [Breaking] Rename `/cra/check_report/network_attributes/get` to `/cra/check_report/network_insights/get`
1076
+
1077
+ ### 2020-09-14_1.532.1
1078
+
1079
+ - Internal changes only
1080
+
1081
+ ### 2020-09-14_1.531.1
1082
+ - Update idempotency key expiration time to 48 hours in `virtual-accounts/#wallet-transaction-execute-request-idempotency-key`
1083
+
1084
+ ### 2020-09-14_1.531.0
1085
+ - Add `balance_plus` to `products` in `LinkTokenCreateRequest`
1086
+ - Add `balance_plus` to `additional_consented_products` in `LinkTokenCreateRequest`
1087
+
1088
+ ### 2020-09-14_1.530.0
1089
+ - Add `/user/remove` endpoint
1090
+
1091
+ ### 2020-09-14_1.529.0
1092
+ - Added `/sandbox/user/reset_login` endpoint
1093
+
1094
+ ### 2020-09-14_1.528.0
1095
+ - Added `beacon/user/account_insights/get` endpoint
1096
+ - Updated `description`field for `access_tokens` in `beacon/user/create` and `beacon/user/update` requests
1097
+ - [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
1098
+
1099
+ ### 2020-09-14_1.527.0
1100
+ - [Breaking] Removed `development.plaid.com` as a valid server and updated docs to remove references to Development, due to the decomissioning of the Development environment
1101
+
1102
+ ### 2020-09-14_1.526.0
1103
+ - [Breaking] Renamed `/user_account/session/get` operationId `sessionGet` to `userAccountSessionGet` for consistency with existing API naming scheme.
1104
+
1105
+ # 29.0.0
1106
+ - Updating to OAS 2020-09-14_1.525.1
1107
+
1108
+ ## Breaking changes in this version
1109
+
1110
+ ### 2020-09-14_1.525.1
1111
+ [Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response
1112
+
1113
+ ### 2020-09-14_1.520.0
1114
+
1115
+ - [Breaking] Contains fixes to Balance Plus (beta):
1116
+ - [Breaking] Convert `risk_level` string to an enum object `RiskLevel`.
1117
+ - [Breaking] Adds missing `required` labels
1118
+
1119
+ ## OpenAPI Schema Changes
1120
+ ### 2020-09-14_1.525.1
1121
+ [Breaking] Renamed `bank_income` to `report` in the `cra/check_report/income_insights/get` response
1122
+
1123
+ ### 2020-09-14_1.524.1
1124
+
1125
+ - Remove `minLength` validations from several attributes. Fixes multiple validation bugs in the ruby client libraries which do not handle `nil` gracefully before this change.
1126
+
1127
+ ### 2020-09-14_1.524.0
1128
+
1129
+ - Add transfer refund event types to TransferEventType enum.
1130
+
1131
+ ### 2020-09-14_1.523.0
1132
+
1133
+ - Added support for the `layer` product.
1134
+
1135
+ ### 2020-09-14_1.522.0
1136
+
1137
+ - Added support for the `/user_account/session/get` API.
1138
+
1139
+ ### 2020-09-14_1.521.0
1140
+
1141
+ - Internal changes only
1142
+
1143
+ ### 2020-09-14_1.520.0
1144
+
1145
+ - [Breaking] Contains fixes to Balance Plus (beta):
1146
+ - [Breaking] Convert `risk_level` string to an enum object `RiskLevel`.
1147
+ - [Breaking] Adds missing `required` labels to certain fields within `BalancePlusAttributes`, `AccountsBalanceGetResponsePaymentRiskAssessment`, `AccountsBalanceGetRequestPaymentDetails`, and `RiskReason`.
1148
+ - Adds missing `additionalProperties` field to `BalancePlusAttributes`
1149
+ - Fix incorrect response example for Balance Plus
1150
+ - Docs updates for Balance Plus
1151
+
1152
+ ### 2020-09-14_1.519.0
1153
+
1154
+ - Add `rtp` to network options in `/transfer/intent/create`
1155
+ - Added `access_tokens` field to `/beacon/user/create` and `/beacon/user/update` requests
1156
+ - Added `item_ids` to `/beacon/user/*` responses
1157
+
1158
+ ### 2020-09-14_1.518.9
1159
+
1160
+ - Update `description` field for `decision_rationale` in `transfer/authorization/create` response
1161
+
1162
+ ### 2020-09-14_1.518.8
1163
+
1164
+ - Fix incorrect documentation for ENTITY_SCREENING: STATUS_UPDATED webhook which wrongly documented `screening_id` instead of `entity_screening_id` in the payload.
1165
+
1166
+ ### 2020-09-14_1.518.7
1167
+
1168
+ - Internal changes only
1169
+
1170
+ ### 2020-09-14_1.518.6
1171
+
1172
+ - Add `add_ons` in cra/check_report/pdf/get
1173
+
1174
+ ### 2020-09-14_1.518.5
1175
+
1176
+ - Internal changes only
1177
+
1178
+ ### 2020-09-14_1.518.4
1179
+
1180
+ - Add `Recall` as a possible Virtual Account wallet transaction type
1181
+
1182
+ ### 2020-09-14_1.518.3
1183
+
1184
+ - Internal changes only
1185
+
1186
+ ### 2020-09-14_1.518.2
1187
+
1188
+ - Documentation edits to cra endpoints
1189
+ - Add `income-sensitive repayment` to StudentRepaymentPlan and update description for repayment plan type
1190
+
1191
+ ### 2020-09-14_1.518.1
1192
+
1193
+ - Documentation edits to cra endpoints
1194
+ - Add item, account, and transaction IDs to `/cra/base_report/get` response
1195
+
1196
+ ### 2020-09-14_1.518.0
1197
+
1198
+ - Add several cra related properties to `/user/create` and `/link/token/create`
1199
+
1200
+ ### 2020-09-14_1.517.7
1201
+
1202
+ - Add `cra/check_report/pdf/get` endpoint
1203
+
1204
+ ### 2020-09-14_1.517.6
1205
+
1206
+ - Add `cra/check_report/base_report/get` endpoint
1207
+
1208
+ ### 2020-09-14_1.517.5
1209
+
1210
+ - Add `error_message` to `document_metadata` object for `credit/payroll_income/get` and `credit/bank_statements/uploads/get`
1211
+
1212
+ ### 2020-09-14_1.517.4
1213
+
1214
+ - Add `production` to the `secrets` object in `/partner/customer/create` response and deprecate `development`
1215
+
1216
+ ### 2020-09-14_1.517.3
1217
+
1218
+ - Add new enums to `canonical_description` in `credit/payroll_income/get`: `RETIREMENT`, `GIG ECONOMY`, and `STOCK COMPENSATION`
1219
+
1220
+ ### 2020-09-14_1.517.2
1221
+
1222
+ - Added `ITEM: EVENTS` webhook and example to documentation
1223
+
1224
+ ### 2020-09-14_1.517.1
1225
+
1226
+ - Added `public_tokens` on `SESSION_FINISHED` webhook
1227
+ - Deprecated `public_token` on `SESSION_FINISHED` webhook
1228
+ - Added `ITEM_ADD_RESULT` webhook
1229
+
1230
+ # 28.0.0
1231
+ - Updating to OAS 2020-09-14_1.517.0
1232
+
1233
+ ## Breaking changes in this version
1234
+ ### 2020-09-14_1.517.0
1235
+ - [Breaking] Update `onExit` field type in `/link/token/get` response from `LinkSessionExit` to `LinkSessionExitDeprecated`
1236
+
1237
+
1238
+ ## OpenAPI Schema Changes
1239
+ ### 2020-09-14_1.517.0
1240
+ - [Breaking] Update `/link/token/get` response structure
1241
+
1242
+ ### 2020-09-14_1.516.0
1243
+ - Internal changes only
1244
+
1245
+ ### 2020-09-14_1.515.0
1246
+ - Added `/cra/loans/applications/register`
1247
+ - Added `/cra/loans/register`
1248
+ - Added `/cra/loans/update`
1249
+ - Added `/cra/loans/unregister`
1250
+
1251
+ ### 2020-09-14_1.514.2
1252
+ - Added `days_since_first_observed transaction` as a field in the Account Risk Insights response.
1253
+
1254
+ ### 2020-09-14_1.514.1
1255
+ - Update `risk_profile_key`and `RiskProfile` description
1256
+
1257
+ ### 2020-09-14_1.514.0
1258
+ - Added `transfer/authorization/cancel` endpoint
1259
+
1260
+ ### 2020-09-14_1.513.0
1261
+ - Added `consumer_report/pdf/get` endpoint
1262
+
1263
+ ### 2020-09-14_1.512.0
1264
+ - Added support for address and date of birth in `/payment_initiation/payment/reverse` request.
1265
+
1266
+ ### 2020-09-14_1.511.0
1267
+ - Added `user_token` to `link/token/get` response metadata
1268
+ - Internal changes
1269
+
1270
+ ### 2020-09-14_1.510.2
1271
+ - Added `include_insights` to `/credit/relay/get` request
1272
+ -
1273
+ ### 2020-09-14_1.510.1
1274
+ - Add `database_insights_pending` as a potential enum value to `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus`.
1275
+ - Remove `database_insights_pass`, `database_insights_pass_with_caution` and `database_insights_fail` as potential values from `LinkDeliveryVerificationStatus` and `LinkSessionSuccessMetadataAccount.VerificationStatus`
1276
+
1277
+ ### 2020-09-14_1.510.0
1278
+ - Internal changes only
1279
+
1280
+ ### 2020-09-14_1.509.4
1281
+ - Internal changes only
1282
+
1283
+ ### 2020-09-14_1.509.3
1284
+ - Update description of transfer authorization decision code `MANUALLY_VERIFIED_ITEM`
1285
+
1286
+ ### 2020-09-14_1.509.2
1287
+ - Fixes to `RemovedTransaction` object definition: set `additionalProperties` explicitly to true and list `account_id` and `transaction_id` as `required`.
1288
+
1289
+ ### 2020-09-14_1.509.1
1290
+ - add `SMS_MICRODEPOSITS_VERIFICATION` to the `webhook_code` field of `/sandbox/item/fire_webhook`
1291
+
1292
+ ### 2020-09-14_1.509.0
1293
+ - Add `supports_payment_consents` to institution's `payment_initiation_metadata`.
1294
+
1295
+ # 27.0.0
1296
+ - Updating to OAS 2020-09-14_1.508.0
1297
+
1298
+ ## Breaking changes in this version
1299
+ ### 2020-09-14_1.504.2
1300
+ - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp.
1301
+ - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp.
1302
+
1303
+ ## OpenAPI Schema Changes
1304
+ ### 2020-09-14_1.508.0
1305
+ - Add new fields to `/cra/bank_income/get` endpoint
1306
+
1307
+ ### 2020-09-14_1.507.3
1308
+ - Add `paystub` and `w2` values to custom sandbox configuration schema
1309
+
1310
+ ### 2020-09-14_1.507.2
1311
+ - Mark `/transfer/balance/get` endpoint deprecated
1312
+
1313
+ ### 2020-09-14_1.507.1
1314
+ - Update `funds_available` description
1315
+
1316
+ ### 2020-09-14_1.507.0
1317
+ - Add `funds_available` transfer status and transfer event type
1318
+
1319
+ ### 2020-09-14_1.506.0
1320
+ - Add `statements` to the `options` field in the request object for `/sandbox/public_token/create` endpoint
1321
+
1322
+ ### 2020-09-14_1.505.1
1323
+ - Internal changes only
1324
+
1325
+ ### 2020-09-14_1.505.0
1326
+ - Add `profile` product
1327
+
1328
+ ### 2020-09-14_1.504.2
1329
+ - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp.
1330
+ - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferACHNetwork` to `TransferRecurringNetwork` as recurring now supports rtp.
1331
+
1332
+ ### 2020-09-14_1.504.1
1333
+ - Documentation updates for `/transactions/sync` and Database Match / Database Insights (beta).
1334
+
1335
+ ### 2020-09-14_1.504.0
1336
+ - Add new fields to `/transactions/sync` and `/processor/transactions/sync` endpoints
1337
+
1338
+ ### 2020-09-14_1.503.6
1339
+ - [Breaking change for Go client library] Make `start_date` and `end_date` required in the `statements` object for the `/link/token/create` endpoint
1340
+
1341
+ ### 2020-09-14_1.503.5
1342
+ - Improve description for `RiskCheckIdentityAbuseSignals`
1343
+
1344
+ # 26.0.1
1345
+ - Updating to OAS 2020-09-14_1.503.4
1346
+
1347
+ ## OpenAPI Schema Changes
1348
+ ### 2020-09-14_1.503.4
1349
+ - Improve description for `TransferNetworkTraceID`
1350
+
1351
+ ### 2020-09-14_1.503.3
1352
+ - Update description for `TransferNetworkTraceID`
1353
+
1354
+ ### 2020-09-14_1.503.2
1355
+ - Change `forecasted_average_monthly_income_prediction_intervals` to plural.
1356
+
1357
+ ### 2020-09-14_1.503.1
1358
+ - Add `has_more` field to /transfer/event/list and /transfer/event/sync to indicate there are more events to be pulled
1359
+
1360
+ ### 2020-09-14_1.503.0
1361
+ - Add new `/cra/base_report/create` endpoint
1362
+
1363
+ # 26.0.0
1364
+ - Updating to OAS 2020-09-14_1.502.4
1365
+
1366
+ ## Breaking changes in this version
1367
+ - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH.
1368
+ - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH.
1369
+
1370
+ ## OpenAPI Schema Changes
1371
+ ### 2020-09-14_1.502.4
1372
+ - Add `sms_microdeposits_verification_enabled` to `auth` object inside `/link/token/create` calls.
1373
+
1374
+ ### 2020-09-14_1.502.3
1375
+ - Added descriptions for `vested_quantity` and `vested_amount` fields for `investments/holdings/get`
1376
+ - Removed description for `vested_quantity` and `vested_amount` fields for `HoldingsOverride` object (for sandbox)
1377
+
1378
+ ### 2020-09-14_1.502.2
1379
+ - [Breaking] Update `network` field type in `/transfer/recurring/create` request from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH.
1380
+ - [Breaking] Update `network` field type in `RecurringTransfer` and `RecurringTransferNullable` from `TransferNetwork` to `TransferACHNetwork` since recurring currently only works for ACH.
1381
+
1382
+ ### 2020-09-14_1.502.1
1383
+ - Update description for `/item/remove` and `/asset_report/remove`
1384
+
1385
+ ### 2020-09-14_1.502.0
1386
+ - Add `client_report_id` fields to `/link/token/create` and `/cra/base_report/get`
1387
+
1388
+ ### 2020-09-14_1.501.2
1389
+ - Updating `insights` field in `/cra/partner_insights/get` response to contain both numerical and string values
1390
+
1391
+ ### 2020-09-14_1.501.1
1392
+ - Enable original description for all customers on `/transactions/get` endpoint
1393
+
1394
+ ### 2020-09-14_1.501.0
1395
+ [Breaking change for Go client library] Mark `address` field in `/beacon/user/create` as optional
1396
+
1397
+ ### 2020-09-14_1.500.0
1398
+ - Remove `prime_trust` processor partner
1399
+
1400
+ ### 2020-09-14_1.499.2
1401
+ - Fix broken link from previous update
1402
+
1403
+ ### 2020-09-14_1.499.1
1404
+ - Updated doc url for some Transfer and processor endpoints to support documentation reorganization
1405
+ - Minor documentation updates and clarifications
1406
+
1407
+ ### 2020-09-14_1.499.0
1408
+ - [Breaking change for Go client library] Make `account_id` optional in `/transactions/recurring/get` endpoint
1409
+
1410
+ ### 2020-09-14_1.489.3
1411
+ - Update description of `network_trace_id`
1412
+
1413
+ ### 2020-09-14_1.489.2
1414
+ - Correct documentation to indicate that `assets` is not supported in the `additional_consented_products` field
1415
+ - Remove `additionalProperties: true` incorrectly applied to `transferIntentGet` object and missed in `2020-09-14_1.352.0`. This will result in more strict type checking for this object, but should not be a breaking change.
1416
+
1417
+ ### 2020-09-14_1.498.1
1418
+ - Enable original description for all customers
1419
+
1420
+ ### 2020-09-14_1.498.0
1421
+ - Add `POST /beacon/account_risk/v1/evaluate` endpoint
1422
+
1423
+ ### 2020-09-14_1.497.0
1424
+ - Add `institution_id` to `processor/account/get` endpoint.
1425
+
1426
+ ### 2020-09-14_1.496.5
1427
+ - Update the description and enum values for `linked_services` in the response of all of the identity verification endpoints:
1428
+ - `identity_verification/create`
1429
+ - `identity_verification/get`
1430
+ - `identity_verification/list`
1431
+ - `identity_verification/retry`
1432
+
1433
+ ### 2020-09-14_1.496.4
1434
+ Add `POST /beacon/user/history/list`
1435
+
1436
+ ### 2020-09-14_1.496.3
1437
+ - Add `timestamp` to the beacon user's `audit_trail` object
1438
+ - Add `version` to the beacon user object.
1439
+
1440
+ # 25.0.0
1441
+ - Updating to OAS 2020-09-14_1.496.2
1442
+ - Added `ApiError` subclasses `ApiConnectionFailedError` and `ApiTimeoutError` to Ruby client library to indicate when the Faraday errors `ConnectionFailedError` and `TimeoutError` occur (https://github.com/plaid/plaid-ruby/pull/483)
1443
+
1444
+ ## Breaking changes in this version
1445
+
1446
+ - [Breaking] Introduce a new `AssetReportAccountBalance` object which duplicates the existing `AccountBalance` object with an additional `margin_loan_amount` field. Updated `AccountAssets.balances` to return the new `AssetReportAccountBalance` object instead of the existing `AccountBalance` object.
1447
+
1448
+ ## OpenAPI Schema Changes
1449
+ ### 2020-09-14_1.496.2
1450
+ - Adds prediction interval to `/cra/bank_income/get`
1451
+
1452
+ ### 2020-09-14_1.496.1
1453
+ - Update the descriptions for `risk_level` and `score` in `/accounts/balance/get`
1454
+
1455
+ ### 2020-09-14_1.496.0
1456
+ - Add `verification_insights` object to `Account` (closed beta feature - Database Insights)
1457
+ - Add `database_insights_pass`, `database_insights_pass_with_caution`, and `database_insights_fail` as new values for `verification_status` field (closed beta feature - Database Insights)
1458
+
1459
+ ### 2020-09-14_1.495.2
1460
+ - Add `pending idr` to student loan liability statuses
1461
+
1462
+ ### 2020-09-14_1.495.1
1463
+ - Add `processor_identity` product
1464
+
1465
+ ### 2020-09-14_1.494.1
1466
+ - Mark `wire_details` as nullable in the transfer object
1467
+
1468
+ ### 2020-09-14_1.494.0
1469
+ - Add `vested_quantity` and `vested_value` fields to the `Holding` object.
1470
+
1471
+ ### 2020-09-14_1.493.0
1472
+ - Add `POST /cra/partner_insights/get`
1473
+
1474
+ ### 2020-09-14_1.492.1
1475
+ - Added documentation for the `HOSTED_VERIFICATION` webhook.
1476
+ - Add `wire` to request and response of `/transfer/authorization/create`
1477
+
1478
+ ### 2020-09-14_1.492.0
1479
+ - Remove `page_count`, `name`, and `status` fields from Identity Document Upload's document metadata.
1480
+
1481
+ ### 2020-09-14_1.491.3
1482
+ - Increase max length of description field on `/transfer/intent/create` from 8 to 15
1483
+
1484
+ ### 2020-09-14_1.491.2
1485
+ - Added documentation for the `securities.type` field in `investments/holdings/get` and `investments/transactions/get` endpoints.
1486
+
1487
+ ### 2020-09-14_1.491.1
1488
+ - Add new `no_data` type to `name` and `date_of_birth` fields in `documentary_verification.documents[].analysis.extracted_data` in the response of all of the identity verification endpoints:
1489
+ - `identity_verification/create`
1490
+ - `identity_verification/get`
1491
+ - `identity_verification/list`
1492
+ - `identity_verification/retry`
1493
+
1494
+ ### 2020-09-14_1.491.0
1495
+ - Add `identity` object to `link/token/create` request body
1496
+
1497
+ ### 2020-09-14_1.490.0
1498
+ - Add `events` field to the `sessions` parameter in the `/link/token/get` response
1499
+
1500
+ ### 2020-09-14_1.489.1
1501
+ - Mark optional `scope` and `reference` fields in `/payment_initiation/consent/payment/execute` as nullable
1502
+
1503
+ ### 2020-09-14_1.489.0
1504
+ - Add optional `scope` and `reference` fields to `/payment_initiation/consent/payment/execute`
1505
+
1506
+ ### 2020-09-14_1.488.0
1507
+ - Add optional `item_ids` field to the request of `credit/payroll_income/get` and `credit/bank_statements/uploads/get`
1508
+
1509
+ ### 2020-09-14_1.487.2
1510
+ - Add `num_1099s_uploaded` to `document_income_results` object in `/credit/sessions/get` response
1511
+
1512
+ ### 2020-09-14_1.487.1
1513
+ - Correct the Document Income Verification `parsing_config` enum used by `/link/token/create` to contain `risk_signals` instead of `fraud_risk` to match the actual API implementation.
1514
+ - Dcumentation updates to reflect updates to Signal, including that new Items with Signal should now be created with `signal` in `/link/token/create` instead of using `/signal/prepare`.
1515
+
1516
+ ### 2020-09-14_1.487.0
1517
+ - [Breaking] Introduce a new `AssetReportAccountBalance` object which duplicates the existing `AccountBalance` object with an additional `margin_loan_amount` field. Updated `AccountAssets.balances` to return the new `AssetReportAccountBalance` object instead of the existing `AccountBalance` object.
1518
+ - Add `vested_quantity` and `vested_value` fields to the `AssetReportInvestments` object.
1519
+
1520
+ ### 2020-09-14_1.486.1
1521
+ - Update `bank_income_sources` in CRA Bank Income Get to be required in response since the empty array is being omitted.
1522
+
1523
+ ### 2020-09-14_1.486.0
1524
+ - Add `requires_real_time_balance_refresh`, `risk_reasons`, `attributes`, `balance_last_updated`, and `score` fields to `/accounts/balance/get` endpoint
1525
+
1526
+ ### 2020-09-14_1.485.1
1527
+ - Update `legal_name` description in `user` object in `/link/token.create` request
1528
+
1529
+ # 24.4.0
1530
+ - Updating to OAS 2020-09-14_1.485.0
1531
+
1532
+ ## OpenAPI Schema Changes
1533
+ ### 2020-09-14_1.485.0
1534
+ - Add `/processor/liabilities/get` endpoint
1535
+
1536
+ ### 2020-09-14_1.484.1
1537
+ - Add `/identity_verification/autofill/create` (closed beta)
1538
+
1539
+ ### 2020-09-14_1.484.0
1540
+ - Add `/statements/refresh` endpoint
1541
+
1542
+ ### 2020-09-14_1.483.2
1543
+ - Add `/beacon/duplicate/get` route
1544
+
1545
+ ### 2020-09-14_1.483.1
1546
+ - Internal changes only
1547
+
1548
+ ### 2020-09-14_1.483.0
1549
+ - Added net new fields to StatementsAccount object: `account_mask`, `account_subtype`, `account_official_name`
1550
+
1551
+ # 24.3.0
1552
+ - Updating to OAS 2020-09-14_1.482.3
1553
+ - Fix bug in error handling (https://github.com/plaid/plaid-ruby/issues/481) introduced in 24.1.0
1554
+
1555
+ ## OpenAPI Schema Changes
1556
+ ### 2020-09-14_1.482.3
1557
+ - Update `description` description for `/transfer/create`
1558
+
1559
+ ### 2020-09-14_1.482.2
1560
+ - Update /credit/relay/get response example
1561
+
1562
+ ### 2020-09-14_1.482.1
1563
+ - Update `funding_account_id` description for `/transfer/intent/create`
1564
+
1565
+ ### 2020-09-14_1.482.0
1566
+ - Adds a new field `payment_details` to `/accounts/balance/get` request
1567
+ - Adds a new field `payment_risk_assessment` to `/accounts/balance/get` response
1568
+
1569
+ ### 2020-09-14_1.481.1
1570
+ - Update `USER_ACCOUNT_REVOKED` description and set to visible
1571
+
1572
+ ### 2020-09-14_1.481.0
1573
+ - Add `available` to balance object in `wallet/get` and `wallet/list` response
1574
+
1575
+ ### 2020-09-14_1.480.1
1576
+ - Documentation-only change to Investments `Security` object for new fields and sandbox availability
1577
+
1578
+ ### 2020-09-14_1.480.0
1579
+ - Add `phone_number` to `/transactions/enrich` response
1580
+
1581
+ ### 2020-09-14_1.479.0
1582
+ - [Breaking change for Go client library] Make `street` and `city` optional in the address attribute of `identity_verification/create`
1583
+
1584
+ ### 2020-09-14_1.478.4
1585
+ - Add `registration_number` to `/partner/customer/create` request
1586
+
1587
+ ### 2020-09-14_1.478.3
1588
+
1589
+ ### 2020-09-14_1.478.2
1590
+ - Deprecate `funding_account_id` from `/transfer/recurring/create` request
1591
+
1592
+ ### 2020-09-14_1.478.1
1593
+ - Description-only changes to support Hosted Link (beta)
1594
+
1595
+ ### 2020-09-14_1.478.0
1596
+ - Add `market_identifier_code` and `option_contract` fields in the Security (investment) object
1597
+ - `option_contract` object contains `contract_type`, `expiration_date`, `strike_price`, and `underlying_security_ticker`
1598
+
1599
+ ### 2020-09-14_1.477.1
1600
+ - Changes `last_user_modified_date` to `last_user_modified_datetime` on transaction stream object.
1601
+
1602
+ ### 2020-09-14_1.477.0
1603
+ - Bug fix nullability definitions for `/beacon/user/create` and `/beacon/user/update` request payloads
1604
+
1605
+ ### 2020-09-14_1.476.1
1606
+ - Update Recurring Transaction description
1607
+
1608
+ ### 2020-09-14_1.476.0
1609
+ - Add `/beacon/user/update`
1610
+
1611
+ ### 2020-09-14_1.475.0
1612
+ - Add `/beacon/report_syndication/get` route
1613
+
1614
+ ### 2020-09-14_1.474.4
1615
+ - Add Statements Refresh webhook
1616
+
1617
+ ### 2020-09-14_1.474.3
1618
+ - Internal changes only
1619
+
1620
+ ### 2020-09-14_1.474.2
1621
+ - Deprecate `credit_funds_source` in `/transfer/authorization/create` request
1622
+
1623
+ ### 2020-09-14_1.474.1
1624
+
1625
+ - Added `identity_match` to Products schema object
1626
+
1627
+ # 24.2.0
1628
+
1629
+ - Updating to OAS 2020-09-14_1.474.0
1630
+
1631
+ ## OpenAPI Schema Changes
1632
+
1633
+ ### 2020-09-14_1.474.0
1634
+
1635
+ - Added `statements/refresh` endpoint
1636
+
1637
+ ### 2020-09-14_1.473.0
1638
+
1639
+ - Add Beacon webhooks
1640
+
1641
+ ### 2020-09-14_1.472.0
1642
+
1643
+ - Change client library visibility of `options.transactions.days_requested` field for `/link/token/create` and `/sandbox/public_token/create`
1644
+ - Add `options.days_requested` field to `/transactions/get` and `/transactions/sync`
1645
+
1646
+ ### 2020-09-14_1.471.0
1647
+
1648
+ [Breaking change for Go client libraries] Make `products` field in `/institutions/search` request optional to fix https://github.com/plaid/plaid-ruby/issues/476
1649
+
1650
+ # 24.1.0
1651
+
1652
+ - Updated OpenAPI generator version to 6.3.0 for bug fixes.
1653
+
1654
+ # 24.0.0
1655
+
1656
+ - Updating to OAS 2020-09-14_1.470.1
1657
+ - Enabled autoload for faster Ruby module loading. This is not anticipated to be a breaking change.
1658
+
1659
+ ## OpenAPI Schema Changes
1660
+
1661
+ ### 2020-09-14_1.470.1
1662
+
1663
+ ### 2020-09-14_1.470.0
1664
+
1665
+ - Add balance insights firleds to CRA Base Reports
1666
+
1667
+ ### 2020-09-14_1.469.1
1668
+
1669
+ - Change visibility of `/transactions/recurring/streams/...` endpoints
1670
+
1671
+ ### 2020-09-14_1.469.0
1672
+
1673
+ - Update date format in Base reports
1674
+
1675
+ ### 2020-09-14_1.468.0
1676
+
1677
+ - [Breaking change for Go client library] Mark `income_verification.access_tokens` and `access_token` nullable in `link/token/create` request, to match the actual behavior of the API.
1678
+ - Add `other` to `account_filters` in `link/token/create` request
1679
+
1680
+ ### 2020-09-14_1.467.0
1681
+
1682
+ - Change `/transactions/recurring/streams/merge` and `/transactions/recurring/streams/update` return type
1683
+
1684
+ ### 2020-09-14_1.466.0
1685
+
1686
+ - Add `/transactions/recurring/streams/create`, `/transactions/recurring/streams/merge`, and `/transactions/recurring/streams/update` endpoints
1687
+
1688
+ ### 2020-09-14_1.465.0
1689
+
1690
+ - [Breaking change for Go client library] Mark `products`, `required_if_supported_products`, `optional_products`, `additional_consented_products`, and `user.ssn` as nullable in `/link/token/create` request.
1691
+ - Set `minLength` for `client_name`, `language`, `access_token`, and `user.client_user_id` in `/link/token/create` request, to match actual validation behavior of the API.
1692
+
1693
+ ### 2020-09-14_1.464.1
1694
+
1695
+ - Add `webhook_code` to `/sandbox/income/fire_webhook`
1696
+ - Change `verification_status` to be an optional field in `/sandbox/income/fire_webhook`
1697
+
1698
+ ### 2020-09-14_1.464.0
1699
+
1700
+ - Add `/processor/signal/prepare` endpoint.
1701
+
1702
+ ### 2020-09-14_1.463.7
1703
+
1704
+ - Internal changes only
1705
+
1706
+ ### 2020-09-14_1.463.6
1707
+
1708
+ - Add `database_matched` to `verification_status` for database matched items.
1709
+
1710
+ ### 2020-09-14_1.463.5
1711
+
1712
+ - Add `hosted_link.url_lifetime_seconds` to `/link/token/create` request
1713
+
1714
+ ### 2020-09-14_1.463.4
1715
+
1716
+ - Add `database_match_enabled` field to `auth` object in `link/token/create`
1717
+
1718
+ ### 2020-09-14_1.463.3
1719
+
1720
+ - Mark `RecurringInsightsStream` fields `is_active`, `merchant_name`, and `average_days_apart` as required.
1721
+
1722
+ ### 2020-09-14_1.463.2
1723
+
1724
+ - Add `user_id` into the webhook schema for `AssetsProductReadyWebhook`
1725
+
1726
+ ### 2020-09-14_1.463.1
1727
+
1728
+ - [Breaking change for Go client library] Mark `access_token` and `account_id` required in `/transfer/create`, to match the actual behavior of the API.
1729
+
1730
+ ### 2020-09-14_1.463.0
1731
+
1732
+ - Add is_user_modified and last_user_modified_date to TransactionStream
1733
+
1734
+ ### 2020-09-14_1.462.0
1735
+
1736
+ - Update `/beta/transactions/user_insights/v1/get` endpoint with recurring transactions and feature updates.
1737
+
1738
+ ### 2020-09-14_1.461.2
1739
+
1740
+ - Clean up description for transfer refund simulate route.
1741
+
1742
+ ### 2020-09-14_1.461.1
1743
+
1744
+ - Remove `client_id` and `secret` from required param list of `/transfer/ledger/distribute`
1745
+
1746
+ ### 2020-09-14_1.461.0
1747
+
1748
+ - Add `/beacon/user/review` route for updating the status of Beacon Users
1749
+
1750
+ ### 2020-09-14_1.460.0
1751
+
1752
+ - Permissions manager API: bug fix: update `date` field in ConnectedApplication schema to `date-time` to match API behavior
1753
+ - Permissions manager API: add `/item/application/unlink` endpoint
1754
+
1755
+ ### 2020-09-14_1.459.2
1756
+
1757
+ - Do not support .docx or .doc file for `/transfer/diligence/document/upload`
1758
+
1759
+ ### 2020-09-14_1.459.1
1760
+
1761
+ - Make `products` request parameter for `/partner/customer/create` optional.
1762
+
1763
+ ### 2020-09-14_1.459.0
1764
+
1765
+ - Add route `/transfer/ledger/distribute`
1766
+
1767
+ ### 2020-09-14_1.458.1
1768
+
1769
+ - Refunds start processing after 4 days (not 3 days).
1770
+
1771
+ ### 2020-09-14_1.458.0
1772
+
1773
+ - Remove `account_ids` parameter `/processor/transactions/get` options object
1774
+ - Change `accounts` response field for `/processor/transactions/get` to `account`
1775
+
1776
+ ### 2020-09-14_1.457.4
1777
+
1778
+ Add BASE_REPORT_WARNING warning type
1779
+
1780
+ ### 2020-09-14_1.457.3
1781
+
1782
+ Add `BE` to the list of available countries
1783
+
1784
+ ### 2020-09-14_1.457.2
1785
+
1786
+ - Add `access_tokens` field to `/link/token/create` request
1787
+
1788
+ ### 2020-09-14_1.457.1
1789
+
1790
+ - Clean up description for transfer ledger simulate routes.
1791
+
1792
+ # 23.0.0
1793
+
1794
+ - Updating to OAS 2020-09-14_1.457.0
1795
+
1796
+ ## Breaking changes in this version
1797
+
1798
+ - Remove `user_token` field from `asset_report/create` request.
1799
+ - Renamed `TransactionsEnrichGetRequest` and `TransactionsEnrichGetResponse` objects to `TransactionsEnrichRequest` and `TransactionsEnrichResponse`.
1800
+
1801
+ ## OpenAPI Schema Changes
1802
+
1803
+ ### 2020-09-14_1.457.0
1804
+
1805
+ - Remove `account_ids` parameter from `/processor/transactions/recurring/get` request
1806
+
1807
+ ### 2020-09-14_1.456.0
1808
+
1809
+ - Add `hosted_link.completion_redirect_uri` to `link/token/create` request
1810
+
1811
+ ### 2020-09-14_1.455.2
1812
+
1813
+ - Deprecate max_single_transfer_amount and max_monthly_amount in /transfer/configuration/get response.
1814
+ - Deprecate monthly_transfer_volume in /transfer/metrics/get response.
1815
+
1816
+ ### 2020-09-14_1.455.1
1817
+
1818
+ - Update documentation for `/credit/payroll_income/parsing_config/update`
1819
+
1820
+ ### 2020-09-14_1.455.0
1821
+
1822
+ - Add new /sandbox/transfer/refund/simulate route to simulate refund events in sandbox.
1823
+
1824
+ ### 2020-09-14_1.454.0
1825
+
1826
+ - Add `is_investments_fallback_item` field to `/investments/holdings/get` and `/investments/transactions/get` responses
1827
+
1828
+ ### 2020-09-14_1.453.0
1829
+
1830
+ - Add `/credit/payroll_income/parsing_config/update` for updating the parsing configuration for document income verficiations
1831
+
1832
+ ### 2020-09-14_1.452.0
1833
+
1834
+ - Add `warnings` field to `/cra/base_report/get` response
1835
+
1836
+ ### 2020-09-14_1.451.0
1837
+
1838
+ - Add `/beacon/report_syndication/list` for listing `BeaconReportSyndication` objects linked to a specific `BeaconUser`
1839
+
1840
+ ### 2020-09-14_1.450.0
1841
+
1842
+ - [Breaking] Remove `user_token` field from `asset_report/create` request.
1843
+
1844
+ ### 2020-09-14_1.449.2
1845
+
1846
+ - Updates `isin` and `cusip` field descriptions for new call to action.
1847
+
1848
+ ### 2020-09-14_1.449.1
1849
+
1850
+ - Add new refund event types.
1851
+
1852
+ ### 2020-09-14_1.449.0
1853
+
1854
+ - Add `/beacon/report/list` for listing `BeaconReport` objects created for a specific `BeaconUser`
1855
+
1856
+ ### 2020-09-14_1.448.0
1857
+
1858
+ - Make `publisher` field from `FDXNotifications` as optional
1859
+
1860
+ ### 2020-09-14_1.447.0
1861
+
1862
+ - Mark `fraud_amount` as nullable for `BeaconReport` objects in `/beacon/report/create`
1863
+
1864
+ ### 2020-09-14_1.446.0
1865
+
1866
+ - Add `allow_manual_entry` field to `investments` object in `link/token/create`
1867
+ - Update `/credit/freddie_mac/reports/get` return type data shape to contain one object with both VOA and VOE assets combined
1868
+
1869
+ ### 2020-09-14_1.445.0
1870
+
1871
+ - Add new insights and counterparty fields for Transactions endpoints
1872
+ - Deprecate legacy category fields for Transactions endpoints
1873
+
1874
+ ### 2020-09-14_1.444.0
1875
+
1876
+ - Add new webhook type `AUTHORIZATION_GRANTED` to `sandbox/item/fire_webhook`
1877
+
1878
+ ### 2020-09-14_1.443.0
1879
+
1880
+ - Add `RETURN` as possible Virtual Account wallet transaction type
1881
+
1882
+ ### 2020-09-14_1.442.0
1883
+
1884
+ - Add `facilitator_fee` field for the Transfers endpoints
1885
+
1886
+ ### 2020-09-14_1.441
1887
+
1888
+ - [Breaking change for Go client library] Update `/transfer/capabilities/get` to no longer accept payment profile token and require an `account_id` and `access_token`
1889
+ - Update examples for ledger endpoints to be more realistic
1890
+
1891
+ ### 2020-09-14_1.440.0
1892
+
1893
+ - Add `optional_products` parameter to `/link/token/create` request.
1894
+
1895
+ ### 2020-09-14_1.439.0
1896
+
1897
+ - [Breaking] Renamed `TransactionsEnrichGetRequest` and `TransactionsEnrichGetResponse` objects to
1898
+ `TransactionsEnrichRequest` and `TransactionsEnrichResponse`.
1899
+
1900
+ ### 2020-09-14_1.438.1
1901
+
1902
+ - [Breaking change for Go client library] remove `device`, `user_present` from required request param list of `/transfer/recurring/create`
1903
+
1904
+ ### 2020-09-14_1.438.0
1905
+
1906
+ - Add new `/beta/transactions/user_insights/v1/get` endpoint
1907
+
1908
+ ### 2020-09-14_1.437.0
1909
+
1910
+ - Remove min/max restriction of `days_requested` in OpenAPI.
1911
+
1912
+ ### 2020-09-14_1.436.0
1913
+
1914
+ - Update `days_requested` to be a required field in base reports in `link/token/create`
1915
+
1916
+ ### 2020-09-14_1.435.0
1917
+
1918
+ - Update `/sandbox/transfer/sweep/simulate` to mark `swept` transfers as `swept_settled`.
1919
+
1920
+ ### 2020-09-14_1.434.0
1921
+
1922
+ - Added a new type of webhook for dashboard alerts, `InstitutionStatusAlertWebhook`.
1923
+
1924
+ ### 2020-09-14_1.433.0
1925
+
1926
+ - Update response of `/transfer/authorizarion/create`
1927
+
1928
+ ### 2020-09-14_1.432.0
1929
+
1930
+ - Update `days_requested` in `base_report` in `link/token/create` to enforce a min/max of 1/731 days
1931
+
1932
+ # 22.0.0
1933
+
1934
+ - Updating to OAS 2020-09-14_1.431.7
1935
+
1936
+ ## Breaking changes in this version
1937
+
1938
+ This version does not contain breaking changes.
1939
+
1940
+ ## OpenAPI Schema Changes
1941
+
1942
+ ### 2020-09-14_1.431.7
1943
+
1944
+ - Add processor Zero Hash
1945
+
1946
+ ### 2020-09-14_1.431.6
1947
+
1948
+ - Update response example of `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
1949
+
1950
+ ### 2020-09-14_1.431.5
1951
+
1952
+ - Update the description of `sweep.settled` event
1953
+
1954
+ ### 2020-09-14_1.431.4
1955
+
1956
+ - Update description of endpoint `/sandbox/transfer/ledger/simulate_available`
1957
+
1958
+ ### 2020-09-14_1.431.3
1959
+
1960
+ - Deprecate `originator_client_id` in `/transfer/get`, `/transfer/cancel`, and `/transfer/balance/get`
1961
+
1962
+ ### 2020-09-14_1.431.2
1963
+
1964
+ - Docs updates for Statements endpoints
1965
+
1966
+ ### 2020-09-14_1.431.1
1967
+
1968
+ - Remove `balance` field from response of `/sandbox/transfer/ledger/simulate_available`
1969
+
1970
+ ### 2020-09-14_1.431.0
1971
+
1972
+ - Add `/user/update` and update the description for consumer report user identity
1973
+
1974
+ ### 2020-09-14_1.430.3
1975
+
1976
+ - Add `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
1977
+
1978
+ ### 2020-09-14_1.430.2
1979
+
1980
+ - Update `transfer/sweep/list` to support filter by `trigger`
1981
+
1982
+ ### 2020-09-14_1.430.1
1983
+
1984
+ - Add `transfer/ledger/withdraw` route
1985
+
1986
+ ### 2020-09-14_1.430.0
1987
+
1988
+ - Add `transfer/originator/funding_account/update` route
1989
+
1990
+ ### 2020-09-14_1.429.3
1991
+
1992
+ - add ledger sweep event types to `TransferEventType`
1993
+
1994
+ ### 2020-09-14_1.429.2
1995
+
1996
+ - Documentation updates for `LOGIN_REPAIRED` webhook and transfer.
1997
+ - Add `transfer/ledger/deposit` route
1998
+
1999
+ ### 2020-09-14_1.429.1
2000
+
2001
+ - Updated /identity/match's address score threshold recommendation from 80 or above to 70 or above
2002
+
2003
+ ### 2020-09-14_1.429.0
2004
+
2005
+ - [Breaking change for Go client library] For Transfer endpoints that take payment profiles as input, remove `payment_profile` field and make
2006
+ `account_id` and `access_token` mandatory. The removed field is not in use.
2007
+ - Mark all payment profile-specific endpoints as `deprecated`.
2008
+ - Docs updates for Transfer, including clarifying that certain request fields for `/transfer/authorization/create`
2009
+ are not currently used.
2010
+ - Propagate Signal docs update from 2020-09-14_1.419.0 to all relevant endpoints.
2011
+ - Add `institution_not_supported` as a property to `LinkSessionExitMetadata.Status`
2012
+
2013
+ ### 2020-09-14_1.428.1
2014
+
2015
+ - Change `/credit/reports/freddie_mac/get` schema to contain new `ReportingInformationParentIdentifier` field
2016
+
2017
+ ### 2020-09-14_1.428.0
2018
+
2019
+ - Add `verification_report_type` to `asset_report/create` request
2020
+
2021
+ ### 2020-09-14_1.427.1
2022
+
2023
+ - Remove references to the verification `report_type` field in `asset_report/get` and `asset_report/pdf/get`
2024
+
2025
+ ### 2020-09-14_1.427.0
2026
+
2027
+ - Add `/processor/account/get` route
2028
+
2029
+ ### 2020-09-14_1.426.0
2030
+
2031
+ - Add `instant_microdeposits_enabled` field to `auth` object in `link/token/create`
2032
+
2033
+ ### 2020-09-14_1.425.0
2034
+
2035
+ - Add `investments` field to `asset_report/get` response as part of the `items.accounts` object
2036
+
2037
+ ### 2020-09-14_1.424.2
2038
+
2039
+ - Update descriptions of some Transactions endpoint fields
2040
+
2041
+ ### 2020-09-14_1.424.1
2042
+
2043
+ - Add clarification to processor webhook doc that the processor can call it
2044
+ - Fix `sandbox/transfer/ledger/simulate_available` doc url
2045
+
2046
+ ### 2020-09-14_1.424.0
2047
+
2048
+ - Add `/sandbox/transfer/ledger/simulate_available` route
2049
+
2050
+ ### 2020-09-14_1.423.0
2051
+
2052
+ - Update code of `BaseReportsErrorWebhook` to `ERROR`
2053
+ - Add new enum to StudentRepaymentPlan and add to description of repayment_plan_type
2054
+
2055
+ ### 2020-09-14_1.422.0
2056
+
2057
+ - Move `BaseReportsProductReadyWebhook` and `BaseReportsErrorWebhook`
2058
+ - Remove `asset_report_id` and add `user_id` to `BaseReportsErrorWebhook`
2059
+
2060
+ ### 2020-09-14_1.421.0
2061
+
2062
+ - Update permissible purpose code `LEGITIMATE_BUSINESS_NEED_TENANT_OTHER` to `LEGITIMATE_BUSINESS_NEED_OTHER`
2063
+
2064
+ ### 2020-09-14_1.420.1
2065
+
2066
+ - Add new enums to `canonical_description` in `credit/payroll_income/get`
2067
+
2068
+ ### 2020-09-14_1.420.0
2069
+
2070
+ - Add `database_match_enabled` field to `auth` object in `link/token/create`
2071
+
2072
+ ### 2020-09-14_1.419.2
2073
+
2074
+ - Add `/transfer/ledger/get` route
2075
+
2076
+ ### 2020-09-14_1.419.1
2077
+
2078
+ - Add `submitted` and `not_submitted` to transferDiligenceStatus
2079
+
2080
+ # 21.3.0
2081
+
2082
+ - Updating to OAS 2020-09-14_1.419.0
2083
+
2084
+ ## OpenAPI Schema Changes
2085
+
2086
+ ### 2020-09-14_1.419.0
2087
+
2088
+ - Update `/signal/decision/report` description
2089
+ - Overwriting `initiated` field is now supported and no longer returns an `INVALID_FIELD` error
2090
+
2091
+ ### 2020-09-14_1.418.0
2092
+
2093
+ - Add `frequency` to `/transactions/enrich`
2094
+
2095
+ ### 2020-09-14_1.417.0
2096
+
2097
+ - Remove `category`, `category_id`, `transaction_type`, `name`, `payment_meta` fields from Base Report insights
2098
+
2099
+ ### 2020-09-14_1.416.0
2100
+
2101
+ - Add `card_switch` to `/link/token/create`
2102
+
2103
+ ### 2020-09-14_1.415.0
2104
+
2105
+ - Add `consumer_report_permissible_purpose` to `link/token/create`
2106
+
2107
+ ### 2020-09-14_1.414.0
2108
+
2109
+ - Update `currency` on `payment/reverse` and `amount_refunded` on `payment/get`
2110
+
2111
+ # 21.2.0
2112
+
2113
+ - Updating to OAS 2020-09-14_1.413.0
2114
+
2115
+ ## OpenAPI Schema Changes
2116
+
2117
+ ### 2020-09-14_1.413.0
2118
+
2119
+ - Add `statements` to `/link/token/create` request
2120
+
2121
+ ### 2020-09-14_1.412.0
2122
+
2123
+ - Add `hosted_link_url` to `/link/token/create` response
2124
+ - Add `hosted_link.delivery_method` to `/link/token/create`
2125
+
2126
+ ### 2020-09-14_1.411.0
2127
+
2128
+ - Add `link_sessions` to `/link/token/get`
2129
+ - Add `LINK:SESSION_FINISHED` webhook
2130
+
2131
+ # 21.1.0
2132
+
2133
+ - Updating to OAS 2020-09-14_1.410.1
2134
+
2135
+ ## OpenAPI Schema Changes
2136
+
2137
+ ### 2020-09-14_1.410.1
2138
+
2139
+ - Add `statements` to the list of supported Plaid products in the `/link/token/create` endpoint
2140
+
2141
+ ### 2020-09-14_1.410.0
2142
+
2143
+ - add `/credit/relay/pdf/get` endpoint
2144
+
2145
+ ### 2020-09-14_1.409.0
2146
+
2147
+ - Add `original_client_id` to `/transfer/balance/get`
2148
+ - Mark `type` optional in `/transfer/balance/get` request
2149
+
2150
+ ### 2020-09-14_1.408.0
2151
+
2152
+ - Add `status` to `document_reference` in `/credit/payroll_income/risk_signals/get`
2153
+
2154
+ ### 2020-09-14_1.407.0
2155
+
2156
+ - Add `consumer_report_user_identity` to `/user/create`
2157
+
2158
+ ### 2020-09-14_1.406.1
2159
+
2160
+ - Add comment explaining availability of `confidence_level` field for `/transactions/*` endpoints
2161
+
2162
+ ### 2020-09-14_1.406.0
2163
+
2164
+ - Added insights fields to `/cra/base_report/get`
2165
+
2166
+ ### 2020-09-14_1.405.0
2167
+
2168
+ - Update identity/match user.address such that none of the fields are required
2169
+ - Add `AddressDataNullableNoRequiredFields`
2170
+
2171
+ ### 2020-09-14_1.404.1
2172
+
2173
+ - Allowing null failure_reason for refunds to be displayed
2174
+ -
2175
+
2176
+ ### 2020-09-14_1.404.0
2177
+
2178
+ - Add `failure_reason` to `/wallet/transaction/get` and `/wallet/transaction/list` endpoint in virtual accounts.
2179
+
2180
+ ### 2020-09-14_1.403.1
2181
+
2182
+ - Add `parsing_config` to `/link/token/create`
2183
+
2184
+ ### 2020-09-14_1.403.0
2185
+
2186
+ - Add `failure_reason` field to refunds for failed and returned refunds
2187
+
2188
+ ### 2020-09-14_1.402.0
2189
+
2190
+ - Add `area_code` match status to the response of the `identity_verification/get` and `identity_verification/list` endpoint
2191
+
2192
+ ### 2020-09-14_1.401.0
2193
+
2194
+ - Add `POST /cra/bank_income/get`
2195
+
2196
+ ### 2020-09-14_1.400.0
2197
+
2198
+ - Add `cra/base_report/get` endpoint
2199
+
2200
+ ### 2020-09-14_1.399.0
2201
+
2202
+ - Add `base_report` field to `/link/token/create` and corresponding Base Report webhooks
2203
+
2204
+ ### 2020-09-14_1.398.0
2205
+
2206
+ - Make CreditBankIncomeWebhookUpdateResponse visible
2207
+
2208
+ ### 2020-09-14_1.397.0
2209
+
2210
+ - Remove extraneous `Item` field from `/processor/transactions/get` response
2211
+ - Reference new `/processor/token/webhook/update` endpoint in processor Transactions routes.
2212
+
2213
+ ### 2020-09-14_1.396.2
2214
+
2215
+ - Document cash management account support
2216
+
2217
+ ### 2020-09-14_1.396.1
2218
+
2219
+ - Fix document capitalization of `confidence_level` field in `/transactions/enrich`
2220
+
2221
+ ### 2020-09-14_1.396.0
2222
+
2223
+ - Add `/beacon/report/create`
2224
+
2225
+ ### 2020-09-14_1.395.0
2226
+
2227
+ - Add `POST /beacon/user/create`
2228
+ - Add `POST /beacon/user/get`
2229
+
2230
+ ### 2020-09-14_1.394.0
2231
+
2232
+ - Made `/statements/list` and `/statements/download` APIs for Plaid's Statements PDF beta product available in client SDKs
2233
+
2234
+ ### 2020-09-14_1.393.0
2235
+
2236
+ - Add `date_of_birth` and `address` fields to `documentary_verification.documents[].extracted_data` in the response of all of the identity verification endpoints:
2237
+ - `identity_verification/create`
2238
+ - `identity_verification/get`
2239
+ - `identity_verification/list`
2240
+ - `identity_verification/retry`
2241
+
2242
+ ### 2020-09-14_1.392.4
2243
+
2244
+ - Update the following about identity/match name, phone number, email, and address score descriptions:
2245
+ - Ensure consistent language across all fields
2246
+ - Include score recommended "match" threshold for all fields.
2247
+
2248
+ ### 2020-09-14_1.392.3
2249
+
2250
+ - Update the `async_update` field description.
2251
+
2252
+ ### 2020-09-14_1.392.2
2253
+
2254
+ - Mark a few response fields as always present in the identity verification API:
2255
+ - `selfie_check.selfies[].capture.image_url`
2256
+ - `selfie_check.selfies[].capture.video_url`
2257
+ - `risk_check.identity_abuse_signals`
2258
+ - `risk_check.identity_abuse_signals.synthetic_identity.score`
2259
+ - `risk_check.identity_abuse_signals.stolen_identity.score`
2260
+
2261
+ ### 2020-09-14_1.392.1
2262
+
2263
+ - Documentation updates for the `/link/token/create` endpoint
2264
+
2265
+ ### 2020-09-14_1.392.0
2266
+
2267
+ - Add `confidence_level` field to Counterparty and PersonalFinanceCategory for `/transactions/enrich`
2268
+
2269
+ ### 2020-09-14_1.391.3
2270
+
2271
+ - Remove the `core_attributes` field in `signal_insights` of /transfer/authorization/create
2272
+
2273
+ ### 2020-09-14_1.391.2
2274
+
2275
+ - Update the `pending_manual_verification` field's description in `/auth/get` response
2276
+
2277
+ # 21.0.0
2278
+
2279
+ - Updating to openapi-generator v6.1 to enable autoload support
2280
+ - Updating to OAS 2020-09-14_1.391.1
2281
+
2282
+ ## Breaking changes in this version
2283
+
2284
+ This version does not contain breaking changes.
2285
+
2286
+ ## OpenAPI Schema Changes
2287
+
2288
+ ### 2020-09-14_1.391.1
2289
+
2290
+ - Update the description of `/investments/transactions/get`
2291
+
2292
+ ### 2020-09-14_1.391.0
2293
+
2294
+ - Update the `async_update` option to be visible in `/investments/transactions/get`
2295
+
2296
+ ### 2020-09-14_1.390.1
2297
+
2298
+ - Update the `signal_insights` field's description in `/transfers/authorization/create` request
2299
+
2300
+ ### 2020-09-14_1.390.0
2301
+
2302
+ - Add `transfer_id` field to `/transfers/sweep/list` request
2303
+
2304
+ ### 2020-09-14_1.389.0
2305
+
2306
+ - Add `InvestmentsHistoricalUpdateWebhook`, a `HISTORICAL_UPDATE` webhook of type `INVESTMENTS_TRANSACTIONS`.
2307
+
2308
+ ### 2020-09-14_1.388.1
2309
+
2310
+ - Add `status` field to a sweep object. Add `status` field to `/transfers/sweep/list` request
2311
+
2312
+ ### 2020-09-14_1.388.0
2313
+
2314
+ - [Breaking] Remove `asset_report_token` as required field in `/asset_report/get` and mark as nullable
2315
+
2316
+ ### 2020-09-14_1.387.1
2317
+
2318
+ - Allow empty `mask` on the `meta` field of overridden accounts in the sandbox custom user configuration object schema.
2319
+
2320
+ ### 2020-09-14_1.387.0
2321
+
2322
+ - Mark `region` and `postal_code` fields as nullable in `/identity_verification/create`, `/identity_verification/retry`, and `/link/token/create`
2323
+
2324
+ ### 2020-09-14_1.386.0
2325
+
2326
+ - Add payloads for processor Transactions webhooks.
2327
+
2328
+ ### 2020-09-14_1.385.2
2329
+
2330
+ - Mark `next_origination_date` nullable
2331
+
2332
+ # 20.0.0
2333
+
2334
+ - Updating to OAS 2020-09-14_1.385.1
2335
+
2336
+ ## Breaking changes in this version
2337
+
2338
+ - (Identity Verification) Renamed `IdentityVerificationRequestUser` object to `IdentityVerificationCreateRequestUser`
2339
+
2340
+ ## OpenAPI Schema Changes
2341
+
2342
+ ### 2020-09-14_1.385.1
2343
+
2344
+ - Add expiration time description to `transfer/authorization/create` `idempotency_key` parameter
2345
+
2346
+ ### 2020-09-14_1.385.0
2347
+
2348
+ - Add `user` field to `/identity_verification/retry`
2349
+ - Add `client_user_id` field to `/identity_verification/create`
2350
+ - Deprecate `user.client_user_id` field in `/identity_verification/create`
2351
+ - [Breaking] Renamed `IdentityVerificationRequestUser` object to `IdentityVerificationCreateRequestUser`
2352
+
2353
+ ### 2020-09-14_1.384.0
2354
+
2355
+ - Remove `maxLength` constraint from `client_user_id` field for `/processor/signal/evaluate` and `/signal/evaluate` requests
2356
+
2357
+ ### 2020-09-14_1.383.3
2358
+
2359
+ - Add `test_clock_id` to `transfer/authorization/create` request
2360
+
2361
+ ### 2020-09-14_1.383.2
2362
+
2363
+ - Update `InvestmentsAuthOwner` title
2364
+
2365
+ ### 2020-09-14_1.383.1
2366
+
2367
+ - Add `account_id` to `bank_accounts` and `transactions` in `/credit/bank_statements/uploads/get` response
2368
+
2369
+ ### 2020-09-14_1.383.0
2370
+
2371
+ - Add `transfer/diligence/document/upload` endpoint
2372
+
2373
+ ### 2020-09-14_1.382.1
2374
+
2375
+ - Add `amount` to `/transfer/sweep/list` request
2376
+
2377
+ ### 2020-09-14_1.382.0
2378
+
2379
+ - Add `signal_insights` to `/transfer/authorization/create` request
2380
+
2381
+ ### 2020-09-14_1.381.0
2382
+
2383
+ - Add definitions for `/sandbox/bank_income/fire_webhook`
2384
+
2385
+ ### 2020-09-14_1.380.0
2386
+
2387
+ - Update validation `sweep_id` for `/transfers/sweep/get` to allow UUID or 8 character hexadecimal string
2388
+
2389
+ # 19.1.0
2390
+
2391
+ - Updating to OAS 2020-09-14_1.379.0
2392
+
2393
+ ## OpenAPI Schema Changes
2394
+
2395
+ ### 2020-09-14_1.379.0
2396
+
2397
+ - Add `scheme` to `/wallet/transaction/get` and `/wallet/transaction/list`
2398
+
2399
+ ### 2020-09-14_1.378.1
2400
+
2401
+ - Fix issue in which `request_id` was erroneously not listed as required in `ItemActivityListResponse`
2402
+
2403
+ ### 2020-09-14_1.378.0
2404
+
2405
+ - Add `reroute_to_credentials` to `/link/token/create` auth request
2406
+
2407
+ ### 2020-09-14_1.377.0
2408
+
2409
+ - Add definitions for `/investments/auth/get`
2410
+
2411
+ ### 2020-09-14_1.376.0
2412
+
2413
+ - Add `required_if_supported_products` to `/link/token/create` request
2414
+
2415
+ ### 2020-09-14_1.375.0
2416
+
2417
+ - Add hidden `account_type` to `/transactions/enrich` request and response
2418
+ - Add hidden `account_subtype` to `/transactions/enrich` request and response
2419
+
2420
+ ### 2020-09-14_1.374.3
2421
+
2422
+ - Add `num_bank_statements_uploaded` to `document_income_results` object in `/credit/sessions/get` response
2423
+
2424
+ ### 2020-09-14_1.374.2
2425
+
2426
+ - Add `income_source` enum to `/transactions/enrich` `counterparty_type` field
2427
+
2428
+ ### 2020-09-14_1.374.1
2429
+
2430
+ - Update `oauth` descriptions for `/institutions/get` and `/institutions/search`
2431
+
2432
+ ### 2020-09-14_1.374.0
2433
+
2434
+ - Add `/credit/bank_statements/uploads/get` endpoint
2435
+
2436
+ ### 2020-09-14_1.373.0
2437
+
2438
+ - Add support for address and date of birth in `virtual-accounts/#wallettransactionexecute` endpoint
2439
+
2440
+ ### 2020-09-14_1.372.3
2441
+
2442
+ - Modify `/transactions/enrich` field `user_id` to `client_user_id`
2443
+ - Modify `/transactions/enrich` field `account_id` to `client_account_id`
2444
+
2445
+ ### 2020-09-14_1.372.2
2446
+
2447
+ - Update docs for `/transactions/enrich` response to include non-null example values for `lat` and `lon` fields
2448
+
2449
+ ### 2020-09-14_1.372.1
2450
+
2451
+ - Update descriptions for `PAYMENT_STATUS_EXECUTED` and `PAYMENT_STATUS_INITIATED`
2452
+ - Update description for `PaymentAmountCurrency`
2453
+
2454
+ ### 2020-09-14_1.372.0
2455
+
2456
+ - Add `user_id` and `account_id` fields to `/transactions/enrich` request and resposne
2457
+
2458
+ ### 2020-09-14_1.371.4
2459
+
2460
+ - Update descriptions for `/credit/payroll_income/risk_signals/get` and `INCOME_VERIFICATION_RISK_SIGNALS` webhook
2461
+
2462
+ ### 2020-09-14_1.371.3
2463
+
2464
+ - Add test_clock_id to `/transfer/simulate`
2465
+ - [Breaking change for Go] Make `virtual_time` optional in `/sandbox/transfer/test_clock/create`
2466
+
2467
+ ### 2020-09-14_1.371.2
2468
+
2469
+ - Add test_clock_id to `/sandbox/transfer/simulate` and `/sandbox/transfer/sweep/simulate` endpoints
2470
+
2471
+ ### 2020-09-14_1.371.1
2472
+
2473
+ - Update `transfer/diligence/submit` copy
2474
+
2475
+ # 19.0.0
2476
+
2477
+ - Updating to OAS 2020-09-14_1.370.0
2478
+
2479
+ ## Breaking changes in this version
2480
+
2481
+ - Converts some integers that were incorrectly typed as `Float` to `Integer`. For more details, see the changelog notes for 2020-09-14_1.349.0.
2482
+
2483
+ ## OpenAPI Schema Changes
2484
+
2485
+ ### 2020-09-14_1.370.0
2486
+
2487
+ - Add `investments/refresh` endpoint
2488
+
2489
+ ### 2020-09-14_1.369.3
2490
+
2491
+ - Update `description` field in `/transfer/create` to have max length of 15
2492
+
2493
+ ### 2020-09-14_1.369.2
2494
+
2495
+ - Add new `CreditBankIncomeCategory` value
2496
+
2497
+ ### 2020-09-14_1.369.1
2498
+
2499
+ - Fix `/processor/transactions` routes doc links
2500
+
2501
+ ### 2020-09-14_1.369.0
2502
+
2503
+ - Add `/processor/token/permissions/get` endpoint
2504
+ - Add `/processor/token/permissions/set` endpoint
2505
+
2506
+ ### 2020-09-14_1.368.2
2507
+
2508
+ - Add `transfer/diligence/submit` endpoint
2509
+
2510
+ ### 2020-09-14_1.368.1
2511
+
2512
+ - Update `client_user_id` description for Identity Verification endpoints
2513
+ - Update `user` description for Identity Match via Identity Verification Data use case
2514
+
2515
+ ### 2020-09-14_1.368.0
2516
+
2517
+ - Add `/transfer/balance/get` endpoint
2518
+
2519
+ ### 2020-09-14_1.367.0
2520
+
2521
+ - Added `LinkEventsWebhook` schema
2522
+
2523
+ ### 2020-09-14_1.366.0
2524
+
2525
+ - Add `credit_funds_source` field for authorizations and transfers
2526
+ - Make `funding_account_id` nullable in various /transfer API responses
2527
+
2528
+ ### 2020-09-14_1.356.0
2529
+
2530
+ - Update `notificationsPayload.customFields` datatype from an object to an array of objects
2531
+
2532
+ ### 2020-09-14_1.355.1
2533
+
2534
+ - Added `warnings` to `/processor/signal/evaluate` response.
2535
+
2536
+ ### 2020-09-14_1.355.0
2537
+
2538
+ - Added `/processor/identity/match` endpoint.
2539
+
2540
+ ### 2020-09-14_1.354.0
2541
+
2542
+ - Adds a `selfie_check` object to the response schema of all the identity verification endpoints:
2543
+ - `identity_verification/create`
2544
+ - `identity_verification/get`
2545
+ - `identity_verification/list`
2546
+ - `identity_verification/retry`
2547
+
2548
+ ### 2020-09-14_1.353.1
2549
+
2550
+ - Update `INCOME_VERIFICATION_RISK_SIGNALS` with webhook tag
2551
+
2552
+ ### 2020-09-14_1.353.0
2553
+
2554
+ - Add `ASSETS: PRODUCT_READY` and `ASSETS: ERROR` webhooks to `/sandbox/item/fire_webhook` endpoint
2555
+
2556
+ ### 2020-09-14_1.352.0
2557
+
2558
+ - Removed explicit `additionalProperties: true` marker for request objects and objects used only within request objects, primarily impacting the Payment Initiation API. This will result in more strict type checking for those objects, but should not be a breaking change.
2559
+
2560
+ ### 2020-09-14_1.351.1
2561
+
2562
+ - Update `transfer/authorization/create` copy
2563
+
2564
+ ### 2020-09-14_1.351.0
2565
+
2566
+ - Add new `INCOME_VERIFICATION_RISK_SIGNALS` webhook
2567
+
2568
+ ### 2020-09-14_1.350.0
2569
+
2570
+ - Remove `settled_amount`
2571
+ - Rename `expected_settlement_schedule` as `expected_sweep_settlement_schedule`
2572
+
2573
+ ### 2020-09-14_1.349.0
2574
+
2575
+ - [Breaking] Converts several types that were incorrectly typed as `number` to `integer`. In some languages, this will change the type used for this field, which may be a breaking change for some Plaid integrations. The following fields are impacted:
2576
+
2577
+ For all products:
2578
+
2579
+ - `PlaidError.status`
2580
+
2581
+ For Liabilities:
2582
+
2583
+ - `PSLFStatus.payments_made`
2584
+ - `PSLFStatus.payments_remaining`
2585
+
2586
+ For Identity Verification and Monitor:
2587
+
2588
+ - `DocumentaryVerificationDocument.DocumentAnalysis.attempt`
2589
+ - `EntityScreeningHitAnalysis.search_terms_version`
2590
+ - `EntityWatchlistScreeningSearchTerms.search_terms_version`
2591
+ - `IdentityVerificationTemplateReference.version`
2592
+
2593
+ The following client library languages are impacted:
2594
+
2595
+ - Go: Type changes from Float64 to Int32
2596
+ - Java: Type changes from Double to Integer
2597
+ - Python: Type changes from float to int
2598
+ - Ruby: Type changes from Float to Integer
2599
+
2600
+ ### 2020-09-14_1.348.2
2601
+
2602
+ - Update `/identity/match`'s score description to explicitly mention that null values are returned if input is missing from either the financial institution or the API
2603
+ - Update `/identity/match` sample response to include `is_business_name_detected`
2604
+
2605
+ ### 2020-09-14_1.348.1
2606
+
2607
+ - Make the `warnings` field in `SignalEvaluateResponse` non-nullable
2608
+
2609
+ ### 2020-09-14_1.348.0
2610
+
2611
+ - Add `STARTED` and `INTERNAL_ERROR` to bank income and employment `/credit/sessions/get` status
2612
+
2613
+ ### 2020-09-14_1.347.1
2614
+
2615
+ - Change invalid format `datetime` to `date` on `initiated_date` field
2616
+ - Update `SignalWarning` descriptions
2617
+
2618
+ ### 2020-09-14_1.347.0
2619
+
2620
+ Fix npm publish
2621
+
2622
+ ### 2020-09-14_1.346.0
2623
+
2624
+ - Releasing new `/credit/payroll_income/risk_signals/get` endpoint
2625
+
2626
+ ### 2020-09-14_1.345.4
2627
+
2628
+ - Revert `sweep_amount` description
2629
+
2630
+ ### 2020-09-14_1.345.3
2631
+
2632
+ - Update `sweep_amount` description
2633
+
2634
+ ### 2020-09-14_1.345.2
2635
+
2636
+ - Internal changes
2637
+
2638
+ # 18.1.0
2639
+
2640
+ - Updating to OAS 2020-09-14_1.345.1
2641
+
2642
+ ## OpenAPI Schema Changes
2643
+
2644
+ ### 2020-09-14_1.345.1
2645
+
2646
+ - Update `/transactions/enrich` field `is_recurring` field to be optional.bool
2647
+
2648
+ ### 2020-09-14_1.345.0
2649
+
2650
+ - Fix bug in which `environment` field was incorrectly missing from Assets webhooks.
2651
+
2652
+ ### 2020-09-14_1.344.0
2653
+
2654
+ - Add recurrence and is_recurring fields to `/transactions/enrich`
2655
+
2656
+ ### 2020-09-14_1.343.6
2657
+
2658
+ - Update incorrect required fields for `/watchlist_screening/entity/update`
2659
+
2660
+ ### 2020-09-14_1.343.5
2661
+
2662
+ - Update `owners` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get`
2663
+
2664
+ ### 2020-09-14_1.343.4
2665
+
2666
+ - Make comment about `webhook` field in `/link/token/create` request more explicit
2667
+
2668
+ ### 2020-09-14_1.343.3
2669
+
2670
+ - Make VOA in /credit/freddie_mac/reports/get optional
2671
+
2672
+ ### 2020-09-14_1.343.2
2673
+
2674
+ - Update `warnings` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get`
2675
+
2676
+ ### 2020-09-14_1.343.1
2677
+
2678
+ - Updated Asset endpoint descriptions related to Verification of Employment
2679
+
2680
+ # 18.0.0
2681
+
2682
+ - Updating to OAS 2020-09-14_1.343.0
2683
+
2684
+ ## Breaking changes in this version
2685
+
2686
+ - (Identity Verification) Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
2687
+
2688
+ ## OpenAPI Schema Changes
2689
+
2690
+ ### 2020-09-14_1.343.0
2691
+
2692
+ - Add new `warnings` field to the response of `/signal/evaluate`
2693
+
2694
+ ### 2020-09-14_1.342.0
2695
+
2696
+ - Add `report_type` to assets webhook docs
2697
+ - Make `add_ons` public in assets docs for /asset_report/create
2698
+ - Make `fast_report` public in assets docs for /asset_report/get
2699
+
2700
+ ### 2020-09-14_1.341.0
2701
+
2702
+ - Add `risk_check` attribute to all Identity Verification responses
2703
+
2704
+ ### 2020-09-14_1.340.1
2705
+
2706
+ - Update examples for `entity_id` in `/transactions/enrich`
2707
+
2708
+ ### 2020-09-14_1.340.0
2709
+
2710
+ - Create `options` in `/link_delivery/create`
2711
+ - Create `recipient` within `options` field
2712
+ - Move `communication_methods` from top level to `recipient`
2713
+ - Add `first_name` in `recipient`
2714
+
2715
+ ### 2020-09-14_1.339.0
2716
+
2717
+ - Add `callback_type` to link delivery webhooks
2718
+
2719
+ ### 2020-09-14_1.338.2
2720
+
2721
+ - Make `communication_methods` optional in `/link_delivery/create`
2722
+
2723
+ ### 2020-09-14_1.338.1
2724
+
2725
+ - Remove beta description from `/transactions/enrich` endpoint docs
2726
+
2727
+ ### 2020-09-14_1.338.0
2728
+
2729
+ - Add `transaction_id` to `/payment-initiation/#payment_status_update`
2730
+ - Add `payment_id` and `wallet_id` to `/virtual-accounts/#wallet_transaction_status_update`
2731
+
2732
+ ### 2020-09-14_1.337.4
2733
+
2734
+ - Modify documentation for credit categories in the `/asset_report/get` based on GTM feedback
2735
+
2736
+ ### 2020-09-14_1.337.3
2737
+
2738
+ - Update description for the `address` field in `/payment_initiation/recipient/create`.
2739
+
2740
+ ### 2020-09-14_1.337.2
2741
+
2742
+ - Add annually recurring frequency to `/transactions/recurring/get`
2743
+
2744
+ ### 2020-09-14_1.337.1
2745
+
2746
+ - Make documentation for credit categories in the `/asset_report/get` endpoint public
2747
+
2748
+ ### 2020-09-14_1.337.0
2749
+
2750
+ - Add bank employment results to `/credit/sessions/get`
2751
+
2752
+ ### 2020-09-14_1.336.1
2753
+
2754
+ - Add `signal` to Products array.
2755
+
2756
+ ### 2020-09-14_1.336.0
2757
+
2758
+ - Add options to `/credit/payroll_income/refresh` to allow item-level refresh
2759
+
2760
+ ### 2020-09-14_1.335.2
2761
+
2762
+ - Updated `amount.value` description field with new minimum requirement for `/payment_initiation/payment/reverse` and `/wallet/transaction/execute`
2763
+
2764
+ ### 2020-09-14_1.335.1
2765
+
2766
+ - Add 'employment' as an available product in the request to `/partner/customer/create`
2767
+
2768
+ ### 2020-09-14_1.335.0
2769
+
2770
+ - [Breaking] Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
2771
+
2772
+ # 17.4.0
2773
+
2774
+ - Updating to OAS 2020-09-14_1.334.0
2775
+
2776
+ ## OpenAPI Schema Changes
2777
+
2778
+ ### 2020-09-14_1.334.0
2779
+
2780
+ - Add "entity_id" field to /transactions/enrich
2781
+
2782
+ ### 2020-09-14_1.333.0
2783
+
2784
+ - Add "add_ons" field to asset_report/create
2785
+
2786
+ ### 2020-09-14_1.332.0
2787
+
2788
+ - [Breaking] Remove `/wallet/transaction/list` endpoint
2789
+ - [Note] Determined that `/wallet/transaction/list` is unused
2790
+
2791
+ ### 2020-09-14_1.331.0
2792
+
2793
+ Add `LinkDeliveryCallbackWebhook`, `LinkUserDeliveryStatusWebhook` for Link Delivery.
2794
+
2795
+ ### 2020-09-14_1.330.0
2796
+
2797
+ - [Breaking] Remove `options.wallet_id` field in `/payment_initiation/payment/create` and `/payment_initiation/consent/create` request.
2798
+ - [Note] Determined that this field is unused.
2799
+
2800
+ ### 2020-09-14_1.229.2
2801
+
2802
+ - Undeprecated the `legal_name` field in the `/link/token/create` request.
2803
+
2804
+ ### 2020-09-14_1.229.1
2805
+
2806
+ - Add `income_verification` as a supported product in the request for `/partner/customer/create`.
2807
+
2808
+ ### 2020-09-14_1.229.0
2809
+
2810
+ - Add `network` field to `/transfer/intent/create` request.
2811
+ - Updated `reference` minLength for `/wallet/transaction/execute` request and `/payment_initiation/payment/reverse` request.
2812
+
2813
+ ### 2020-09-14_1.228.0
2814
+
2815
+ - Add `access_tokens` and `item_ids` to `/link_delivery/get` response
2816
+
2817
+ ### 2020-09-14_1.227.0
2818
+
2819
+ - Add optional `persistent_account_id` field to account responses
2820
+
2821
+ ### 2020-09-14_1.226.0
2822
+
2823
+ - Add `employment` fields to `/link/token/create`
2824
+
2825
+ ### 2020-09-14_1.225.0
2826
+
2827
+ - Add `redacted_at` field in Identity Verification response and Documentary Verification Document component
2828
+ - Update `original_front` field in Identity Verification Document Images to be nullable in redacted Identity Verification sessions
2829
+
2830
+ ### 2020-09-14_1.224.0
2831
+
2832
+ - Add `earliest_deposit_date` and change `last_deposit_date` to `latest_deposit_date` for `/beta/credit/v1/bank_employment/get`
2833
+
2834
+ ### 2020-09-14_1.223.0
2835
+
2836
+ - Add `redirect_uris` to `/partner/customer/create` request.
2837
+
2838
+ ### 2020-09-14_1.222.0
2839
+
2840
+ - Add `wallet_id` field to `/wallet/transaction/get` and `/wallet/transaction/list` responses
2841
+
2842
+ ### 2020-09-14_1.221.0
2843
+
2844
+ - Update `link_delivery/get` to remove `public_tokens` from the response
2845
+
2846
+ ### 2020-09-14_1.220.0
2847
+
2848
+ - Update `link_delivery/create` to accept `communication_methods` and deprecate `delivery_method` and `delivery_destination`
2849
+
2850
+ ### 2020-09-14_1.219.1
2851
+
2852
+ - Fix the `refund_id` example.
2853
+ - Update address objects to reflect that in rare instances, `city` may be `null`.
2854
+
2855
+ ### 2020-09-14_1.219.0
2856
+
2857
+ - Add partner webhook event type
2858
+
2859
+ ### 2020-09-14_1.218.1
2860
+
2861
+ - Mark `phone_number_verified_time` and `email_address_verified_time` as deprecated, since it is no longer required to provide these fields to enable to enable the Returning User Experience.
2862
+
2863
+ ### 2020-09-14_1.218.1
2864
+
2865
+ - Introduce `expected_settlement_date` field in the Transfer object
2866
+
2867
+ ### 2020-09-14_1.218.0
2868
+
2869
+ - Add `/beta/credit/v1/bank_employment/get` endpoint
2870
+
2871
+ ### 2020-09-14_1.217.0
2872
+
2873
+ - Add `updated` field to `/credit/audit_copy_token/update` response
2874
+ - Add `SchemaVersion` to VOE and VOA schemas for `/credit/freddie_mac/reports/get`
2875
+
2876
+ ### 2020-09-14_1.216.0
2877
+
2878
+ - Introduce `funding_account_id` field in the Transfer API
2879
+ - Remove deprecated `origination_account_id` field from the Transfer documentation
2880
+
2881
+ ### 2020-09-14_1.215.2
2882
+
2883
+ - Use more strict validation for `payment_id` and `recipient_id` fields in API
2884
+
2885
+ ### 2020-09-14_1.215.1
2886
+
2887
+ - Use more strict validation for payment `consent_id` field in API
2888
+
2889
+ ### 2020-09-14_1.215.0
2890
+
2891
+ - Add `status` to Wallet schema
2892
+
2893
+ # 17.3.0
2894
+
2895
+ - Updating to OAS 2020-09-14_1.214.0
2896
+
2897
+ ## OpenAPI Schema Changes
2898
+
2899
+ ### 2020-09-14_1.214.0
2900
+
2901
+ - Add `/credit/freddie_mac/reports/get` endpoint
2902
+
2903
+ ### 2020-09-14_1.213.1
2904
+
2905
+ - Reflect that `days_requested` field in Bank Income Verification object in `/link/token/create` request is required when using Bank Income.
2906
+ - Reflect that `is_update_mode` field in Bank Income Verification object in `/link/token/create` request defaults to `false`.
2907
+ - Update description to reflect that Document Income object in `/link/token/create` request is not required, even when using Document Income.
2908
+
2909
+ ### 2020-09-14_1.213.0
2910
+
2911
+ - Update `PartnerEndCustomerStatus` enum values.
2912
+
2913
+ ### 2020-09-14_1.212.0
2914
+
2915
+ - Add `/credit/audit_copy_token/update` endpoint
2916
+ - Add `report_type` to AssetReportCreateRequest
2917
+
2918
+ ### 2020-09-14_1.211.1
2919
+
2920
+ - Fix `US_MBS` list code which was mistakenly documented as `US_MBC` for screening individuals with Monitor
2921
+ - Document `TR_CMB` list code for screening individuals with Monitor
2922
+ - Document `IZ_WBK` list code for screening individuals and entities with Monitor
2923
+
2924
+ ### 2020-09-14_1.211.0
2925
+
2926
+ - Add `/partner/customer/oauth_institutions/get` endpoint.
2927
+
2928
+ ### 2020-09-14_1.210.8
2929
+
2930
+ - Update example response for `/credit/bank_income/get`
2931
+
2932
+ ### 2020-09-14_1.210.7
2933
+
2934
+ - Documentation updates for Investments APIs and Bank Transfer APIs.
2935
+
2936
+ ### 2020-09-14_1.210.6
2937
+
2938
+ - Add validation on `originator_client_id` and `redirect_uri` for `/transfer/originator/create` and `transfer/originator/get` request
2939
+
2940
+ ### 2020-09-14_1.210.5
2941
+
2942
+ - Add `company_name` to TransferOriginatorGetResponse
2943
+
2944
+ # 17.2.0
2945
+
2946
+ - Updating to OAS 2020-09-14_1.210.4
2947
+
2948
+ ## OpenAPI Schema Changes
2949
+
2950
+ ### 2020-09-14_1.210.4
2951
+
2952
+ - Add `recurring_transfer_id` to Transfer
2953
+
2954
+ ### 2020-09-14_1.210.3
2955
+
2956
+ - Make `id_numbers` field hidden in `/user/create` request
2957
+
2958
+ ### 2020-09-14_1.210.2
2959
+
2960
+ - Make `transfer_ids` required in RecurringTransfer
2961
+
2962
+ ### 2020-09-14_1.210.1
2963
+
2964
+ - Change the `/transactions/enrich` `options.include_legacy_categories` field to `options.include_legacy_category`
2965
+ - Make documentation for the `/transactions/enrich` `options.include_legacy_category` request field visible
2966
+ - Make documentation for the `/transactions/enrich` `legacy_category` and `legacy_category_id` response fields visible
2967
+ - Add `direction` to required fields for `ClientProvidedTransaction`
2968
+
2969
+ ### 2020-09-14_1.210.0
2970
+
2971
+ - Add `/transfer/capabilities/get` endpoint to fetch RTP eligibility for a linked plaid item
2972
+
2973
+ ### 2020-09-14_1.209.2
2974
+
2975
+ - Renamed the `NullableRecurringTransfer` type to `RecurringTransferNullable` type
2976
+
2977
+ ### 2020-09-14_1.209.1
2978
+
2979
+ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `email_address_verified_time` fields within `LinkTokenCreateRequestUser` to resolve undesireable client library behavior in certain languages.
2980
+
2981
+ ### 2020-09-14_1.209.0
2982
+
2983
+ - add `NullableRecurringTransfer` field
2984
+ - replace `RecurringTransfer` with `NullableRecurringTransfer` for `TransferRecurringCreateResponse`
2985
+ - and `Decision` in required fields for `TransferRecurringCreateResponse`
2986
+ - add required fields for `TransferRecurringSchedule`
2987
+
2988
+ ### 2020-09-14_1.208.0
2989
+
2990
+ - Add `total_amounts` field to `/credit/bank_income/get` response
2991
+ - Deprecate `amount`, `iso_currency_code`, and `unofficial_currency_code` at top levels in `/credit/bank_income/get` response
2992
+
2993
+ ### 2020-09-14_1.207.0
2994
+
2995
+ - Add `id_numbers` field to `/user/create` request
2996
+
2997
+ ### 2020-09-14_1.206.11
2998
+
2999
+ - Add `RECURRING_NEW_TRANSFER` webhook event.
3000
+ - Add `RECURRING_TRANSFER_SKIPPED` webhook event.
3001
+ - Add `RECURRING_CANCELLED` webhook event.
3002
+
3003
+ ### 2020-09-14_1.206.10
3004
+
3005
+ - make `idempotency_key` field for `/transfer/recurring/create` non-nullable
3006
+
3007
+ ### 2020-09-14_1.206.9
3008
+
3009
+ - Add `description` field for `RecurringTransfer` object
3010
+ - Make `TransferRecurringStatus` non-nullable
3011
+
3012
+ ### 2020-09-14_1.206.8
3013
+
3014
+ - Make all mentions of relay tokens lowercase
3015
+
3016
+ ### 2020-09-14_1.206.7
3017
+
3018
+ - Updated external URLs for Credit Relay endpoints, and marked them as beta in the summary
3019
+
3020
+ ### 2020-09-14_1.206.6
3021
+
3022
+ - Add more enums values to `pay_rate` field in `/credit/payroll_income/get` response
3023
+ - Add `pay_basis` field to `/credit/payroll_income/get`
3024
+
3025
+ ### 2020-09-14_1.206.5
3026
+
3027
+ - Updated Credit Relay Token descriptions
3028
+
3029
+ ### 2020-09-14_1.206.4
3030
+
3031
+ - Add `FUNDS_SWEEP` as a `type` enum for the `WalletTransaction` object
3032
+
3033
+ ### 2020-09-14_1.206.3
3034
+
3035
+ - Make `test_clock_id` non-nullable in `test_clock`.
3036
+
3037
+ ### 2020-09-14_1.206.2
3038
+
3039
+ - Update `CounterpartyType` to rename `delivery_marketplace` to `marketplace`
3040
+ - Update `CounterpartyType` to add `payment_terminal`
3041
+
3042
+ ### 2020-09-14_1.206.1
3043
+
3044
+ - Update the `transactions/enrich` transaction description example to match the request.
3045
+
3046
+ ### 2020-09-14_1.206.0
3047
+
3048
+ - Add `/sandbox/transfer/test_clock/list` for recurring transfer
3049
+ - rm `decision` and `decision_rationale` from `RecurringTransfer`
3050
+ - add `decision` and `decision_rationale` in `TransferRecurringCreateResponse`
3051
+ - rename `frozen_timestamp` to `virtual_time`
3052
+ - not requiring `client_id` and `secret` for recurring transfer APIs
3053
+
3054
+ ### 2020-09-14_1.205.9
3055
+
3056
+ - Use a nested `options` field for optional request params to `transactions/enrich`
3057
+ - Make nullable fields required for `transactions/enrich`
3058
+
3059
+ ### 2020-09-14_1.205.8
3060
+
3061
+ - Update supported payment scheme options for `/payment_initiation/payment/create`
3062
+ – Update description of `/payment_initiation/recipient/create` to mention non-Eurozone countries.
3063
+ – Update `/payment_initiation/payment/create` mentioning new currencies and non-Eurozone markets.
3064
+ – Removed `CHF` and `CZK` from the list of supported currencies.
3065
+
3066
+ ### 2020-09-14_1.205.7
3067
+
3068
+ - Add website and logo_url to the `Counterparty` object for the Enrich product.
3069
+ - Update descriptions for logo_url field in `Counterparty`, `TransactionCounterparty`, `Enrichments` and `Enhancements`.
3070
+
3071
+ ### 2020-09-14_1.205.6
3072
+
3073
+ - Update field descriptions and response examples for `transactions/enrich`
3074
+
3075
+ ### 2020-09-14_1.205.5
3076
+
3077
+ - Add support for optional request parameters in /transactions/enrich
3078
+ - Add `location` field to `ClientProvidedTransaction` object
3079
+ - Add `mcc` field to `ClientProvidedTransaction` object
3080
+ - Add `date_posted` field to `ClientProvidedTransaction` object
3081
+
3082
+ ### 2020-09-14_1.205.4
3083
+
3084
+ - Document partial refunds
3085
+ - Update description for `/payment_initiation/payment/reverse` endpoint
3086
+ - Update description for `/payment_initiation/payment/get` endpoint
3087
+
3088
+ # 17.1.0
3089
+
3090
+ - Updating to OAS 2020-09-14_1.205.3
3091
+
3092
+ ## OpenAPI Schema Changes
3093
+
3094
+ ### 2020-09-14_1.205.3
3095
+
3096
+ - Update description for `/signal/evaluate` endpoint
3097
+
3098
+ ### 2020-09-14_1.205.2
3099
+
3100
+ - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint
3101
+
3102
+ ### 2020-09-14_1.205.1
3103
+
3104
+ - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements
3105
+
3106
+ ### 2020-09-14_1.205.0
3107
+
3108
+ - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`.
3109
+
3110
+ ### 2020-09-14_1.204.0
3111
+
3112
+ - Remove `/income/verification/refresh` endpoint
3113
+
3114
+ ### 2020-09-14_1.203.0
3115
+
3116
+ - Add 7 brand new recurring transfer APIs
3117
+ - Add `/transfer/recurring/create`
3118
+ - Add `/transfer/recurring/list`
3119
+ - Add `/transfer/recurring/get`
3120
+ - Add `/transfer/recurring/cancel`
3121
+ - Add `/sandbox/transfer/test_clock/create`
3122
+ - Add `/sandbox/transfer/test_clock/advance`
3123
+ - Add `/sandbox/transfer/test_clock/get`
3124
+
3125
+ ### 2020-09-14_1.202.6
3126
+
3127
+ - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores`
3128
+
3129
+ ### 2020-09-14_1.202.5
3130
+
3131
+ - Add `/partner/customer/remove` endpoint
3132
+
3133
+ ### 2020-09-14_1.202.4
3134
+
3135
+ - Internal changes
3136
+
3137
+ ### 2020-09-14_1.202.3
3138
+
3139
+ - New Transfer API routes for hosted onboarding of TPS end-customers
3140
+
3141
+ ### 2020-09-14_1.202.0
3142
+
3143
+ - Add `refunds` field to `Transfer` object
3144
+ - Add `refund_id` field to `TransferEvent` object
3145
+ - Fix typo for `transfer/get` and `transfer/refund/get`
3146
+
3147
+ ### 2020-09-14_1.201.0
3148
+
3149
+ - Add support for partial refunds
3150
+ - Add `amount` field to `/payment_initiation/payment/reverse` request
3151
+ - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
3152
+
3153
+ ### 2020-09-14_1.200.0
3154
+
3155
+ - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get`
3156
+
3157
+ ### 2020-09-14_1.199.0
3158
+
3159
+ - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint
3160
+
3161
+ ### 2020-09-14_1.198.8
3162
+
3163
+ - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response.
3164
+
3165
+ ### 2020-09-14_1.198.7
3166
+
3167
+ - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook`
3168
+
3169
+ ### 2020-09-14_1.198.6
3170
+
3171
+ - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior.
3172
+ - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook.
3173
+
3174
+ ### 2020-09-14_1.198.5
3175
+
3176
+ - Internal changes
3177
+
3178
+ ### 2020-09-14_1.198.4
3179
+
3180
+ - Add `deleted_at` to `/payment_profile/get` response.
3181
+
3182
+ ### 2020-09-14_1.198.3
3183
+
3184
+ - Change `start_date` to `start_time` for `/wallet/transaction/list` response.
3185
+
3186
+ ### 2020-09-14_1.198.2
3187
+
3188
+ - Update list of available products for `/partner/customer/create`.
3189
+
3190
+ ### 2020-09-14_1.198.1
3191
+
3192
+ - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response.
3193
+
3194
+ ### 2020-09-14_1.198.0
3195
+
3196
+ - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint.
3197
+ - Add `last_status_update` and `payment_id` field to `WalletTransaction`.
3198
+ - Add `transaction_id` field to `PaymentInitiationPayment`
3199
+
3200
+ ### 2020-09-14_1.197.6
3201
+
3202
+ - Add `originator_client_id` to Transfer API endpoints
3203
+
3204
+ ### 2020-09-14_1.197.5
3205
+
3206
+ - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint.
3207
+
3208
+ ### 2020-09-14_1.197.4
3209
+
3210
+ - Add `asset_under_management` field to `PartnerCustomerCreateRequest`.
3211
+
3212
+ # 17.0.0
3213
+
3214
+ - Updating to OAS 2020-09-14_1.205.3
3215
+
3216
+ ## Breaking changes in this version
3217
+
3218
+ - (Identity Verification) Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
3219
+
3220
+ ## OpenAPI Schema Changes
3221
+
3222
+ ### 2020-09-14_1.205.3
3223
+
3224
+ - Update description for `/signal/evaluate` endpoint
3225
+
3226
+ ### 2020-09-14_1.205.2
3227
+
3228
+ - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint
3229
+
3230
+ ### 2020-09-14_1.205.1
3231
+
3232
+ - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements
3233
+
3234
+ ### 2020-09-14_1.205.0
3235
+
3236
+ - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`.
3237
+
3238
+ ### 2020-09-14_1.204.0
3239
+
3240
+ - Remove `/income/verification/refresh` endpoint
3241
+
3242
+ ### 2020-09-14_1.203.0
3243
+
3244
+ - Add 7 brand new recurring transfer APIs
3245
+ - Add `/transfer/recurring/create`
3246
+ - Add `/transfer/recurring/list`
3247
+ - Add `/transfer/recurring/get`
3248
+ - Add `/transfer/recurring/cancel`
3249
+ - Add `/sandbox/transfer/test_clock/create`
3250
+ - Add `/sandbox/transfer/test_clock/advance`
3251
+ - Add `/sandbox/transfer/test_clock/get`
3252
+
3253
+ ### 2020-09-14_1.202.6
3254
+
3255
+ - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores`
3256
+
3257
+ ### 2020-09-14_1.202.5
3258
+
3259
+ - Add `/partner/customer/remove` endpoint
3260
+
3261
+ ### 2020-09-14_1.202.4
3262
+
3263
+ - Internal changes
3264
+
3265
+ ### 2020-09-14_1.202.3
3266
+
3267
+ - New Transfer API routes for hosted onboarding of TPS end-customers
3268
+
3269
+ ### 2020-09-14_1.202.0
3270
+
3271
+ - Add `refunds` field to `Transfer` object
3272
+ - Add `refund_id` field to `TransferEvent` object
3273
+ - Fix typo for `transfer/get` and `transfer/refund/get`
3274
+
3275
+ ### 2020-09-14_1.201.0
3276
+
3277
+ - Add support for partial refunds
3278
+ - Add `amount` field to `/payment_initiation/payment/reverse` request
3279
+ - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
3280
+
3281
+ ### 2020-09-14_1.200.0
3282
+
3283
+ - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get`
3284
+
3285
+ ### 2020-09-14_1.199.0
3286
+
3287
+ - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint
3288
+
3289
+ ### 2020-09-14_1.198.8
3290
+
3291
+ - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response.
3292
+
3293
+ ### 2020-09-14_1.198.7
3294
+
3295
+ - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook`
3296
+
3297
+ ### 2020-09-14_1.198.6
3298
+
3299
+ - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior.
3300
+ - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook.
3301
+
3302
+ ### 2020-09-14_1.198.5
3303
+
3304
+ - Internal changes
3305
+
3306
+ ### 2020-09-14_1.198.4
3307
+
3308
+ - Add `deleted_at` to `/payment_profile/get` response.
3309
+
3310
+ ### 2020-09-14_1.198.3
3311
+
3312
+ - Change `start_date` to `start_time` for `/wallet/transaction/list` response.
3313
+
3314
+ ### 2020-09-14_1.198.2
3315
+
3316
+ - Update list of available products for `/partner/customer/create`.
3317
+
3318
+ ### 2020-09-14_1.198.1
3319
+
3320
+ - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response.
3321
+
3322
+ ### 2020-09-14_1.198.0
3323
+
3324
+ - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint.
3325
+ - Add `last_status_update` and `payment_id` field to `WalletTransaction`.
3326
+ - Add `transaction_id` field to `PaymentInitiationPayment`
3327
+
3328
+ ### 2020-09-14_1.197.6
3329
+
3330
+ - Add `originator_client_id` to Transfer API endpoints
3331
+
3332
+ ### 2020-09-14_1.197.5
3333
+
3334
+ - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint.
3335
+
3336
+ ### 2020-09-14_1.197.4
3337
+
3338
+ - Add `asset_under_management` field to `PartnerCustomerCreateRequest`.
3339
+
3340
+ # 17.0.0
3341
+
3342
+ - Updating to OAS 2020-09-14_1.197.3
3343
+
3344
+ ## Breaking changes in this version
3345
+
3346
+ - Move from Ruby 2.4.0 to Ruby 3, incorporating [#440](https://github.com/plaid/plaid-ruby/pull/440)
3347
+ - Consolidate usages of `Error` into `PlaidError`
3348
+ - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
3349
+ - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API.
3350
+ - (Transfer) Rename `TransferUserInRequest` to `TransferAuthorizationUserInRequest` for `/transfer/authorization/create`
3351
+
3352
+ ## OpenAPI Schema Changes
3353
+
3354
+ ### 2020-09-14_1.197.3
3355
+
3356
+ - Update supported `CountryCode`'s in `link/token/create` docs.
3357
+
3358
+ ### 2020-09-14_1.197.2
3359
+
3360
+ - ach_class optional
3361
+ - add rtp network option
3362
+
3363
+ ### 2020-09-14_1.197.1
3364
+
3365
+ - Add newly supported languages for Link
3366
+
3367
+ ### 2020-09-14_1.197.0
3368
+
3369
+ - Add `PAYMENT_PROFILE_LOGIN_REQUIRED` to transfer authorization `decision_rationale.code`.
3370
+
3371
+ ### 2020-09-14_1.196.3
3372
+
3373
+ - Add `institution_name` field to `payroll_income_result` of `/credit/sessions/get`
3374
+
3375
+ ### 2020-09-14_1.196.2
3376
+
3377
+ - Add requirements for `logo` in `PartnerCustomerCreateRequest`.
3378
+
3379
+ ### 2020-09-14_1.196.2
3380
+
3381
+ - Deprecate webhook status `VERIFICATION_STATUS_PENDING_APPROVAL` in `income_verification` apis.
3382
+
3383
+ ### 2020-09-14_1.196.1
3384
+
3385
+ - Add a note in the description of `/transfer/authorization/create`
3386
+
3387
+ ### 2020-09-14_1.196.0
3388
+
3389
+ - Added endpoint `/sandbox/payment_profile/reset_login`
3390
+
3391
+ ### 2020-09-14_1.195.0
3392
+
3393
+ - Consolidate usages of `Error` into `PlaidError`
3394
+ - Add a `PlaidErrorType` enum
3395
+
3396
+ ### 2020-09-14_1.194.2
3397
+
3398
+ - Fix typo for `income_verification` in `/sandbox/public_token/create` options
3399
+
3400
+ ### 2020-09-14_1.194.1
3401
+
3402
+ - Update field descriptions in `/partner/customer/*` responses.
3403
+ - Make `PartnerEndCustomerWithSecrets` extend `PartnerEndCustomer`.
3404
+ - Fix documentation links in `/partner/customer/*` endpoints.
3405
+
3406
+ ### 2020-09-14_1.194.0
3407
+
3408
+ - Add `/partner/customer/enable` endpoint
3409
+
3410
+ ### 2020-09-14_1.193.0
3411
+
3412
+ - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
3413
+
3414
+ ### 2020-09-14_1.192.3
3415
+
3416
+ - Add `/fdx/notifications` endpoint.
3417
+
3418
+ ### 2020-09-14_1.192.2
3419
+
3420
+ - Add `USER_REPORTED_NO_INCOME` to CreditSessionBankIncomeStatus
3421
+
3422
+ ### 2020-09-14_1.192.1
3423
+
3424
+ - Update description for `payment_profile_token` field
3425
+
3426
+ ### 2020-09-14_1.192.0
3427
+
3428
+ - Add `income_verfication` field to `/sandbox/public_token/create`
3429
+
3430
+ ### 2020-09-14_1.191.1
3431
+
3432
+ - Add `document_income_result` field to `credit/sessions/get`
3433
+
3434
+ ### 2020-09-14_1.191.0
3435
+
3436
+ - Remove `payment_profile_id` from `/payment_profile/*`, `/transfer/authorization/create`, and `/transfer/create` endpoints and replace with `payment_profile_token`
3437
+
3438
+ ### 2020-09-14_1.190.0
3439
+
3440
+ - Removed auditor_id from /credit/audit_copy/token/create
3441
+
3442
+ ### 2020-09-14_1.189.0
3443
+
3444
+ - Add length boundary for the `client_user_id` field in `user/create`
3445
+
3446
+ ### 2020-09-14_1.188.0
3447
+
3448
+ - Add `SchemaVersion` field to Freddie Mac Verification of Assets Schema
3449
+
3450
+ ### 2020-09-14_1.187.0
3451
+
3452
+ - Add `non-custodial wallet` to account subtypes supported for investments
3453
+ - Add `trade` investment transaction subtype as a subtype of `transfer` investment transaction type
3454
+
3455
+ ### 2020-09-14_1.186.2
3456
+
3457
+ - Add `errors` field to `credit/sessions/get`
3458
+
3459
+ ### 2020-09-14_1.186.1
3460
+
3461
+ - Add `payroll_income_result` field to `credit/sessions/get`
3462
+
3463
+ ### 2020-09-14_1.186.0
3464
+
3465
+ - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API.
3466
+
3467
+ ### 2020-09-14_1.185.0
3468
+
3469
+ - Add support for `USER_INPUT_TIMEOUT` as a value for `force_error` in the sandbox custom user schema.
3470
+
3471
+ ### 2020-09-14_1.184.0
3472
+
3473
+ - Make `payment_id` not required in `/link/token/create` under the `payment_initiation` field.
3474
+
3475
+ ### 2020-09-14_1.183.0
3476
+
3477
+ - Add `beacon_session_id` field in req of /transfer/authorization/create endpoint.
3478
+
3479
+ ### 2020-09-14_1.182.0
3480
+
3481
+ - Add `/link/oauth/correlation_id/exchange` endpoint.
3482
+
3
3483
  # 16.0.0
3484
+
4
3485
  - Updating to OAS 2020-09-14_1.181.1
5
3486
 
3487
+ ## Breaking changes in this version
3488
+
3489
+ - (Identity Verification) Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable`
3490
+ instead.
3491
+
6
3492
  ## OpenAPI Schema Changes
3493
+
7
3494
  ### 2020-09-14_1.181.1
3495
+
8
3496
  - Update `report_tokens` in `/credit/relay/create` endpoint request to be a list of strings instead a list of objects
9
3497
 
10
3498
  ### 2020-09-14_1.181.0
@@ -14,7 +3502,7 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
14
3502
  ### 2020-09-14_1.180.0
15
3503
 
16
3504
  - Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable`
17
- instead.
3505
+ instead.
18
3506
 
19
3507
  ### 2020-09-14_1.179.0
20
3508
 
@@ -38,14 +3526,17 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
38
3526
  - Add `settled` as a valid event type for `/sandbox/transfer/simulate`
39
3527
 
40
3528
  ### 2020-09-14_1.177.3
3529
+
41
3530
  - Replace `ASSET_TRANSACTION_DESCRIPTION` with `ASSET_TRANSACTION_DESCRIPTON` in Freddie Mac
42
3531
  Asset Report
43
3532
 
44
3533
  ### 2020-09-14_1.177.2
3534
+
45
3535
  - Add `ownership_type` to Asset Report account object, to reflect actual API behavior.
46
3536
  - Update and clarify docs, including update to reflect new Transfers cutoff times.
47
3537
 
48
3538
  ### 2020-09-14_1.177.1
3539
+
49
3540
  - Add `settled` as a possible Transfer status and `swept_settled` as a possible Transfer sweep status
50
3541
  - Add `settled` and `swept_settled` as new Transfer event types
51
3542
  - Add `settled` field to Transfer sweep object
@@ -56,9 +3547,11 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
56
3547
  - Add `options` and `days_to_included` to `AssetReportGetRequest`
57
3548
 
58
3549
  ### 2020-09-14_1.176.2
3550
+
59
3551
  - Add `recipient_id` field examples to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses
60
3552
 
61
3553
  ### 2020-09-14_1.176.1
3554
+
62
3555
  - Set `employment_report_token` field in the `/credit/employment/get` endpoint to be not required
63
3556
 
64
3557
  ### 2020-09-14_1.176.0
@@ -215,9 +3708,11 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
215
3708
  - Update `PaymentInitiationPaymentStatus` to include an additional `PAYMENT_STATUS_SETTLED` enum
216
3709
 
217
3710
  # 15.11.0
3711
+
218
3712
  - Updating to OAS 2020-09-14_1.161.5
219
3713
 
220
3714
  ## OpenAPI Schema Changes
3715
+
221
3716
  ### 2020-09-14_1.161.5
222
3717
 
223
3718
  - Reverts the changes made in 2020-09-14_1.157.0
@@ -227,7 +3722,7 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
227
3722
  - Update description for webhook `USER_PERMISSION_REVOKED`
228
3723
 
229
3724
  ### 2020-09-14_1.161.3
230
-
3725
+
231
3726
  - Bug fix: Put quotes around the '529' account type to prevent generated client libraries from treating it as an integer.
232
3727
  - Add `RECURRING_TRANSACTIONS_UPDATE` to description of sandbox webhook testing endpoint
233
3728
 
@@ -240,6 +3735,7 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
240
3735
  - Add required fields back to AssetReport schema
241
3736
 
242
3737
  ### 2020-09-14_1.161.0
3738
+
243
3739
  - Remove `access_token` request parameter from `/beta/partner/v1/customers/create`
244
3740
 
245
3741
  ### 2020-09-14_1.160.0
@@ -277,25 +3773,32 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
277
3773
  - Create `/credit/bank_income/pdf/get` to allow customers to retrieve the bank income product as a PDF
278
3774
 
279
3775
  ### 2020-09-14_1.153.1
3776
+
280
3777
  -- Add `personal_finance_category_icon_url` to `/beta/transactions/v1/enhance` response
281
3778
 
282
3779
  ### 2020-09-14_1.153.0
3780
+
283
3781
  -- Add new endpoint `/beta/partner/v1/customers/create`
284
3782
 
285
3783
  ### 2020-09-14_1.152.0
3784
+
286
3785
  - Add `form1099s` as part of the `credit/payroll_income/get` response.
287
3786
  - Add `Credit1099` object and corresponding subtypes.
288
3787
 
289
3788
  ### 2020-09-14_1.151.1
3789
+
290
3790
  - Update required fields list for guaranteed ACH customers
291
3791
 
292
3792
  ### 2020-09-14_1.151.0
3793
+
293
3794
  - Mark `verification` field under `paystubs` object in `/credit/payroll_income/get` as deprecated
294
3795
 
295
3796
  ### 2020-09-14_1.150.0
3797
+
296
3798
  - Make `user_present` under `/transfer/authorization/create` nullable
297
3799
 
298
3800
  ### 2020-09-14_1.149.1
3801
+
299
3802
  - Update fields description for guaranteed ACH customers
300
3803
 
301
3804
  ### 2020-09-14_1.149.0
@@ -317,9 +3820,11 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
317
3820
  - Add new endpoints `/credit/relay/get`, `/credit/relay/refresh` and `/credit/relay/remove`
318
3821
 
319
3822
  # 15.10.0
3823
+
320
3824
  - Updating to OAS 2020-09-14_1.146.0
321
3825
 
322
3826
  ## OpenAPI Schema Changes
3827
+
323
3828
  ### 2020-09-14_1.146.0
324
3829
 
325
3830
  - make item_logins field not required
@@ -398,64 +3903,85 @@ See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/
398
3903
  - Add `/credit/audit_copy_token/remove` to invalidate Audit Copy tokens
399
3904
 
400
3905
  # 15.9.0
3906
+
401
3907
  - Updating to OAS 2020-09-14_1.131.3
402
3908
 
403
3909
  ## OpenAPI Schema Changes
3910
+
404
3911
  ### 2020-09-14_1.131.3
3912
+
405
3913
  - Update external URL for `/transfer/migrate_account` endpoint
406
3914
 
407
3915
  ### 2020-09-14_1.131.2
3916
+
408
3917
  - Add `TRANSFER_LIMIT_REACHED` to enum `TransferAuthorizationDecisionRationaleCode`
409
3918
 
410
3919
  ### 2020-09-14_1.131.1
3920
+
411
3921
  - Update `/payment_initiation/consent/*` external docs URLs
412
3922
 
413
3923
  ### 2020-09-14_1.131.0
3924
+
414
3925
  - Add `iban` to `counterparty`'s `numbers` field in `/wallet/transaction/execute`
415
3926
 
416
3927
  ### 2020-09-14_1.130.0
3928
+
417
3929
  - Update description of `/user/create` to make it more clear what would happen when a client calls the user creation endpoint with the same client_user_id multiple times.
418
3930
 
419
3931
  ### 2020-09-14_1.129.0
3932
+
420
3933
  - Add `signal_description` for each risk signal in `/beta/credit/payroll_income/risk_signals/get`
421
3934
  - Change `DocumentRiskSignalInstitutionMetadata` to be nullable
422
3935
 
423
3936
  ### 2020-09-14_1.128.6
3937
+
424
3938
  - Fix category rules formatting
425
3939
 
426
3940
  ### 2020-09-14_1.128.5
3941
+
427
3942
  - Change description in `UserCustomPassword` to reflect that only top level fields are optional not all fields
428
3943
 
429
3944
  ### 2020-09-14_1.128.4
3945
+
430
3946
  - Move Category Rules description to `include_personal_finance_category` flag
431
3947
 
432
3948
  # 15.8.0
3949
+
433
3950
  - Updating to OAS 2020-09-14_1.128.4
434
3951
 
435
3952
  ## OpenAPI Schema Changes
3953
+
436
3954
  ### 2020-09-14_1.128.4
3955
+
437
3956
  - Add `identity_verification` as a new optional parameter for `/link/token/create`
438
3957
 
439
3958
  ### 2020-09-14_1.128.3
3959
+
440
3960
  - Add category rules beta to `personal_finance_category` field description
441
- in `/transactions/get`
3961
+ in `/transactions/get`
442
3962
 
443
3963
  # 15.7.0
3964
+
444
3965
  - Updating to OAS 2020-09-14_1.128.2
445
3966
 
446
3967
  ## OpenAPI Schema Changes
3968
+
447
3969
  ### 2020-09-14_1.128.2
3970
+
448
3971
  - Update description of `/investments/transactions/get` endpoint
449
- - Update description of `cost_basis` field
3972
+ - Update description of `cost_basis` field
450
3973
 
451
3974
  ### 2020-09-14_1.128.1
3975
+
452
3976
  - Add `merchant_website` and `merchant_logo_url` to `/beta/transactions/v1/enhance` response
453
3977
 
454
3978
  ### 2020-09-14_1.128.0
3979
+
455
3980
  - Add `auth_type_select_enabled`, `automated_microdeposits_enabled`, `instant_match_enabled`, and `same_day_microdeposits_enabled` to `/link/token/create`
456
3981
  - Marked `flow_type` parameter as deprecated
457
3982
 
458
3983
  ### 2020-09-14_1.127.0
3984
+
459
3985
  - Add `consent_id` filter to `/payment_initiation/payment/list`
460
3986
  - Add `consent_id` to `/link/token/create`
461
3987
 
@@ -468,9 +3994,11 @@ in `/transactions/get`
468
3994
  - Add `accounts` object to `/credit/payroll_income/get` response
469
3995
 
470
3996
  ### 2020-09-14_1.124.0
3997
+
471
3998
  - Added `include_fast_report` in `asset_report/create` endpoint. Added `fast_report` in `asset_report/get` endpoint
472
3999
 
473
4000
  ### 2020-09-14_1.123.1
4001
+
474
4002
  - Removed `reversed` and `reverse_swept` from possible event_type values in TransferEventListRequest docs
475
4003
 
476
4004
  ### 2020-09-14_1.123.0
@@ -482,166 +4010,221 @@ in `/transactions/get`
482
4010
  - Add `request_id` to all Identity Verification and Monitor responses
483
4011
 
484
4012
  ### 2020-09-14_1.121.2
4013
+
485
4014
  - Added sample user_id to INCOME_VERIFICATION webhook
486
4015
 
487
4016
  ### 2020-09-14_1.121.1
4017
+
488
4018
  - Pre-release API refinements to Monitor and Flow endpoints
489
4019
 
490
4020
  # 15.6.0
4021
+
491
4022
  - Updating to OAS 2020-09-14_1.121.0
492
4023
 
493
4024
  ## OpenAPI Schema Changes
4025
+
494
4026
  ### 2020-09-14_1.121.0
4027
+
495
4028
  - Add TimestampNullable type
496
4029
 
497
4030
  ### 2020-09-14_1.120.0
4031
+
498
4032
  - Removed `Uploaded`, `Created` and `APPROVAL_STATUS_APPROVED` enum strings from `PayrollItemStatus` field.
499
4033
 
500
4034
  ### 2020-09-14_1.119.0
4035
+
501
4036
  - Add `returned` to TransferStatus enum
502
4037
  - Add `return_swept` to TransferSweepStatus enum
503
4038
  - Add `returned` and `return_swept` to TransferEventType enum
504
4039
 
505
4040
  ### 2020-09-14_1.118.0
4041
+
506
4042
  - Added `employee_type` and `last_paystub_date` to `/credit/employment/get` response
507
4043
 
508
4044
  ### 2020-09-14_1.117.1
4045
+
509
4046
  - Make `/payment_initiation/consent/create` API more strict
510
4047
 
511
4048
  ### 2020-09-14_1.117.0
4049
+
512
4050
  - Add `/credit/audit_copy_token/create` endpoint
513
4051
 
514
4052
  ### 2020-09-14_1.116.0
4053
+
515
4054
  - Add `/wallet/list` endpoint
516
4055
 
517
4056
  # 15.5.0
4057
+
518
4058
  - Updating to OAS 2020-09-14_1.115.2
519
4059
 
520
4060
  ## OpenAPI Schema Changes
4061
+
521
4062
  ### 2020-09-14_1.115.2
4063
+
522
4064
  - Update description fields to fix formatting errors
523
4065
  - Reflect that `error.suggested_action` is `nullable`
524
4066
 
525
4067
  ### 2020-09-14_1.115.1
4068
+
526
4069
  - Update OpenAPI spec
527
4070
 
528
4071
  ### 2020-09-14_1.115.0
4072
+
529
4073
  - Added `income_report_token` to `/credit/payroll_income/get` response
530
4074
 
531
4075
  ### 2020-09-14_1.114.2
4076
+
532
4077
  - Add `/wallet/create` endpoint
533
4078
 
534
4079
  ### 2020-09-14_1.114.1
4080
+
535
4081
  - Add beta `additional_consented_products` field to `/link/token/create`
536
4082
 
537
4083
  ### 2020-09-14_1.113.1
4084
+
538
4085
  - Updated `/transactions/recurring/get` description
539
4086
 
540
4087
  ### 2020-09-14_1.113.0
4088
+
541
4089
  - Add webhooks for new Monitor and Identity Verification products
542
4090
 
543
4091
  ### 2020-09-14_1.112.0
4092
+
544
4093
  - Add endpoints for new Monitor and Identity Verification products
545
4094
 
546
4095
  ### 2020-09-14_1.111.15
4096
+
547
4097
  - Remove `emi_recipient_id` from Payment Initiation Recipient
548
4098
 
549
4099
  ### 2020-09-14_1.111.14
4100
+
550
4101
  - Add optional `iban` and `bacs` fields to `options` in the `/payment_initiation/consent/create` request
551
4102
 
552
4103
  ### 2020-09-14_1.111.13
4104
+
553
4105
  - Updated `/transactions/sync` description
554
4106
 
555
4107
  ### 2020-09-14_1.111.12
4108
+
556
4109
  - Add more accurate enum documentations to `/transactions/recurring/get` API doc
557
4110
 
558
4111
  ### 2020-09-14_1.111.11
4112
+
559
4113
  - Additional documentation for `/transactions/sync`
560
4114
 
561
4115
  ### 2020-09-14_1.111.9
4116
+
562
4117
  - Remove deprecated field `createdAt` from `/application/get` response
563
4118
 
564
4119
  ### 2020-09-14_1.111.8
4120
+
565
4121
  - Add field validation to `BankTransferDirection`
566
4122
 
567
4123
  ### 2020-09-14_1.111.7
4124
+
568
4125
  - Remove deprecated field `createdAt` from `/application/get` response
569
4126
 
570
4127
  ### 2020-09-14_1.111.6
4128
+
571
4129
  - Add external doc link to `transactions/recurring/get`
572
4130
 
573
4131
  ### 2020-09-14_1.111.5
4132
+
574
4133
  - Updating the API doc for Recurring Transactions
575
4134
 
576
4135
  ### 2020-09-14_1.111.4
4136
+
577
4137
  - Add `DisplayName` in `/application/get` response
578
4138
 
579
4139
  ### 2020-09-14_1.111.3
4140
+
580
4141
  - Updated sample responses for all Transfer endpoints
581
4142
 
582
4143
  ### 2020-09-14_1.111.2
4144
+
583
4145
  - Changing `beta/transactions/rules/` routes to `beta/transactions/rules/v1`
584
4146
 
585
4147
  ### 2020-09-14_1.111.1
4148
+
586
4149
  - Fixing `InsitututionMetadata` typo to `InstitutionMetadata` in private `/beta/credit/payroll_income/risk_signals/get`endpoint response
587
4150
 
588
4151
  ### 2020-09-14_1.111.0
4152
+
589
4153
  - Added `require_guarantee`, `guarantee_decision`, and `guarantee_decision_rationale` to `/transfer/intent` in order to support Guarantee when using Transfer UI.
590
4154
 
591
4155
  ### 2020-09-14_1.110.2
4156
+
592
4157
  - Add additional supported `type` enums in `WalletTransaction`.
593
4158
 
594
4159
  ### 2020-09-14_1.110.1
4160
+
595
4161
  - Add Additional History billing information for /asset_report/create.
596
4162
 
597
4163
  ### 2020-09-14_1.110.0
4164
+
598
4165
  - Add `user_id` to income verification webhook payload
599
4166
 
600
4167
  ### 2020-09-14_1.109.1
4168
+
601
4169
  - Make `consent_id` field nullable in `PaymentInitiationPayment`.
602
4170
 
603
4171
  ### 2020-09-14_1.109.0
4172
+
604
4173
  - Replace `initiated_refunds` with `refund_ids` in the `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
605
4174
 
606
4175
  ### 2020-09-14_1.108.0
4176
+
607
4177
  - Added `/beta/credit/payroll_income/risk_signals/get` endpoint (currently private)
608
4178
 
609
4179
  ### 2020-09-14_1.107.4
4180
+
610
4181
  - Remove unsupported ACH classes from `bank_transfer/` and `transfer/` endpoints.
611
4182
 
612
4183
  ### 2020-09-14_1.107.3
4184
+
613
4185
  - Add `enable_multiple_items` parameter for bank income.
614
4186
 
615
4187
  ### 2020-09-14_1.107.2
4188
+
616
4189
  - Fix typo in `institution_name` parameter for credit endpoints.
617
4190
 
618
4191
  ### 2020-09-14_1.107.0
4192
+
619
4193
  - Added `reference` and `idempotency_key` fields to the `payment_initiation/payment/reverse` request.
620
4194
 
621
4195
  ### 2020-09-14_1.106.0
4196
+
622
4197
  - Added `is_update_mode` to `income_verification` in the `/link/token/create` body
623
4198
 
624
4199
  ### 2020-09-14_1.105.2
4200
+
625
4201
  - Consolidate item schemas
626
4202
 
627
4203
  # 15.4.0
4204
+
628
4205
  - Updating to OAS 2020-09-14_1.105.1
629
4206
  - Expose Faraday::Connection object for additional configuration options
630
4207
 
631
4208
  ## OpenAPI Schema Changes
4209
+
632
4210
  ### 2020-09-14_1.105.1
4211
+
633
4212
  - Removed `client_id` and `secret` as required fields from `/transfer/intent/{get,create}` to match actual API behavior.
634
4213
 
635
4214
  ### 2020-09-14_1.105.0
4215
+
636
4216
  - Add `/credit/payroll_income/refresh` endpoint
637
4217
 
638
4218
  ### 2020-09-14_1.104.0
4219
+
639
4220
  - Added `/signal/prepare`
640
4221
 
641
4222
  ### 2020-09-14_1.103.0
4223
+
642
4224
  - Add `/transactions/recurring/deactivate` endpoint
643
4225
 
644
4226
  ### 2020-09-14_1.102.0
4227
+
645
4228
  - Added `/watchlist_screening/individual/list` (currently private)
646
4229
  - Added `/watchlist_screening/individual/create` (currently private)
647
4230
  - Added `/watchlist_screening/individual/get` (currently private)
@@ -670,260 +4253,344 @@ in `/transactions/get`
670
4253
  - Modified `/identity_verification/create` (currently private)
671
4254
 
672
4255
  ### 2020-09-14_1.101.0
4256
+
673
4257
  - Add endpoint for `/credit/bank_income/refresh`
674
4258
 
675
4259
  ### 2020-09-14_1.100.0
4260
+
676
4261
  - Add `include_original_description`, `include_personal_finance_category` options to `/transactions/sync` request.
677
4262
 
678
4263
  ### 2020-09-14_1.99.0
4264
+
679
4265
  - API changes for /credit/employment/get
680
4266
 
681
4267
  ### 2020-09-14_1.98.1
4268
+
682
4269
  - Add `gusto` as processor partner
683
4270
 
684
4271
  ### 2020-09-14_1.98.0
4272
+
685
4273
  - Add `user_token` as a request parameter for `/sandbox/public_token/create`
686
4274
 
687
4275
  ### 2020-09-14_1.97.1
4276
+
688
4277
  - Remove `auth`, `transactions_updates`, `investments_updates`, and `identity` as required fields from Item status to match actual API behavior.
689
4278
 
690
4279
  # 15.3.0
4280
+
691
4281
  - Updating to OAS 2020-09-14_1.97.0
692
4282
 
693
4283
  ## OpenAPI Schema Changes
4284
+
694
4285
  ### 2020-09-14_1.97.0
4286
+
695
4287
  - [Beta] Rename some `Credit` refs that were preventing client library generation from completing successfully
696
4288
 
697
4289
  ### 2020-09-14_1.96.0
4290
+
698
4291
  - remove unused `payroll_income_id` from `/credit/payroll_income/get` field
699
4292
  - add status object to items in `/credit/payroll_income/get` response body
700
4293
 
701
4294
  ### 2020-09-14_1.95.1
4295
+
702
4296
  - Add `TransferEventsUpdateWebhook` schema
703
4297
 
704
4298
  ### 2020-09-14_1.95.0
4299
+
705
4300
  - Add `institution_data` parameter to `/link/token/create`
706
4301
 
707
4302
  ### 2020-09-14_1.94.2
4303
+
708
4304
  - Tidy up YAML
709
4305
 
710
4306
  ### 2020-09-14_1.94.1
4307
+
711
4308
  - Add `highnote` processor to `/processor/token/create`
712
4309
 
713
4310
  # 15.2.0
4311
+
714
4312
  - Updating to OAS 2020-09-14_1.94.0
715
4313
 
716
4314
  ## OpenAPI Schema Changes
4315
+
717
4316
  ### 2020-09-14_1.94.0
4317
+
718
4318
  - Add `use_case`, `company_legal_name`, `city`, `region`, `country_code`, `postal_code` as a required response field of `Application`
719
4319
 
720
4320
  ### 2020-09-14_1.93.2
4321
+
721
4322
  - Remove `income_verification_id` from income webhook example
722
4323
  - Fix incorrect URL for `/user/create` endpoint
723
4324
 
724
4325
  ### 2020-09-14_1.93.1
4326
+
725
4327
  - Remove deprecated `income_verification_id` from income webhooks
726
4328
  - Standardize income webhook casing
727
4329
 
728
4330
  ### 2020-09-14_1.93.0
4331
+
729
4332
  - Add several new fields to `/signal/evaluate` response
730
- -
4333
+ -
4334
+
731
4335
  ### 2020-09-14_1.92.4
4336
+
732
4337
  - Add `/sandbox/transfer/fire_webhook` endpoint
733
4338
 
734
4339
  ### 2020-09-14_1.91.4
4340
+
735
4341
  - Mark certain Income endpoints as deprecated in favor of the new `/credit/*` endpoints.
736
4342
 
737
4343
  ### 2020-09-14_1.91.3
4344
+
738
4345
  - Add `checkout` processor to `/processor/token/create`
739
4346
 
740
4347
  ### 2020-09-14_1.91.2
4348
+
741
4349
  - Add `webhook_type` parameter to `/sandbox/item/fire_webhook`
742
4350
  - Support for investments transactions, investments holdings and liabilities `DEFAULT_UPDATE` webhooks
743
4351
 
744
4352
  ### 2020-09-14_1.90.2
4353
+
745
4354
  - Add new warning type to `/credit/bank_income/get` response
746
4355
 
747
4356
  ### 2020-09-14_1.90.1
4357
+
748
4358
  - Add `marqeta` and `solid` as Auth processor partners
749
4359
  - Fix schema of `cause` parameter for Asset Reports
750
4360
  - Fix some invalid examples
751
-
4361
+
752
4362
  ### 2020-09-14_1.90.0
4363
+
753
4364
  - Add `/credit/employment/get` endpoint
754
4365
  - Add optional `access_tokens` array to `/credit/payroll_income/precheck` request
755
4366
 
756
4367
  ### 2020-09-14_1.89.3
4368
+
757
4369
  - Update description of `/sandbox/item/fire_webhook`
758
4370
 
759
4371
  ### 2020-09-14_1.89.2
4372
+
760
4373
  - Update description of `accounts/get`
761
4374
 
762
4375
  ### 2020-09-14_1.89.1
4376
+
763
4377
  - Added `AUTH_DATA_UPDATE` webhook code as valid input to `/sandbox/item/fire_webhook`
764
4378
  - Update description for `/sandbox/item/fire_webhook`
765
4379
 
766
4380
  ### 2020-09-14_1.89.0
4381
+
767
4382
  - Add `/transfer/migrate_account` endpoint
768
4383
 
769
4384
  ### 2020-09-14_1.88.2
4385
+
770
4386
  - Fix operationId for `/credit/payroll_income/precheck`
771
4387
 
772
4388
  ### 2020-09-14_1.88.1
4389
+
773
4390
  - Remove deprecated fields from `/item/application/list`
774
4391
 
775
4392
  ### 2020-09-14_1.88.0
4393
+
776
4394
  - Add `wire_routing_number` parameter to `/bank_transfer/migrate_account`
777
4395
 
778
4396
  ### 2020-09-14_1.87.1
4397
+
779
4398
  - Specify minimum length of 1 for `description` on `TransferIntentCreateRequest`
780
4399
 
781
4400
  ### 2020-09-14_1.87.0
4401
+
782
4402
  - Add `consent_id` support in the Institutions Search request
783
4403
 
784
4404
  ### 2020-09-14_1.86.1
4405
+
785
4406
  - Add `apex_clearing` as a processor partner
786
4407
 
787
4408
  ### 2020-09-14_1.86.0
4409
+
788
4410
  - Introduce Credit Payroll Income APIs
789
4411
  - Introduce Credit Precheck API
790
4412
 
791
4413
  ### 2020-09-14_1.85.1
4414
+
792
4415
  - Add `/identity_verification/create` endpoint, kept private for now
793
4416
 
794
4417
  ### 2020-09-14_1.85.0
4418
+
795
4419
  - Add `status` field to `ConnectedApplication`
796
4420
 
797
4421
  # 15.1.0
4422
+
798
4423
  - Updating to OAS 2020-09-14_1.84.5
799
4424
 
800
4425
  ## OpenAPI Schema Changes
4426
+
801
4427
  ### 2020-09-14_1.84.5
4428
+
802
4429
  - Added missing `asset_report_id` field to `/asset_report/relay/refresh`
803
4430
 
804
4431
  ### 2020-09-14_1.84.4
4432
+
805
4433
  - Change summary description and url for `/credit/bank_income/get`
806
4434
 
807
4435
  ### 2020-09-14_1.84.3
4436
+
808
4437
  - Slight wording change for `/credit/bank_income/get` response fields
809
4438
 
810
4439
  ### 2020-09-14_1.84.3
811
- - Move `user_token` to top level of `link/token/create` request
4440
+
4441
+ - Move `user_token` to top level of `link/token/create` request
812
4442
 
813
4443
  ### 2020-09-14_1.84.2
4444
+
814
4445
  - Correct typo in enum value for Investment subtypes (`person` -> `pension`)
815
4446
 
816
4447
  ### 2020-09-14_1.84.1
4448
+
817
4449
  - Fix schema to properly handle personal finance categories in `/transactions/get`
818
4450
 
819
4451
  ### 2020-09-14_1.84.0
4452
+
820
4453
  - Add `user_token` parameter to `link/token/create`
821
4454
 
822
4455
  ### 2020-09-14_1.83.1
4456
+
823
4457
  - Add new fields to `/credit/bank_income/get` response
824
4458
 
825
4459
  ### 2020-09-14_1.83.0
4460
+
826
4461
  - Remove `permitted` decision for `/transfer/authorization/create`
827
4462
 
828
4463
  ### 2020-09-14_1.82.0
4464
+
829
4465
  - Add beta field `consented_products` to `/item/get/` endpoint response
830
4466
 
831
4467
  ### 2020-09-14_1.82.0
4468
+
832
4469
  - Revamp LinkTokenCreate.IncomeVerificationOptions for GA
833
4470
 
834
4471
  ### 2020-09-14_1.81.0
4472
+
835
4473
  - Add `/transaction/rules/create`, `/transaction/rules/list` and `/transaction/rules/remove` endpoints
836
4474
 
837
4475
  ### 2020-09-14_1.80.0
4476
+
838
4477
  - Added `/user/create` endpoint
839
4478
 
840
4479
  # 15.0.0
4480
+
841
4481
  - Updating to OAS 2020-09-14_1.79.0
842
4482
 
843
4483
  ## Breaking changes
4484
+
844
4485
  - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
845
- - Non integer numbers are now `float64` fields
846
4486
 
847
4487
  ## OpenAPI Schema Changes
4488
+
848
4489
  ### 2020-09-14_1.79.0
4490
+
849
4491
  - Update to include all changes up to `2020-09-14_1.77.4` (Undo revert from `1.78.x` updates)
850
4492
 
851
4493
  ### 2020-09-14_1.77.4
4494
+
852
4495
  - Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects
853
4496
 
854
4497
  ### 2020-09-14_1.77.3
4498
+
855
4499
  - Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects
856
4500
 
857
4501
  ### 2020-09-14_1.77.2
4502
+
858
4503
  - Add `ProductAccess` fields for upcoming partner
859
4504
 
860
4505
  # 14.14.0
4506
+
861
4507
  - Updating to OAS 2020-09-14_1.78.2
862
4508
  - Ruby library 14.13.0 was erroneously released as a `minor` version; 14.13.0 changes will be re-released as a `major` version shortly.
863
4509
 
864
4510
  # 14.13.0
4511
+
865
4512
  - Updating to OAS 2020-09-14_1.77.1
866
4513
 
867
4514
  # Breaking changes
4515
+
868
4516
  - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
869
4517
 
870
4518
  ## OpenAPI Schema Changes
4519
+
871
4520
  ### 2020-09-14_1.77.1
4521
+
872
4522
  - Fix extraneous field in enum that caused issue in code generation
873
4523
  - Added `asset_report_id` to the example for `/asset_report/relay/refresh`
874
4524
 
875
4525
  ### 2020-09-14_1.77.0
4526
+
876
4527
  - Explicitly set `format: double` for non-integer numbers so generated fields prefer float64
877
4528
 
878
4529
  ### 2020-09-14_1.76.0
4530
+
879
4531
  - Add three new endpoints for Assets: `/asset_report/relay/create`, `/asset_report/relay/get`, and `/asset_report/relay/rmeove`
880
4532
 
881
4533
  ### 2020-09-14_1.75.0
4534
+
882
4535
  - Added `/asset_report/relay/refresh` endpoint
883
4536
 
884
4537
  ### 2020-09-14_1.74.0
4538
+
885
4539
  - Add `recurring_transactions` to list of products
886
4540
 
887
4541
  ### 2020-09-14_1.73.0
4542
+
888
4543
  - Add new endpoint for `/credit/bank_income/get`
889
4544
 
890
4545
  ### 2020-09-14_1.72.0
4546
+
891
4547
  - Updated documentation URLs for all product endpoints. They can now be found
892
- at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
4548
+ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
893
4549
 
894
4550
  ### 2020-09-14_1.71.0
4551
+
895
4552
  - internal changes
896
4553
 
897
4554
  ### 2020-09-14_1.70.0
4555
+
898
4556
  - Remove deprecated `income_verification_id` from `/sandbox/income/fire_webhook`
899
4557
 
900
4558
  ### 2020-09-14_1.69.1
4559
+
901
4560
  - Reorder processors enum
902
4561
 
903
4562
  ### 2020-09-14_1.69.0
4563
+
904
4564
  - Added `/beta/transactions/v1/enhance` endpoint
905
4565
 
906
4566
  ### 2020-09-14_1.68.1
4567
+
907
4568
  - Added `status` object to sample responses for `/institutions/get` and `institutions/search` endpoints
908
4569
 
909
4570
  ### 2020-09-14_1.68.0
4571
+
910
4572
  - Mark `include_personal_finance_category_beta` property as deprecated.
911
4573
  - Add new argument `include_personal_finance_category` to TransactionsGetRequestOptions.
912
4574
  - Update docs for `/transactions/get` request and response, referencing personal_finance_category taxonomy csv file.
913
4575
 
914
4576
  ### 2020-09-14_1.67.1
4577
+
915
4578
  - internal changes
916
4579
 
917
4580
  ### 2020-09-14_1.67.0
4581
+
918
4582
  - Removed unused `/income/verification/summary/get` endpoint
919
4583
 
920
4584
  ### 2020-09-14_1.66.0
4585
+
921
4586
  - Added Payment Consent endpoints
922
4587
 
923
4588
  ### 2020-09-14_1.65.0
4589
+
924
4590
  - Removed unused `/income/verification/paystub/get` endpoint
925
4591
 
926
4592
  ### 2020-09-14_1.64.15
4593
+
927
4594
  - De-anonymized enums:
928
4595
  - `PaymentInitiationPaymentReverseResponse.properties.status` => `PaymentInitiationRefundStatus`
929
4596
  - `PaymentInitiationPaymentCreateResponse.properties.status` => `PaymentInitiationPaymentCreateStatus`
@@ -943,32 +4610,41 @@ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/
943
4610
  - `IncomeVerificationPrecheckMilitaryInfo.properties.branch` is now a string field (previously enum)
944
4611
 
945
4612
  ### 2020-09-14_1.64.15
4613
+
946
4614
  - Made `last_statement_balance` and `minimum_payment_amount` `nullable` for credit card liabilities schema to reflect existing API behavior.
947
4615
 
948
4616
  ### 2020-09-14_1.64.14
4617
+
949
4618
  - Made `last_payment_amount` and `last_statement_issue_date` `nullable` for credit card liabilities schema to reflect existing API behavior.
950
4619
  - Fix transfers examples to reflect more consistent usage of `region` field.
951
4620
 
952
4621
  # 14.12.1
4622
+
953
4623
  - Updating to OAS 2020-09-14_1.64.13
954
4624
  - Fix issue where library did not correctly detect if app is a Rails app.
955
4625
 
956
4626
  ## OpenAPI Schema Changes
4627
+
957
4628
  ### 2020-09-14_1.64.13
4629
+
958
4630
  - Deprecate `idempotency_key` parameter in transfer/create
959
4631
 
960
4632
  ### 2020-09-14_1.64.12
4633
+
961
4634
  - Removed the unused `required_product_access` and `optional_product_access` parameters from `RequestedScopes`
962
4635
 
963
4636
  ### 2020-09-14_1.64.11
4637
+
964
4638
  - Fix some examples that were not consistent with their schemas
965
4639
  - Add `adjustments` as an investments transaction type to make OpenAPI file consistent with values returned by the API
966
4640
  - Clarify description field for `marital_status` to reflect possible values
967
4641
 
968
4642
  ### 2020-09-14_1.64.10
4643
+
969
4644
  - Updated the external docs URL for Bank Transfers sandbox endpoints
970
4645
 
971
4646
  ### 2020-09-14_1.64.9
4647
+
972
4648
  - De-anonymized the object filters under `LinkTokenCreateRequestAccountSubtypes`, as anonymous objects aren't compatible with the generated CLibs.
973
4649
  - De-anonymized some misc. objects
974
4650
  - `PaymentInitiationMetadata/properties/maximum_payment_amount`
@@ -978,116 +4654,152 @@ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/
978
4654
  - `LiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities`
979
4655
 
980
4656
  ### 2020-09-14_1.64.8
4657
+
981
4658
  - Updated the description of the historical_balances array
982
4659
 
983
4660
  ### 2020-09-14_1.64.7
4661
+
984
4662
  - Add new possible enums for income verification earnings breakdown canonical description
985
4663
 
986
4664
  ### 2020-09-14_1.64.6
4665
+
987
4666
  - Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only.
988
4667
 
989
4668
  ### 2020-09-14_1.64.5
4669
+
990
4670
  - Make guarantee fields required in Transfer endpoints
991
4671
 
992
4672
  ### 2020-09-14_1.64.4
4673
+
993
4674
  - Updated description for `failure_reason` field in Transfer endpoints
994
4675
 
995
4676
  ### 2020-09-14_1.64.3
4677
+
996
4678
  - Make `repayment_id` required in `/transfer/repayment/return/list` endpoint
997
4679
 
998
4680
  ### 2020-09-14_1.64.2
999
- - Update description for legal name field in `BankTransferUser`
4681
+
4682
+ - Update description for legal name field in `BankTransferUser`
1000
4683
 
1001
4684
  ### 2020-09-14_1.64.1
4685
+
1002
4686
  - Update descriptions for `/transfer/repayment/list` and `/transfer/repayment/return/list` endpoints
1003
4687
 
1004
4688
  ### 2020-09-14_1.64.0
4689
+
1005
4690
  - Remove `scheme_automatic_downgrade` from `/payment_initiation/payment/create`
1006
4691
 
1007
4692
  ### 2020-09-14_1.63.1
4693
+
1008
4694
  - Update description for `/sandbox/transfer/sweep/simulate` endpoint
1009
4695
 
1010
4696
  ### 2020-09-14_1.63.0
4697
+
1011
4698
  - Refactor account subtype enums for greater specificity. This has no changes to the API but is a major semver change for Python, Node, Go, and Java client library interfaces to the AccountSubtype object within account filtering contexts in `/link/token/create`. The `AccountSubtype` namespace in this context is now prefixed with the AccountType. (Example for Node: Old: `AccountSubtype.checking` New: `DepositoryAccountSubtype.checking`)
1012
4699
 
1013
4700
  ### 2020-09-14_1.62.7
4701
+
1014
4702
  - Update description for `datetime` and `authorized_datetime` fields in Transactions endpoints
1015
4703
 
1016
4704
  ### 2020-09-14_1.62.6
4705
+
1017
4706
  - Make `sweep_id` / `sweep_amount` fields on Transfer Event nullable
1018
4707
 
1019
4708
  ### 2020-09-14_1.62.6
4709
+
1020
4710
  - Set `institution_status` to be nullable in `InstitutionsGetResponse`
1021
4711
 
1022
4712
  ### 2020-09-14_1.62.5
4713
+
1023
4714
  - Update external docs URLs for Transfer and Bank Transfer endpoints
1024
4715
  - Update description for `ach_return_code` field in Transfer endpoints
1025
4716
 
1026
4717
  ### 2020-09-14_1.62.4
4718
+
1027
4719
  - Add `join_date` to `/application/get` and `/item/application/list`
1028
4720
  - Remove `created_at` from `/application/get`
1029
4721
 
1030
4722
  ### 2020-09-14_1.62.3
4723
+
1031
4724
  - Updated various description fields for Income
1032
4725
 
1033
4726
  ### 2020-09-14_1.62.2
4727
+
1034
4728
  - Add `employment` as an available product in Product array.
1035
4729
 
1036
4730
  # 14.12.0
4731
+
1037
4732
  - Updating to OAS 2020-09-14_1.62.1
1038
4733
 
1039
4734
  # 14.11.1
4735
+
1040
4736
  - Added a release step to the `Makefile` to purge previously released version of plaid-ruby in the current release.
1041
4737
 
1042
4738
  # 14.11.0
4739
+
1043
4740
  - Updating to OAS 2020-09-14_1.61.0
1044
4741
 
1045
4742
  # 14.10.0
4743
+
1046
4744
  - Updating to OAS 2020-09-14_1.58.1
1047
4745
 
1048
4746
  # 14.9.0
4747
+
1049
4748
  - Updating to OAS 2020-09-14_1.54.2
1050
4749
 
1051
4750
  # 14.8.0
4751
+
1052
4752
  - Updating to OAS 2020-09-14_1.46.1
1053
4753
 
1054
4754
  # 14.7.0
4755
+
1055
4756
  - Updating to OAS 2020-09-14_1.44.0
1056
4757
 
1057
4758
  # 14.6.0
4759
+
1058
4760
  - Updating to OAS 2020-09-14_1.40.3
1059
4761
 
1060
4762
  # 14.5.0
4763
+
1061
4764
  - Updating to OAS 2020-09-14_1.36.4
1062
4765
 
1063
4766
  # 14.4.0
4767
+
1064
4768
  - Updating to OAS 2020-09-14_1.34.1
1065
4769
  - Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle
1066
- new enum values being returned from endpoints. Previously, if there were new enum values
1067
- endpoint calls would fail.
4770
+ new enum values being returned from endpoints. Previously, if there were new enum values
4771
+ endpoint calls would fail.
1068
4772
 
1069
4773
  # 14.3.0
4774
+
1070
4775
  Updating to OAS 2020-09-14_1.33.0.
1071
4776
 
1072
4777
  # 14.2.0
4778
+
1073
4779
  Updating to OAS 2020-09-14_1.31.1.
1074
4780
 
1075
4781
  # 14.1.0
4782
+
1076
4783
  Updating to OAS 2020-09-14_1.26.1.
1077
4784
 
1078
4785
  # 14.0.0
1079
- The official release of the `plaid-ruby` generated library. Refer to the beta migration guide for tips on migrating from older version of the libraries.
4786
+
4787
+ The official release of the `plaid-ruby` generated library. See the [migration guide](https://github.com/plaid/plaid-java#migration-guide) for instructions on migrating to this version.
1080
4788
 
1081
4789
  This particular version is pinned to OpenAPI version `2020-09-14_1.20.6`.
1082
4790
 
1083
4791
  # 14.0.0.beta.5
4792
+
1084
4793
  Generated from OAS version 2020-09-14_1.16.4. See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1085
4794
 
1086
4795
  # 14.0.0.beta.4
4796
+
1087
4797
  See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
4798
+
1088
4799
  - Remove validation for `maxProperties` due to generator bug.
1089
4800
 
1090
4801
  # 14.0.0.beta.3
4802
+
1091
4803
  Type fixes, see full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
1092
4804
 
1093
4805
  # 14.0.0.beta.1
@@ -1096,83 +4808,22 @@ This version represents a transition in how we maintain our external client libr
1096
4808
 
1097
4809
  The minimum required ruby version is 2.4.0.
1098
4810
 
1099
- **Ruby Migration Guide:**
1100
-
1101
- ### Client initialization
1102
- From:
1103
- ```ruby
1104
- client = Plaid::Client.new(env: :sandbox,
1105
- client_id: client_id,
1106
- secret: secret)
1107
- ```
1108
-
1109
- To:
1110
- ```ruby
1111
- configuration = Plaid::Configuration.new
1112
- configuration.server_index = Plaid::Configuration::Environment["sandbox"]
1113
- configuration.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_RUBY_CLIENT_ID"]
1114
- configuration.api_key["PLAID-SECRET"] = ENV["PLAID_RUBY_SECRET"]
1115
- configuration.api_key["Plaid-Version"] = "2020-09-14"
1116
-
1117
- api_client = Plaid::ApiClient.new(
1118
- configuration
1119
- )
1120
-
1121
- client = Plaid::PlaidApi.new(api_client)
1122
- ```
1123
-
1124
- ### Endpoints
1125
- All endpoint requests now take a request model and the functions have been renamed to include `_`.
1126
-
1127
- From:
1128
- ```ruby
1129
- response = client.auth.get(access_token)
1130
- ```
1131
-
1132
- To:
1133
- ```ruby
1134
- auth_get_request = Plaid::AuthGetRequest.new
1135
- auth_get_request.access_token = access_token
1136
-
1137
- or
1138
-
1139
- auth_get_request = Plaid::AuthGetRequest.new({:access_token => access_token})
1140
-
1141
- response = client.auth_get(auth_get_request)
1142
- ```
1143
-
1144
- ### Errors
1145
-
1146
- From:
1147
- ```ruby
1148
- begin
1149
- client.auth.get(auth_get_request)
1150
- rescue Plaid::PlaidAPIError => e
1151
- raise e if e.error_code != 'PRODUCT_NOT_READY'
1152
- sleep 1
1153
- end
1154
- ```
1155
-
1156
- To:
1157
- ```ruby
1158
- begin
1159
- client.auth_get(auth_get_request)
1160
- rescue Plaid::ApiError => e
1161
- json_response = JSON.parse(e.response_body)
1162
- if json_response["error_code"] != "PRODUCT_NOT_READY"
1163
- end
1164
- ```
4811
+ See the [migration guide](https://github.com/plaid/plaid-java#migration-guide) for instructions on migrating to this version.
1165
4812
 
1166
4813
  # 13.2.0
4814
+
1167
4815
  - Add support for `options` to `/payment_initiation/payment/create`
1168
4816
 
1169
4817
  # 13.1.0
4818
+
1170
4819
  - Add Standing Orders support to Payment Initiation
1171
4820
 
1172
4821
  # 13.0.1
4822
+
1173
4823
  - Add `update_type` to `Item` model.
1174
4824
 
1175
4825
  # 13.0.0
4826
+
1176
4827
  - Add support for providing a payment initiation schedule
1177
4828
  - Add back the (now deprecated) `/item/public_token/create` endpoint
1178
4829
  - Add back the (now deprecated) `/payment_initiation/payment/token/create` endpoint
@@ -1185,13 +4836,13 @@ BREAKING CHANGES:
1185
4836
 
1186
4837
  - The library has been pinned to the '2020-09-14' API release. Visit the [docs](https://plaid.com/docs/api/versioning/) to see what changed.
1187
4838
  - the `/item/public_token/create` endpoint has been disabled in favor of the /link/token/create
1188
- endpoint
4839
+ endpoint
1189
4840
  - The `/item/add_token/create endpoint` has been disabled in favor of the /link/token/create
1190
4841
  - The `/payment_initiation/payment/token/create` endpoint has been disabled in favor of the /link/token/create
1191
- endpoint
4842
+ endpoint
1192
4843
  - The `/item/remove` endpoint will no longer return a `removed` boolean.
1193
4844
  - The `/institutions/get`, `/institutions/get_by_id`, and `/institutions/search` now require
1194
- `country_codes` to be passed in.
4845
+ `country_codes` to be passed in.
1195
4846
 
1196
4847
  # 11.1.0
1197
4848