plaid 22.0.0 → 24.0.0

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