plaid 22.0.0 → 23.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1370) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +779 -105
  3. data/CONTRIBUTING.md +4 -1
  4. data/Gemfile.lock +2 -2
  5. data/Makefile +1 -1
  6. data/README.md +112 -57
  7. data/lib/plaid/api/plaid_api.rb +371 -31
  8. data/lib/plaid/api_client.rb +2 -2
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +1 -1
  11. data/lib/plaid/models/account_access.rb +1 -1
  12. data/lib/plaid/models/account_assets.rb +1 -1
  13. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  14. data/lib/plaid/models/account_balance.rb +1 -1
  15. data/lib/plaid/models/account_base.rb +1 -1
  16. data/lib/plaid/models/account_filter.rb +1 -1
  17. data/lib/plaid/models/account_filters_response.rb +1 -1
  18. data/lib/plaid/models/account_identity.rb +1 -1
  19. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  20. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  22. data/lib/plaid/models/account_product_access.rb +1 -1
  23. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  24. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  25. data/lib/plaid/models/account_subtype.rb +1 -1
  26. data/lib/plaid/models/account_type.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request.rb +1 -1
  30. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  31. data/lib/plaid/models/accounts_get_response.rb +1 -1
  32. data/lib/plaid/models/ach_class.rb +1 -1
  33. data/lib/plaid/models/action_state.rb +1 -1
  34. data/lib/plaid/models/activity.rb +1 -1
  35. data/lib/plaid/models/activity_type.rb +1 -1
  36. data/lib/plaid/models/address.rb +1 -1
  37. data/lib/plaid/models/address_data.rb +1 -1
  38. data/lib/plaid/models/address_data_not_required.rb +1 -1
  39. data/lib/plaid/models/address_data_nullable.rb +1 -1
  40. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +1 -1
  41. data/lib/plaid/models/address_match_score.rb +1 -1
  42. data/lib/plaid/models/address_nullable.rb +1 -1
  43. data/lib/plaid/models/address_purpose_label.rb +1 -1
  44. data/lib/plaid/models/application.rb +1 -1
  45. data/lib/plaid/models/application_get_request.rb +1 -1
  46. data/lib/plaid/models/application_get_response.rb +1 -1
  47. data/lib/plaid/models/apr.rb +1 -1
  48. data/lib/plaid/models/asset.rb +1 -1
  49. data/lib/plaid/models/asset_detail.rb +1 -1
  50. data/lib/plaid/models/asset_holder.rb +1 -1
  51. data/lib/plaid/models/asset_holder_name.rb +1 -1
  52. data/lib/plaid/models/asset_owner.rb +1 -1
  53. data/lib/plaid/models/asset_owners.rb +1 -1
  54. data/lib/plaid/models/asset_report.rb +1 -1
  55. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_create_request.rb +2 -12
  62. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  63. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  67. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  71. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_investment_holding.rb +1 -1
  73. data/lib/plaid/models/asset_report_investment_security.rb +1 -1
  74. data/lib/plaid/models/asset_report_investments.rb +1 -1
  75. data/lib/plaid/models/asset_report_item.rb +1 -1
  76. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  78. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  80. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  81. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  84. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  85. data/lib/plaid/models/asset_report_user.rb +1 -1
  86. data/lib/plaid/models/asset_transaction.rb +1 -1
  87. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  88. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  89. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  90. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  91. data/lib/plaid/models/asset_transactions.rb +1 -1
  92. data/lib/plaid/models/asset_type.rb +1 -1
  93. data/lib/plaid/models/assets.rb +1 -1
  94. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  95. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  96. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  97. data/lib/plaid/models/auth_get_request.rb +1 -1
  98. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  99. data/lib/plaid/models/auth_get_response.rb +1 -1
  100. data/lib/plaid/models/auth_metadata.rb +1 -1
  101. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  102. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  103. data/lib/plaid/models/bank_income_complete_result.rb +1 -1
  104. data/lib/plaid/models/bank_income_complete_webhook.rb +1 -1
  105. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  106. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  107. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  108. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  109. data/lib/plaid/models/bank_transfer.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  138. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  140. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  142. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  143. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  144. data/lib/plaid/models/base_report.rb +1 -1
  145. data/lib/plaid/models/base_report_account.rb +1 -1
  146. data/lib/plaid/models/base_report_account_insights.rb +1 -1
  147. data/lib/plaid/models/base_report_average_flow_insights.rb +1 -1
  148. data/lib/plaid/models/base_report_get_request.rb +1 -1
  149. data/lib/plaid/models/base_report_get_response.rb +14 -2
  150. data/lib/plaid/models/base_report_item.rb +1 -1
  151. data/lib/plaid/models/base_report_longest_gap_insights.rb +1 -1
  152. data/lib/plaid/models/base_report_number_flow_insights.rb +1 -1
  153. data/lib/plaid/models/base_report_transaction.rb +1 -1
  154. data/lib/plaid/models/base_report_warning.rb +254 -0
  155. data/lib/plaid/models/base_report_warning_code.rb +39 -0
  156. data/lib/plaid/models/base_reports_error_webhook.rb +1 -1
  157. data/lib/plaid/models/base_reports_product_ready_webhook.rb +1 -1
  158. data/lib/plaid/models/beacon_audit_trail.rb +1 -1
  159. data/lib/plaid/models/beacon_audit_trail_source.rb +1 -1
  160. data/lib/plaid/models/beacon_match_summary_code.rb +41 -0
  161. data/lib/plaid/models/beacon_report.rb +309 -0
  162. data/lib/plaid/models/beacon_report_create_request.rb +2 -1
  163. data/lib/plaid/models/beacon_report_create_response.rb +2 -6
  164. data/lib/plaid/models/beacon_report_list_request.rb +257 -0
  165. data/lib/plaid/models/{credit_freddie_mac_service_voe25.rb → beacon_report_list_response.rb} +37 -25
  166. data/lib/plaid/models/beacon_report_syndication.rb +254 -0
  167. data/lib/plaid/models/beacon_report_syndication_analysis.rb +309 -0
  168. data/lib/plaid/models/beacon_report_syndication_list_request.rb +257 -0
  169. data/lib/plaid/models/beacon_report_syndication_list_response.rb +253 -0
  170. data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voe25.rb → beacon_report_syndication_original_report.rb} +51 -27
  171. data/lib/plaid/models/beacon_report_type.rb +1 -1
  172. data/lib/plaid/models/beacon_user_address.rb +1 -1
  173. data/lib/plaid/models/beacon_user_create_embedded_report.rb +2 -2
  174. data/lib/plaid/models/beacon_user_create_request.rb +1 -1
  175. data/lib/plaid/models/beacon_user_create_response.rb +1 -1
  176. data/lib/plaid/models/beacon_user_data.rb +1 -1
  177. data/lib/plaid/models/beacon_user_get_request.rb +1 -1
  178. data/lib/plaid/models/beacon_user_get_response.rb +1 -1
  179. data/lib/plaid/models/beacon_user_id_number.rb +1 -1
  180. data/lib/plaid/models/beacon_user_name.rb +1 -1
  181. data/lib/plaid/models/beacon_user_request_address.rb +1 -1
  182. data/lib/plaid/models/beacon_user_request_data.rb +1 -1
  183. data/lib/plaid/models/beacon_user_status.rb +1 -1
  184. data/lib/plaid/models/categories_get_response.rb +1 -1
  185. data/lib/plaid/models/category.rb +1 -1
  186. data/lib/plaid/models/category_insight_details.rb +288 -0
  187. data/lib/plaid/models/category_insights.rb +235 -0
  188. data/lib/plaid/models/cause.rb +1 -1
  189. data/lib/plaid/models/cause_all_of.rb +1 -1
  190. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  191. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  192. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  193. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  194. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  195. data/lib/plaid/models/connected_application.rb +1 -1
  196. data/lib/plaid/models/consumer_report_permissible_purpose.rb +1 -1
  197. data/lib/plaid/models/consumer_report_user_identity.rb +1 -1
  198. data/lib/plaid/models/counterparty.rb +1 -1
  199. data/lib/plaid/models/{signal_insights.rb → counterparty_insights.rb} +23 -20
  200. data/lib/plaid/models/counterparty_type.rb +1 -1
  201. data/lib/plaid/models/country_code.rb +1 -1
  202. data/lib/plaid/models/cra_bank_income.rb +1 -1
  203. data/lib/plaid/models/cra_bank_income_account.rb +1 -1
  204. data/lib/plaid/models/cra_bank_income_cause.rb +1 -1
  205. data/lib/plaid/models/cra_bank_income_complete_result.rb +1 -1
  206. data/lib/plaid/models/cra_bank_income_complete_webhook.rb +1 -1
  207. data/lib/plaid/models/cra_bank_income_employer.rb +1 -1
  208. data/lib/plaid/models/cra_bank_income_get_request.rb +1 -1
  209. data/lib/plaid/models/cra_bank_income_get_response.rb +1 -1
  210. data/lib/plaid/models/cra_bank_income_historical_summary.rb +1 -1
  211. data/lib/plaid/models/cra_bank_income_item.rb +1 -1
  212. data/lib/plaid/models/cra_bank_income_source.rb +1 -1
  213. data/lib/plaid/models/cra_bank_income_summary.rb +1 -1
  214. data/lib/plaid/models/cra_bank_income_transaction.rb +1 -1
  215. data/lib/plaid/models/cra_bank_income_warning.rb +1 -1
  216. data/lib/plaid/models/cra_bank_income_warning_code.rb +1 -1
  217. data/lib/plaid/models/credit1099.rb +1 -1
  218. data/lib/plaid/models/credit1099_filer.rb +1 -1
  219. data/lib/plaid/models/credit1099_payer.rb +1 -1
  220. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  221. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  222. data/lib/plaid/models/credit_ach_class.rb +1 -1
  223. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  224. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  225. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  226. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  227. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  228. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  229. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  230. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  231. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  232. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  233. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  234. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  235. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  236. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  237. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  238. data/lib/plaid/models/credit_bank_income.rb +1 -1
  239. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  240. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  241. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  242. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  243. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  244. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  245. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  246. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  247. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  248. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  249. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  250. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  251. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  252. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  253. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  254. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  255. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  256. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  257. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  258. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  259. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  260. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  261. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +1 -1
  262. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  263. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  264. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  265. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  266. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  267. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  268. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  269. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  270. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  271. data/lib/plaid/models/credit_card_liability.rb +1 -1
  272. data/lib/plaid/models/credit_category.rb +1 -1
  273. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  274. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  275. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  276. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  277. data/lib/plaid/models/credit_employment_item.rb +1 -1
  278. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  279. data/lib/plaid/models/credit_filter.rb +1 -1
  280. data/lib/plaid/models/{credit_freddie_mac_asset_voa24.rb → credit_freddie_mac_asset.rb} +5 -5
  281. data/lib/plaid/models/{credit_freddie_mac_asset_transaction_voa24.rb → credit_freddie_mac_asset_transaction.rb} +4 -4
  282. data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voe25.rb → credit_freddie_mac_asset_transactions.rb} +5 -5
  283. data/lib/plaid/models/{credit_freddie_mac_assets_voe25.rb → credit_freddie_mac_assets.rb} +5 -5
  284. data/lib/plaid/models/{credit_freddie_mac_individual_name_voa24.rb → credit_freddie_mac_individual_name.rb} +4 -4
  285. data/lib/plaid/models/{credit_freddie_mac_loan_voa24.rb → credit_freddie_mac_loan.rb} +5 -5
  286. data/lib/plaid/models/{credit_freddie_mac_loan_identifiers_voa24.rb → credit_freddie_mac_loan_identifiers.rb} +4 -4
  287. data/lib/plaid/models/{credit_freddie_mac_loans_voa24.rb → credit_freddie_mac_loans.rb} +5 -5
  288. data/lib/plaid/models/{credit_freddie_mac_parties_voa24.rb → credit_freddie_mac_parties.rb} +5 -5
  289. data/lib/plaid/models/{credit_freddie_mac_party_voa24.rb → credit_freddie_mac_party.rb} +5 -5
  290. data/lib/plaid/models/{credit_freddie_mac_party_individual_voa24.rb → credit_freddie_mac_party_individual.rb} +5 -5
  291. data/lib/plaid/models/{credit_freddie_mac_reporting_information_voa24.rb → credit_freddie_mac_reporting_information.rb} +4 -4
  292. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  293. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +31 -22
  294. data/lib/plaid/models/{credit_freddie_mac_service_voa24.rb → credit_freddie_mac_service.rb} +5 -5
  295. data/lib/plaid/models/{credit_freddie_mac_services_voa24.rb → credit_freddie_mac_services.rb} +5 -5
  296. data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_voa24.rb → credit_freddie_mac_verification_of_asset.rb} +6 -6
  297. data/lib/plaid/models/{credit_freddie_mac_verification_of_asset_response_voa24.rb → credit_freddie_mac_verification_of_asset_response.rb} +5 -5
  298. data/lib/plaid/models/{credit_freddie_mac_verification_of_assets_deal_voa24.rb → credit_freddie_mac_verification_of_assets_deal.rb} +7 -7
  299. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  300. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  301. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  302. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  303. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  304. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  305. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  306. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  307. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  308. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  309. data/lib/plaid/models/{credit_freddie_mac_asset_voe25.rb → credit_payroll_income_parsing_config_update_request.rb} +52 -46
  310. data/lib/plaid/models/{credit_freddie_mac_asset_transactions_voa24.rb → credit_payroll_income_parsing_config_update_response.rb} +16 -17
  311. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  312. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  313. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  314. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  315. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  316. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  317. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  318. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  319. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  320. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  321. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  322. data/lib/plaid/models/credit_relay_pdf_get_request.rb +1 -1
  323. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  324. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  325. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  326. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  327. data/lib/plaid/models/credit_session.rb +1 -1
  328. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  329. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  330. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  331. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  332. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  333. data/lib/plaid/models/credit_session_error.rb +1 -1
  334. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  335. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  336. data/lib/plaid/models/credit_session_results.rb +1 -1
  337. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  338. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  339. data/lib/plaid/models/credit_w2.rb +1 -1
  340. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  341. data/lib/plaid/models/dashboard_user.rb +1 -1
  342. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  343. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  344. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  345. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  346. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  347. data/lib/plaid/models/date_range.rb +1 -1
  348. data/lib/plaid/models/deductions.rb +1 -1
  349. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  350. data/lib/plaid/models/deductions_total.rb +1 -1
  351. data/lib/plaid/models/default_update_webhook.rb +1 -1
  352. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  353. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  354. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  355. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  356. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  357. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  358. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  359. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  360. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  361. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  362. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  363. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  364. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  365. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  366. data/lib/plaid/models/depository_filter.rb +1 -1
  367. data/lib/plaid/models/detailed_originator.rb +2 -1
  368. data/lib/plaid/models/detected_account.rb +298 -0
  369. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  370. data/lib/plaid/models/doc_type.rb +1 -1
  371. data/lib/plaid/models/document_analysis.rb +1 -1
  372. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  373. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  374. data/lib/plaid/models/document_metadata.rb +1 -1
  375. data/lib/plaid/models/document_name_match_code.rb +1 -1
  376. data/lib/plaid/models/document_risk_signal.rb +1 -1
  377. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  378. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  379. data/lib/plaid/models/document_risk_summary.rb +1 -1
  380. data/lib/plaid/models/document_status.rb +1 -1
  381. data/lib/plaid/models/documentary_verification.rb +1 -1
  382. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  383. data/lib/plaid/models/earnings.rb +1 -1
  384. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  385. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  386. data/lib/plaid/models/earnings_total.rb +1 -1
  387. data/lib/plaid/models/email.rb +1 -1
  388. data/lib/plaid/models/email_address_match_score.rb +1 -1
  389. data/lib/plaid/models/employee.rb +1 -1
  390. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  391. data/lib/plaid/models/employer.rb +1 -1
  392. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  393. data/lib/plaid/models/employer_verification.rb +1 -1
  394. data/lib/plaid/models/employers_search_request.rb +1 -1
  395. data/lib/plaid/models/employers_search_response.rb +1 -1
  396. data/lib/plaid/models/employment_details.rb +1 -1
  397. data/lib/plaid/models/employment_source_type.rb +1 -1
  398. data/lib/plaid/models/employment_verification.rb +1 -1
  399. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  400. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  401. data/lib/plaid/models/employment_verification_status.rb +1 -1
  402. data/lib/plaid/models/enhancements.rb +1 -1
  403. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  404. data/lib/plaid/models/enrichments.rb +1 -1
  405. data/lib/plaid/models/entity_document.rb +1 -1
  406. data/lib/plaid/models/entity_document_type.rb +1 -1
  407. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  408. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  409. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  410. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  411. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  412. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  413. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  414. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  415. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  416. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  417. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  418. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  419. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  420. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  421. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  422. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  423. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  424. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  425. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  426. data/lib/plaid/models/expiration_date.rb +1 -1
  427. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  428. data/lib/plaid/models/external_payment_options.rb +1 -1
  429. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  430. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  431. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  432. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  433. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  434. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  435. data/lib/plaid/models/fdx_content_types.rb +1 -1
  436. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  437. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  438. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  439. data/lib/plaid/models/fdx_notification.rb +1 -6
  440. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  441. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  442. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  443. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  444. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  445. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  446. data/lib/plaid/models/fdx_party.rb +1 -1
  447. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  448. data/lib/plaid/models/fdx_party_type.rb +1 -1
  449. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  450. data/lib/plaid/models/financial_institution_insights.rb +265 -0
  451. data/lib/plaid/models/form1099_type.rb +1 -1
  452. data/lib/plaid/models/fraud_amount.rb +1 -1
  453. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  454. data/lib/plaid/models/health_incident.rb +1 -1
  455. data/lib/plaid/models/historical_balance.rb +1 -1
  456. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  457. data/lib/plaid/models/holding.rb +1 -1
  458. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  459. data/lib/plaid/models/holdings_override.rb +1 -1
  460. data/lib/plaid/models/hosted_link_delivery_method.rb +1 -1
  461. data/lib/plaid/models/id_number_type.rb +1 -1
  462. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  463. data/lib/plaid/models/identity_get_request.rb +1 -1
  464. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  465. data/lib/plaid/models/identity_get_response.rb +1 -1
  466. data/lib/plaid/models/identity_match_request.rb +1 -1
  467. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  468. data/lib/plaid/models/identity_match_response.rb +1 -1
  469. data/lib/plaid/models/identity_match_user.rb +1 -1
  470. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  471. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  472. data/lib/plaid/models/identity_update_types.rb +1 -1
  473. data/lib/plaid/models/identity_verification.rb +1 -1
  474. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  475. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  476. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  477. data/lib/plaid/models/identity_verification_document_address_response.rb +1 -1
  478. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  479. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  480. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  481. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  482. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  483. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  484. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  485. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  486. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  487. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  488. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  489. data/lib/plaid/models/identity_verification_status.rb +1 -1
  490. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  491. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  492. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  493. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  494. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  495. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  496. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  497. data/lib/plaid/models/image_quality.rb +1 -1
  498. data/lib/plaid/models/incident_update.rb +1 -1
  499. data/lib/plaid/models/income_breakdown.rb +1 -1
  500. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  501. data/lib/plaid/models/income_override.rb +1 -1
  502. data/lib/plaid/models/income_summary.rb +1 -1
  503. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  504. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  505. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  506. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  507. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  508. data/lib/plaid/models/income_verification_doc_parsing_config.rb +1 -1
  509. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  510. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  511. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  512. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  513. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  514. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  515. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  516. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  517. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  518. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  519. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  520. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  521. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  522. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +1 -1
  523. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  524. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  525. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  526. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  527. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  528. data/lib/plaid/models/individual_name.rb +1 -1
  529. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  530. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  531. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  532. data/lib/plaid/models/inflow_model.rb +1 -1
  533. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  534. data/lib/plaid/models/institution.rb +1 -1
  535. data/lib/plaid/models/institution_status.rb +1 -1
  536. data/lib/plaid/models/institution_status_alert_webhook.rb +285 -0
  537. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  538. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  539. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  540. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  541. data/lib/plaid/models/institutions_get_request.rb +1 -1
  542. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  543. data/lib/plaid/models/institutions_get_response.rb +1 -1
  544. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  545. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  546. data/lib/plaid/models/institutions_search_request.rb +1 -1
  547. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  548. data/lib/plaid/models/institutions_search_response.rb +1 -1
  549. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  550. data/lib/plaid/models/investment_filter.rb +1 -1
  551. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  552. data/lib/plaid/models/investment_transaction.rb +1 -1
  553. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  554. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  555. data/lib/plaid/models/investments_auth_get_numbers.rb +1 -1
  556. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  557. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  558. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  559. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  560. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  561. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  562. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  563. data/lib/plaid/models/investments_holdings_get_response.rb +15 -5
  564. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  565. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  566. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  567. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  568. data/lib/plaid/models/investments_transactions_get_response.rb +15 -5
  569. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  570. data/lib/plaid/models/iso_currency_code.rb +1 -1
  571. data/lib/plaid/models/issuing_country.rb +1 -1
  572. data/lib/plaid/models/item.rb +1 -1
  573. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  574. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  575. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  576. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  577. data/lib/plaid/models/item_application_list_request.rb +1 -1
  578. data/lib/plaid/models/item_application_list_response.rb +1 -1
  579. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  580. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  581. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  582. data/lib/plaid/models/item_error_webhook.rb +1 -1
  583. data/lib/plaid/models/item_get_request.rb +1 -1
  584. data/lib/plaid/models/item_get_response.rb +1 -1
  585. data/lib/plaid/models/item_import_request.rb +1 -1
  586. data/lib/plaid/models/item_import_request_options.rb +1 -1
  587. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  588. data/lib/plaid/models/item_import_response.rb +1 -1
  589. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  590. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  591. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  592. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  593. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  594. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  595. data/lib/plaid/models/item_remove_request.rb +1 -1
  596. data/lib/plaid/models/item_remove_response.rb +1 -1
  597. data/lib/plaid/models/item_status.rb +1 -1
  598. data/lib/plaid/models/item_status_investments.rb +1 -1
  599. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  600. data/lib/plaid/models/item_status_nullable.rb +1 -1
  601. data/lib/plaid/models/item_status_transactions.rb +1 -1
  602. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  603. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  604. data/lib/plaid/models/jwk_public_key.rb +1 -1
  605. data/lib/plaid/models/jwt_header.rb +1 -1
  606. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  607. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  608. data/lib/plaid/models/kyc_check_details.rb +1 -1
  609. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  610. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  611. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  612. data/lib/plaid/models/last_data_access_times.rb +1 -1
  613. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  614. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  615. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  616. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  617. data/lib/plaid/models/liabilities_object.rb +1 -1
  618. data/lib/plaid/models/liability_override.rb +1 -1
  619. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  620. data/lib/plaid/models/link_delivery_account.rb +1 -1
  621. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  622. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  623. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  624. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  625. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  626. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  627. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  628. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  629. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  630. data/lib/plaid/models/link_delivery_options.rb +1 -1
  631. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  632. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  633. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  634. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  635. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  636. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  637. data/lib/plaid/models/link_event.rb +1 -1
  638. data/lib/plaid/models/link_event_metadata.rb +1 -1
  639. data/lib/plaid/models/link_event_name.rb +1 -1
  640. data/lib/plaid/models/link_events_webhook.rb +1 -1
  641. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  642. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  643. data/lib/plaid/models/link_session_exit.rb +1 -1
  644. data/lib/plaid/models/link_session_exit_metadata.rb +1 -1
  645. data/lib/plaid/models/link_session_exit_metadata_institution.rb +1 -1
  646. data/lib/plaid/models/link_session_finished_webhook.rb +1 -1
  647. data/lib/plaid/models/link_session_success.rb +1 -1
  648. data/lib/plaid/models/link_session_success_metadata.rb +1 -1
  649. data/lib/plaid/models/link_session_success_metadata_account.rb +1 -1
  650. data/lib/plaid/models/link_session_success_metadata_institution.rb +1 -1
  651. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +1 -1
  652. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  653. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  654. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  655. data/lib/plaid/models/link_token_create_hosted_link.rb +15 -5
  656. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  657. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  658. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  659. data/lib/plaid/models/link_token_create_request.rb +16 -4
  660. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  661. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  662. data/lib/plaid/models/link_token_create_request_base_report.rb +6 -1
  663. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  664. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  665. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  666. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  667. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  668. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  669. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  670. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  671. data/lib/plaid/models/link_token_create_request_statements.rb +1 -1
  672. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  673. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  674. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  675. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  676. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  677. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  678. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  679. data/lib/plaid/models/link_token_create_response.rb +1 -1
  680. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  681. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  682. data/lib/plaid/models/link_token_get_request.rb +1 -1
  683. data/lib/plaid/models/link_token_get_response.rb +1 -1
  684. data/lib/plaid/models/link_token_get_sessions_response.rb +1 -1
  685. data/lib/plaid/models/link_token_investments.rb +15 -5
  686. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  687. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  688. data/lib/plaid/models/loan.rb +1 -1
  689. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  690. data/lib/plaid/models/loan_filter.rb +1 -1
  691. data/lib/plaid/models/loan_identifier.rb +1 -1
  692. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  693. data/lib/plaid/models/loan_identifiers.rb +1 -1
  694. data/lib/plaid/models/loans.rb +1 -1
  695. data/lib/plaid/models/location.rb +1 -1
  696. data/lib/plaid/models/match_summary.rb +1 -1
  697. data/lib/plaid/models/match_summary_code.rb +1 -1
  698. data/lib/plaid/models/merchant_insights.rb +315 -0
  699. data/lib/plaid/models/meta.rb +1 -1
  700. data/lib/plaid/models/mfa.rb +1 -1
  701. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  702. data/lib/plaid/models/mortgage_liability.rb +1 -1
  703. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  704. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  705. data/lib/plaid/models/name_match_score.rb +1 -1
  706. data/lib/plaid/models/net_pay.rb +1 -1
  707. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  708. data/lib/plaid/models/numbers.rb +1 -1
  709. data/lib/plaid/models/numbers_acats.rb +1 -1
  710. data/lib/plaid/models/numbers_ach.rb +1 -1
  711. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  712. data/lib/plaid/models/numbers_aton.rb +1 -1
  713. data/lib/plaid/models/numbers_bacs.rb +1 -1
  714. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  715. data/lib/plaid/models/numbers_eft.rb +1 -1
  716. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  717. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  718. data/lib/plaid/models/numbers_international.rb +1 -1
  719. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  720. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  721. data/lib/plaid/models/omittable_transfer_type.rb +1 -1
  722. data/lib/plaid/models/originator.rb +1 -1
  723. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  724. data/lib/plaid/models/override_account_type.rb +1 -1
  725. data/lib/plaid/models/override_accounts.rb +1 -1
  726. data/lib/plaid/models/owner.rb +1 -1
  727. data/lib/plaid/models/owner_override.rb +1 -1
  728. data/lib/plaid/models/ownership_type.rb +1 -1
  729. data/lib/plaid/models/parties.rb +1 -1
  730. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  731. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  732. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  733. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  734. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  735. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  736. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  737. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  738. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  739. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  740. data/lib/plaid/models/partner_end_customer.rb +1 -1
  741. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  742. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  743. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  744. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  745. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  746. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  747. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  748. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  749. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  750. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  751. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  752. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  753. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  754. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  755. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  756. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  757. data/lib/plaid/models/party.rb +1 -1
  758. data/lib/plaid/models/party_individual.rb +1 -1
  759. data/lib/plaid/models/party_role_type.rb +1 -1
  760. data/lib/plaid/models/pay.rb +1 -1
  761. data/lib/plaid/models/pay_frequency.rb +1 -1
  762. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  763. data/lib/plaid/models/pay_period_details.rb +1 -1
  764. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  765. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  766. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  767. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  768. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  769. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  770. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  771. data/lib/plaid/models/payment_amount.rb +1 -1
  772. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  773. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  774. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  775. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  776. data/lib/plaid/models/payment_channel.rb +1 -1
  777. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  778. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  779. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  780. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  781. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  782. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  783. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  784. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  785. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  786. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  787. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  788. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  789. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  790. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  791. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  792. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  793. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  794. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  795. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  796. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  797. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  798. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  799. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  800. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  801. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  802. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  803. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  804. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  805. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  806. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  807. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  808. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  809. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  810. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  811. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  812. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  813. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  814. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  815. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  816. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  817. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  818. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  819. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  820. data/lib/plaid/models/payment_meta.rb +1 -1
  821. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  822. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  823. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  824. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  825. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  826. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  827. data/lib/plaid/models/payment_profile_status.rb +1 -1
  828. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  829. data/lib/plaid/models/payment_scheme.rb +1 -1
  830. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  831. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  832. data/lib/plaid/models/payroll_income_object.rb +1 -1
  833. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  834. data/lib/plaid/models/payroll_item.rb +1 -1
  835. data/lib/plaid/models/payroll_item_status.rb +1 -1
  836. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  837. data/lib/plaid/models/paystub.rb +1 -1
  838. data/lib/plaid/models/paystub_address.rb +1 -1
  839. data/lib/plaid/models/paystub_deduction.rb +1 -1
  840. data/lib/plaid/models/paystub_details.rb +1 -1
  841. data/lib/plaid/models/paystub_employer.rb +1 -1
  842. data/lib/plaid/models/paystub_override.rb +1 -1
  843. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  844. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  845. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  846. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  847. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  848. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  849. data/lib/plaid/models/personal_finance_category.rb +3 -3
  850. data/lib/plaid/models/phone_number.rb +1 -1
  851. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  852. data/lib/plaid/models/phone_type.rb +1 -1
  853. data/lib/plaid/models/physical_document_category.rb +1 -1
  854. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  855. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  856. data/lib/plaid/models/physical_document_images.rb +1 -1
  857. data/lib/plaid/models/plaid_error.rb +1 -1
  858. data/lib/plaid/models/plaid_error_type.rb +1 -1
  859. data/lib/plaid/models/platform_ids.rb +1 -1
  860. data/lib/plaid/models/po_box_status.rb +1 -1
  861. data/lib/plaid/models/processor_account_get_request.rb +1 -1
  862. data/lib/plaid/models/processor_account_get_response.rb +1 -1
  863. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  864. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  865. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  866. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  867. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  868. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  869. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  870. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  871. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  872. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  873. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  874. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  875. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  876. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  877. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  878. data/lib/plaid/models/processor_number.rb +1 -1
  879. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  880. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  881. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  882. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  883. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  884. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  885. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  886. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  887. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  888. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  889. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  890. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  891. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  892. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  893. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  894. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  895. data/lib/plaid/models/processor_token_webhook_update.rb +1 -1
  896. data/lib/plaid/models/processor_token_webhook_update_request.rb +1 -1
  897. data/lib/plaid/models/processor_token_webhook_update_response.rb +1 -1
  898. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  899. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  900. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +5 -22
  901. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  902. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  903. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  904. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  905. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  906. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  907. data/lib/plaid/models/product_access.rb +1 -1
  908. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  909. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  910. data/lib/plaid/models/product_status.rb +1 -1
  911. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  912. data/lib/plaid/models/products.rb +1 -1
  913. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  914. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  915. data/lib/plaid/models/proxy_type.rb +1 -1
  916. data/lib/plaid/models/pslf_status.rb +1 -1
  917. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  918. data/lib/plaid/models/recipient_bacs.rb +1 -1
  919. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  920. data/lib/plaid/models/recurrence.rb +1 -1
  921. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  922. data/lib/plaid/models/recurring_frequency.rb +1 -1
  923. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  924. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  925. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  926. data/lib/plaid/models/recurring_transfer.rb +1 -1
  927. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  928. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  929. data/lib/plaid/models/removed_transaction.rb +1 -1
  930. data/lib/plaid/models/report_type.rb +1 -1
  931. data/lib/plaid/models/reporting_information.rb +1 -1
  932. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  933. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  934. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  935. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  936. data/lib/plaid/models/risk_check_details.rb +1 -1
  937. data/lib/plaid/models/risk_check_device.rb +1 -1
  938. data/lib/plaid/models/risk_check_email.rb +1 -1
  939. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  940. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  941. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  942. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  943. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  944. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  945. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  946. data/lib/plaid/models/risk_check_phone.rb +1 -1
  947. data/lib/plaid/models/risk_check_stolen_identity.rb +1 -1
  948. data/lib/plaid/models/risk_check_synthetic_identity.rb +1 -1
  949. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  950. data/lib/plaid/models/risk_signal_document_status.rb +1 -1
  951. data/lib/plaid/models/role.rb +1 -1
  952. data/lib/plaid/models/role_detail.rb +1 -1
  953. data/lib/plaid/models/roles.rb +1 -1
  954. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  955. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  956. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  957. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  958. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  959. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  960. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  961. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  962. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  963. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  964. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  965. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  966. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  967. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  968. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  969. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  970. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  971. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  972. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  973. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  974. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  975. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  976. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  977. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  978. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  979. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  980. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  981. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  982. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  983. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  984. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_request.rb +1 -1
  985. data/lib/plaid/models/sandbox_transfer_ledger_deposit_simulate_response.rb +1 -1
  986. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_request.rb +1 -1
  987. data/lib/plaid/models/sandbox_transfer_ledger_simulate_available_response.rb +1 -1
  988. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_request.rb +1 -1
  989. data/lib/plaid/models/sandbox_transfer_ledger_withdraw_simulate_response.rb +1 -1
  990. data/lib/plaid/models/sandbox_transfer_refund_simulate_request.rb +282 -0
  991. data/lib/plaid/models/{credit_freddie_mac_assets_voa24.rb → sandbox_transfer_refund_simulate_response.rb} +16 -18
  992. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  993. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  994. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  995. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  996. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  997. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  998. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  999. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  1000. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  1001. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  1002. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  1003. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  1004. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  1005. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  1006. data/lib/plaid/models/scopes.rb +1 -1
  1007. data/lib/plaid/models/scopes_context.rb +1 -1
  1008. data/lib/plaid/models/scopes_nullable.rb +1 -1
  1009. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  1010. data/lib/plaid/models/screening_hit_data.rb +1 -1
  1011. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  1012. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  1013. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  1014. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  1015. data/lib/plaid/models/security.rb +3 -3
  1016. data/lib/plaid/models/security_override.rb +3 -3
  1017. data/lib/plaid/models/selfie_analysis.rb +1 -1
  1018. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  1019. data/lib/plaid/models/selfie_capture.rb +1 -1
  1020. data/lib/plaid/models/selfie_check.rb +1 -1
  1021. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  1022. data/lib/plaid/models/selfie_check_status.rb +1 -1
  1023. data/lib/plaid/models/selfie_status.rb +1 -1
  1024. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1025. data/lib/plaid/models/service.rb +1 -1
  1026. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1027. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1028. data/lib/plaid/models/service_product_fulfillment_identifier.rb +2 -2
  1029. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1030. data/lib/plaid/models/services.rb +1 -1
  1031. data/lib/plaid/models/signal_address_data.rb +1 -1
  1032. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1033. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1034. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1035. data/lib/plaid/models/signal_device.rb +1 -1
  1036. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1037. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1038. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1039. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1040. data/lib/plaid/models/signal_person_name.rb +1 -1
  1041. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1042. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1043. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1044. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1045. data/lib/plaid/models/signal_scores.rb +1 -1
  1046. data/lib/plaid/models/signal_user.rb +1 -1
  1047. data/lib/plaid/models/signal_warning.rb +1 -1
  1048. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1049. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1050. data/lib/plaid/models/source.rb +1 -1
  1051. data/lib/plaid/models/standalone_account_type.rb +1 -1
  1052. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1053. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1054. data/lib/plaid/models/statements_account.rb +1 -1
  1055. data/lib/plaid/models/statements_download_request.rb +1 -1
  1056. data/lib/plaid/models/statements_list_request.rb +1 -1
  1057. data/lib/plaid/models/statements_list_response.rb +1 -1
  1058. data/lib/plaid/models/statements_statement.rb +1 -1
  1059. data/lib/plaid/models/status.rb +1 -1
  1060. data/lib/plaid/models/statuses.rb +1 -1
  1061. data/lib/plaid/models/strategy.rb +1 -1
  1062. data/lib/plaid/models/student_loan.rb +1 -1
  1063. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1064. data/lib/plaid/models/student_loan_status.rb +1 -1
  1065. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1066. data/lib/plaid/models/sweep_status.rb +1 -1
  1067. data/lib/plaid/models/sweep_trigger.rb +1 -1
  1068. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  1069. data/lib/plaid/models/taxform.rb +1 -1
  1070. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1071. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1072. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1073. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1074. data/lib/plaid/models/total.rb +1 -1
  1075. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1076. data/lib/plaid/models/transaction.rb +6 -6
  1077. data/lib/plaid/models/transaction_all_of.rb +2 -2
  1078. data/lib/plaid/models/transaction_base.rb +5 -5
  1079. data/lib/plaid/models/transaction_code.rb +1 -1
  1080. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1081. data/lib/plaid/models/transaction_data.rb +1 -1
  1082. data/lib/plaid/models/transaction_override.rb +1 -1
  1083. data/lib/plaid/models/transaction_stream.rb +1 -1
  1084. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1085. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1086. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1087. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1088. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1089. data/lib/plaid/models/{transactions_enrich_get_request.rb → transactions_enrich_request.rb} +5 -5
  1090. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1091. data/lib/plaid/models/{transactions_enrich_get_response.rb → transactions_enrich_response.rb} +5 -5
  1092. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1093. data/lib/plaid/models/transactions_get_request_options.rb +5 -5
  1094. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1095. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1096. data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
  1097. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1098. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1099. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1100. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1101. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1102. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1103. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1104. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1105. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1106. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1107. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1108. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1109. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1110. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1111. data/lib/plaid/models/transactions_sync_request_options.rb +3 -3
  1112. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1113. data/lib/plaid/models/{credit_freddie_verification_of_employment_deal_voe25.rb → transactions_user_insights_get_request.rb} +30 -37
  1114. data/lib/plaid/models/{fraud_amount_nullable.rb → transactions_user_insights_get_response.rb} +30 -27
  1115. data/lib/plaid/models/transfer.rb +17 -7
  1116. data/lib/plaid/models/transfer_ach_network.rb +1 -1
  1117. data/lib/plaid/models/transfer_authorization.rb +12 -12
  1118. data/lib/plaid/models/transfer_authorization_create_request.rb +3 -3
  1119. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1120. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1121. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1122. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1123. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1124. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1125. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1126. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1127. data/lib/plaid/models/{credit_freddie_mac_asset_detail_voe25.rb → transfer_authorization_payment_risk.rb} +85 -91
  1128. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
  1129. data/lib/plaid/models/transfer_authorization_risk_level.rb +42 -0
  1130. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1131. data/lib/plaid/models/transfer_balance.rb +1 -1
  1132. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1133. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1134. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1135. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1136. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1137. data/lib/plaid/models/transfer_capabilities_get_request.rb +11 -1
  1138. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1139. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1140. data/lib/plaid/models/transfer_configuration_get_request.rb +2 -2
  1141. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1142. data/lib/plaid/models/transfer_create_request.rb +16 -6
  1143. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1144. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1145. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1146. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1147. data/lib/plaid/models/transfer_device.rb +1 -1
  1148. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +2 -2
  1149. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1150. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1151. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1152. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1153. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1154. data/lib/plaid/models/transfer_event.rb +1 -1
  1155. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1156. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1157. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1158. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1159. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1160. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1161. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1162. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1163. data/lib/plaid/models/transfer_failure.rb +1 -1
  1164. data/lib/plaid/models/transfer_funding_account.rb +2 -2
  1165. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1166. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1167. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1168. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1169. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1170. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1171. data/lib/plaid/models/transfer_intent_create_request.rb +2 -2
  1172. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1173. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1174. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1175. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1176. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1177. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1178. data/lib/plaid/models/transfer_ledger_balance.rb +1 -1
  1179. data/lib/plaid/models/transfer_ledger_deposit_request.rb +3 -3
  1180. data/lib/plaid/models/transfer_ledger_deposit_response.rb +1 -1
  1181. data/lib/plaid/models/transfer_ledger_get_request.rb +1 -1
  1182. data/lib/plaid/models/transfer_ledger_get_response.rb +1 -1
  1183. data/lib/plaid/models/transfer_ledger_sweep_simulate_event_type.rb +1 -1
  1184. data/lib/plaid/models/transfer_ledger_withdraw_request.rb +3 -3
  1185. data/lib/plaid/models/transfer_ledger_withdraw_response.rb +1 -1
  1186. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1187. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1188. data/lib/plaid/models/transfer_metrics_get_request.rb +2 -2
  1189. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1190. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1191. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1192. data/lib/plaid/models/transfer_network.rb +1 -1
  1193. data/lib/plaid/models/transfer_originator_address.rb +5 -1
  1194. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1195. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1196. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1197. data/lib/plaid/models/transfer_originator_funding_account_update_request.rb +1 -1
  1198. data/lib/plaid/models/transfer_originator_funding_account_update_response.rb +1 -1
  1199. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1200. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1201. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1202. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1203. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1204. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1205. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1206. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1207. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -7
  1208. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1209. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1210. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1211. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1212. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1213. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1214. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1215. data/lib/plaid/models/transfer_refund.rb +1 -1
  1216. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1217. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1218. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1219. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1220. data/lib/plaid/models/transfer_refund_failure.rb +1 -1
  1221. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1222. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1223. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1224. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1225. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1226. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1227. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1228. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1229. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1230. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1231. data/lib/plaid/models/transfer_status.rb +1 -1
  1232. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1233. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1234. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1235. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1236. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1237. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1238. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1239. data/lib/plaid/models/transfer_type.rb +1 -1
  1240. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1241. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1242. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1243. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1244. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1245. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1246. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1247. data/lib/plaid/models/user_address.rb +1 -1
  1248. data/lib/plaid/models/user_create_request.rb +1 -1
  1249. data/lib/plaid/models/user_create_response.rb +1 -1
  1250. data/lib/plaid/models/user_custom_password.rb +1 -1
  1251. data/lib/plaid/models/user_data_overview.rb +291 -0
  1252. data/lib/plaid/models/user_id_number.rb +1 -1
  1253. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1254. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1255. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1256. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1257. data/lib/plaid/models/user_update_request.rb +1 -1
  1258. data/lib/plaid/models/user_update_response.rb +1 -1
  1259. data/lib/plaid/models/validation_source.rb +1 -1
  1260. data/lib/plaid/models/validation_sources.rb +1 -1
  1261. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1262. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1263. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1264. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1265. data/lib/plaid/models/verification_status.rb +1 -1
  1266. data/lib/plaid/models/w2.rb +1 -1
  1267. data/lib/plaid/models/w2_box12.rb +1 -1
  1268. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1269. data/lib/plaid/models/wallet.rb +1 -1
  1270. data/lib/plaid/models/wallet_balance.rb +1 -1
  1271. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1272. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1273. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1274. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1275. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1276. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1277. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1278. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1279. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1280. data/lib/plaid/models/wallet_status.rb +1 -1
  1281. data/lib/plaid/models/wallet_transaction.rb +4 -4
  1282. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1283. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1284. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1285. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1286. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1287. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1288. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1289. data/lib/plaid/models/wallet_transaction_failure_reason.rb +1 -1
  1290. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1291. data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
  1292. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1293. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1294. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1295. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1296. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1297. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1298. data/lib/plaid/models/warning.rb +1 -1
  1299. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1300. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1301. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1302. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1303. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1304. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1305. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1306. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1307. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1308. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1309. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1310. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1311. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1312. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1313. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1314. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1315. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1316. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1317. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1318. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1319. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1320. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1321. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1322. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1323. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1324. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1325. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1326. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1327. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1328. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1329. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1330. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1331. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1332. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1333. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1334. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1335. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1336. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1337. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1338. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1339. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1340. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1341. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1342. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1343. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1344. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1345. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1346. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1347. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1348. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1349. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1350. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1351. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1352. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1353. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1354. data/lib/plaid/models/webhook_type.rb +1 -1
  1355. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1356. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1357. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1358. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1359. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1360. data/lib/plaid/version.rb +2 -2
  1361. data/lib/plaid.rb +47 -35
  1362. data/plaid.gemspec +1 -1
  1363. data/test/test_enrich.rb +2 -2
  1364. metadata +48 -36
  1365. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +0 -324
  1366. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +0 -225
  1367. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +0 -225
  1368. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +0 -253
  1369. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +0 -240
  1370. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +0 -240
data/CHANGELOG.md CHANGED
@@ -1,97 +1,270 @@
1
1
  See full changelog for the OpenAPI schema (OAS) [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2
2
 
3
+ # 23.0.0
4
+
5
+ - Updating to OAS 2020-09-14_1.457.0
6
+
7
+ ## Breaking changes in this version
8
+
9
+ - Remove `user_token` field from `asset_report/create` request.
10
+ - Renamed `TransactionsEnrichGetRequest` and `TransactionsEnrichGetResponse` objects to `TransactionsEnrichRequest` and `TransactionsEnrichResponse`.
11
+
12
+ ## OpenAPI Schema Changes
13
+
14
+ ### 2020-09-14_1.457.0
15
+
16
+ - Remove `account_ids` parameter from `/processor/transactions/recurring/get` request
17
+
18
+ ### 2020-09-14_1.456.0
19
+
20
+ - Add `hosted_link.completion_redirect_uri` to `link/token/create` request
21
+
22
+ ### 2020-09-14_1.455.2
23
+
24
+ - Deprecate max_single_transfer_amount and max_monthly_amount in /transfer/configuration/get response.
25
+ - Deprecate monthly_transfer_volume in /transfer/metrics/get response.
26
+
27
+ ### 2020-09-14_1.455.1
28
+
29
+ - Update documentation for `/credit/payroll_income/parsing_config/update`
30
+
31
+ ### 2020-09-14_1.455.0
32
+
33
+ - Add new /sandbox/transfer/refund/simulate route to simulate refund events in sandbox.
34
+
35
+ ### 2020-09-14_1.454.0
36
+
37
+ - Add `is_investments_fallback_item` field to `/investments/holdings/get` and `/investments/transactions/get` responses
38
+
39
+ ### 2020-09-14_1.453.0
40
+
41
+ - Add `/credit/payroll_income/parsing_config/update` for updating the parsing configuration for document income verficiations
42
+
43
+ ### 2020-09-14_1.452.0
44
+
45
+ - Add `warnings` field to `/cra/base_report/get` response
46
+
47
+ ### 2020-09-14_1.451.0
48
+
49
+ - Add `/beacon/report_syndication/list` for listing `BeaconReportSyndication` objects linked to a specific `BeaconUser`
50
+
51
+ ### 2020-09-14_1.450.0
52
+
53
+ - [Breaking] Remove `user_token` field from `asset_report/create` request.
54
+
55
+ ### 2020-09-14_1.449.2
56
+
57
+ - Updates `isin` and `cusip` field descriptions for new call to action.
58
+
59
+ ### 2020-09-14_1.449.1
60
+
61
+ - Add new refund event types.
62
+
63
+ ### 2020-09-14_1.449.0
64
+
65
+ - Add `/beacon/report/list` for listing `BeaconReport` objects created for a specific `BeaconUser`
66
+
67
+ ### 2020-09-14_1.448.0
68
+
69
+ - Make `publisher` field from `FDXNotifications` as optional
70
+
71
+ ### 2020-09-14_1.447.0
72
+
73
+ - Mark `fraud_amount` as nullable for `BeaconReport` objects in `/beacon/report/create`
74
+
75
+ ### 2020-09-14_1.446.0
76
+
77
+ - Add `allow_manual_entry` field to `investments` object in `link/token/create`
78
+ - Update `/credit/freddie_mac/reports/get` return type data shape to contain one object with both VOA and VOE assets combined
79
+
80
+ ### 2020-09-14_1.445.0
81
+
82
+ - Add new insights and counterparty fields for Transactions endpoints
83
+ - Deprecate legacy category fields for Transactions endpoints
84
+
85
+ ### 2020-09-14_1.444.0
86
+
87
+ - Add new webhook type `AUTHORIZATION_GRANTED` to `sandbox/item/fire_webhook`
88
+
89
+ ### 2020-09-14_1.443.0
90
+
91
+ - Add `RETURN` as possible Virtual Account wallet transaction type
92
+
93
+ ### 2020-09-14_1.442.0
94
+
95
+ - Add `facilitator_fee` field for the Transfers endpoints
96
+
97
+ ### 2020-09-14_1.441
98
+
99
+ - [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`
100
+ - Update examples for ledger endpoints to be more realistic
101
+
102
+ ### 2020-09-14_1.440.0
103
+
104
+ - Add `optional_products` parameter to `/link/token/create` request.
105
+
106
+ ### 2020-09-14_1.439.0
107
+
108
+ - [Breaking] Renamed `TransactionsEnrichGetRequest` and `TransactionsEnrichGetResponse` objects to
109
+ `TransactionsEnrichRequest` and `TransactionsEnrichResponse`.
110
+
111
+ ### 2020-09-14_1.438.1
112
+
113
+ - [Breaking change for Go client library] remove `device`, `user_present` from required request param list of `/transfer/recurring/create`
114
+
115
+ ### 2020-09-14_1.438.0
116
+
117
+ - Add new `/beta/transactions/user_insights/v1/get` endpoint
118
+
119
+ ### 2020-09-14_1.437.0
120
+
121
+ - Remove min/max restriction of `days_requested` in OpenAPI.
122
+
123
+ ### 2020-09-14_1.436.0
124
+
125
+ - Update `days_requested` to be a required field in base reports in `link/token/create`
126
+
127
+ ### 2020-09-14_1.435.0
128
+
129
+ - Update `/sandbox/transfer/sweep/simulate` to mark `swept` transfers as `swept_settled`.
130
+
131
+ ### 2020-09-14_1.434.0
132
+
133
+ - Added a new type of webhook for dashboard alerts, `InstitutionStatusAlertWebhook`.
134
+
135
+ ### 2020-09-14_1.433.0
136
+
137
+ - Update response of `/transfer/authorizarion/create`
138
+
139
+ ### 2020-09-14_1.432.0
140
+
141
+ - Update `days_requested` in `base_report` in `link/token/create` to enforce a min/max of 1/731 days
142
+
3
143
  # 22.0.0
144
+
4
145
  - Updating to OAS 2020-09-14_1.431.7
5
146
 
147
+ ## Breaking changes in this version
148
+
149
+ This version does not contain breaking changes.
150
+
6
151
  ## OpenAPI Schema Changes
152
+
7
153
  ### 2020-09-14_1.431.7
154
+
8
155
  - Add processor Zero Hash
9
156
 
10
157
  ### 2020-09-14_1.431.6
158
+
11
159
  - Update response example of `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
12
160
 
13
161
  ### 2020-09-14_1.431.5
162
+
14
163
  - Update the description of `sweep.settled` event
15
164
 
16
165
  ### 2020-09-14_1.431.4
166
+
17
167
  - Update description of endpoint `/sandbox/transfer/ledger/simulate_available`
18
168
 
19
169
  ### 2020-09-14_1.431.3
170
+
20
171
  - Deprecate `originator_client_id` in `/transfer/get`, `/transfer/cancel`, and `/transfer/balance/get`
21
172
 
22
173
  ### 2020-09-14_1.431.2
174
+
23
175
  - Docs updates for Statements endpoints
24
176
 
25
177
  ### 2020-09-14_1.431.1
178
+
26
179
  - Remove `balance` field from response of `/sandbox/transfer/ledger/simulate_available`
27
180
 
28
181
  ### 2020-09-14_1.431.0
182
+
29
183
  - Add `/user/update` and update the description for consumer report user identity
30
184
 
31
185
  ### 2020-09-14_1.430.3
186
+
32
187
  - Add `sandbox/transfer/ledger/deposit/simulate` and `sandbox/transfer/ledger/withdraw/simulate`
33
188
 
34
189
  ### 2020-09-14_1.430.2
190
+
35
191
  - Update `transfer/sweep/list` to support filter by `trigger`
36
192
 
37
193
  ### 2020-09-14_1.430.1
194
+
38
195
  - Add `transfer/ledger/withdraw` route
39
196
 
40
197
  ### 2020-09-14_1.430.0
198
+
41
199
  - Add `transfer/originator/funding_account/update` route
42
200
 
43
201
  ### 2020-09-14_1.429.3
202
+
44
203
  - add ledger sweep event types to `TransferEventType`
45
204
 
46
205
  ### 2020-09-14_1.429.2
206
+
47
207
  - Documentation updates for `LOGIN_REPAIRED` webhook and transfer.
48
208
  - Add `transfer/ledger/deposit` route
49
209
 
50
210
  ### 2020-09-14_1.429.1
211
+
51
212
  - Updated /identity/match's address score threshold recommendation from 80 or above to 70 or above
52
213
 
53
214
  ### 2020-09-14_1.429.0
54
- - [Breaking change for Go client library] For Transfer endpoints that take payment profiles as input, remove `payment_profile` field and make
55
- `account_id` and `access_token` mandatory. The removed field is not in use.
215
+
216
+ - [Breaking change for Go client library] For Transfer endpoints that take payment profiles as input, remove `payment_profile` field and make
217
+ `account_id` and `access_token` mandatory. The removed field is not in use.
56
218
  - Mark all payment profile-specific endpoints as `deprecated`.
57
219
  - Docs updates for Transfer, including clarifying that certain request fields for `/transfer/authorization/create`
58
- are not currently used.
220
+ are not currently used.
59
221
  - Propagate Signal docs update from 2020-09-14_1.419.0 to all relevant endpoints.
60
222
  - Add `institution_not_supported` as a property to `LinkSessionExitMetadata.Status`
61
223
 
62
224
  ### 2020-09-14_1.428.1
225
+
63
226
  - Change `/credit/reports/freddie_mac/get` schema to contain new `ReportingInformationParentIdentifier` field
64
227
 
65
228
  ### 2020-09-14_1.428.0
229
+
66
230
  - Add `verification_report_type` to `asset_report/create` request
67
231
 
68
232
  ### 2020-09-14_1.427.1
233
+
69
234
  - Remove references to the verification `report_type` field in `asset_report/get` and `asset_report/pdf/get`
70
235
 
71
236
  ### 2020-09-14_1.427.0
237
+
72
238
  - Add `/processor/account/get` route
73
239
 
74
240
  ### 2020-09-14_1.426.0
241
+
75
242
  - Add `instant_microdeposits_enabled` field to `auth` object in `link/token/create`
76
243
 
77
244
  ### 2020-09-14_1.425.0
245
+
78
246
  - Add `investments` field to `asset_report/get` response as part of the `items.accounts` object
79
247
 
80
248
  ### 2020-09-14_1.424.2
249
+
81
250
  - Update descriptions of some Transactions endpoint fields
82
251
 
83
252
  ### 2020-09-14_1.424.1
253
+
84
254
  - Add clarification to processor webhook doc that the processor can call it
85
255
  - Fix `sandbox/transfer/ledger/simulate_available` doc url
86
256
 
87
257
  ### 2020-09-14_1.424.0
258
+
88
259
  - Add `/sandbox/transfer/ledger/simulate_available` route
89
260
 
90
261
  ### 2020-09-14_1.423.0
262
+
91
263
  - Update code of `BaseReportsErrorWebhook` to `ERROR`
92
264
  - Add new enum to StudentRepaymentPlan and add to description of repayment_plan_type
93
265
 
94
266
  ### 2020-09-14_1.422.0
267
+
95
268
  - Move `BaseReportsProductReadyWebhook` and `BaseReportsErrorWebhook`
96
269
  - Remove `asset_report_id` and add `user_id` to `BaseReportsErrorWebhook`
97
270
 
@@ -116,14 +289,16 @@ are not currently used.
116
289
  - Add `submitted` and `not_submitted` to transferDiligenceStatus
117
290
 
118
291
  # 21.3.0
292
+
119
293
  - Updating to OAS 2020-09-14_1.419.0
120
294
 
121
295
  ## OpenAPI Schema Changes
296
+
122
297
  ### 2020-09-14_1.419.0
123
298
 
124
299
  - Update `/signal/decision/report` description
125
300
  - Overwriting `initiated` field is now supported and no longer returns an `INVALID_FIELD` error
126
-
301
+
127
302
  ### 2020-09-14_1.418.0
128
303
 
129
304
  - Add `frequency` to `/transactions/enrich`
@@ -145,99 +320,130 @@ are not currently used.
145
320
  - Update `currency` on `payment/reverse` and `amount_refunded` on `payment/get`
146
321
 
147
322
  # 21.2.0
323
+
148
324
  - Updating to OAS 2020-09-14_1.413.0
149
325
 
150
326
  ## OpenAPI Schema Changes
327
+
151
328
  ### 2020-09-14_1.413.0
329
+
152
330
  - Add `statements` to `/link/token/create` request
153
331
 
154
332
  ### 2020-09-14_1.412.0
333
+
155
334
  - Add `hosted_link_url` to `/link/token/create` response
156
335
  - Add `hosted_link.delivery_method` to `/link/token/create`
157
336
 
158
337
  ### 2020-09-14_1.411.0
338
+
159
339
  - Add `link_sessions` to `/link/token/get`
160
340
  - Add `LINK:SESSION_FINISHED` webhook
161
341
 
162
342
  # 21.1.0
343
+
163
344
  - Updating to OAS 2020-09-14_1.410.1
164
345
 
165
346
  ## OpenAPI Schema Changes
347
+
166
348
  ### 2020-09-14_1.410.1
349
+
167
350
  - Add `statements` to the list of supported Plaid products in the `/link/token/create` endpoint
168
351
 
169
352
  ### 2020-09-14_1.410.0
353
+
170
354
  - add `/credit/relay/pdf/get` endpoint
171
355
 
172
356
  ### 2020-09-14_1.409.0
357
+
173
358
  - Add `original_client_id` to `/transfer/balance/get`
174
359
  - Mark `type` optional in `/transfer/balance/get` request
175
360
 
176
361
  ### 2020-09-14_1.408.0
362
+
177
363
  - Add `status` to `document_reference` in `/credit/payroll_income/risk_signals/get`
178
364
 
179
365
  ### 2020-09-14_1.407.0
366
+
180
367
  - Add `consumer_report_user_identity` to `/user/create`
181
368
 
182
369
  ### 2020-09-14_1.406.1
370
+
183
371
  - Add comment explaining availability of `confidence_level` field for `/transactions/*` endpoints
184
372
 
185
373
  ### 2020-09-14_1.406.0
374
+
186
375
  - Added insights fields to `/cra/base_report/get`
187
376
 
188
377
  ### 2020-09-14_1.405.0
378
+
189
379
  - Update identity/match user.address such that none of the fields are required
190
380
  - Add `AddressDataNullableNoRequiredFields`
191
381
 
192
382
  ### 2020-09-14_1.404.1
383
+
193
384
  - Allowing null failure_reason for refunds to be displayed
194
- -
385
+ -
386
+
195
387
  ### 2020-09-14_1.404.0
388
+
196
389
  - Add `failure_reason` to `/wallet/transaction/get` and `/wallet/transaction/list` endpoint in virtual accounts.
197
390
 
198
391
  ### 2020-09-14_1.403.1
392
+
199
393
  - Add `parsing_config` to `/link/token/create`
200
394
 
201
395
  ### 2020-09-14_1.403.0
396
+
202
397
  - Add `failure_reason` field to refunds for failed and returned refunds
203
398
 
204
399
  ### 2020-09-14_1.402.0
205
- - Add `area_code` match status to the response of the `identity_verification/get` and `identity_verification/list` endpoint
206
400
 
401
+ - Add `area_code` match status to the response of the `identity_verification/get` and `identity_verification/list` endpoint
207
402
 
208
403
  ### 2020-09-14_1.401.0
404
+
209
405
  - Add `POST /cra/bank_income/get`
210
406
 
211
407
  ### 2020-09-14_1.400.0
408
+
212
409
  - Add `cra/base_report/get` endpoint
213
410
 
214
411
  ### 2020-09-14_1.399.0
412
+
215
413
  - Add `base_report` field to `/link/token/create` and corresponding Base Report webhooks
216
414
 
217
415
  ### 2020-09-14_1.398.0
416
+
218
417
  - Make CreditBankIncomeWebhookUpdateResponse visible
219
418
 
220
419
  ### 2020-09-14_1.397.0
420
+
221
421
  - Remove extraneous `Item` field from `/processor/transactions/get` response
222
422
  - Reference new `/processor/token/webhook/update` endpoint in processor Transactions routes.
223
423
 
224
424
  ### 2020-09-14_1.396.2
425
+
225
426
  - Document cash management account support
226
427
 
227
428
  ### 2020-09-14_1.396.1
429
+
228
430
  - Fix document capitalization of `confidence_level` field in `/transactions/enrich`
229
431
 
230
432
  ### 2020-09-14_1.396.0
433
+
231
434
  - Add `/beacon/report/create`
232
435
 
233
436
  ### 2020-09-14_1.395.0
437
+
234
438
  - Add `POST /beacon/user/create`
235
439
  - Add `POST /beacon/user/get`
236
440
 
237
441
  ### 2020-09-14_1.394.0
442
+
238
443
  - Made `/statements/list` and `/statements/download` APIs for Plaid's Statements PDF beta product available in client SDKs
239
444
 
240
445
  ### 2020-09-14_1.393.0
446
+
241
447
  - Add `date_of_birth` and `address` fields to `documentary_verification.documents[].extracted_data` in the response of all of the identity verification endpoints:
242
448
  - `identity_verification/create`
243
449
  - `identity_verification/get`
@@ -245,11 +451,13 @@ are not currently used.
245
451
  - `identity_verification/retry`
246
452
 
247
453
  ### 2020-09-14_1.392.4
454
+
248
455
  - Update the following about identity/match name, phone number, email, and address score descriptions:
249
456
  - Ensure consistent language across all fields
250
457
  - Include score recommended "match" threshold for all fields.
251
458
 
252
459
  ### 2020-09-14_1.392.3
460
+
253
461
  - Update the `async_update` field description.
254
462
 
255
463
  ### 2020-09-14_1.392.2
@@ -262,245 +470,336 @@ are not currently used.
262
470
  - `risk_check.identity_abuse_signals.stolen_identity.score`
263
471
 
264
472
  ### 2020-09-14_1.392.1
473
+
265
474
  - Documentation updates for the `/link/token/create` endpoint
266
475
 
267
476
  ### 2020-09-14_1.392.0
477
+
268
478
  - Add `confidence_level` field to Counterparty and PersonalFinanceCategory for `/transactions/enrich`
269
479
 
270
480
  ### 2020-09-14_1.391.3
481
+
271
482
  - Remove the `core_attributes` field in `signal_insights` of /transfer/authorization/create
272
483
 
273
484
  ### 2020-09-14_1.391.2
485
+
274
486
  - Update the `pending_manual_verification` field's description in `/auth/get` response
275
487
 
488
+ # 21.0.0
489
+
276
490
  - Updating to openapi-generator v6.1 to enable autoload support
277
491
  - Updating to OAS 2020-09-14_1.391.1
278
492
 
493
+ ## Breaking changes in this version
494
+
495
+ This version does not contain breaking changes.
496
+
279
497
  ## OpenAPI Schema Changes
498
+
280
499
  ### 2020-09-14_1.391.1
500
+
281
501
  - Update the description of `/investments/transactions/get`
282
502
 
283
503
  ### 2020-09-14_1.391.0
504
+
284
505
  - Update the `async_update` option to be visible in `/investments/transactions/get`
285
506
 
286
507
  ### 2020-09-14_1.390.1
508
+
287
509
  - Update the `signal_insights` field's description in `/transfers/authorization/create` request
288
510
 
289
- ### 2020-09-14_1.390.0
511
+ ### 2020-09-14_1.390.0
512
+
290
513
  - Add `transfer_id` field to `/transfers/sweep/list` request
291
514
 
292
515
  ### 2020-09-14_1.389.0
516
+
293
517
  - Add `InvestmentsHistoricalUpdateWebhook`, a `HISTORICAL_UPDATE` webhook of type `INVESTMENTS_TRANSACTIONS`.
294
518
 
295
519
  ### 2020-09-14_1.388.1
520
+
296
521
  - Add `status` field to a sweep object. Add `status` field to `/transfers/sweep/list` request
297
522
 
298
523
  ### 2020-09-14_1.388.0
524
+
299
525
  - [Breaking] Remove `asset_report_token` as required field in `/asset_report/get` and mark as nullable
300
526
 
301
527
  ### 2020-09-14_1.387.1
528
+
302
529
  - Allow empty `mask` on the `meta` field of overridden accounts in the sandbox custom user configuration object schema.
303
530
 
304
531
  ### 2020-09-14_1.387.0
532
+
305
533
  - Mark `region` and `postal_code` fields as nullable in `/identity_verification/create`, `/identity_verification/retry`, and `/link/token/create`
306
534
 
307
535
  ### 2020-09-14_1.386.0
536
+
308
537
  - Add payloads for processor Transactions webhooks.
309
538
 
310
539
  ### 2020-09-14_1.385.2
540
+
311
541
  - Mark `next_origination_date` nullable
312
542
 
313
543
  # 20.0.0
544
+
314
545
  - Updating to OAS 2020-09-14_1.385.1
315
546
 
547
+ ## Breaking changes in this version
548
+
549
+ - (Identity Verification) Renamed `IdentityVerificationRequestUser` object to `IdentityVerificationCreateRequestUser`
550
+
316
551
  ## OpenAPI Schema Changes
552
+
317
553
  ### 2020-09-14_1.385.1
554
+
318
555
  - Add expiration time description to `transfer/authorization/create` `idempotency_key` parameter
319
556
 
320
557
  ### 2020-09-14_1.385.0
558
+
321
559
  - Add `user` field to `/identity_verification/retry`
322
560
  - Add `client_user_id` field to `/identity_verification/create`
323
561
  - Deprecate `user.client_user_id` field in `/identity_verification/create`
324
562
  - [Breaking] Renamed `IdentityVerificationRequestUser` object to `IdentityVerificationCreateRequestUser`
325
563
 
326
564
  ### 2020-09-14_1.384.0
565
+
327
566
  - Remove `maxLength` constraint from `client_user_id` field for `/processor/signal/evaluate` and `/signal/evaluate` requests
328
567
 
329
568
  ### 2020-09-14_1.383.3
569
+
330
570
  - Add `test_clock_id` to `transfer/authorization/create` request
331
571
 
332
572
  ### 2020-09-14_1.383.2
573
+
333
574
  - Update `InvestmentsAuthOwner` title
334
575
 
335
576
  ### 2020-09-14_1.383.1
577
+
336
578
  - Add `account_id` to `bank_accounts` and `transactions` in `/credit/bank_statements/uploads/get` response
337
579
 
338
580
  ### 2020-09-14_1.383.0
581
+
339
582
  - Add `transfer/diligence/document/upload` endpoint
340
583
 
341
584
  ### 2020-09-14_1.382.1
585
+
342
586
  - Add `amount` to `/transfer/sweep/list` request
587
+
343
588
  ### 2020-09-14_1.382.0
589
+
344
590
  - Add `signal_insights` to `/transfer/authorization/create` request
345
591
 
346
592
  ### 2020-09-14_1.381.0
593
+
347
594
  - Add definitions for `/sandbox/bank_income/fire_webhook`
348
595
 
349
596
  ### 2020-09-14_1.380.0
597
+
350
598
  - Update validation `sweep_id` for `/transfers/sweep/get` to allow UUID or 8 character hexadecimal string
351
599
 
352
600
  # 19.1.0
601
+
353
602
  - Updating to OAS 2020-09-14_1.379.0
354
603
 
355
604
  ## OpenAPI Schema Changes
605
+
356
606
  ### 2020-09-14_1.379.0
607
+
357
608
  - Add `scheme` to `/wallet/transaction/get` and `/wallet/transaction/list`
358
609
 
359
610
  ### 2020-09-14_1.378.1
360
- - Fix issue in which `request_id` was erroneously not listed as required in `ItemActivityListResponse`
611
+
612
+ - Fix issue in which `request_id` was erroneously not listed as required in `ItemActivityListResponse`
361
613
 
362
614
  ### 2020-09-14_1.378.0
615
+
363
616
  - Add `reroute_to_credentials` to `/link/token/create` auth request
364
617
 
365
618
  ### 2020-09-14_1.377.0
619
+
366
620
  - Add definitions for `/investments/auth/get`
367
621
 
368
622
  ### 2020-09-14_1.376.0
623
+
369
624
  - Add `required_if_supported_products` to `/link/token/create` request
370
625
 
371
626
  ### 2020-09-14_1.375.0
627
+
372
628
  - Add hidden `account_type` to `/transactions/enrich` request and response
373
629
  - Add hidden `account_subtype` to `/transactions/enrich` request and response
374
630
 
375
631
  ### 2020-09-14_1.374.3
632
+
376
633
  - Add `num_bank_statements_uploaded` to `document_income_results` object in `/credit/sessions/get` response
377
634
 
378
635
  ### 2020-09-14_1.374.2
636
+
379
637
  - Add `income_source` enum to `/transactions/enrich` `counterparty_type` field
380
638
 
381
639
  ### 2020-09-14_1.374.1
640
+
382
641
  - Update `oauth` descriptions for `/institutions/get` and `/institutions/search`
383
642
 
384
643
  ### 2020-09-14_1.374.0
644
+
385
645
  - Add `/credit/bank_statements/uploads/get` endpoint
386
646
 
387
647
  ### 2020-09-14_1.373.0
648
+
388
649
  - Add support for address and date of birth in `virtual-accounts/#wallettransactionexecute` endpoint
389
650
 
390
651
  ### 2020-09-14_1.372.3
652
+
391
653
  - Modify `/transactions/enrich` field `user_id` to `client_user_id`
392
654
  - Modify `/transactions/enrich` field `account_id` to `client_account_id`
393
655
 
394
656
  ### 2020-09-14_1.372.2
657
+
395
658
  - Update docs for `/transactions/enrich` response to include non-null example values for `lat` and `lon` fields
396
659
 
397
660
  ### 2020-09-14_1.372.1
661
+
398
662
  - Update descriptions for `PAYMENT_STATUS_EXECUTED` and `PAYMENT_STATUS_INITIATED`
399
663
  - Update description for `PaymentAmountCurrency`
400
664
 
401
665
  ### 2020-09-14_1.372.0
666
+
402
667
  - Add `user_id` and `account_id` fields to `/transactions/enrich` request and resposne
403
668
 
404
669
  ### 2020-09-14_1.371.4
670
+
405
671
  - Update descriptions for `/credit/payroll_income/risk_signals/get` and `INCOME_VERIFICATION_RISK_SIGNALS` webhook
406
672
 
407
673
  ### 2020-09-14_1.371.3
674
+
408
675
  - Add test_clock_id to `/transfer/simulate`
409
676
  - [Breaking change for Go] Make `virtual_time` optional in `/sandbox/transfer/test_clock/create`
410
677
 
411
678
  ### 2020-09-14_1.371.2
679
+
412
680
  - Add test_clock_id to `/sandbox/transfer/simulate` and `/sandbox/transfer/sweep/simulate` endpoints
413
681
 
414
682
  ### 2020-09-14_1.371.1
683
+
415
684
  - Update `transfer/diligence/submit` copy
416
685
 
417
686
  # 19.0.0
687
+
418
688
  - Updating to OAS 2020-09-14_1.370.0
419
689
 
690
+ ## Breaking changes in this version
691
+
692
+ - 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.
693
+
420
694
  ## OpenAPI Schema Changes
695
+
421
696
  ### 2020-09-14_1.370.0
697
+
422
698
  - Add `investments/refresh` endpoint
423
699
 
424
700
  ### 2020-09-14_1.369.3
701
+
425
702
  - Update `description` field in `/transfer/create` to have max length of 15
426
703
 
427
704
  ### 2020-09-14_1.369.2
705
+
428
706
  - Add new `CreditBankIncomeCategory` value
429
707
 
430
708
  ### 2020-09-14_1.369.1
709
+
431
710
  - Fix `/processor/transactions` routes doc links
432
711
 
433
712
  ### 2020-09-14_1.369.0
713
+
434
714
  - Add `/processor/token/permissions/get` endpoint
435
715
  - Add `/processor/token/permissions/set` endpoint
436
716
 
437
717
  ### 2020-09-14_1.368.2
718
+
438
719
  - Add `transfer/diligence/submit` endpoint
439
720
 
440
721
  ### 2020-09-14_1.368.1
722
+
441
723
  - Update `client_user_id` description for Identity Verification endpoints
442
724
  - Update `user` description for Identity Match via Identity Verification Data use case
443
725
 
444
726
  ### 2020-09-14_1.368.0
727
+
445
728
  - Add `/transfer/balance/get` endpoint
446
729
 
447
730
  ### 2020-09-14_1.367.0
731
+
448
732
  - Added `LinkEventsWebhook` schema
449
733
 
450
734
  ### 2020-09-14_1.366.0
735
+
451
736
  - Add `credit_funds_source` field for authorizations and transfers
452
737
  - Make `funding_account_id` nullable in various /transfer API responses
453
738
 
454
739
  ### 2020-09-14_1.356.0
740
+
455
741
  - Update `notificationsPayload.customFields` datatype from an object to an array of objects
456
742
 
457
743
  ### 2020-09-14_1.355.1
744
+
458
745
  - Added `warnings` to `/processor/signal/evaluate` response.
459
746
 
460
747
  ### 2020-09-14_1.355.0
748
+
461
749
  - Added `/processor/identity/match` endpoint.
462
750
 
463
751
  ### 2020-09-14_1.354.0
752
+
464
753
  - Adds a `selfie_check` object to the response schema of all the identity verification endpoints:
465
754
  - `identity_verification/create`
466
755
  - `identity_verification/get`
467
756
  - `identity_verification/list`
468
757
  - `identity_verification/retry`
469
-
758
+
470
759
  ### 2020-09-14_1.353.1
760
+
471
761
  - Update `INCOME_VERIFICATION_RISK_SIGNALS` with webhook tag
472
762
 
473
763
  ### 2020-09-14_1.353.0
764
+
474
765
  - Add `ASSETS: PRODUCT_READY` and `ASSETS: ERROR` webhooks to `/sandbox/item/fire_webhook` endpoint
475
766
 
476
767
  ### 2020-09-14_1.352.0
768
+
477
769
  - 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.
478
770
 
479
771
  ### 2020-09-14_1.351.1
772
+
480
773
  - Update `transfer/authorization/create` copy
481
774
 
482
775
  ### 2020-09-14_1.351.0
776
+
483
777
  - Add new `INCOME_VERIFICATION_RISK_SIGNALS` webhook
484
778
 
485
779
  ### 2020-09-14_1.350.0
780
+
486
781
  - Remove `settled_amount`
487
782
  - Rename `expected_settlement_schedule` as `expected_sweep_settlement_schedule`
488
783
 
489
784
  ### 2020-09-14_1.349.0
785
+
490
786
  - [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:
491
787
 
492
788
  For all products:
493
- - `PlaidError.status`
789
+
790
+ - `PlaidError.status`
494
791
 
495
792
  For Liabilities:
496
- - `PSLFStatus.payments_made`
497
- - `PSLFStatus.payments_remaining`
793
+
794
+ - `PSLFStatus.payments_made`
795
+ - `PSLFStatus.payments_remaining`
498
796
 
499
797
  For Identity Verification and Monitor:
500
- - `DocumentaryVerificationDocument.DocumentAnalysis.attempt`
501
- - `EntityScreeningHitAnalysis.search_terms_version`
502
- - `EntityWatchlistScreeningSearchTerms.search_terms_version`
503
- - `IdentityVerificationTemplateReference.version`
798
+
799
+ - `DocumentaryVerificationDocument.DocumentAnalysis.attempt`
800
+ - `EntityScreeningHitAnalysis.search_terms_version`
801
+ - `EntityWatchlistScreeningSearchTerms.search_terms_version`
802
+ - `IdentityVerificationTemplateReference.version`
504
803
 
505
804
  The following client library languages are impacted:
506
805
 
@@ -510,13 +809,16 @@ The following client library languages are impacted:
510
809
  - Ruby: Type changes from Float to Integer
511
810
 
512
811
  ### 2020-09-14_1.348.2
812
+
513
813
  - 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
514
814
  - Update `/identity/match` sample response to include `is_business_name_detected`
515
815
 
516
816
  ### 2020-09-14_1.348.1
817
+
517
818
  - Make the `warnings` field in `SignalEvaluateResponse` non-nullable
518
819
 
519
820
  ### 2020-09-14_1.348.0
821
+
520
822
  - Add `STARTED` and `INTERNAL_ERROR` to bank income and employment `/credit/sessions/get` status
521
823
 
522
824
  ### 2020-09-14_1.347.1
@@ -525,31 +827,41 @@ The following client library languages are impacted:
525
827
  - Update `SignalWarning` descriptions
526
828
 
527
829
  ### 2020-09-14_1.347.0
830
+
528
831
  Fix npm publish
529
832
 
530
833
  ### 2020-09-14_1.346.0
834
+
531
835
  - Releasing new `/credit/payroll_income/risk_signals/get` endpoint
532
836
 
533
837
  ### 2020-09-14_1.345.4
838
+
534
839
  - Revert `sweep_amount` description
535
840
 
536
841
  ### 2020-09-14_1.345.3
842
+
537
843
  - Update `sweep_amount` description
538
844
 
539
845
  ### 2020-09-14_1.345.2
846
+
540
847
  - Internal changes
541
848
 
542
849
  # 18.1.0
850
+
543
851
  - Updating to OAS 2020-09-14_1.345.1
544
852
 
545
853
  ## OpenAPI Schema Changes
854
+
546
855
  ### 2020-09-14_1.345.1
856
+
547
857
  - Update `/transactions/enrich` field `is_recurring` field to be optional.bool
548
858
 
549
859
  ### 2020-09-14_1.345.0
860
+
550
861
  - Fix bug in which `environment` field was incorrectly missing from Assets webhooks.
551
862
 
552
863
  ### 2020-09-14_1.344.0
864
+
553
865
  - Add recurrence and is_recurring fields to `/transactions/enrich`
554
866
 
555
867
  ### 2020-09-14_1.343.6
@@ -557,195 +869,260 @@ Fix npm publish
557
869
  - Update incorrect required fields for `/watchlist_screening/entity/update`
558
870
 
559
871
  ### 2020-09-14_1.343.5
872
+
560
873
  - Update `owners` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get`
561
874
 
562
875
  ### 2020-09-14_1.343.4
876
+
563
877
  - Make comment about `webhook` field in `/link/token/create` request more explicit
564
878
 
565
879
  ### 2020-09-14_1.343.3
880
+
566
881
  - Make VOA in /credit/freddie_mac/reports/get optional
567
882
 
568
883
  ### 2020-09-14_1.343.2
884
+
569
885
  - Update `warnings` description for `/credit/bank_income/get` and `/beta/credit/v1/bank_employment/get`
570
886
 
571
887
  ### 2020-09-14_1.343.1
888
+
572
889
  - Updated Asset endpoint descriptions related to Verification of Employment
573
890
 
574
891
  # 18.0.0
892
+
575
893
  - Updating to OAS 2020-09-14_1.343.0
576
894
 
895
+ ## Breaking changes in this version
896
+
897
+ - (Identity Verification) Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
898
+
577
899
  ## OpenAPI Schema Changes
900
+
578
901
  ### 2020-09-14_1.343.0
902
+
579
903
  - Add new `warnings` field to the response of `/signal/evaluate`
580
904
 
581
905
  ### 2020-09-14_1.342.0
906
+
582
907
  - Add `report_type` to assets webhook docs
583
908
  - Make `add_ons` public in assets docs for /asset_report/create
584
909
  - Make `fast_report` public in assets docs for /asset_report/get
585
910
 
586
911
  ### 2020-09-14_1.341.0
912
+
587
913
  - Add `risk_check` attribute to all Identity Verification responses
588
914
 
589
915
  ### 2020-09-14_1.340.1
916
+
590
917
  - Update examples for `entity_id` in `/transactions/enrich`
591
918
 
592
919
  ### 2020-09-14_1.340.0
920
+
593
921
  - Create `options` in `/link_delivery/create`
594
922
  - Create `recipient` within `options` field
595
923
  - Move `communication_methods` from top level to `recipient`
596
924
  - Add `first_name` in `recipient`
597
925
 
598
926
  ### 2020-09-14_1.339.0
927
+
599
928
  - Add `callback_type` to link delivery webhooks
600
929
 
601
930
  ### 2020-09-14_1.338.2
931
+
602
932
  - Make `communication_methods` optional in `/link_delivery/create`
603
933
 
604
934
  ### 2020-09-14_1.338.1
935
+
605
936
  - Remove beta description from `/transactions/enrich` endpoint docs
606
937
 
607
938
  ### 2020-09-14_1.338.0
939
+
608
940
  - Add `transaction_id` to `/payment-initiation/#payment_status_update`
609
941
  - Add `payment_id` and `wallet_id` to `/virtual-accounts/#wallet_transaction_status_update`
610
942
 
611
943
  ### 2020-09-14_1.337.4
944
+
612
945
  - Modify documentation for credit categories in the `/asset_report/get` based on GTM feedback
613
946
 
614
947
  ### 2020-09-14_1.337.3
948
+
615
949
  - Update description for the `address` field in `/payment_initiation/recipient/create`.
616
950
 
617
951
  ### 2020-09-14_1.337.2
952
+
618
953
  - Add annually recurring frequency to `/transactions/recurring/get`
619
954
 
620
955
  ### 2020-09-14_1.337.1
956
+
621
957
  - Make documentation for credit categories in the `/asset_report/get` endpoint public
622
958
 
623
959
  ### 2020-09-14_1.337.0
960
+
624
961
  - Add bank employment results to `/credit/sessions/get`
625
962
 
626
963
  ### 2020-09-14_1.336.1
964
+
627
965
  - Add `signal` to Products array.
628
966
 
629
967
  ### 2020-09-14_1.336.0
968
+
630
969
  - Add options to `/credit/payroll_income/refresh` to allow item-level refresh
631
970
 
632
971
  ### 2020-09-14_1.335.2
972
+
633
973
  - Updated `amount.value` description field with new minimum requirement for `/payment_initiation/payment/reverse` and `/wallet/transaction/execute`
634
974
 
635
975
  ### 2020-09-14_1.335.1
976
+
636
977
  - Add 'employment' as an available product in the request to `/partner/customer/create`
637
978
 
638
979
  ### 2020-09-14_1.335.0
980
+
639
981
  - [Breaking] Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
640
982
 
641
983
  # 17.4.0
984
+
642
985
  - Updating to OAS 2020-09-14_1.334.0
643
986
 
644
987
  ## OpenAPI Schema Changes
988
+
645
989
  ### 2020-09-14_1.334.0
990
+
646
991
  - Add "entity_id" field to /transactions/enrich
647
992
 
648
993
  ### 2020-09-14_1.333.0
994
+
649
995
  - Add "add_ons" field to asset_report/create
650
996
 
651
997
  ### 2020-09-14_1.332.0
998
+
652
999
  - [Breaking] Remove `/wallet/transaction/list` endpoint
653
1000
  - [Note] Determined that `/wallet/transaction/list` is unused
654
1001
 
655
1002
  ### 2020-09-14_1.331.0
1003
+
656
1004
  Add `LinkDeliveryCallbackWebhook`, `LinkUserDeliveryStatusWebhook` for Link Delivery.
657
1005
 
658
1006
  ### 2020-09-14_1.330.0
1007
+
659
1008
  - [Breaking] Remove `options.wallet_id` field in `/payment_initiation/payment/create` and `/payment_initiation/consent/create` request.
660
1009
  - [Note] Determined that this field is unused.
661
1010
 
662
1011
  ### 2020-09-14_1.229.2
1012
+
663
1013
  - Undeprecated the `legal_name` field in the `/link/token/create` request.
664
1014
 
665
1015
  ### 2020-09-14_1.229.1
1016
+
666
1017
  - Add `income_verification` as a supported product in the request for `/partner/customer/create`.
667
1018
 
668
1019
  ### 2020-09-14_1.229.0
1020
+
669
1021
  - Add `network` field to `/transfer/intent/create` request.
670
1022
  - Updated `reference` minLength for `/wallet/transaction/execute` request and `/payment_initiation/payment/reverse` request.
671
1023
 
672
1024
  ### 2020-09-14_1.228.0
1025
+
673
1026
  - Add `access_tokens` and `item_ids` to `/link_delivery/get` response
674
1027
 
675
1028
  ### 2020-09-14_1.227.0
1029
+
676
1030
  - Add optional `persistent_account_id` field to account responses
677
1031
 
678
1032
  ### 2020-09-14_1.226.0
1033
+
679
1034
  - Add `employment` fields to `/link/token/create`
680
1035
 
681
1036
  ### 2020-09-14_1.225.0
1037
+
682
1038
  - Add `redacted_at` field in Identity Verification response and Documentary Verification Document component
683
1039
  - Update `original_front` field in Identity Verification Document Images to be nullable in redacted Identity Verification sessions
684
1040
 
685
1041
  ### 2020-09-14_1.224.0
1042
+
686
1043
  - Add `earliest_deposit_date` and change `last_deposit_date` to `latest_deposit_date` for `/beta/credit/v1/bank_employment/get`
687
1044
 
688
1045
  ### 2020-09-14_1.223.0
1046
+
689
1047
  - Add `redirect_uris` to `/partner/customer/create` request.
690
1048
 
691
1049
  ### 2020-09-14_1.222.0
1050
+
692
1051
  - Add `wallet_id` field to `/wallet/transaction/get` and `/wallet/transaction/list` responses
693
1052
 
694
1053
  ### 2020-09-14_1.221.0
1054
+
695
1055
  - Update `link_delivery/get` to remove `public_tokens` from the response
696
1056
 
697
1057
  ### 2020-09-14_1.220.0
1058
+
698
1059
  - Update `link_delivery/create` to accept `communication_methods` and deprecate `delivery_method` and `delivery_destination`
699
1060
 
700
1061
  ### 2020-09-14_1.219.1
1062
+
701
1063
  - Fix the `refund_id` example.
702
1064
  - Update address objects to reflect that in rare instances, `city` may be `null`.
703
1065
 
704
1066
  ### 2020-09-14_1.219.0
1067
+
705
1068
  - Add partner webhook event type
706
1069
 
707
1070
  ### 2020-09-14_1.218.1
1071
+
708
1072
  - 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.
709
1073
 
710
1074
  ### 2020-09-14_1.218.1
1075
+
711
1076
  - Introduce `expected_settlement_date` field in the Transfer object
712
1077
 
713
1078
  ### 2020-09-14_1.218.0
1079
+
714
1080
  - Add `/beta/credit/v1/bank_employment/get` endpoint
715
1081
 
716
1082
  ### 2020-09-14_1.217.0
1083
+
717
1084
  - Add `updated` field to `/credit/audit_copy_token/update` response
718
1085
  - Add `SchemaVersion` to VOE and VOA schemas for `/credit/freddie_mac/reports/get`
719
1086
 
720
1087
  ### 2020-09-14_1.216.0
1088
+
721
1089
  - Introduce `funding_account_id` field in the Transfer API
722
1090
  - Remove deprecated `origination_account_id` field from the Transfer documentation
723
1091
 
724
1092
  ### 2020-09-14_1.215.2
1093
+
725
1094
  - Use more strict validation for `payment_id` and `recipient_id` fields in API
726
1095
 
727
1096
  ### 2020-09-14_1.215.1
1097
+
728
1098
  - Use more strict validation for payment `consent_id` field in API
729
1099
 
730
1100
  ### 2020-09-14_1.215.0
1101
+
731
1102
  - Add `status` to Wallet schema
732
1103
 
733
1104
  # 17.3.0
1105
+
734
1106
  - Updating to OAS 2020-09-14_1.214.0
735
1107
 
736
1108
  ## OpenAPI Schema Changes
1109
+
737
1110
  ### 2020-09-14_1.214.0
1111
+
738
1112
  - Add `/credit/freddie_mac/reports/get` endpoint
739
1113
 
740
1114
  ### 2020-09-14_1.213.1
1115
+
741
1116
  - Reflect that `days_requested` field in Bank Income Verification object in `/link/token/create` request is required when using Bank Income.
742
1117
  - Reflect that `is_update_mode` field in Bank Income Verification object in `/link/token/create` request defaults to `false`.
743
- - Update description to reflect that Document Income object in `/link/token/create` request is not required, even when using Document Income.
1118
+ - Update description to reflect that Document Income object in `/link/token/create` request is not required, even when using Document Income.
744
1119
 
745
1120
  ### 2020-09-14_1.213.0
1121
+
746
1122
  - Update `PartnerEndCustomerStatus` enum values.
747
1123
 
748
1124
  ### 2020-09-14_1.212.0
1125
+
749
1126
  - Add `/credit/audit_copy_token/update` endpoint
750
1127
  - Add `report_type` to AssetReportCreateRequest
751
1128
 
@@ -756,100 +1133,129 @@ Add `LinkDeliveryCallbackWebhook`, `LinkUserDeliveryStatusWebhook` for Link Deli
756
1133
  - Document `IZ_WBK` list code for screening individuals and entities with Monitor
757
1134
 
758
1135
  ### 2020-09-14_1.211.0
1136
+
759
1137
  - Add `/partner/customer/oauth_institutions/get` endpoint.
760
1138
 
761
1139
  ### 2020-09-14_1.210.8
1140
+
762
1141
  - Update example response for `/credit/bank_income/get`
763
1142
 
764
1143
  ### 2020-09-14_1.210.7
1144
+
765
1145
  - Documentation updates for Investments APIs and Bank Transfer APIs.
766
1146
 
767
1147
  ### 2020-09-14_1.210.6
1148
+
768
1149
  - Add validation on `originator_client_id` and `redirect_uri` for `/transfer/originator/create` and `transfer/originator/get` request
769
1150
 
770
1151
  ### 2020-09-14_1.210.5
1152
+
771
1153
  - Add `company_name` to TransferOriginatorGetResponse
772
1154
 
773
1155
  # 17.2.0
1156
+
774
1157
  - Updating to OAS 2020-09-14_1.210.4
775
1158
 
776
1159
  ## OpenAPI Schema Changes
1160
+
777
1161
  ### 2020-09-14_1.210.4
1162
+
778
1163
  - Add `recurring_transfer_id` to Transfer
779
1164
 
780
1165
  ### 2020-09-14_1.210.3
781
- - Make `id_numbers` field hidden in `/user/create` request
1166
+
1167
+ - Make `id_numbers` field hidden in `/user/create` request
782
1168
 
783
1169
  ### 2020-09-14_1.210.2
1170
+
784
1171
  - Make `transfer_ids` required in RecurringTransfer
785
1172
 
786
1173
  ### 2020-09-14_1.210.1
1174
+
787
1175
  - Change the `/transactions/enrich` `options.include_legacy_categories` field to `options.include_legacy_category`
788
1176
  - Make documentation for the `/transactions/enrich` `options.include_legacy_category` request field visible
789
1177
  - Make documentation for the `/transactions/enrich` `legacy_category` and `legacy_category_id` response fields visible
790
1178
  - Add `direction` to required fields for `ClientProvidedTransaction`
791
1179
 
792
1180
  ### 2020-09-14_1.210.0
1181
+
793
1182
  - Add `/transfer/capabilities/get` endpoint to fetch RTP eligibility for a linked plaid item
794
1183
 
795
1184
  ### 2020-09-14_1.209.2
1185
+
796
1186
  - Renamed the `NullableRecurringTransfer` type to `RecurringTransferNullable` type
797
1187
 
798
1188
  ### 2020-09-14_1.209.1
1189
+
799
1190
  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.
800
1191
 
801
1192
  ### 2020-09-14_1.209.0
1193
+
802
1194
  - add `NullableRecurringTransfer` field
803
1195
  - replace `RecurringTransfer` with `NullableRecurringTransfer` for `TransferRecurringCreateResponse`
804
1196
  - and `Decision` in required fields for `TransferRecurringCreateResponse`
805
1197
  - add required fields for `TransferRecurringSchedule`
806
1198
 
807
1199
  ### 2020-09-14_1.208.0
1200
+
808
1201
  - Add `total_amounts` field to `/credit/bank_income/get` response
809
1202
  - Deprecate `amount`, `iso_currency_code`, and `unofficial_currency_code` at top levels in `/credit/bank_income/get` response
810
1203
 
811
1204
  ### 2020-09-14_1.207.0
1205
+
812
1206
  - Add `id_numbers` field to `/user/create` request
813
1207
 
814
1208
  ### 2020-09-14_1.206.11
1209
+
815
1210
  - Add `RECURRING_NEW_TRANSFER` webhook event.
816
1211
  - Add `RECURRING_TRANSFER_SKIPPED` webhook event.
817
1212
  - Add `RECURRING_CANCELLED` webhook event.
818
1213
 
819
1214
  ### 2020-09-14_1.206.10
1215
+
820
1216
  - make `idempotency_key` field for `/transfer/recurring/create` non-nullable
821
1217
 
822
1218
  ### 2020-09-14_1.206.9
1219
+
823
1220
  - Add `description` field for `RecurringTransfer` object
824
1221
  - Make `TransferRecurringStatus` non-nullable
825
1222
 
826
1223
  ### 2020-09-14_1.206.8
1224
+
827
1225
  - Make all mentions of relay tokens lowercase
828
1226
 
829
1227
  ### 2020-09-14_1.206.7
1228
+
830
1229
  - Updated external URLs for Credit Relay endpoints, and marked them as beta in the summary
831
1230
 
832
1231
  ### 2020-09-14_1.206.6
1232
+
833
1233
  - Add more enums values to `pay_rate` field in `/credit/payroll_income/get` response
834
1234
  - Add `pay_basis` field to `/credit/payroll_income/get`
835
1235
 
836
1236
  ### 2020-09-14_1.206.5
1237
+
837
1238
  - Updated Credit Relay Token descriptions
838
1239
 
839
1240
  ### 2020-09-14_1.206.4
1241
+
840
1242
  - Add `FUNDS_SWEEP` as a `type` enum for the `WalletTransaction` object
841
1243
 
842
1244
  ### 2020-09-14_1.206.3
1245
+
843
1246
  - Make `test_clock_id` non-nullable in `test_clock`.
844
1247
 
845
1248
  ### 2020-09-14_1.206.2
1249
+
846
1250
  - Update `CounterpartyType` to rename `delivery_marketplace` to `marketplace`
847
1251
  - Update `CounterpartyType` to add `payment_terminal`
848
1252
 
849
1253
  ### 2020-09-14_1.206.1
1254
+
850
1255
  - Update the `transactions/enrich` transaction description example to match the request.
851
1256
 
852
1257
  ### 2020-09-14_1.206.0
1258
+
853
1259
  - Add `/sandbox/transfer/test_clock/list` for recurring transfer
854
1260
  - rm `decision` and `decision_rationale` from `RecurringTransfer`
855
1261
  - add `decision` and `decision_rationale` in `TransferRecurringCreateResponse`
@@ -857,53 +1263,67 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
857
1263
  - not requiring `client_id` and `secret` for recurring transfer APIs
858
1264
 
859
1265
  ### 2020-09-14_1.205.9
1266
+
860
1267
  - Use a nested `options` field for optional request params to `transactions/enrich`
861
1268
  - Make nullable fields required for `transactions/enrich`
862
1269
 
863
1270
  ### 2020-09-14_1.205.8
1271
+
864
1272
  - Update supported payment scheme options for `/payment_initiation/payment/create`
865
- Update description of `/payment_initiation/recipient/create` to mention non-Eurozone countries.
866
- Update `/payment_initiation/payment/create` mentioning new currencies and non-Eurozone markets.
867
- Removed `CHF` and `CZK` from the list of supported currencies.
1273
+ Update description of `/payment_initiation/recipient/create` to mention non-Eurozone countries.
1274
+ Update `/payment_initiation/payment/create` mentioning new currencies and non-Eurozone markets.
1275
+ Removed `CHF` and `CZK` from the list of supported currencies.
868
1276
 
869
1277
  ### 2020-09-14_1.205.7
1278
+
870
1279
  - Add website and logo_url to the `Counterparty` object for the Enrich product.
871
1280
  - Update descriptions for logo_url field in `Counterparty`, `TransactionCounterparty`, `Enrichments` and `Enhancements`.
872
1281
 
873
1282
  ### 2020-09-14_1.205.6
1283
+
874
1284
  - Update field descriptions and response examples for `transactions/enrich`
875
1285
 
876
1286
  ### 2020-09-14_1.205.5
1287
+
877
1288
  - Add support for optional request parameters in /transactions/enrich
878
1289
  - Add `location` field to `ClientProvidedTransaction` object
879
1290
  - Add `mcc` field to `ClientProvidedTransaction` object
880
1291
  - Add `date_posted` field to `ClientProvidedTransaction` object
881
1292
 
882
1293
  ### 2020-09-14_1.205.4
1294
+
883
1295
  - Document partial refunds
884
1296
  - Update description for `/payment_initiation/payment/reverse` endpoint
885
1297
  - Update description for `/payment_initiation/payment/get` endpoint
886
1298
 
887
1299
  # 17.1.0
1300
+
888
1301
  - Updating to OAS 2020-09-14_1.205.3
889
1302
 
890
1303
  ## OpenAPI Schema Changes
1304
+
891
1305
  ### 2020-09-14_1.205.3
1306
+
892
1307
  - Update description for `/signal/evaluate` endpoint
893
1308
 
894
1309
  ### 2020-09-14_1.205.2
1310
+
895
1311
  - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint
896
1312
 
897
1313
  ### 2020-09-14_1.205.1
1314
+
898
1315
  - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements
899
1316
 
900
1317
  ### 2020-09-14_1.205.0
1318
+
901
1319
  - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`.
902
1320
 
903
1321
  ### 2020-09-14_1.204.0
1322
+
904
1323
  - Remove `/income/verification/refresh` endpoint
905
1324
 
906
1325
  ### 2020-09-14_1.203.0
1326
+
907
1327
  - Add 7 brand new recurring transfer APIs
908
1328
  - Add `/transfer/recurring/create`
909
1329
  - Add `/transfer/recurring/list`
@@ -914,92 +1334,124 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
914
1334
  - Add `/sandbox/transfer/test_clock/get`
915
1335
 
916
1336
  ### 2020-09-14_1.202.6
1337
+
917
1338
  - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores`
918
1339
 
919
1340
  ### 2020-09-14_1.202.5
1341
+
920
1342
  - Add `/partner/customer/remove` endpoint
921
1343
 
922
1344
  ### 2020-09-14_1.202.4
1345
+
923
1346
  - Internal changes
924
1347
 
925
1348
  ### 2020-09-14_1.202.3
1349
+
926
1350
  - New Transfer API routes for hosted onboarding of TPS end-customers
927
1351
 
928
1352
  ### 2020-09-14_1.202.0
1353
+
929
1354
  - Add `refunds` field to `Transfer` object
930
1355
  - Add `refund_id` field to `TransferEvent` object
931
1356
  - Fix typo for `transfer/get` and `transfer/refund/get`
932
1357
 
933
1358
  ### 2020-09-14_1.201.0
1359
+
934
1360
  - Add support for partial refunds
935
1361
  - Add `amount` field to `/payment_initiation/payment/reverse` request
936
1362
  - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
937
1363
 
938
1364
  ### 2020-09-14_1.200.0
1365
+
939
1366
  - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get`
940
1367
 
941
1368
  ### 2020-09-14_1.199.0
1369
+
942
1370
  - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint
943
1371
 
944
1372
  ### 2020-09-14_1.198.8
1373
+
945
1374
  - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response.
946
1375
 
947
1376
  ### 2020-09-14_1.198.7
1377
+
948
1378
  - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook`
949
1379
 
950
1380
  ### 2020-09-14_1.198.6
1381
+
951
1382
  - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior.
952
1383
  - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook.
953
1384
 
954
1385
  ### 2020-09-14_1.198.5
1386
+
955
1387
  - Internal changes
956
1388
 
957
1389
  ### 2020-09-14_1.198.4
1390
+
958
1391
  - Add `deleted_at` to `/payment_profile/get` response.
959
1392
 
960
1393
  ### 2020-09-14_1.198.3
1394
+
961
1395
  - Change `start_date` to `start_time` for `/wallet/transaction/list` response.
962
1396
 
963
1397
  ### 2020-09-14_1.198.2
1398
+
964
1399
  - Update list of available products for `/partner/customer/create`.
965
1400
 
966
1401
  ### 2020-09-14_1.198.1
1402
+
967
1403
  - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response.
968
1404
 
969
1405
  ### 2020-09-14_1.198.0
1406
+
970
1407
  - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint.
971
1408
  - Add `last_status_update` and `payment_id` field to `WalletTransaction`.
972
1409
  - Add `transaction_id` field to `PaymentInitiationPayment`
973
1410
 
974
1411
  ### 2020-09-14_1.197.6
1412
+
975
1413
  - Add `originator_client_id` to Transfer API endpoints
976
1414
 
977
1415
  ### 2020-09-14_1.197.5
1416
+
978
1417
  - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint.
979
1418
 
980
1419
  ### 2020-09-14_1.197.4
1420
+
981
1421
  - Add `asset_under_management` field to `PartnerCustomerCreateRequest`.
982
1422
 
983
1423
  # 17.0.0
1424
+
984
1425
  - Updating to OAS 2020-09-14_1.205.3
985
1426
 
1427
+ ## Breaking changes in this version
1428
+
1429
+ - (Identity Verification) Renamed Identity Verification UserName objects to IdentityVerificationRequestUserName and IdentityVerificationResponseUserName
1430
+
986
1431
  ## OpenAPI Schema Changes
1432
+
987
1433
  ### 2020-09-14_1.205.3
1434
+
988
1435
  - Update description for `/signal/evaluate` endpoint
989
1436
 
990
1437
  ### 2020-09-14_1.205.2
1438
+
991
1439
  - Update response examples, descriptions, and formatting for `/transactions/enrich` endpoint
992
1440
 
993
1441
  ### 2020-09-14_1.205.1
1442
+
994
1443
  - Update descriptions for `CUSIP` and `ISIN` fields in the investments `Security` type to reflect CGS license requirements
995
1444
 
996
1445
  ### 2020-09-14_1.205.0
1446
+
997
1447
  - Add `/transactions/enrich` endpoint, the EA version of `/beta/transactions/v1/enhance`.
998
1448
 
999
1449
  ### 2020-09-14_1.204.0
1450
+
1000
1451
  - Remove `/income/verification/refresh` endpoint
1001
1452
 
1002
1453
  ### 2020-09-14_1.203.0
1454
+
1003
1455
  - Add 7 brand new recurring transfer APIs
1004
1456
  - Add `/transfer/recurring/create`
1005
1457
  - Add `/transfer/recurring/list`
@@ -1010,163 +1462,213 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1010
1462
  - Add `/sandbox/transfer/test_clock/get`
1011
1463
 
1012
1464
  ### 2020-09-14_1.202.6
1465
+
1013
1466
  - IdentityMatchResponse `PhoneNumberMatchScore` and `EmailAddressMatchScore` use `score` instead of `scores`
1014
1467
 
1015
1468
  ### 2020-09-14_1.202.5
1469
+
1016
1470
  - Add `/partner/customer/remove` endpoint
1017
1471
 
1018
1472
  ### 2020-09-14_1.202.4
1473
+
1019
1474
  - Internal changes
1020
1475
 
1021
1476
  ### 2020-09-14_1.202.3
1477
+
1022
1478
  - New Transfer API routes for hosted onboarding of TPS end-customers
1023
1479
 
1024
1480
  ### 2020-09-14_1.202.0
1481
+
1025
1482
  - Add `refunds` field to `Transfer` object
1026
1483
  - Add `refund_id` field to `TransferEvent` object
1027
1484
  - Fix typo for `transfer/get` and `transfer/refund/get`
1028
1485
 
1029
1486
  ### 2020-09-14_1.201.0
1487
+
1030
1488
  - Add support for partial refunds
1031
1489
  - Add `amount` field to `/payment_initiation/payment/reverse` request
1032
1490
  - Add `amount_refunded` field to `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
1033
1491
 
1034
1492
  ### 2020-09-14_1.200.0
1493
+
1035
1494
  - Add `risk_summary` and `page_number` to `/beta/credit/payroll_income/risk_signals/get`
1036
1495
 
1037
1496
  ### 2020-09-14_1.199.0
1497
+
1038
1498
  - Renamed `/wallet/transactions/list` into `/wallet/transaction/list` as endpoint
1039
1499
 
1040
1500
  ### 2020-09-14_1.198.8
1501
+
1041
1502
  - `/transfer/authorization/create` and `/transfer/create` may not return `account_id` in response.
1042
1503
 
1043
1504
  ### 2020-09-14_1.198.7
1505
+
1044
1506
  - Add `SYNC_UPDATES_AVAILABLE` support to `/sandbox/item/fire_webhook`
1045
1507
 
1046
1508
  ### 2020-09-14_1.198.6
1509
+
1047
1510
  - Make `ProductStatus` object nullable to reflect Sandbox-specific behavior.
1048
1511
  - Clarify documentation for `SYNC_UPDATES_AVAILABLE` webhook.
1049
1512
 
1050
1513
  ### 2020-09-14_1.198.5
1514
+
1051
1515
  - Internal changes
1052
1516
 
1053
1517
  ### 2020-09-14_1.198.4
1518
+
1054
1519
  - Add `deleted_at` to `/payment_profile/get` response.
1055
1520
 
1056
1521
  ### 2020-09-14_1.198.3
1522
+
1057
1523
  - Change `start_date` to `start_time` for `/wallet/transaction/list` response.
1058
1524
 
1059
1525
  ### 2020-09-14_1.198.2
1526
+
1060
1527
  - Update list of available products for `/partner/customer/create`.
1061
1528
 
1062
1529
  ### 2020-09-14_1.198.1
1530
+
1063
1531
  - Add `institution_name` and `institution_id` fields to `/credit/payroll_income/get` response.
1064
1532
 
1065
1533
  ### 2020-09-14_1.198.0
1534
+
1066
1535
  - Add `options.start_date` and `options.end_date` to `/wallet/transaction/list` endpoint.
1067
1536
  - Add `last_status_update` and `payment_id` field to `WalletTransaction`.
1068
1537
  - Add `transaction_id` field to `PaymentInitiationPayment`
1069
1538
 
1070
1539
  ### 2020-09-14_1.197.6
1540
+
1071
1541
  - Add `originator_client_id` to Transfer API endpoints
1072
1542
 
1073
1543
  ### 2020-09-14_1.197.5
1544
+
1074
1545
  - Deprecate `origination_account_id` from `/transfer/authorization/create` endpoint.
1075
1546
 
1076
1547
  ### 2020-09-14_1.197.4
1548
+
1077
1549
  - Add `asset_under_management` field to `PartnerCustomerCreateRequest`.
1078
1550
 
1079
1551
  # 17.0.0
1552
+
1080
1553
  - Updating to OAS 2020-09-14_1.197.3
1081
1554
 
1082
- ## Breaking changes
1555
+ ## Breaking changes in this version
1556
+
1083
1557
  - Move from Ruby 2.4.0 to Ruby 3, incorporating [#440](https://github.com/plaid/plaid-ruby/pull/440)
1084
1558
  - Consolidate usages of `Error` into `PlaidError`
1085
1559
  - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
1086
1560
  - Update `IdentityVerificationRequestUser.date_of_birth` to be required to match the existing behavior of the API.
1561
+ - (Transfer) Rename `TransferUserInRequest` to `TransferAuthorizationUserInRequest` for `/transfer/authorization/create`
1087
1562
 
1088
1563
  ## OpenAPI Schema Changes
1564
+
1089
1565
  ### 2020-09-14_1.197.3
1566
+
1090
1567
  - Update supported `CountryCode`'s in `link/token/create` docs.
1091
1568
 
1092
1569
  ### 2020-09-14_1.197.2
1570
+
1093
1571
  - ach_class optional
1094
1572
  - add rtp network option
1095
1573
 
1096
1574
  ### 2020-09-14_1.197.1
1575
+
1097
1576
  - Add newly supported languages for Link
1098
1577
 
1099
1578
  ### 2020-09-14_1.197.0
1579
+
1100
1580
  - Add `PAYMENT_PROFILE_LOGIN_REQUIRED` to transfer authorization `decision_rationale.code`.
1101
1581
 
1102
1582
  ### 2020-09-14_1.196.3
1583
+
1103
1584
  - Add `institution_name` field to `payroll_income_result` of `/credit/sessions/get`
1104
1585
 
1105
1586
  ### 2020-09-14_1.196.2
1587
+
1106
1588
  - Add requirements for `logo` in `PartnerCustomerCreateRequest`.
1107
1589
 
1108
1590
  ### 2020-09-14_1.196.2
1591
+
1109
1592
  - Deprecate webhook status `VERIFICATION_STATUS_PENDING_APPROVAL` in `income_verification` apis.
1110
1593
 
1111
1594
  ### 2020-09-14_1.196.1
1595
+
1112
1596
  - Add a note in the description of `/transfer/authorization/create`
1113
1597
 
1114
1598
  ### 2020-09-14_1.196.0
1115
- - Added endpoint `/sandbox/payment_profile/reset_login`
1599
+
1600
+ - Added endpoint `/sandbox/payment_profile/reset_login`
1116
1601
 
1117
1602
  ### 2020-09-14_1.195.0
1603
+
1118
1604
  - Consolidate usages of `Error` into `PlaidError`
1119
1605
  - Add a `PlaidErrorType` enum
1120
1606
 
1121
1607
  ### 2020-09-14_1.194.2
1608
+
1122
1609
  - Fix typo for `income_verification` in `/sandbox/public_token/create` options
1123
1610
 
1124
1611
  ### 2020-09-14_1.194.1
1612
+
1125
1613
  - Update field descriptions in `/partner/customer/*` responses.
1126
1614
  - Make `PartnerEndCustomerWithSecrets` extend `PartnerEndCustomer`.
1127
1615
  - Fix documentation links in `/partner/customer/*` endpoints.
1128
1616
 
1129
1617
  ### 2020-09-14_1.194.0
1618
+
1130
1619
  - Add `/partner/customer/enable` endpoint
1131
1620
 
1132
1621
  ### 2020-09-14_1.193.0
1622
+
1133
1623
  - Rename `LOGIN_REQUIRED` from transfer authorizations `decision_rationale` to `ITEM_LOGIN_REQUIRED`
1134
1624
 
1135
1625
  ### 2020-09-14_1.192.3
1626
+
1136
1627
  - Add `/fdx/notifications` endpoint.
1137
1628
 
1138
1629
  ### 2020-09-14_1.192.2
1630
+
1139
1631
  - Add `USER_REPORTED_NO_INCOME` to CreditSessionBankIncomeStatus
1140
1632
 
1141
1633
  ### 2020-09-14_1.192.1
1634
+
1142
1635
  - Update description for `payment_profile_token` field
1143
1636
 
1144
1637
  ### 2020-09-14_1.192.0
1638
+
1145
1639
  - Add `income_verfication` field to `/sandbox/public_token/create`
1146
1640
 
1147
1641
  ### 2020-09-14_1.191.1
1642
+
1148
1643
  - Add `document_income_result` field to `credit/sessions/get`
1149
1644
 
1150
1645
  ### 2020-09-14_1.191.0
1646
+
1151
1647
  - Remove `payment_profile_id` from `/payment_profile/*`, `/transfer/authorization/create`, and `/transfer/create` endpoints and replace with `payment_profile_token`
1152
1648
 
1153
1649
  ### 2020-09-14_1.190.0
1650
+
1154
1651
  - Removed auditor_id from /credit/audit_copy/token/create
1155
1652
 
1156
1653
  ### 2020-09-14_1.189.0
1654
+
1157
1655
  - Add length boundary for the `client_user_id` field in `user/create`
1158
1656
 
1159
1657
  ### 2020-09-14_1.188.0
1658
+
1160
1659
  - Add `SchemaVersion` field to Freddie Mac Verification of Assets Schema
1161
1660
 
1162
1661
  ### 2020-09-14_1.187.0
1662
+
1163
1663
  - Add `non-custodial wallet` to account subtypes supported for investments
1164
1664
  - Add `trade` investment transaction subtype as a subtype of `transfer` investment transaction type
1165
1665
 
1166
1666
  ### 2020-09-14_1.186.2
1667
+
1167
1668
  - Add `errors` field to `credit/sessions/get`
1168
1669
 
1169
1670
  ### 2020-09-14_1.186.1
1671
+
1170
1672
  - Add `payroll_income_result` field to `credit/sessions/get`
1171
1673
 
1172
1674
  ### 2020-09-14_1.186.0
@@ -1186,13 +1688,22 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1186
1688
  - Add `beacon_session_id` field in req of /transfer/authorization/create endpoint.
1187
1689
 
1188
1690
  ### 2020-09-14_1.182.0
1691
+
1189
1692
  - Add `/link/oauth/correlation_id/exchange` endpoint.
1190
1693
 
1191
1694
  # 16.0.0
1695
+
1192
1696
  - Updating to OAS 2020-09-14_1.181.1
1193
1697
 
1698
+ ## Breaking changes in this version
1699
+
1700
+ - (Identity Verification) Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable`
1701
+ instead.
1702
+
1194
1703
  ## OpenAPI Schema Changes
1704
+
1195
1705
  ### 2020-09-14_1.181.1
1706
+
1196
1707
  - Update `report_tokens` in `/credit/relay/create` endpoint request to be a list of strings instead a list of objects
1197
1708
 
1198
1709
  ### 2020-09-14_1.181.0
@@ -1202,7 +1713,7 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1202
1713
  ### 2020-09-14_1.180.0
1203
1714
 
1204
1715
  - Remove `Date` and `DateNullable` types in identity_verification and monitor endpoints. Replace with `ISO8601Date` and `ISO8601DateNullable`
1205
- instead.
1716
+ instead.
1206
1717
 
1207
1718
  ### 2020-09-14_1.179.0
1208
1719
 
@@ -1226,14 +1737,17 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1226
1737
  - Add `settled` as a valid event type for `/sandbox/transfer/simulate`
1227
1738
 
1228
1739
  ### 2020-09-14_1.177.3
1740
+
1229
1741
  - Replace `ASSET_TRANSACTION_DESCRIPTION` with `ASSET_TRANSACTION_DESCRIPTON` in Freddie Mac
1230
1742
  Asset Report
1231
1743
 
1232
1744
  ### 2020-09-14_1.177.2
1745
+
1233
1746
  - Add `ownership_type` to Asset Report account object, to reflect actual API behavior.
1234
1747
  - Update and clarify docs, including update to reflect new Transfers cutoff times.
1235
1748
 
1236
1749
  ### 2020-09-14_1.177.1
1750
+
1237
1751
  - Add `settled` as a possible Transfer status and `swept_settled` as a possible Transfer sweep status
1238
1752
  - Add `settled` and `swept_settled` as new Transfer event types
1239
1753
  - Add `settled` field to Transfer sweep object
@@ -1244,9 +1758,11 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1244
1758
  - Add `options` and `days_to_included` to `AssetReportGetRequest`
1245
1759
 
1246
1760
  ### 2020-09-14_1.176.2
1761
+
1247
1762
  - Add `recipient_id` field examples to the `/wallet/create`, `/wallet/get`, and `/wallet/list` responses
1248
1763
 
1249
1764
  ### 2020-09-14_1.176.1
1765
+
1250
1766
  - Set `employment_report_token` field in the `/credit/employment/get` endpoint to be not required
1251
1767
 
1252
1768
  ### 2020-09-14_1.176.0
@@ -1403,9 +1919,11 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1403
1919
  - Update `PaymentInitiationPaymentStatus` to include an additional `PAYMENT_STATUS_SETTLED` enum
1404
1920
 
1405
1921
  # 15.11.0
1922
+
1406
1923
  - Updating to OAS 2020-09-14_1.161.5
1407
1924
 
1408
1925
  ## OpenAPI Schema Changes
1926
+
1409
1927
  ### 2020-09-14_1.161.5
1410
1928
 
1411
1929
  - Reverts the changes made in 2020-09-14_1.157.0
@@ -1415,7 +1933,7 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1415
1933
  - Update description for webhook `USER_PERMISSION_REVOKED`
1416
1934
 
1417
1935
  ### 2020-09-14_1.161.3
1418
-
1936
+
1419
1937
  - Bug fix: Put quotes around the '529' account type to prevent generated client libraries from treating it as an integer.
1420
1938
  - Add `RECURRING_TRANSACTIONS_UPDATE` to description of sandbox webhook testing endpoint
1421
1939
 
@@ -1428,6 +1946,7 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1428
1946
  - Add required fields back to AssetReport schema
1429
1947
 
1430
1948
  ### 2020-09-14_1.161.0
1949
+
1431
1950
  - Remove `access_token` request parameter from `/beta/partner/v1/customers/create`
1432
1951
 
1433
1952
  ### 2020-09-14_1.160.0
@@ -1465,25 +1984,32 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1465
1984
  - Create `/credit/bank_income/pdf/get` to allow customers to retrieve the bank income product as a PDF
1466
1985
 
1467
1986
  ### 2020-09-14_1.153.1
1987
+
1468
1988
  -- Add `personal_finance_category_icon_url` to `/beta/transactions/v1/enhance` response
1469
1989
 
1470
1990
  ### 2020-09-14_1.153.0
1991
+
1471
1992
  -- Add new endpoint `/beta/partner/v1/customers/create`
1472
1993
 
1473
1994
  ### 2020-09-14_1.152.0
1995
+
1474
1996
  - Add `form1099s` as part of the `credit/payroll_income/get` response.
1475
1997
  - Add `Credit1099` object and corresponding subtypes.
1476
1998
 
1477
1999
  ### 2020-09-14_1.151.1
2000
+
1478
2001
  - Update required fields list for guaranteed ACH customers
1479
2002
 
1480
2003
  ### 2020-09-14_1.151.0
2004
+
1481
2005
  - Mark `verification` field under `paystubs` object in `/credit/payroll_income/get` as deprecated
1482
2006
 
1483
2007
  ### 2020-09-14_1.150.0
2008
+
1484
2009
  - Make `user_present` under `/transfer/authorization/create` nullable
1485
2010
 
1486
2011
  ### 2020-09-14_1.149.1
2012
+
1487
2013
  - Update fields description for guaranteed ACH customers
1488
2014
 
1489
2015
  ### 2020-09-14_1.149.0
@@ -1505,9 +2031,11 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1505
2031
  - Add new endpoints `/credit/relay/get`, `/credit/relay/refresh` and `/credit/relay/remove`
1506
2032
 
1507
2033
  # 15.10.0
2034
+
1508
2035
  - Updating to OAS 2020-09-14_1.146.0
1509
2036
 
1510
2037
  ## OpenAPI Schema Changes
2038
+
1511
2039
  ### 2020-09-14_1.146.0
1512
2040
 
1513
2041
  - make item_logins field not required
@@ -1586,64 +2114,85 @@ Add `nullable` property to `date_of_birth`, `phone_number_verified_time`, and `e
1586
2114
  - Add `/credit/audit_copy_token/remove` to invalidate Audit Copy tokens
1587
2115
 
1588
2116
  # 15.9.0
2117
+
1589
2118
  - Updating to OAS 2020-09-14_1.131.3
1590
2119
 
1591
2120
  ## OpenAPI Schema Changes
2121
+
1592
2122
  ### 2020-09-14_1.131.3
2123
+
1593
2124
  - Update external URL for `/transfer/migrate_account` endpoint
1594
2125
 
1595
2126
  ### 2020-09-14_1.131.2
2127
+
1596
2128
  - Add `TRANSFER_LIMIT_REACHED` to enum `TransferAuthorizationDecisionRationaleCode`
1597
2129
 
1598
2130
  ### 2020-09-14_1.131.1
2131
+
1599
2132
  - Update `/payment_initiation/consent/*` external docs URLs
1600
2133
 
1601
2134
  ### 2020-09-14_1.131.0
2135
+
1602
2136
  - Add `iban` to `counterparty`'s `numbers` field in `/wallet/transaction/execute`
1603
2137
 
1604
2138
  ### 2020-09-14_1.130.0
2139
+
1605
2140
  - 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.
1606
2141
 
1607
2142
  ### 2020-09-14_1.129.0
2143
+
1608
2144
  - Add `signal_description` for each risk signal in `/beta/credit/payroll_income/risk_signals/get`
1609
2145
  - Change `DocumentRiskSignalInstitutionMetadata` to be nullable
1610
2146
 
1611
2147
  ### 2020-09-14_1.128.6
2148
+
1612
2149
  - Fix category rules formatting
1613
2150
 
1614
2151
  ### 2020-09-14_1.128.5
2152
+
1615
2153
  - Change description in `UserCustomPassword` to reflect that only top level fields are optional not all fields
1616
2154
 
1617
2155
  ### 2020-09-14_1.128.4
2156
+
1618
2157
  - Move Category Rules description to `include_personal_finance_category` flag
1619
2158
 
1620
2159
  # 15.8.0
2160
+
1621
2161
  - Updating to OAS 2020-09-14_1.128.4
1622
2162
 
1623
2163
  ## OpenAPI Schema Changes
2164
+
1624
2165
  ### 2020-09-14_1.128.4
2166
+
1625
2167
  - Add `identity_verification` as a new optional parameter for `/link/token/create`
1626
2168
 
1627
2169
  ### 2020-09-14_1.128.3
2170
+
1628
2171
  - Add category rules beta to `personal_finance_category` field description
1629
- in `/transactions/get`
2172
+ in `/transactions/get`
1630
2173
 
1631
2174
  # 15.7.0
2175
+
1632
2176
  - Updating to OAS 2020-09-14_1.128.2
1633
2177
 
1634
2178
  ## OpenAPI Schema Changes
2179
+
1635
2180
  ### 2020-09-14_1.128.2
2181
+
1636
2182
  - Update description of `/investments/transactions/get` endpoint
1637
- - Update description of `cost_basis` field
2183
+ - Update description of `cost_basis` field
1638
2184
 
1639
2185
  ### 2020-09-14_1.128.1
2186
+
1640
2187
  - Add `merchant_website` and `merchant_logo_url` to `/beta/transactions/v1/enhance` response
1641
2188
 
1642
2189
  ### 2020-09-14_1.128.0
2190
+
1643
2191
  - Add `auth_type_select_enabled`, `automated_microdeposits_enabled`, `instant_match_enabled`, and `same_day_microdeposits_enabled` to `/link/token/create`
1644
2192
  - Marked `flow_type` parameter as deprecated
1645
2193
 
1646
2194
  ### 2020-09-14_1.127.0
2195
+
1647
2196
  - Add `consent_id` filter to `/payment_initiation/payment/list`
1648
2197
  - Add `consent_id` to `/link/token/create`
1649
2198
 
@@ -1656,9 +2205,11 @@ in `/transactions/get`
1656
2205
  - Add `accounts` object to `/credit/payroll_income/get` response
1657
2206
 
1658
2207
  ### 2020-09-14_1.124.0
2208
+
1659
2209
  - Added `include_fast_report` in `asset_report/create` endpoint. Added `fast_report` in `asset_report/get` endpoint
1660
2210
 
1661
2211
  ### 2020-09-14_1.123.1
2212
+
1662
2213
  - Removed `reversed` and `reverse_swept` from possible event_type values in TransferEventListRequest docs
1663
2214
 
1664
2215
  ### 2020-09-14_1.123.0
@@ -1670,166 +2221,221 @@ in `/transactions/get`
1670
2221
  - Add `request_id` to all Identity Verification and Monitor responses
1671
2222
 
1672
2223
  ### 2020-09-14_1.121.2
2224
+
1673
2225
  - Added sample user_id to INCOME_VERIFICATION webhook
1674
2226
 
1675
2227
  ### 2020-09-14_1.121.1
2228
+
1676
2229
  - Pre-release API refinements to Monitor and Flow endpoints
1677
2230
 
1678
2231
  # 15.6.0
2232
+
1679
2233
  - Updating to OAS 2020-09-14_1.121.0
1680
2234
 
1681
2235
  ## OpenAPI Schema Changes
2236
+
1682
2237
  ### 2020-09-14_1.121.0
2238
+
1683
2239
  - Add TimestampNullable type
1684
2240
 
1685
2241
  ### 2020-09-14_1.120.0
2242
+
1686
2243
  - Removed `Uploaded`, `Created` and `APPROVAL_STATUS_APPROVED` enum strings from `PayrollItemStatus` field.
1687
2244
 
1688
2245
  ### 2020-09-14_1.119.0
2246
+
1689
2247
  - Add `returned` to TransferStatus enum
1690
2248
  - Add `return_swept` to TransferSweepStatus enum
1691
2249
  - Add `returned` and `return_swept` to TransferEventType enum
1692
2250
 
1693
2251
  ### 2020-09-14_1.118.0
2252
+
1694
2253
  - Added `employee_type` and `last_paystub_date` to `/credit/employment/get` response
1695
2254
 
1696
2255
  ### 2020-09-14_1.117.1
2256
+
1697
2257
  - Make `/payment_initiation/consent/create` API more strict
1698
2258
 
1699
2259
  ### 2020-09-14_1.117.0
2260
+
1700
2261
  - Add `/credit/audit_copy_token/create` endpoint
1701
2262
 
1702
2263
  ### 2020-09-14_1.116.0
2264
+
1703
2265
  - Add `/wallet/list` endpoint
1704
2266
 
1705
2267
  # 15.5.0
2268
+
1706
2269
  - Updating to OAS 2020-09-14_1.115.2
1707
2270
 
1708
2271
  ## OpenAPI Schema Changes
2272
+
1709
2273
  ### 2020-09-14_1.115.2
2274
+
1710
2275
  - Update description fields to fix formatting errors
1711
2276
  - Reflect that `error.suggested_action` is `nullable`
1712
2277
 
1713
2278
  ### 2020-09-14_1.115.1
2279
+
1714
2280
  - Update OpenAPI spec
1715
2281
 
1716
2282
  ### 2020-09-14_1.115.0
2283
+
1717
2284
  - Added `income_report_token` to `/credit/payroll_income/get` response
1718
2285
 
1719
2286
  ### 2020-09-14_1.114.2
2287
+
1720
2288
  - Add `/wallet/create` endpoint
1721
2289
 
1722
2290
  ### 2020-09-14_1.114.1
2291
+
1723
2292
  - Add beta `additional_consented_products` field to `/link/token/create`
1724
2293
 
1725
2294
  ### 2020-09-14_1.113.1
2295
+
1726
2296
  - Updated `/transactions/recurring/get` description
1727
2297
 
1728
2298
  ### 2020-09-14_1.113.0
2299
+
1729
2300
  - Add webhooks for new Monitor and Identity Verification products
1730
2301
 
1731
2302
  ### 2020-09-14_1.112.0
2303
+
1732
2304
  - Add endpoints for new Monitor and Identity Verification products
1733
2305
 
1734
2306
  ### 2020-09-14_1.111.15
2307
+
1735
2308
  - Remove `emi_recipient_id` from Payment Initiation Recipient
1736
2309
 
1737
2310
  ### 2020-09-14_1.111.14
2311
+
1738
2312
  - Add optional `iban` and `bacs` fields to `options` in the `/payment_initiation/consent/create` request
1739
2313
 
1740
2314
  ### 2020-09-14_1.111.13
2315
+
1741
2316
  - Updated `/transactions/sync` description
1742
2317
 
1743
2318
  ### 2020-09-14_1.111.12
2319
+
1744
2320
  - Add more accurate enum documentations to `/transactions/recurring/get` API doc
1745
2321
 
1746
2322
  ### 2020-09-14_1.111.11
2323
+
1747
2324
  - Additional documentation for `/transactions/sync`
1748
2325
 
1749
2326
  ### 2020-09-14_1.111.9
2327
+
1750
2328
  - Remove deprecated field `createdAt` from `/application/get` response
1751
2329
 
1752
2330
  ### 2020-09-14_1.111.8
2331
+
1753
2332
  - Add field validation to `BankTransferDirection`
1754
2333
 
1755
2334
  ### 2020-09-14_1.111.7
2335
+
1756
2336
  - Remove deprecated field `createdAt` from `/application/get` response
1757
2337
 
1758
2338
  ### 2020-09-14_1.111.6
2339
+
1759
2340
  - Add external doc link to `transactions/recurring/get`
1760
2341
 
1761
2342
  ### 2020-09-14_1.111.5
2343
+
1762
2344
  - Updating the API doc for Recurring Transactions
1763
2345
 
1764
2346
  ### 2020-09-14_1.111.4
2347
+
1765
2348
  - Add `DisplayName` in `/application/get` response
1766
2349
 
1767
2350
  ### 2020-09-14_1.111.3
2351
+
1768
2352
  - Updated sample responses for all Transfer endpoints
1769
2353
 
1770
2354
  ### 2020-09-14_1.111.2
2355
+
1771
2356
  - Changing `beta/transactions/rules/` routes to `beta/transactions/rules/v1`
1772
2357
 
1773
2358
  ### 2020-09-14_1.111.1
2359
+
1774
2360
  - Fixing `InsitututionMetadata` typo to `InstitutionMetadata` in private `/beta/credit/payroll_income/risk_signals/get`endpoint response
1775
2361
 
1776
2362
  ### 2020-09-14_1.111.0
2363
+
1777
2364
  - Added `require_guarantee`, `guarantee_decision`, and `guarantee_decision_rationale` to `/transfer/intent` in order to support Guarantee when using Transfer UI.
1778
2365
 
1779
2366
  ### 2020-09-14_1.110.2
2367
+
1780
2368
  - Add additional supported `type` enums in `WalletTransaction`.
1781
2369
 
1782
2370
  ### 2020-09-14_1.110.1
2371
+
1783
2372
  - Add Additional History billing information for /asset_report/create.
1784
2373
 
1785
2374
  ### 2020-09-14_1.110.0
2375
+
1786
2376
  - Add `user_id` to income verification webhook payload
1787
2377
 
1788
2378
  ### 2020-09-14_1.109.1
2379
+
1789
2380
  - Make `consent_id` field nullable in `PaymentInitiationPayment`.
1790
2381
 
1791
2382
  ### 2020-09-14_1.109.0
2383
+
1792
2384
  - Replace `initiated_refunds` with `refund_ids` in the `/payment_initiation/payment/get` and `/payment_initiation/payment/list` responses
1793
2385
 
1794
2386
  ### 2020-09-14_1.108.0
2387
+
1795
2388
  - Added `/beta/credit/payroll_income/risk_signals/get` endpoint (currently private)
1796
2389
 
1797
2390
  ### 2020-09-14_1.107.4
2391
+
1798
2392
  - Remove unsupported ACH classes from `bank_transfer/` and `transfer/` endpoints.
1799
2393
 
1800
2394
  ### 2020-09-14_1.107.3
2395
+
1801
2396
  - Add `enable_multiple_items` parameter for bank income.
1802
2397
 
1803
2398
  ### 2020-09-14_1.107.2
2399
+
1804
2400
  - Fix typo in `institution_name` parameter for credit endpoints.
1805
2401
 
1806
2402
  ### 2020-09-14_1.107.0
2403
+
1807
2404
  - Added `reference` and `idempotency_key` fields to the `payment_initiation/payment/reverse` request.
1808
2405
 
1809
2406
  ### 2020-09-14_1.106.0
2407
+
1810
2408
  - Added `is_update_mode` to `income_verification` in the `/link/token/create` body
1811
2409
 
1812
2410
  ### 2020-09-14_1.105.2
2411
+
1813
2412
  - Consolidate item schemas
1814
2413
 
1815
2414
  # 15.4.0
2415
+
1816
2416
  - Updating to OAS 2020-09-14_1.105.1
1817
2417
  - Expose Faraday::Connection object for additional configuration options
1818
2418
 
1819
2419
  ## OpenAPI Schema Changes
2420
+
1820
2421
  ### 2020-09-14_1.105.1
2422
+
1821
2423
  - Removed `client_id` and `secret` as required fields from `/transfer/intent/{get,create}` to match actual API behavior.
1822
2424
 
1823
2425
  ### 2020-09-14_1.105.0
2426
+
1824
2427
  - Add `/credit/payroll_income/refresh` endpoint
1825
2428
 
1826
2429
  ### 2020-09-14_1.104.0
2430
+
1827
2431
  - Added `/signal/prepare`
1828
2432
 
1829
2433
  ### 2020-09-14_1.103.0
2434
+
1830
2435
  - Add `/transactions/recurring/deactivate` endpoint
1831
2436
 
1832
2437
  ### 2020-09-14_1.102.0
2438
+
1833
2439
  - Added `/watchlist_screening/individual/list` (currently private)
1834
2440
  - Added `/watchlist_screening/individual/create` (currently private)
1835
2441
  - Added `/watchlist_screening/individual/get` (currently private)
@@ -1858,260 +2464,344 @@ in `/transactions/get`
1858
2464
  - Modified `/identity_verification/create` (currently private)
1859
2465
 
1860
2466
  ### 2020-09-14_1.101.0
2467
+
1861
2468
  - Add endpoint for `/credit/bank_income/refresh`
1862
2469
 
1863
2470
  ### 2020-09-14_1.100.0
2471
+
1864
2472
  - Add `include_original_description`, `include_personal_finance_category` options to `/transactions/sync` request.
1865
2473
 
1866
2474
  ### 2020-09-14_1.99.0
2475
+
1867
2476
  - API changes for /credit/employment/get
1868
2477
 
1869
2478
  ### 2020-09-14_1.98.1
2479
+
1870
2480
  - Add `gusto` as processor partner
1871
2481
 
1872
2482
  ### 2020-09-14_1.98.0
2483
+
1873
2484
  - Add `user_token` as a request parameter for `/sandbox/public_token/create`
1874
2485
 
1875
2486
  ### 2020-09-14_1.97.1
2487
+
1876
2488
  - Remove `auth`, `transactions_updates`, `investments_updates`, and `identity` as required fields from Item status to match actual API behavior.
1877
2489
 
1878
2490
  # 15.3.0
2491
+
1879
2492
  - Updating to OAS 2020-09-14_1.97.0
1880
2493
 
1881
2494
  ## OpenAPI Schema Changes
2495
+
1882
2496
  ### 2020-09-14_1.97.0
2497
+
1883
2498
  - [Beta] Rename some `Credit` refs that were preventing client library generation from completing successfully
1884
2499
 
1885
2500
  ### 2020-09-14_1.96.0
2501
+
1886
2502
  - remove unused `payroll_income_id` from `/credit/payroll_income/get` field
1887
2503
  - add status object to items in `/credit/payroll_income/get` response body
1888
2504
 
1889
2505
  ### 2020-09-14_1.95.1
2506
+
1890
2507
  - Add `TransferEventsUpdateWebhook` schema
1891
2508
 
1892
2509
  ### 2020-09-14_1.95.0
2510
+
1893
2511
  - Add `institution_data` parameter to `/link/token/create`
1894
2512
 
1895
2513
  ### 2020-09-14_1.94.2
2514
+
1896
2515
  - Tidy up YAML
1897
2516
 
1898
2517
  ### 2020-09-14_1.94.1
2518
+
1899
2519
  - Add `highnote` processor to `/processor/token/create`
1900
2520
 
1901
2521
  # 15.2.0
2522
+
1902
2523
  - Updating to OAS 2020-09-14_1.94.0
1903
2524
 
1904
2525
  ## OpenAPI Schema Changes
2526
+
1905
2527
  ### 2020-09-14_1.94.0
2528
+
1906
2529
  - Add `use_case`, `company_legal_name`, `city`, `region`, `country_code`, `postal_code` as a required response field of `Application`
1907
2530
 
1908
2531
  ### 2020-09-14_1.93.2
2532
+
1909
2533
  - Remove `income_verification_id` from income webhook example
1910
2534
  - Fix incorrect URL for `/user/create` endpoint
1911
2535
 
1912
2536
  ### 2020-09-14_1.93.1
2537
+
1913
2538
  - Remove deprecated `income_verification_id` from income webhooks
1914
2539
  - Standardize income webhook casing
1915
2540
 
1916
2541
  ### 2020-09-14_1.93.0
2542
+
1917
2543
  - Add several new fields to `/signal/evaluate` response
1918
- -
2544
+ -
2545
+
1919
2546
  ### 2020-09-14_1.92.4
2547
+
1920
2548
  - Add `/sandbox/transfer/fire_webhook` endpoint
1921
2549
 
1922
2550
  ### 2020-09-14_1.91.4
2551
+
1923
2552
  - Mark certain Income endpoints as deprecated in favor of the new `/credit/*` endpoints.
1924
2553
 
1925
2554
  ### 2020-09-14_1.91.3
2555
+
1926
2556
  - Add `checkout` processor to `/processor/token/create`
1927
2557
 
1928
2558
  ### 2020-09-14_1.91.2
2559
+
1929
2560
  - Add `webhook_type` parameter to `/sandbox/item/fire_webhook`
1930
2561
  - Support for investments transactions, investments holdings and liabilities `DEFAULT_UPDATE` webhooks
1931
2562
 
1932
2563
  ### 2020-09-14_1.90.2
2564
+
1933
2565
  - Add new warning type to `/credit/bank_income/get` response
1934
2566
 
1935
2567
  ### 2020-09-14_1.90.1
2568
+
1936
2569
  - Add `marqeta` and `solid` as Auth processor partners
1937
2570
  - Fix schema of `cause` parameter for Asset Reports
1938
2571
  - Fix some invalid examples
1939
-
2572
+
1940
2573
  ### 2020-09-14_1.90.0
2574
+
1941
2575
  - Add `/credit/employment/get` endpoint
1942
2576
  - Add optional `access_tokens` array to `/credit/payroll_income/precheck` request
1943
2577
 
1944
2578
  ### 2020-09-14_1.89.3
2579
+
1945
2580
  - Update description of `/sandbox/item/fire_webhook`
1946
2581
 
1947
2582
  ### 2020-09-14_1.89.2
2583
+
1948
2584
  - Update description of `accounts/get`
1949
2585
 
1950
2586
  ### 2020-09-14_1.89.1
2587
+
1951
2588
  - Added `AUTH_DATA_UPDATE` webhook code as valid input to `/sandbox/item/fire_webhook`
1952
2589
  - Update description for `/sandbox/item/fire_webhook`
1953
2590
 
1954
2591
  ### 2020-09-14_1.89.0
2592
+
1955
2593
  - Add `/transfer/migrate_account` endpoint
1956
2594
 
1957
2595
  ### 2020-09-14_1.88.2
2596
+
1958
2597
  - Fix operationId for `/credit/payroll_income/precheck`
1959
2598
 
1960
2599
  ### 2020-09-14_1.88.1
2600
+
1961
2601
  - Remove deprecated fields from `/item/application/list`
1962
2602
 
1963
2603
  ### 2020-09-14_1.88.0
2604
+
1964
2605
  - Add `wire_routing_number` parameter to `/bank_transfer/migrate_account`
1965
2606
 
1966
2607
  ### 2020-09-14_1.87.1
2608
+
1967
2609
  - Specify minimum length of 1 for `description` on `TransferIntentCreateRequest`
1968
2610
 
1969
2611
  ### 2020-09-14_1.87.0
2612
+
1970
2613
  - Add `consent_id` support in the Institutions Search request
1971
2614
 
1972
2615
  ### 2020-09-14_1.86.1
2616
+
1973
2617
  - Add `apex_clearing` as a processor partner
1974
2618
 
1975
2619
  ### 2020-09-14_1.86.0
2620
+
1976
2621
  - Introduce Credit Payroll Income APIs
1977
2622
  - Introduce Credit Precheck API
1978
2623
 
1979
2624
  ### 2020-09-14_1.85.1
2625
+
1980
2626
  - Add `/identity_verification/create` endpoint, kept private for now
1981
2627
 
1982
2628
  ### 2020-09-14_1.85.0
2629
+
1983
2630
  - Add `status` field to `ConnectedApplication`
1984
2631
 
1985
2632
  # 15.1.0
2633
+
1986
2634
  - Updating to OAS 2020-09-14_1.84.5
1987
2635
 
1988
2636
  ## OpenAPI Schema Changes
2637
+
1989
2638
  ### 2020-09-14_1.84.5
2639
+
1990
2640
  - Added missing `asset_report_id` field to `/asset_report/relay/refresh`
1991
2641
 
1992
2642
  ### 2020-09-14_1.84.4
2643
+
1993
2644
  - Change summary description and url for `/credit/bank_income/get`
1994
2645
 
1995
2646
  ### 2020-09-14_1.84.3
2647
+
1996
2648
  - Slight wording change for `/credit/bank_income/get` response fields
1997
2649
 
1998
2650
  ### 2020-09-14_1.84.3
1999
- - Move `user_token` to top level of `link/token/create` request
2651
+
2652
+ - Move `user_token` to top level of `link/token/create` request
2000
2653
 
2001
2654
  ### 2020-09-14_1.84.2
2655
+
2002
2656
  - Correct typo in enum value for Investment subtypes (`person` -> `pension`)
2003
2657
 
2004
2658
  ### 2020-09-14_1.84.1
2659
+
2005
2660
  - Fix schema to properly handle personal finance categories in `/transactions/get`
2006
2661
 
2007
2662
  ### 2020-09-14_1.84.0
2663
+
2008
2664
  - Add `user_token` parameter to `link/token/create`
2009
2665
 
2010
2666
  ### 2020-09-14_1.83.1
2667
+
2011
2668
  - Add new fields to `/credit/bank_income/get` response
2012
2669
 
2013
2670
  ### 2020-09-14_1.83.0
2671
+
2014
2672
  - Remove `permitted` decision for `/transfer/authorization/create`
2015
2673
 
2016
2674
  ### 2020-09-14_1.82.0
2675
+
2017
2676
  - Add beta field `consented_products` to `/item/get/` endpoint response
2018
2677
 
2019
2678
  ### 2020-09-14_1.82.0
2679
+
2020
2680
  - Revamp LinkTokenCreate.IncomeVerificationOptions for GA
2021
2681
 
2022
2682
  ### 2020-09-14_1.81.0
2683
+
2023
2684
  - Add `/transaction/rules/create`, `/transaction/rules/list` and `/transaction/rules/remove` endpoints
2024
2685
 
2025
2686
  ### 2020-09-14_1.80.0
2687
+
2026
2688
  - Added `/user/create` endpoint
2027
2689
 
2028
2690
  # 15.0.0
2691
+
2029
2692
  - Updating to OAS 2020-09-14_1.79.0
2030
2693
 
2031
2694
  ## Breaking changes
2695
+
2032
2696
  - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
2033
- - Non integer numbers are now `float64` fields
2034
2697
 
2035
2698
  ## OpenAPI Schema Changes
2699
+
2036
2700
  ### 2020-09-14_1.79.0
2701
+
2037
2702
  - Update to include all changes up to `2020-09-14_1.77.4` (Undo revert from `1.78.x` updates)
2038
2703
 
2039
2704
  ### 2020-09-14_1.77.4
2705
+
2040
2706
  - Remove the word "Asset" before "Relay" in every asset report relay related responses and request objects
2041
2707
 
2042
2708
  ### 2020-09-14_1.77.3
2709
+
2043
2710
  - Add "AssetReport" at the beginning of relay related responses and request objects to match the same pattern as other assets related objects
2044
2711
 
2045
2712
  ### 2020-09-14_1.77.2
2713
+
2046
2714
  - Add `ProductAccess` fields for upcoming partner
2047
2715
 
2048
2716
  # 14.14.0
2717
+
2049
2718
  - Updating to OAS 2020-09-14_1.78.2
2050
2719
  - 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.
2051
2720
 
2052
2721
  # 14.13.0
2722
+
2053
2723
  - Updating to OAS 2020-09-14_1.77.1
2054
2724
 
2055
2725
  # Breaking changes
2726
+
2056
2727
  - Many enum fields have been de-anonymized and renamed, new names can be found in the `2020-09-14_1.64.15` change message
2057
2728
 
2058
2729
  ## OpenAPI Schema Changes
2730
+
2059
2731
  ### 2020-09-14_1.77.1
2732
+
2060
2733
  - Fix extraneous field in enum that caused issue in code generation
2061
2734
  - Added `asset_report_id` to the example for `/asset_report/relay/refresh`
2062
2735
 
2063
2736
  ### 2020-09-14_1.77.0
2737
+
2064
2738
  - Explicitly set `format: double` for non-integer numbers so generated fields prefer float64
2065
2739
 
2066
2740
  ### 2020-09-14_1.76.0
2741
+
2067
2742
  - Add three new endpoints for Assets: `/asset_report/relay/create`, `/asset_report/relay/get`, and `/asset_report/relay/rmeove`
2068
2743
 
2069
2744
  ### 2020-09-14_1.75.0
2745
+
2070
2746
  - Added `/asset_report/relay/refresh` endpoint
2071
2747
 
2072
2748
  ### 2020-09-14_1.74.0
2749
+
2073
2750
  - Add `recurring_transactions` to list of products
2074
2751
 
2075
2752
  ### 2020-09-14_1.73.0
2753
+
2076
2754
  - Add new endpoint for `/credit/bank_income/get`
2077
2755
 
2078
2756
  ### 2020-09-14_1.72.0
2757
+
2079
2758
  - Updated documentation URLs for all product endpoints. They can now be found
2080
- at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
2759
+ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/#endpoint`
2081
2760
 
2082
2761
  ### 2020-09-14_1.71.0
2762
+
2083
2763
  - internal changes
2084
2764
 
2085
2765
  ### 2020-09-14_1.70.0
2766
+
2086
2767
  - Remove deprecated `income_verification_id` from `/sandbox/income/fire_webhook`
2087
2768
 
2088
2769
  ### 2020-09-14_1.69.1
2770
+
2089
2771
  - Reorder processors enum
2090
2772
 
2091
2773
  ### 2020-09-14_1.69.0
2774
+
2092
2775
  - Added `/beta/transactions/v1/enhance` endpoint
2093
2776
 
2094
2777
  ### 2020-09-14_1.68.1
2778
+
2095
2779
  - Added `status` object to sample responses for `/institutions/get` and `institutions/search` endpoints
2096
2780
 
2097
2781
  ### 2020-09-14_1.68.0
2782
+
2098
2783
  - Mark `include_personal_finance_category_beta` property as deprecated.
2099
2784
  - Add new argument `include_personal_finance_category` to TransactionsGetRequestOptions.
2100
2785
  - Update docs for `/transactions/get` request and response, referencing personal_finance_category taxonomy csv file.
2101
2786
 
2102
2787
  ### 2020-09-14_1.67.1
2788
+
2103
2789
  - internal changes
2104
2790
 
2105
2791
  ### 2020-09-14_1.67.0
2792
+
2106
2793
  - Removed unused `/income/verification/summary/get` endpoint
2107
2794
 
2108
2795
  ### 2020-09-14_1.66.0
2796
+
2109
2797
  - Added Payment Consent endpoints
2110
2798
 
2111
2799
  ### 2020-09-14_1.65.0
2800
+
2112
2801
  - Removed unused `/income/verification/paystub/get` endpoint
2113
2802
 
2114
2803
  ### 2020-09-14_1.64.15
2804
+
2115
2805
  - De-anonymized enums:
2116
2806
  - `PaymentInitiationPaymentReverseResponse.properties.status` => `PaymentInitiationRefundStatus`
2117
2807
  - `PaymentInitiationPaymentCreateResponse.properties.status` => `PaymentInitiationPaymentCreateStatus`
@@ -2131,32 +2821,41 @@ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/
2131
2821
  - `IncomeVerificationPrecheckMilitaryInfo.properties.branch` is now a string field (previously enum)
2132
2822
 
2133
2823
  ### 2020-09-14_1.64.15
2824
+
2134
2825
  - Made `last_statement_balance` and `minimum_payment_amount` `nullable` for credit card liabilities schema to reflect existing API behavior.
2135
2826
 
2136
2827
  ### 2020-09-14_1.64.14
2828
+
2137
2829
  - Made `last_payment_amount` and `last_statement_issue_date` `nullable` for credit card liabilities schema to reflect existing API behavior.
2138
2830
  - Fix transfers examples to reflect more consistent usage of `region` field.
2139
2831
 
2140
2832
  # 14.12.1
2833
+
2141
2834
  - Updating to OAS 2020-09-14_1.64.13
2142
2835
  - Fix issue where library did not correctly detect if app is a Rails app.
2143
2836
 
2144
2837
  ## OpenAPI Schema Changes
2838
+
2145
2839
  ### 2020-09-14_1.64.13
2840
+
2146
2841
  - Deprecate `idempotency_key` parameter in transfer/create
2147
2842
 
2148
2843
  ### 2020-09-14_1.64.12
2844
+
2149
2845
  - Removed the unused `required_product_access` and `optional_product_access` parameters from `RequestedScopes`
2150
2846
 
2151
2847
  ### 2020-09-14_1.64.11
2848
+
2152
2849
  - Fix some examples that were not consistent with their schemas
2153
2850
  - Add `adjustments` as an investments transaction type to make OpenAPI file consistent with values returned by the API
2154
2851
  - Clarify description field for `marital_status` to reflect possible values
2155
2852
 
2156
2853
  ### 2020-09-14_1.64.10
2854
+
2157
2855
  - Updated the external docs URL for Bank Transfers sandbox endpoints
2158
2856
 
2159
2857
  ### 2020-09-14_1.64.9
2858
+
2160
2859
  - De-anonymized the object filters under `LinkTokenCreateRequestAccountSubtypes`, as anonymous objects aren't compatible with the generated CLibs.
2161
2860
  - De-anonymized some misc. objects
2162
2861
  - `PaymentInitiationMetadata/properties/maximum_payment_amount`
@@ -2166,116 +2865,152 @@ at `/docs/api/products/<product-name>/#endpoint` instead of `/docs/api/products/
2166
2865
  - `LiabilitiesDefaultUpdateWebhook/properties/account_ids_with_updated_liabilities`
2167
2866
 
2168
2867
  ### 2020-09-14_1.64.8
2868
+
2169
2869
  - Updated the description of the historical_balances array
2170
2870
 
2171
2871
  ### 2020-09-14_1.64.7
2872
+
2172
2873
  - Add new possible enums for income verification earnings breakdown canonical description
2173
2874
 
2174
2875
  ### 2020-09-14_1.64.6
2876
+
2175
2877
  - Hid a few product enum values that are deprecated or no longer valid for certain request fields. This affects the documentation only.
2176
2878
 
2177
2879
  ### 2020-09-14_1.64.5
2880
+
2178
2881
  - Make guarantee fields required in Transfer endpoints
2179
2882
 
2180
2883
  ### 2020-09-14_1.64.4
2884
+
2181
2885
  - Updated description for `failure_reason` field in Transfer endpoints
2182
2886
 
2183
2887
  ### 2020-09-14_1.64.3
2888
+
2184
2889
  - Make `repayment_id` required in `/transfer/repayment/return/list` endpoint
2185
2890
 
2186
2891
  ### 2020-09-14_1.64.2
2187
- - Update description for legal name field in `BankTransferUser`
2892
+
2893
+ - Update description for legal name field in `BankTransferUser`
2188
2894
 
2189
2895
  ### 2020-09-14_1.64.1
2896
+
2190
2897
  - Update descriptions for `/transfer/repayment/list` and `/transfer/repayment/return/list` endpoints
2191
2898
 
2192
2899
  ### 2020-09-14_1.64.0
2900
+
2193
2901
  - Remove `scheme_automatic_downgrade` from `/payment_initiation/payment/create`
2194
2902
 
2195
2903
  ### 2020-09-14_1.63.1
2904
+
2196
2905
  - Update description for `/sandbox/transfer/sweep/simulate` endpoint
2197
2906
 
2198
2907
  ### 2020-09-14_1.63.0
2908
+
2199
2909
  - 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`)
2200
2910
 
2201
2911
  ### 2020-09-14_1.62.7
2912
+
2202
2913
  - Update description for `datetime` and `authorized_datetime` fields in Transactions endpoints
2203
2914
 
2204
2915
  ### 2020-09-14_1.62.6
2916
+
2205
2917
  - Make `sweep_id` / `sweep_amount` fields on Transfer Event nullable
2206
2918
 
2207
2919
  ### 2020-09-14_1.62.6
2920
+
2208
2921
  - Set `institution_status` to be nullable in `InstitutionsGetResponse`
2209
2922
 
2210
2923
  ### 2020-09-14_1.62.5
2924
+
2211
2925
  - Update external docs URLs for Transfer and Bank Transfer endpoints
2212
2926
  - Update description for `ach_return_code` field in Transfer endpoints
2213
2927
 
2214
2928
  ### 2020-09-14_1.62.4
2929
+
2215
2930
  - Add `join_date` to `/application/get` and `/item/application/list`
2216
2931
  - Remove `created_at` from `/application/get`
2217
2932
 
2218
2933
  ### 2020-09-14_1.62.3
2934
+
2219
2935
  - Updated various description fields for Income
2220
2936
 
2221
2937
  ### 2020-09-14_1.62.2
2938
+
2222
2939
  - Add `employment` as an available product in Product array.
2223
2940
 
2224
2941
  # 14.12.0
2942
+
2225
2943
  - Updating to OAS 2020-09-14_1.62.1
2226
2944
 
2227
2945
  # 14.11.1
2946
+
2228
2947
  - Added a release step to the `Makefile` to purge previously released version of plaid-ruby in the current release.
2229
2948
 
2230
2949
  # 14.11.0
2950
+
2231
2951
  - Updating to OAS 2020-09-14_1.61.0
2232
2952
 
2233
2953
  # 14.10.0
2954
+
2234
2955
  - Updating to OAS 2020-09-14_1.58.1
2235
2956
 
2236
2957
  # 14.9.0
2958
+
2237
2959
  - Updating to OAS 2020-09-14_1.54.2
2238
2960
 
2239
2961
  # 14.8.0
2962
+
2240
2963
  - Updating to OAS 2020-09-14_1.46.1
2241
2964
 
2242
2965
  # 14.7.0
2966
+
2243
2967
  - Updating to OAS 2020-09-14_1.44.0
2244
2968
 
2245
2969
  # 14.6.0
2970
+
2246
2971
  - Updating to OAS 2020-09-14_1.40.3
2247
2972
 
2248
2973
  # 14.5.0
2974
+
2249
2975
  - Updating to OAS 2020-09-14_1.36.4
2250
2976
 
2251
2977
  # 14.4.0
2978
+
2252
2979
  - Updating to OAS 2020-09-14_1.34.1
2253
2980
  - Fixed an issue with enums in this library. The library is supposed to be able to gracefully handle
2254
- new enum values being returned from endpoints. Previously, if there were new enum values
2255
- endpoint calls would fail.
2981
+ new enum values being returned from endpoints. Previously, if there were new enum values
2982
+ endpoint calls would fail.
2256
2983
 
2257
2984
  # 14.3.0
2985
+
2258
2986
  Updating to OAS 2020-09-14_1.33.0.
2259
2987
 
2260
2988
  # 14.2.0
2989
+
2261
2990
  Updating to OAS 2020-09-14_1.31.1.
2262
2991
 
2263
2992
  # 14.1.0
2993
+
2264
2994
  Updating to OAS 2020-09-14_1.26.1.
2265
2995
 
2266
2996
  # 14.0.0
2267
- 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.
2997
+
2998
+ 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.
2268
2999
 
2269
3000
  This particular version is pinned to OpenAPI version `2020-09-14_1.20.6`.
2270
3001
 
2271
3002
  # 14.0.0.beta.5
3003
+
2272
3004
  Generated from OAS version 2020-09-14_1.16.4. See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2273
3005
 
2274
3006
  # 14.0.0.beta.4
3007
+
2275
3008
  See full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
3009
+
2276
3010
  - Remove validation for `maxProperties` due to generator bug.
2277
3011
 
2278
3012
  # 14.0.0.beta.3
3013
+
2279
3014
  Type fixes, see full changelog [here](https://github.com/plaid/plaid-openapi/blob/master/CHANGELOG.md).
2280
3015
 
2281
3016
  # 14.0.0.beta.1
@@ -2284,83 +3019,22 @@ This version represents a transition in how we maintain our external client libr
2284
3019
 
2285
3020
  The minimum required ruby version is 2.4.0.
2286
3021
 
2287
- **Ruby Migration Guide:**
2288
-
2289
- ### Client initialization
2290
- From:
2291
- ```ruby
2292
- client = Plaid::Client.new(env: :sandbox,
2293
- client_id: client_id,
2294
- secret: secret)
2295
- ```
2296
-
2297
- To:
2298
- ```ruby
2299
- configuration = Plaid::Configuration.new
2300
- configuration.server_index = Plaid::Configuration::Environment["sandbox"]
2301
- configuration.api_key["PLAID-CLIENT-ID"] = ENV["PLAID_RUBY_CLIENT_ID"]
2302
- configuration.api_key["PLAID-SECRET"] = ENV["PLAID_RUBY_SECRET"]
2303
- configuration.api_key["Plaid-Version"] = "2020-09-14"
2304
-
2305
- api_client = Plaid::ApiClient.new(
2306
- configuration
2307
- )
2308
-
2309
- client = Plaid::PlaidApi.new(api_client)
2310
- ```
2311
-
2312
- ### Endpoints
2313
- All endpoint requests now take a request model and the functions have been renamed to include `_`.
2314
-
2315
- From:
2316
- ```ruby
2317
- response = client.auth.get(access_token)
2318
- ```
2319
-
2320
- To:
2321
- ```ruby
2322
- auth_get_request = Plaid::AuthGetRequest.new
2323
- auth_get_request.access_token = access_token
2324
-
2325
- or
2326
-
2327
- auth_get_request = Plaid::AuthGetRequest.new({:access_token => access_token})
2328
-
2329
- response = client.auth_get(auth_get_request)
2330
- ```
2331
-
2332
- ### Errors
2333
-
2334
- From:
2335
- ```ruby
2336
- begin
2337
- client.auth.get(auth_get_request)
2338
- rescue Plaid::PlaidAPIError => e
2339
- raise e if e.error_code != 'PRODUCT_NOT_READY'
2340
- sleep 1
2341
- end
2342
- ```
2343
-
2344
- To:
2345
- ```ruby
2346
- begin
2347
- client.auth_get(auth_get_request)
2348
- rescue Plaid::ApiError => e
2349
- json_response = JSON.parse(e.response_body)
2350
- if json_response["error_code"] != "PRODUCT_NOT_READY"
2351
- end
2352
- ```
3022
+ See the [migration guide](https://github.com/plaid/plaid-java#migration-guide) for instructions on migrating to this version.
2353
3023
 
2354
3024
  # 13.2.0
3025
+
2355
3026
  - Add support for `options` to `/payment_initiation/payment/create`
2356
3027
 
2357
3028
  # 13.1.0
3029
+
2358
3030
  - Add Standing Orders support to Payment Initiation
2359
3031
 
2360
3032
  # 13.0.1
3033
+
2361
3034
  - Add `update_type` to `Item` model.
2362
3035
 
2363
3036
  # 13.0.0
3037
+
2364
3038
  - Add support for providing a payment initiation schedule
2365
3039
  - Add back the (now deprecated) `/item/public_token/create` endpoint
2366
3040
  - Add back the (now deprecated) `/payment_initiation/payment/token/create` endpoint
@@ -2373,13 +3047,13 @@ BREAKING CHANGES:
2373
3047
 
2374
3048
  - 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.
2375
3049
  - the `/item/public_token/create` endpoint has been disabled in favor of the /link/token/create
2376
- endpoint
3050
+ endpoint
2377
3051
  - The `/item/add_token/create endpoint` has been disabled in favor of the /link/token/create
2378
3052
  - The `/payment_initiation/payment/token/create` endpoint has been disabled in favor of the /link/token/create
2379
- endpoint
3053
+ endpoint
2380
3054
  - The `/item/remove` endpoint will no longer return a `removed` boolean.
2381
3055
  - The `/institutions/get`, `/institutions/get_by_id`, and `/institutions/search` now require
2382
- `country_codes` to be passed in.
3056
+ `country_codes` to be passed in.
2383
3057
 
2384
3058
  # 11.1.0
2385
3059