plaid 21.0.0 → 21.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1319) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +129 -1
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +630 -18
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +6 -6
  11. data/lib/plaid/models/account_assets_all_of.rb +5 -5
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +2 -2
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +2 -2
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_identity_match_score.rb +2 -2
  19. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  20. data/lib/plaid/models/account_product_access.rb +1 -1
  21. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  22. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  23. data/lib/plaid/models/account_subtype.rb +1 -1
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/action_state.rb +1 -1
  32. data/lib/plaid/models/activity.rb +1 -1
  33. data/lib/plaid/models/activity_type.rb +1 -1
  34. data/lib/plaid/models/address.rb +1 -1
  35. data/lib/plaid/models/address_data.rb +1 -1
  36. data/lib/plaid/models/address_data_not_required.rb +265 -0
  37. data/lib/plaid/models/address_data_nullable.rb +1 -1
  38. data/lib/plaid/models/address_data_nullable_no_required_fields.rb +272 -0
  39. data/lib/plaid/models/address_match_score.rb +2 -2
  40. data/lib/plaid/models/address_nullable.rb +1 -1
  41. data/lib/plaid/models/address_purpose_label.rb +1 -1
  42. data/lib/plaid/models/application.rb +1 -1
  43. data/lib/plaid/models/application_get_request.rb +1 -1
  44. data/lib/plaid/models/application_get_response.rb +1 -1
  45. data/lib/plaid/models/apr.rb +1 -1
  46. data/lib/plaid/models/asset.rb +1 -1
  47. data/lib/plaid/models/asset_detail.rb +1 -1
  48. data/lib/plaid/models/asset_holder.rb +1 -1
  49. data/lib/plaid/models/asset_holder_name.rb +1 -1
  50. data/lib/plaid/models/asset_owner.rb +1 -1
  51. data/lib/plaid/models/asset_owners.rb +1 -1
  52. data/lib/plaid/models/asset_report.rb +1 -1
  53. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  61. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  62. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  63. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  65. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  67. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  69. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  70. data/lib/plaid/models/asset_report_item.rb +1 -1
  71. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  72. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  73. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  74. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  75. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  76. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  77. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  78. data/lib/plaid/models/asset_report_transaction.rb +7 -7
  79. data/lib/plaid/models/asset_report_transaction_type.rb +1 -1
  80. data/lib/plaid/models/asset_report_user.rb +1 -1
  81. data/lib/plaid/models/asset_transaction.rb +1 -1
  82. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  83. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  84. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  85. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  86. data/lib/plaid/models/asset_transactions.rb +1 -1
  87. data/lib/plaid/models/asset_type.rb +1 -1
  88. data/lib/plaid/models/assets.rb +1 -1
  89. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  90. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  91. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  92. data/lib/plaid/models/auth_get_request.rb +1 -1
  93. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  94. data/lib/plaid/models/auth_get_response.rb +1 -1
  95. data/lib/plaid/models/auth_metadata.rb +1 -1
  96. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  97. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  98. data/lib/plaid/models/bank_income_complete_result.rb +39 -0
  99. data/lib/plaid/models/bank_income_complete_webhook.rb +284 -0
  100. data/lib/plaid/models/bank_income_refresh_complete_result.rb +1 -1
  101. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +1 -1
  102. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +1 -1
  103. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  104. data/lib/plaid/models/bank_transfer.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  136. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  137. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  138. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  139. data/lib/plaid/models/base_report.rb +273 -0
  140. data/lib/plaid/models/base_report_account.rb +371 -0
  141. data/lib/plaid/models/base_report_account_insights.rb +325 -0
  142. data/lib/plaid/models/base_report_average_flow_insights.rb +240 -0
  143. data/lib/plaid/models/base_report_get_request.rb +246 -0
  144. data/lib/plaid/models/base_report_get_response.rb +240 -0
  145. data/lib/plaid/models/base_report_item.rb +273 -0
  146. data/lib/plaid/models/base_report_longest_gap_insights.rb +241 -0
  147. data/lib/plaid/models/base_report_number_flow_insights.rb +241 -0
  148. data/lib/plaid/models/base_report_transaction.rb +404 -0
  149. data/lib/plaid/models/base_report_transaction_type.rb +41 -0
  150. data/lib/plaid/models/base_reports_error_webhook.rb +275 -0
  151. data/lib/plaid/models/base_reports_product_ready_webhook.rb +265 -0
  152. data/lib/plaid/models/beacon_audit_trail.rb +236 -0
  153. data/lib/plaid/models/beacon_audit_trail_source.rb +41 -0
  154. data/lib/plaid/models/beacon_report_create_request.rb +284 -0
  155. data/lib/plaid/models/beacon_report_create_response.rb +328 -0
  156. data/lib/plaid/models/beacon_report_type.rb +42 -0
  157. data/lib/plaid/models/beacon_user_address.rb +310 -0
  158. data/lib/plaid/models/beacon_user_create_embedded_report.rb +250 -0
  159. data/lib/plaid/models/beacon_user_create_request.rb +306 -0
  160. data/lib/plaid/models/beacon_user_create_response.rb +364 -0
  161. data/lib/plaid/models/beacon_user_data.rb +301 -0
  162. data/lib/plaid/models/beacon_user_get_request.rb +246 -0
  163. data/lib/plaid/models/beacon_user_get_response.rb +364 -0
  164. data/lib/plaid/models/beacon_user_id_number.rb +240 -0
  165. data/lib/plaid/models/beacon_user_name.rb +241 -0
  166. data/lib/plaid/models/beacon_user_request_address.rb +310 -0
  167. data/lib/plaid/models/beacon_user_request_data.rb +295 -0
  168. data/lib/plaid/models/beacon_user_status.rb +40 -0
  169. data/lib/plaid/models/categories_get_response.rb +1 -1
  170. data/lib/plaid/models/category.rb +1 -1
  171. data/lib/plaid/models/cause.rb +1 -1
  172. data/lib/plaid/models/cause_all_of.rb +1 -1
  173. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  174. data/lib/plaid/models/client_provided_enriched_transaction.rb +1 -1
  175. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  176. data/lib/plaid/models/client_provided_transaction.rb +1 -1
  177. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  178. data/lib/plaid/models/connected_application.rb +1 -1
  179. data/lib/plaid/models/consumer_report_user_identity.rb +289 -0
  180. data/lib/plaid/models/counterparty.rb +17 -6
  181. data/lib/plaid/models/counterparty_type.rb +1 -1
  182. data/lib/plaid/models/country_code.rb +1 -1
  183. data/lib/plaid/models/cra_bank_income.rb +274 -0
  184. data/lib/plaid/models/cra_bank_income_account.rb +293 -0
  185. data/lib/plaid/models/cra_bank_income_cause.rb +270 -0
  186. data/lib/plaid/models/cra_bank_income_employer.rb +222 -0
  187. data/lib/plaid/models/cra_bank_income_get_request.rb +241 -0
  188. data/lib/plaid/models/cra_bank_income_get_response.rb +237 -0
  189. data/lib/plaid/models/cra_bank_income_historical_summary.rb +254 -0
  190. data/lib/plaid/models/cra_bank_income_item.rb +265 -0
  191. data/lib/plaid/models/cra_bank_income_source.rb +375 -0
  192. data/lib/plaid/models/cra_bank_income_summary.rb +320 -0
  193. data/lib/plaid/models/cra_bank_income_transaction.rb +295 -0
  194. data/lib/plaid/models/cra_bank_income_warning.rb +238 -0
  195. data/lib/plaid/models/cra_bank_income_warning_code.rb +41 -0
  196. data/lib/plaid/models/credit1099.rb +1 -1
  197. data/lib/plaid/models/credit1099_filer.rb +1 -1
  198. data/lib/plaid/models/credit1099_payer.rb +1 -1
  199. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  200. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  201. data/lib/plaid/models/credit_ach_class.rb +1 -1
  202. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  203. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  204. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  205. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  206. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  207. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  208. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  209. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  210. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  211. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  212. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  213. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  214. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  215. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  216. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  217. data/lib/plaid/models/credit_bank_income.rb +1 -1
  218. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  219. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  220. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  221. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  222. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  223. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  224. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  225. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  226. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  227. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  228. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  229. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  230. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  231. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  232. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  233. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  234. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  235. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  236. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  237. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  238. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  239. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +1 -1
  240. data/lib/plaid/models/credit_bank_income_webhook_update_response.rb +226 -0
  241. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +1 -1
  242. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +1 -1
  243. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +1 -1
  244. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +1 -1
  245. data/lib/plaid/models/credit_bank_statement_upload_item.rb +1 -1
  246. data/lib/plaid/models/credit_bank_statement_upload_object.rb +1 -1
  247. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +1 -1
  248. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +1 -1
  249. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +1 -1
  250. data/lib/plaid/models/credit_card_liability.rb +1 -1
  251. data/lib/plaid/models/credit_category.rb +1 -1
  252. data/lib/plaid/models/credit_document_metadata.rb +2 -2
  253. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  254. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  255. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  256. data/lib/plaid/models/credit_employment_item.rb +1 -1
  257. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  258. data/lib/plaid/models/credit_filter.rb +1 -1
  259. data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +1 -1
  260. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +1 -1
  261. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +1 -1
  262. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +1 -1
  263. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +1 -1
  264. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +1 -1
  265. data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +1 -1
  266. data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +1 -1
  267. data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +1 -1
  268. data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +1 -1
  269. data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +1 -1
  270. data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +1 -1
  271. data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +1 -1
  272. data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +1 -1
  273. data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +1 -1
  274. data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +1 -1
  275. data/lib/plaid/models/credit_freddie_mac_party_voa24.rb +1 -1
  276. data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +1 -1
  277. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  278. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  279. data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +1 -1
  280. data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +1 -1
  281. data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +1 -1
  282. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +1 -1
  283. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +1 -1
  284. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +1 -1
  285. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +1 -1
  286. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +1 -1
  287. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +1 -1
  288. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +1 -1
  289. data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +1 -1
  290. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +1 -1
  291. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  292. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  293. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  294. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  295. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  296. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  297. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  298. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  299. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  300. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  301. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  302. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  303. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  304. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  305. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  306. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  307. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  308. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  309. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  310. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  311. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  312. data/lib/plaid/models/credit_relay_pdf_get_request.rb +260 -0
  313. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  314. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  315. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  316. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  317. data/lib/plaid/models/credit_session.rb +1 -1
  318. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  319. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  320. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  321. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  322. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  323. data/lib/plaid/models/credit_session_error.rb +1 -1
  324. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  325. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  326. data/lib/plaid/models/credit_session_results.rb +1 -1
  327. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  328. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  329. data/lib/plaid/models/credit_w2.rb +1 -1
  330. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  331. data/lib/plaid/models/dashboard_user.rb +1 -1
  332. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  333. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  334. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  335. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  336. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  337. data/lib/plaid/models/date_range.rb +1 -1
  338. data/lib/plaid/models/deductions.rb +1 -1
  339. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  340. data/lib/plaid/models/deductions_total.rb +1 -1
  341. data/lib/plaid/models/default_update_webhook.rb +1 -1
  342. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  343. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  344. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  345. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  346. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  347. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  348. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  349. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  350. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  351. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  352. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  353. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  354. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  355. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  356. data/lib/plaid/models/depository_filter.rb +1 -1
  357. data/lib/plaid/models/detailed_originator.rb +1 -1
  358. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  359. data/lib/plaid/models/doc_type.rb +1 -1
  360. data/lib/plaid/models/document_analysis.rb +1 -1
  361. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  362. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  363. data/lib/plaid/models/document_metadata.rb +1 -1
  364. data/lib/plaid/models/document_name_match_code.rb +1 -1
  365. data/lib/plaid/models/document_risk_signal.rb +1 -1
  366. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  367. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  368. data/lib/plaid/models/document_risk_summary.rb +1 -1
  369. data/lib/plaid/models/document_status.rb +1 -1
  370. data/lib/plaid/models/documentary_verification.rb +1 -1
  371. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  372. data/lib/plaid/models/earnings.rb +1 -1
  373. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  374. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  375. data/lib/plaid/models/earnings_total.rb +1 -1
  376. data/lib/plaid/models/email.rb +1 -1
  377. data/lib/plaid/models/email_address_match_score.rb +2 -2
  378. data/lib/plaid/models/employee.rb +1 -1
  379. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  380. data/lib/plaid/models/employer.rb +1 -1
  381. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  382. data/lib/plaid/models/employer_verification.rb +1 -1
  383. data/lib/plaid/models/employers_search_request.rb +1 -1
  384. data/lib/plaid/models/employers_search_response.rb +1 -1
  385. data/lib/plaid/models/employment_details.rb +1 -1
  386. data/lib/plaid/models/employment_source_type.rb +1 -1
  387. data/lib/plaid/models/employment_verification.rb +1 -1
  388. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  389. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  390. data/lib/plaid/models/employment_verification_status.rb +1 -1
  391. data/lib/plaid/models/enhancements.rb +1 -1
  392. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  393. data/lib/plaid/models/enrichments.rb +1 -1
  394. data/lib/plaid/models/entity_document.rb +1 -1
  395. data/lib/plaid/models/entity_document_type.rb +1 -1
  396. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  397. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  398. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  399. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  400. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  401. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  402. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  403. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  404. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  405. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  406. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  407. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  408. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  409. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  410. data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
  411. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  412. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  413. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  414. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  415. data/lib/plaid/models/expiration_date.rb +1 -1
  416. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  417. data/lib/plaid/models/external_payment_options.rb +1 -1
  418. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  419. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  420. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  421. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  422. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  423. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  424. data/lib/plaid/models/fdx_content_types.rb +1 -1
  425. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  426. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  427. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  428. data/lib/plaid/models/fdx_notification.rb +1 -1
  429. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  430. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  431. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  432. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  433. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  434. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  435. data/lib/plaid/models/fdx_party.rb +1 -1
  436. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  437. data/lib/plaid/models/fdx_party_type.rb +1 -1
  438. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  439. data/lib/plaid/models/form1099_type.rb +1 -1
  440. data/lib/plaid/models/fraud_amount.rb +240 -0
  441. data/lib/plaid/models/fraud_amount_nullable.rb +240 -0
  442. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  443. data/lib/plaid/models/health_incident.rb +1 -1
  444. data/lib/plaid/models/historical_balance.rb +2 -2
  445. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  446. data/lib/plaid/models/holding.rb +1 -1
  447. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  448. data/lib/plaid/models/holdings_override.rb +1 -1
  449. data/lib/plaid/models/hosted_link_delivery_method.rb +39 -0
  450. data/lib/plaid/models/id_number_type.rb +1 -1
  451. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  452. data/lib/plaid/models/identity_get_request.rb +1 -1
  453. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  454. data/lib/plaid/models/identity_get_response.rb +1 -1
  455. data/lib/plaid/models/identity_match_request.rb +1 -1
  456. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  457. data/lib/plaid/models/identity_match_response.rb +1 -1
  458. data/lib/plaid/models/identity_match_user.rb +2 -2
  459. data/lib/plaid/models/identity_refresh_request.rb +1 -1
  460. data/lib/plaid/models/identity_refresh_response.rb +1 -1
  461. data/lib/plaid/models/identity_update_types.rb +1 -1
  462. data/lib/plaid/models/identity_verification.rb +2 -2
  463. data/lib/plaid/models/identity_verification_create_request.rb +2 -2
  464. data/lib/plaid/models/identity_verification_create_request_user.rb +1 -1
  465. data/lib/plaid/models/identity_verification_create_response.rb +2 -2
  466. data/lib/plaid/models/identity_verification_document_address_response.rb +299 -0
  467. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  468. data/lib/plaid/models/identity_verification_get_response.rb +2 -2
  469. data/lib/plaid/models/identity_verification_list_request.rb +2 -2
  470. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  471. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  472. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  473. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  474. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  475. data/lib/plaid/models/identity_verification_retry_request.rb +2 -2
  476. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  477. data/lib/plaid/models/identity_verification_retry_response.rb +2 -2
  478. data/lib/plaid/models/identity_verification_status.rb +1 -1
  479. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  480. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  481. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  482. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  483. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  484. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  485. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  486. data/lib/plaid/models/image_quality.rb +1 -1
  487. data/lib/plaid/models/incident_update.rb +1 -1
  488. data/lib/plaid/models/income_breakdown.rb +1 -1
  489. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  490. data/lib/plaid/models/income_override.rb +1 -1
  491. data/lib/plaid/models/income_summary.rb +1 -1
  492. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  493. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  494. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  495. data/lib/plaid/models/income_verification_create_request_options.rb +2 -2
  496. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  497. data/lib/plaid/models/income_verification_doc_parsing_config.rb +39 -0
  498. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  499. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  500. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  501. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  502. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  503. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  504. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  505. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  506. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  507. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  508. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  509. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  510. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  511. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +2 -2
  512. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  513. data/lib/plaid/models/income_verification_status_webhook.rb +2 -2
  514. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  515. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  516. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  517. data/lib/plaid/models/individual_name.rb +1 -1
  518. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  519. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  520. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  521. data/lib/plaid/models/inflow_model.rb +1 -1
  522. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  523. data/lib/plaid/models/institution.rb +1 -1
  524. data/lib/plaid/models/institution_status.rb +1 -1
  525. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  526. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  527. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  528. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  529. data/lib/plaid/models/institutions_get_request.rb +1 -1
  530. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  531. data/lib/plaid/models/institutions_get_response.rb +1 -1
  532. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  533. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  534. data/lib/plaid/models/institutions_search_request.rb +1 -1
  535. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  536. data/lib/plaid/models/institutions_search_response.rb +1 -1
  537. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  538. data/lib/plaid/models/investment_filter.rb +1 -1
  539. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  540. data/lib/plaid/models/investment_transaction.rb +1 -1
  541. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  542. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  543. data/lib/plaid/models/investments_auth_get_numbers.rb +16 -5
  544. data/lib/plaid/models/investments_auth_get_request.rb +1 -1
  545. data/lib/plaid/models/investments_auth_get_request_options.rb +1 -1
  546. data/lib/plaid/models/investments_auth_get_response.rb +1 -1
  547. data/lib/plaid/models/investments_auth_owner.rb +1 -1
  548. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  549. data/lib/plaid/models/investments_historical_update_webhook.rb +1 -1
  550. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  551. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  552. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  553. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  554. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  555. data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
  556. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  557. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  558. data/lib/plaid/models/iso_currency_code.rb +38 -0
  559. data/lib/plaid/models/issuing_country.rb +1 -1
  560. data/lib/plaid/models/item.rb +1 -1
  561. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  562. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  563. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  564. data/lib/plaid/models/item_activity_list_response.rb +1 -1
  565. data/lib/plaid/models/item_application_list_request.rb +1 -1
  566. data/lib/plaid/models/item_application_list_response.rb +1 -1
  567. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  568. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  569. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  570. data/lib/plaid/models/item_error_webhook.rb +1 -1
  571. data/lib/plaid/models/item_get_request.rb +1 -1
  572. data/lib/plaid/models/item_get_response.rb +1 -1
  573. data/lib/plaid/models/item_import_request.rb +1 -1
  574. data/lib/plaid/models/item_import_request_options.rb +1 -1
  575. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  576. data/lib/plaid/models/item_import_response.rb +1 -1
  577. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  578. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  579. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  580. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  581. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  582. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  583. data/lib/plaid/models/item_remove_request.rb +1 -1
  584. data/lib/plaid/models/item_remove_response.rb +1 -1
  585. data/lib/plaid/models/item_status.rb +1 -1
  586. data/lib/plaid/models/item_status_investments.rb +1 -1
  587. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  588. data/lib/plaid/models/item_status_nullable.rb +1 -1
  589. data/lib/plaid/models/item_status_transactions.rb +1 -1
  590. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  591. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  592. data/lib/plaid/models/jwk_public_key.rb +1 -1
  593. data/lib/plaid/models/jwt_header.rb +1 -1
  594. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  595. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  596. data/lib/plaid/models/kyc_check_details.rb +1 -1
  597. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  598. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  599. data/lib/plaid/models/kyc_check_phone_summary.rb +19 -5
  600. data/lib/plaid/models/last_data_access_times.rb +1 -1
  601. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  602. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  603. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  604. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  605. data/lib/plaid/models/liabilities_object.rb +1 -1
  606. data/lib/plaid/models/liability_override.rb +1 -1
  607. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  608. data/lib/plaid/models/link_delivery_account.rb +1 -1
  609. data/lib/plaid/models/link_delivery_callback_webhook.rb +1 -1
  610. data/lib/plaid/models/link_delivery_communication_method.rb +1 -1
  611. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  612. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  613. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  614. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  615. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  616. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  617. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  618. data/lib/plaid/models/link_delivery_options.rb +1 -1
  619. data/lib/plaid/models/link_delivery_recipient.rb +1 -1
  620. data/lib/plaid/models/link_delivery_session_status.rb +2 -1
  621. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  622. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  623. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +1 -1
  624. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +1 -1
  625. data/lib/plaid/models/link_event.rb +1 -1
  626. data/lib/plaid/models/link_event_metadata.rb +1 -1
  627. data/lib/plaid/models/link_event_name.rb +1 -1
  628. data/lib/plaid/models/link_events_webhook.rb +1 -1
  629. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  630. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  631. data/lib/plaid/models/link_session_exit.rb +231 -0
  632. data/lib/plaid/models/link_session_exit_metadata.rb +251 -0
  633. data/lib/plaid/models/link_session_exit_metadata_institution.rb +231 -0
  634. data/lib/plaid/models/link_session_finished_webhook.rb +296 -0
  635. data/lib/plaid/models/link_session_success.rb +236 -0
  636. data/lib/plaid/models/link_session_success_metadata.rb +253 -0
  637. data/lib/plaid/models/link_session_success_metadata_account.rb +284 -0
  638. data/lib/plaid/models/link_session_success_metadata_institution.rb +231 -0
  639. data/lib/plaid/models/link_session_success_metadata_transfer_status.rb +39 -0
  640. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  641. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  642. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  643. data/lib/plaid/models/link_token_create_hosted_link.rb +220 -0
  644. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  645. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  646. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  647. data/lib/plaid/models/link_token_create_request.rb +32 -5
  648. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  649. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  650. data/lib/plaid/models/link_token_create_request_base_report.rb +221 -0
  651. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  652. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  653. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  654. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  655. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  656. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  657. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +22 -9
  658. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  659. data/lib/plaid/models/link_token_create_request_statements.rb +231 -0
  660. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  661. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  662. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  663. data/lib/plaid/models/link_token_create_request_user_address.rb +1 -1
  664. data/lib/plaid/models/link_token_create_request_user_id_number.rb +1 -1
  665. data/lib/plaid/models/link_token_create_request_user_name.rb +1 -1
  666. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  667. data/lib/plaid/models/link_token_create_response.rb +15 -5
  668. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  669. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  670. data/lib/plaid/models/link_token_get_request.rb +1 -1
  671. data/lib/plaid/models/link_token_get_response.rb +14 -2
  672. data/lib/plaid/models/link_token_get_sessions_response.rb +267 -0
  673. data/lib/plaid/models/link_token_investments.rb +1 -1
  674. data/lib/plaid/models/link_token_investments_auth.rb +1 -1
  675. data/lib/plaid/models/link_user_delivery_status_webhook.rb +1 -1
  676. data/lib/plaid/models/loan.rb +1 -1
  677. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  678. data/lib/plaid/models/loan_filter.rb +1 -1
  679. data/lib/plaid/models/loan_identifier.rb +1 -1
  680. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  681. data/lib/plaid/models/loan_identifiers.rb +1 -1
  682. data/lib/plaid/models/loans.rb +1 -1
  683. data/lib/plaid/models/location.rb +1 -1
  684. data/lib/plaid/models/match_summary.rb +1 -1
  685. data/lib/plaid/models/match_summary_code.rb +1 -1
  686. data/lib/plaid/models/meta.rb +1 -1
  687. data/lib/plaid/models/mfa.rb +1 -1
  688. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  689. data/lib/plaid/models/mortgage_liability.rb +1 -1
  690. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  691. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  692. data/lib/plaid/models/name_match_score.rb +2 -2
  693. data/lib/plaid/models/net_pay.rb +1 -1
  694. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  695. data/lib/plaid/models/numbers.rb +1 -1
  696. data/lib/plaid/models/numbers_acats.rb +1 -1
  697. data/lib/plaid/models/numbers_ach.rb +2 -2
  698. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  699. data/lib/plaid/models/numbers_aton.rb +241 -0
  700. data/lib/plaid/models/numbers_bacs.rb +1 -1
  701. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  702. data/lib/plaid/models/numbers_eft.rb +1 -1
  703. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  704. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  705. data/lib/plaid/models/numbers_international.rb +1 -1
  706. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  707. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  708. data/lib/plaid/models/originator.rb +1 -1
  709. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  710. data/lib/plaid/models/override_account_type.rb +1 -1
  711. data/lib/plaid/models/override_accounts.rb +1 -1
  712. data/lib/plaid/models/owner.rb +1 -1
  713. data/lib/plaid/models/owner_override.rb +1 -1
  714. data/lib/plaid/models/ownership_type.rb +1 -1
  715. data/lib/plaid/models/parties.rb +1 -1
  716. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  717. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  718. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  719. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  720. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  721. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  722. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  723. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  724. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  725. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  726. data/lib/plaid/models/partner_end_customer.rb +1 -1
  727. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  728. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  729. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  730. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  731. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  732. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  733. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  734. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  735. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  736. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  737. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  738. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  739. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  740. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  741. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  742. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  743. data/lib/plaid/models/party.rb +1 -1
  744. data/lib/plaid/models/party_individual.rb +1 -1
  745. data/lib/plaid/models/party_role_type.rb +1 -1
  746. data/lib/plaid/models/pay.rb +1 -1
  747. data/lib/plaid/models/pay_frequency.rb +1 -1
  748. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  749. data/lib/plaid/models/pay_period_details.rb +1 -1
  750. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  751. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  752. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  753. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  754. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  755. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  756. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  757. data/lib/plaid/models/payment_amount.rb +1 -1
  758. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  759. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  760. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  761. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  762. data/lib/plaid/models/payment_channel.rb +1 -1
  763. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  764. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  765. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  766. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  767. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  768. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  769. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  770. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  771. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  772. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  773. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  774. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  775. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  776. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  777. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  778. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  779. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  780. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  781. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  782. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  783. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  784. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  785. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  786. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  787. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  788. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  789. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  790. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  791. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  792. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  793. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  794. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  795. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  796. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  797. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  798. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  799. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  800. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  801. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  802. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  803. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  804. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  805. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  806. data/lib/plaid/models/payment_meta.rb +2 -2
  807. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  808. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  809. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  810. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  811. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  812. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  813. data/lib/plaid/models/payment_profile_status.rb +1 -1
  814. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  815. data/lib/plaid/models/payment_scheme.rb +1 -1
  816. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  817. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  818. data/lib/plaid/models/payroll_income_object.rb +1 -1
  819. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  820. data/lib/plaid/models/payroll_item.rb +1 -1
  821. data/lib/plaid/models/payroll_item_status.rb +1 -1
  822. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  823. data/lib/plaid/models/paystub.rb +1 -1
  824. data/lib/plaid/models/paystub_address.rb +1 -1
  825. data/lib/plaid/models/paystub_deduction.rb +1 -1
  826. data/lib/plaid/models/paystub_details.rb +1 -1
  827. data/lib/plaid/models/paystub_employer.rb +1 -1
  828. data/lib/plaid/models/paystub_override.rb +1 -1
  829. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  830. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  831. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  832. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  833. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  834. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  835. data/lib/plaid/models/personal_finance_category.rb +16 -5
  836. data/lib/plaid/models/phone_number.rb +1 -1
  837. data/lib/plaid/models/phone_number_match_score.rb +2 -2
  838. data/lib/plaid/models/phone_type.rb +1 -1
  839. data/lib/plaid/models/physical_document_category.rb +2 -1
  840. data/lib/plaid/models/physical_document_extracted_data.rb +27 -6
  841. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  842. data/lib/plaid/models/physical_document_images.rb +1 -1
  843. data/lib/plaid/models/plaid_error.rb +1 -1
  844. data/lib/plaid/models/plaid_error_type.rb +1 -1
  845. data/lib/plaid/models/platform_ids.rb +1 -1
  846. data/lib/plaid/models/po_box_status.rb +1 -1
  847. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  848. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  849. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  850. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  851. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  852. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  853. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  854. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  855. data/lib/plaid/models/processor_default_update_webhook.rb +1 -1
  856. data/lib/plaid/models/processor_historical_update_webhook.rb +1 -1
  857. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  858. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  859. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  860. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  861. data/lib/plaid/models/processor_initial_update_webhook.rb +1 -1
  862. data/lib/plaid/models/processor_number.rb +1 -1
  863. data/lib/plaid/models/processor_recurring_transactions_update_webhook.rb +1 -1
  864. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  865. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  866. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  867. data/lib/plaid/models/processor_signal_evaluate_response.rb +1 -1
  868. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  869. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  870. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  871. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  872. data/lib/plaid/models/processor_sync_updates_available_webhook.rb +1 -1
  873. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  874. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  875. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  876. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  877. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  878. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  879. data/lib/plaid/models/processor_token_webhook_update.rb +295 -0
  880. data/lib/plaid/models/processor_token_webhook_update_request.rb +257 -0
  881. data/lib/plaid/models/processor_token_webhook_update_response.rb +226 -0
  882. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  883. data/lib/plaid/models/processor_transactions_get_response.rb +2 -16
  884. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  885. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  886. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  887. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  888. data/lib/plaid/models/processor_transactions_removed_webhook.rb +1 -1
  889. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  890. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  891. data/lib/plaid/models/product_access.rb +1 -1
  892. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +1 -1
  893. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +1 -1
  894. data/lib/plaid/models/product_status.rb +1 -1
  895. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  896. data/lib/plaid/models/products.rb +2 -1
  897. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  898. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  899. data/lib/plaid/models/proxy_type.rb +1 -1
  900. data/lib/plaid/models/pslf_status.rb +1 -1
  901. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  902. data/lib/plaid/models/recipient_bacs.rb +1 -1
  903. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  904. data/lib/plaid/models/recurrence.rb +1 -1
  905. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  906. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  907. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  908. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  909. data/lib/plaid/models/recurring_transfer.rb +1 -1
  910. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  911. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  912. data/lib/plaid/models/removed_transaction.rb +1 -1
  913. data/lib/plaid/models/report_type.rb +1 -1
  914. data/lib/plaid/models/reporting_information.rb +1 -1
  915. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  916. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  917. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  918. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  919. data/lib/plaid/models/risk_check_details.rb +1 -1
  920. data/lib/plaid/models/risk_check_device.rb +1 -1
  921. data/lib/plaid/models/risk_check_email.rb +1 -1
  922. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  923. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  924. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  925. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  926. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  927. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +1 -1
  928. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  929. data/lib/plaid/models/risk_check_phone.rb +1 -1
  930. data/lib/plaid/models/risk_check_stolen_identity.rb +6 -1
  931. data/lib/plaid/models/risk_check_synthetic_identity.rb +6 -1
  932. data/lib/plaid/models/risk_signal_document_reference.rb +14 -5
  933. data/lib/plaid/models/risk_signal_document_status.rb +42 -0
  934. data/lib/plaid/models/role.rb +1 -1
  935. data/lib/plaid/models/role_detail.rb +1 -1
  936. data/lib/plaid/models/roles.rb +1 -1
  937. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +1 -1
  938. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +1 -1
  939. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +1 -1
  940. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +1 -1
  941. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  942. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  943. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  944. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  945. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  946. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  947. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  948. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  949. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  950. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  951. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  952. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  953. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  954. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  955. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  956. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  957. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  958. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  959. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  960. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  961. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  962. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  963. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  964. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  965. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  966. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  967. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  968. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  969. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  970. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  971. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  972. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  973. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  974. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  975. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +1 -1
  976. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  977. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  978. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  979. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  980. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  981. data/lib/plaid/models/scopes.rb +1 -1
  982. data/lib/plaid/models/scopes_context.rb +1 -1
  983. data/lib/plaid/models/scopes_nullable.rb +1 -1
  984. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  985. data/lib/plaid/models/screening_hit_data.rb +1 -1
  986. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  987. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  988. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  989. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  990. data/lib/plaid/models/security.rb +1 -1
  991. data/lib/plaid/models/security_override.rb +1 -1
  992. data/lib/plaid/models/selfie_analysis.rb +1 -1
  993. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  994. data/lib/plaid/models/selfie_capture.rb +1 -1
  995. data/lib/plaid/models/selfie_check.rb +1 -1
  996. data/lib/plaid/models/selfie_check_selfie.rb +2 -2
  997. data/lib/plaid/models/selfie_check_status.rb +1 -1
  998. data/lib/plaid/models/selfie_status.rb +1 -1
  999. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  1000. data/lib/plaid/models/service.rb +1 -1
  1001. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  1002. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  1003. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  1004. data/lib/plaid/models/servicer_address_data.rb +1 -1
  1005. data/lib/plaid/models/services.rb +1 -1
  1006. data/lib/plaid/models/signal_address_data.rb +1 -1
  1007. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  1008. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  1009. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  1010. data/lib/plaid/models/signal_device.rb +1 -1
  1011. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  1012. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  1013. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  1014. data/lib/plaid/models/signal_insights.rb +2 -11
  1015. data/lib/plaid/models/signal_payment_method.rb +1 -1
  1016. data/lib/plaid/models/signal_person_name.rb +1 -1
  1017. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  1018. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  1019. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  1020. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  1021. data/lib/plaid/models/signal_scores.rb +1 -1
  1022. data/lib/plaid/models/signal_user.rb +1 -1
  1023. data/lib/plaid/models/signal_warning.rb +1 -1
  1024. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  1025. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  1026. data/lib/plaid/models/source.rb +1 -1
  1027. data/lib/plaid/models/standalone_account_type.rb +2 -2
  1028. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  1029. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  1030. data/lib/plaid/models/statements_account.rb +273 -0
  1031. data/lib/plaid/models/statements_download_request.rb +261 -0
  1032. data/lib/plaid/models/statements_list_request.rb +246 -0
  1033. data/lib/plaid/models/statements_list_response.rb +287 -0
  1034. data/lib/plaid/models/statements_statement.rb +256 -0
  1035. data/lib/plaid/models/status.rb +1 -1
  1036. data/lib/plaid/models/statuses.rb +1 -1
  1037. data/lib/plaid/models/strategy.rb +1 -1
  1038. data/lib/plaid/models/student_loan.rb +1 -1
  1039. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  1040. data/lib/plaid/models/student_loan_status.rb +1 -1
  1041. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  1042. data/lib/plaid/models/sweep_status.rb +1 -1
  1043. data/lib/plaid/models/sync_updates_available_webhook.rb +2 -2
  1044. data/lib/plaid/models/taxform.rb +1 -1
  1045. data/lib/plaid/models/taxpayer_id.rb +1 -1
  1046. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  1047. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  1048. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  1049. data/lib/plaid/models/total.rb +1 -1
  1050. data/lib/plaid/models/total_canonical_description.rb +1 -1
  1051. data/lib/plaid/models/transaction.rb +3 -3
  1052. data/lib/plaid/models/transaction_all_of.rb +1 -1
  1053. data/lib/plaid/models/transaction_base.rb +3 -3
  1054. data/lib/plaid/models/transaction_code.rb +1 -1
  1055. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  1056. data/lib/plaid/models/transaction_data.rb +1 -1
  1057. data/lib/plaid/models/transaction_override.rb +1 -1
  1058. data/lib/plaid/models/transaction_stream.rb +1 -1
  1059. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  1060. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  1061. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  1062. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  1063. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  1064. data/lib/plaid/models/transactions_enrich_get_request.rb +1 -1
  1065. data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
  1066. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  1067. data/lib/plaid/models/transactions_get_request.rb +1 -1
  1068. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  1069. data/lib/plaid/models/transactions_get_response.rb +1 -1
  1070. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  1071. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  1072. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  1073. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  1074. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  1075. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  1076. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  1077. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  1078. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  1079. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  1080. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  1081. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  1082. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  1083. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  1084. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  1085. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  1086. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  1087. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  1088. data/lib/plaid/models/transfer.rb +17 -2
  1089. data/lib/plaid/models/transfer_authorization.rb +1 -1
  1090. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  1091. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1092. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1093. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1094. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1095. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  1096. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1097. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1098. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1099. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1100. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1101. data/lib/plaid/models/transfer_balance.rb +12 -2
  1102. data/lib/plaid/models/transfer_balance_get_request.rb +13 -7
  1103. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1104. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1105. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1106. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1107. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1108. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1109. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1110. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1111. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1112. data/lib/plaid/models/transfer_create_request.rb +1 -1
  1113. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1114. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1115. data/lib/plaid/models/transfer_credit_usage_configuration.rb +1 -1
  1116. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1117. data/lib/plaid/models/transfer_device.rb +1 -1
  1118. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +1 -1
  1119. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +1 -1
  1120. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1121. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1122. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1123. data/lib/plaid/models/transfer_document_purpose.rb +1 -1
  1124. data/lib/plaid/models/transfer_event.rb +1 -1
  1125. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1126. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1127. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1128. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1129. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1130. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1131. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1132. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1133. data/lib/plaid/models/transfer_failure.rb +1 -1
  1134. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1135. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1136. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1137. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1138. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1139. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1140. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1141. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1142. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1143. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1144. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1145. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1146. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1147. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1148. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1149. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1150. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1151. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1152. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1153. data/lib/plaid/models/transfer_network.rb +1 -1
  1154. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1155. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1156. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1157. data/lib/plaid/models/transfer_originator_diligence.rb +1 -1
  1158. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1159. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1160. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1161. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1162. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1163. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1164. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1165. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1166. data/lib/plaid/models/transfer_recurring_create_request.rb +1 -1
  1167. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1168. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1169. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1170. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1171. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1172. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1173. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1174. data/lib/plaid/models/transfer_refund.rb +12 -2
  1175. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1176. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1177. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1178. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1179. data/lib/plaid/models/transfer_refund_failure.rb +232 -0
  1180. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1181. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1182. data/lib/plaid/models/transfer_refund_status.rb +3 -1
  1183. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1184. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1185. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1186. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1187. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1188. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1189. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1190. data/lib/plaid/models/transfer_status.rb +1 -1
  1191. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1192. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1193. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1194. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1195. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1196. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1197. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1198. data/lib/plaid/models/transfer_type.rb +1 -1
  1199. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1200. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1201. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1202. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1203. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1204. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1205. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1206. data/lib/plaid/models/user_address.rb +1 -1
  1207. data/lib/plaid/models/user_create_request.rb +15 -5
  1208. data/lib/plaid/models/user_create_response.rb +1 -1
  1209. data/lib/plaid/models/user_custom_password.rb +1 -1
  1210. data/lib/plaid/models/user_id_number.rb +1 -1
  1211. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1212. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1213. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1214. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1215. data/lib/plaid/models/validation_source.rb +1 -1
  1216. data/lib/plaid/models/validation_sources.rb +1 -1
  1217. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1218. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1219. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1220. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1221. data/lib/plaid/models/verification_status.rb +1 -1
  1222. data/lib/plaid/models/w2.rb +1 -1
  1223. data/lib/plaid/models/w2_box12.rb +1 -1
  1224. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1225. data/lib/plaid/models/wallet.rb +1 -1
  1226. data/lib/plaid/models/wallet_balance.rb +1 -1
  1227. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1228. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1229. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1230. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1231. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1232. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1233. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1234. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1235. data/lib/plaid/models/wallet_payment_scheme.rb +1 -1
  1236. data/lib/plaid/models/wallet_status.rb +1 -1
  1237. data/lib/plaid/models/wallet_transaction.rb +16 -6
  1238. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1239. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1240. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1241. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1242. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1243. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1244. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1245. data/lib/plaid/models/wallet_transaction_failure_reason.rb +42 -0
  1246. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1247. data/lib/plaid/models/wallet_transaction_get_response.rb +12 -2
  1248. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1249. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1250. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1251. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1252. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1253. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1254. data/lib/plaid/models/warning.rb +1 -1
  1255. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1256. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1257. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1258. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +2 -2
  1259. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
  1260. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1261. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
  1262. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1263. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1264. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1265. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1266. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
  1267. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1268. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1269. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1270. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1271. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1272. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1273. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1274. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1275. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1276. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
  1277. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1278. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
  1279. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1280. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1281. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1282. data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
  1283. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +2 -2
  1284. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
  1285. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1286. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
  1287. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1288. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1289. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1290. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1291. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +2 -2
  1292. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1293. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1294. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1295. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1296. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1297. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1298. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1299. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1300. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1301. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
  1302. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1303. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
  1304. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1305. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1306. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1307. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1308. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1309. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1310. data/lib/plaid/models/webhook_type.rb +1 -1
  1311. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1312. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1313. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1314. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1315. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1316. data/lib/plaid/version.rb +2 -2
  1317. data/lib/plaid.rb +82 -1
  1318. data/plaid.gemspec +1 -1
  1319. metadata +83 -2
@@ -3,7 +3,7 @@
3
3
 
4
4
  #The Plaid REST API. Please see https://plaid.com/docs/api for more details.
5
5
 
6
- The version of the OpenAPI document: 2020-09-14_1.391.1
6
+ The version of the OpenAPI document: 2020-09-14_1.413.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.1.0
@@ -564,7 +564,7 @@ module Plaid
564
564
  end
565
565
 
566
566
  # Retrieve an Asset Report
567
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. If report_type was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in asset_report/create, debit transactions and transaction amounts won’t be included in the report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
567
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
568
568
  # @param asset_report_get_request [AssetReportGetRequest]
569
569
  # @param [Hash] opts the optional parameters
570
570
  # @return [AssetReportGetResponse]
@@ -574,7 +574,7 @@ module Plaid
574
574
  end
575
575
 
576
576
  # Retrieve an Asset Report
577
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. If report_type was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in asset_report/create, debit transactions and transaction amounts won’t be included in the report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
577
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call `/asset_report/get` endpoint with `include_insights` set to `true`. If `report_type` was set to `VERIFICATION_OF_EMPLOYMENT` when the Asset Report was created in `/asset_report/create`, debit transactions and transaction amounts won’t be included in the report. For latency-sensitive applications, you can optionally call `/asset_report/create` with `options.add_ons` set to `[\"fast_assets\"]`. This will cause Plaid to create two versions of the Asset Report: one with only current and available balance and identity information, and then later on the complete Asset Report. You will receive separate webhooks for each version of the Asset Report.
578
578
  # @param asset_report_get_request [AssetReportGetRequest]
579
579
  # @param [Hash] opts the optional parameters
580
580
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -1583,6 +1583,278 @@ module Plaid
1583
1583
  return data, status_code, headers
1584
1584
  end
1585
1585
 
1586
+ # Retrieve a Base Report
1587
+ # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the `user_token` created in `/link/token/create`.
1588
+ # @param base_report_get_request [BaseReportGetRequest]
1589
+ # @param [Hash] opts the optional parameters
1590
+ # @return [BaseReportGetResponse]
1591
+ def base_report_get(base_report_get_request, opts = {})
1592
+ data, _status_code, _headers = base_report_get_with_http_info(base_report_get_request, opts)
1593
+ data
1594
+ end
1595
+
1596
+ # Retrieve a Base Report
1597
+ # This endpoint allows the customer to retrieve a Base Report. Customers should pass in the &#x60;user_token&#x60; created in &#x60;/link/token/create&#x60;.
1598
+ # @param base_report_get_request [BaseReportGetRequest]
1599
+ # @param [Hash] opts the optional parameters
1600
+ # @return [Array<(BaseReportGetResponse, Integer, Hash)>] BaseReportGetResponse data, response status code and response headers
1601
+ def base_report_get_with_http_info(base_report_get_request, opts = {})
1602
+ if @api_client.config.debugging
1603
+ @api_client.config.logger.debug 'Calling API: PlaidApi.base_report_get ...'
1604
+ end
1605
+ # verify the required parameter 'base_report_get_request' is set
1606
+ if @api_client.config.client_side_validation && base_report_get_request.nil?
1607
+ fail ArgumentError, "Missing the required parameter 'base_report_get_request' when calling PlaidApi.base_report_get"
1608
+ end
1609
+ # resource path
1610
+ local_var_path = '/cra/base_report/get'
1611
+
1612
+ # query parameters
1613
+ query_params = opts[:query_params] || {}
1614
+
1615
+ # header parameters
1616
+ header_params = opts[:header_params] || {}
1617
+ # HTTP header 'Accept' (if needed)
1618
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1619
+ # HTTP header 'Content-Type'
1620
+ content_type = @api_client.select_header_content_type(['application/json'])
1621
+ if !content_type.nil?
1622
+ header_params['Content-Type'] = content_type
1623
+ end
1624
+
1625
+ # form parameters
1626
+ form_params = opts[:form_params] || {}
1627
+
1628
+ # http body (model)
1629
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(base_report_get_request)
1630
+
1631
+ # return_type
1632
+ return_type = opts[:debug_return_type] || 'BaseReportGetResponse'
1633
+
1634
+ # auth_names
1635
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1636
+
1637
+ new_options = opts.merge(
1638
+ :operation => :"PlaidApi.base_report_get",
1639
+ :header_params => header_params,
1640
+ :query_params => query_params,
1641
+ :form_params => form_params,
1642
+ :body => post_body,
1643
+ :auth_names => auth_names,
1644
+ :return_type => return_type
1645
+ )
1646
+
1647
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1648
+ if @api_client.config.debugging
1649
+ @api_client.config.logger.debug "API called: PlaidApi#base_report_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1650
+ end
1651
+ return data, status_code, headers
1652
+ end
1653
+
1654
+ # Create a Beacon Report
1655
+ # Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the `/beacon/user/create` endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs.
1656
+ # @param beacon_report_create_request [BeaconReportCreateRequest]
1657
+ # @param [Hash] opts the optional parameters
1658
+ # @return [BeaconReportCreateResponse]
1659
+ def beacon_report_create(beacon_report_create_request, opts = {})
1660
+ data, _status_code, _headers = beacon_report_create_with_http_info(beacon_report_create_request, opts)
1661
+ data
1662
+ end
1663
+
1664
+ # Create a Beacon Report
1665
+ # Create a fraud report for a given Beacon User. Note: If you are creating users with the express purpose of providing historical fraud data, you should use the &#x60;/beacon/user/create&#x60; endpoint instead and embed the fraud report in the request. This will ensure that the Beacon User you create will not be subject to any billing costs.
1666
+ # @param beacon_report_create_request [BeaconReportCreateRequest]
1667
+ # @param [Hash] opts the optional parameters
1668
+ # @return [Array<(BeaconReportCreateResponse, Integer, Hash)>] BeaconReportCreateResponse data, response status code and response headers
1669
+ def beacon_report_create_with_http_info(beacon_report_create_request, opts = {})
1670
+ if @api_client.config.debugging
1671
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_report_create ...'
1672
+ end
1673
+ # verify the required parameter 'beacon_report_create_request' is set
1674
+ if @api_client.config.client_side_validation && beacon_report_create_request.nil?
1675
+ fail ArgumentError, "Missing the required parameter 'beacon_report_create_request' when calling PlaidApi.beacon_report_create"
1676
+ end
1677
+ # resource path
1678
+ local_var_path = '/beacon/report/create'
1679
+
1680
+ # query parameters
1681
+ query_params = opts[:query_params] || {}
1682
+
1683
+ # header parameters
1684
+ header_params = opts[:header_params] || {}
1685
+ # HTTP header 'Accept' (if needed)
1686
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1687
+ # HTTP header 'Content-Type'
1688
+ content_type = @api_client.select_header_content_type(['application/json'])
1689
+ if !content_type.nil?
1690
+ header_params['Content-Type'] = content_type
1691
+ end
1692
+
1693
+ # form parameters
1694
+ form_params = opts[:form_params] || {}
1695
+
1696
+ # http body (model)
1697
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_report_create_request)
1698
+
1699
+ # return_type
1700
+ return_type = opts[:debug_return_type] || 'BeaconReportCreateResponse'
1701
+
1702
+ # auth_names
1703
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1704
+
1705
+ new_options = opts.merge(
1706
+ :operation => :"PlaidApi.beacon_report_create",
1707
+ :header_params => header_params,
1708
+ :query_params => query_params,
1709
+ :form_params => form_params,
1710
+ :body => post_body,
1711
+ :auth_names => auth_names,
1712
+ :return_type => return_type
1713
+ )
1714
+
1715
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1716
+ if @api_client.config.debugging
1717
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_report_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1718
+ end
1719
+ return data, status_code, headers
1720
+ end
1721
+
1722
+ # Create a Beacon User
1723
+ # Create and scan a Beacon User against your Beacon Program, according to your program's settings. When you submit a new user to `/beacon/user/create`, several checks are performed immediately: - The user's PII (provided within the `user` object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program's \"Duplicate Information Filtering\" settings, the user will be returned with a status of `pending_review`. - The user's PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user's data matches a fraud report that your team created, the user will be returned with a status of `rejected`. - Finally, the user's PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a `pending_review` status if your program has enabled automatic flagging based on network fraud.
1724
+ # @param beacon_user_create_request [BeaconUserCreateRequest]
1725
+ # @param [Hash] opts the optional parameters
1726
+ # @return [BeaconUserCreateResponse]
1727
+ def beacon_user_create(beacon_user_create_request, opts = {})
1728
+ data, _status_code, _headers = beacon_user_create_with_http_info(beacon_user_create_request, opts)
1729
+ data
1730
+ end
1731
+
1732
+ # Create a Beacon User
1733
+ # Create and scan a Beacon User against your Beacon Program, according to your program&#39;s settings. When you submit a new user to &#x60;/beacon/user/create&#x60;, several checks are performed immediately: - The user&#39;s PII (provided within the &#x60;user&#x60; object) is searched against all other users within the Beacon Program you specified. If a match is found that violates your program&#39;s \&quot;Duplicate Information Filtering\&quot; settings, the user will be returned with a status of &#x60;pending_review&#x60;. - The user&#39;s PII is also searched against all fraud reports created by your organization across all of your Beacon Programs. If the user&#39;s data matches a fraud report that your team created, the user will be returned with a status of &#x60;rejected&#x60;. - Finally, the user&#39;s PII is searched against all fraud report shared with the Beacon Network by other companies. If a matching fraud report is found, the user will be returned with a &#x60;pending_review&#x60; status if your program has enabled automatic flagging based on network fraud.
1734
+ # @param beacon_user_create_request [BeaconUserCreateRequest]
1735
+ # @param [Hash] opts the optional parameters
1736
+ # @return [Array<(BeaconUserCreateResponse, Integer, Hash)>] BeaconUserCreateResponse data, response status code and response headers
1737
+ def beacon_user_create_with_http_info(beacon_user_create_request, opts = {})
1738
+ if @api_client.config.debugging
1739
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_create ...'
1740
+ end
1741
+ # verify the required parameter 'beacon_user_create_request' is set
1742
+ if @api_client.config.client_side_validation && beacon_user_create_request.nil?
1743
+ fail ArgumentError, "Missing the required parameter 'beacon_user_create_request' when calling PlaidApi.beacon_user_create"
1744
+ end
1745
+ # resource path
1746
+ local_var_path = '/beacon/user/create'
1747
+
1748
+ # query parameters
1749
+ query_params = opts[:query_params] || {}
1750
+
1751
+ # header parameters
1752
+ header_params = opts[:header_params] || {}
1753
+ # HTTP header 'Accept' (if needed)
1754
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1755
+ # HTTP header 'Content-Type'
1756
+ content_type = @api_client.select_header_content_type(['application/json'])
1757
+ if !content_type.nil?
1758
+ header_params['Content-Type'] = content_type
1759
+ end
1760
+
1761
+ # form parameters
1762
+ form_params = opts[:form_params] || {}
1763
+
1764
+ # http body (model)
1765
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_create_request)
1766
+
1767
+ # return_type
1768
+ return_type = opts[:debug_return_type] || 'BeaconUserCreateResponse'
1769
+
1770
+ # auth_names
1771
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1772
+
1773
+ new_options = opts.merge(
1774
+ :operation => :"PlaidApi.beacon_user_create",
1775
+ :header_params => header_params,
1776
+ :query_params => query_params,
1777
+ :form_params => form_params,
1778
+ :body => post_body,
1779
+ :auth_names => auth_names,
1780
+ :return_type => return_type
1781
+ )
1782
+
1783
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1784
+ if @api_client.config.debugging
1785
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1786
+ end
1787
+ return data, status_code, headers
1788
+ end
1789
+
1790
+ # Get a Beacon User
1791
+ # Fetch a Beacon User. The Beacon User is returned with all of their associated information and a `status` based on the Beacon Network duplicate record and fraud checks.
1792
+ # @param beacon_user_get_request [BeaconUserGetRequest]
1793
+ # @param [Hash] opts the optional parameters
1794
+ # @return [BeaconUserGetResponse]
1795
+ def beacon_user_get(beacon_user_get_request, opts = {})
1796
+ data, _status_code, _headers = beacon_user_get_with_http_info(beacon_user_get_request, opts)
1797
+ data
1798
+ end
1799
+
1800
+ # Get a Beacon User
1801
+ # Fetch a Beacon User. The Beacon User is returned with all of their associated information and a &#x60;status&#x60; based on the Beacon Network duplicate record and fraud checks.
1802
+ # @param beacon_user_get_request [BeaconUserGetRequest]
1803
+ # @param [Hash] opts the optional parameters
1804
+ # @return [Array<(BeaconUserGetResponse, Integer, Hash)>] BeaconUserGetResponse data, response status code and response headers
1805
+ def beacon_user_get_with_http_info(beacon_user_get_request, opts = {})
1806
+ if @api_client.config.debugging
1807
+ @api_client.config.logger.debug 'Calling API: PlaidApi.beacon_user_get ...'
1808
+ end
1809
+ # verify the required parameter 'beacon_user_get_request' is set
1810
+ if @api_client.config.client_side_validation && beacon_user_get_request.nil?
1811
+ fail ArgumentError, "Missing the required parameter 'beacon_user_get_request' when calling PlaidApi.beacon_user_get"
1812
+ end
1813
+ # resource path
1814
+ local_var_path = '/beacon/user/get'
1815
+
1816
+ # query parameters
1817
+ query_params = opts[:query_params] || {}
1818
+
1819
+ # header parameters
1820
+ header_params = opts[:header_params] || {}
1821
+ # HTTP header 'Accept' (if needed)
1822
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1823
+ # HTTP header 'Content-Type'
1824
+ content_type = @api_client.select_header_content_type(['application/json'])
1825
+ if !content_type.nil?
1826
+ header_params['Content-Type'] = content_type
1827
+ end
1828
+
1829
+ # form parameters
1830
+ form_params = opts[:form_params] || {}
1831
+
1832
+ # http body (model)
1833
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(beacon_user_get_request)
1834
+
1835
+ # return_type
1836
+ return_type = opts[:debug_return_type] || 'BeaconUserGetResponse'
1837
+
1838
+ # auth_names
1839
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1840
+
1841
+ new_options = opts.merge(
1842
+ :operation => :"PlaidApi.beacon_user_get",
1843
+ :header_params => header_params,
1844
+ :query_params => query_params,
1845
+ :form_params => form_params,
1846
+ :body => post_body,
1847
+ :auth_names => auth_names,
1848
+ :return_type => return_type
1849
+ )
1850
+
1851
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1852
+ if @api_client.config.debugging
1853
+ @api_client.config.logger.debug "API called: PlaidApi#beacon_user_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1854
+ end
1855
+ return data, status_code, headers
1856
+ end
1857
+
1586
1858
  # Get categories
1587
1859
  # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer `personal_finance_category` taxonomy instead of the older `category` taxonomy supported by this endpoint. The [`personal_finance_category taxonomy` CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
1588
1860
  # @param body [Object]
@@ -1651,6 +1923,74 @@ module Plaid
1651
1923
  return data, status_code, headers
1652
1924
  end
1653
1925
 
1926
+ # Retrieve information from the bank accounts used for income verification
1927
+ # `/cra/bank_income/get` returns the bank income report(s) for a specified user.
1928
+ # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
1929
+ # @param [Hash] opts the optional parameters
1930
+ # @return [CraBankIncomeGetResponse]
1931
+ def cra_bank_income_get(cra_bank_income_get_request, opts = {})
1932
+ data, _status_code, _headers = cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts)
1933
+ data
1934
+ end
1935
+
1936
+ # Retrieve information from the bank accounts used for income verification
1937
+ # &#x60;/cra/bank_income/get&#x60; returns the bank income report(s) for a specified user.
1938
+ # @param cra_bank_income_get_request [CraBankIncomeGetRequest]
1939
+ # @param [Hash] opts the optional parameters
1940
+ # @return [Array<(CraBankIncomeGetResponse, Integer, Hash)>] CraBankIncomeGetResponse data, response status code and response headers
1941
+ def cra_bank_income_get_with_http_info(cra_bank_income_get_request, opts = {})
1942
+ if @api_client.config.debugging
1943
+ @api_client.config.logger.debug 'Calling API: PlaidApi.cra_bank_income_get ...'
1944
+ end
1945
+ # verify the required parameter 'cra_bank_income_get_request' is set
1946
+ if @api_client.config.client_side_validation && cra_bank_income_get_request.nil?
1947
+ fail ArgumentError, "Missing the required parameter 'cra_bank_income_get_request' when calling PlaidApi.cra_bank_income_get"
1948
+ end
1949
+ # resource path
1950
+ local_var_path = '/cra/bank_income/get'
1951
+
1952
+ # query parameters
1953
+ query_params = opts[:query_params] || {}
1954
+
1955
+ # header parameters
1956
+ header_params = opts[:header_params] || {}
1957
+ # HTTP header 'Accept' (if needed)
1958
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1959
+ # HTTP header 'Content-Type'
1960
+ content_type = @api_client.select_header_content_type(['application/json'])
1961
+ if !content_type.nil?
1962
+ header_params['Content-Type'] = content_type
1963
+ end
1964
+
1965
+ # form parameters
1966
+ form_params = opts[:form_params] || {}
1967
+
1968
+ # http body (model)
1969
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(cra_bank_income_get_request)
1970
+
1971
+ # return_type
1972
+ return_type = opts[:debug_return_type] || 'CraBankIncomeGetResponse'
1973
+
1974
+ # auth_names
1975
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1976
+
1977
+ new_options = opts.merge(
1978
+ :operation => :"PlaidApi.cra_bank_income_get",
1979
+ :header_params => header_params,
1980
+ :query_params => query_params,
1981
+ :form_params => form_params,
1982
+ :body => post_body,
1983
+ :auth_names => auth_names,
1984
+ :return_type => return_type
1985
+ )
1986
+
1987
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1988
+ if @api_client.config.debugging
1989
+ @api_client.config.logger.debug "API called: PlaidApi#cra_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1990
+ end
1991
+ return data, status_code, headers
1992
+ end
1993
+
1654
1994
  # Create payment token
1655
1995
  # The `/payment_initiation/payment/token/create` endpoint has been deprecated. New Plaid customers will be unable to use this endpoint, and existing customers are encouraged to migrate to the newer, `link_token`-based flow. The recommended flow is to provide the `payment_id` to `/link/token/create`, which returns a `link_token` used to initialize Link. The `/payment_initiation/payment/token/create` is used to create a `payment_token`, which can then be used in Link initialization to enter a payment initiation flow. You can only use a `payment_token` once. If this attempt fails, the end user aborts the flow, or the token expires, you will need to create a new payment token. Creating a new payment token does not require end user input.
1656
1996
  # @param payment_initiation_payment_token_create_request [PaymentInitiationPaymentTokenCreateRequest]
@@ -2199,17 +2539,17 @@ module Plaid
2199
2539
  # `/credit/bank_income/webhook/update` allows you to subscribe or unsubscribe a user for income webhook notifications. If a user is subscribed, on significant changes to the user's income profile, you will receive a `BANK_INCOME_REFRESH_UPDATE` webhook, prompting you to refresh bank income data for the user.
2200
2540
  # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
2201
2541
  # @param [Hash] opts the optional parameters
2202
- # @return [nil]
2542
+ # @return [CreditBankIncomeWebhookUpdateResponse]
2203
2543
  def credit_bank_income_webhook_update(credit_bank_income_webhook_update_request, opts = {})
2204
- credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts)
2205
- nil
2544
+ data, _status_code, _headers = credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts)
2545
+ data
2206
2546
  end
2207
2547
 
2208
2548
  # Subscribe and unsubscribe to proactive notifications for a user&#39;s income profile
2209
2549
  # &#x60;/credit/bank_income/webhook/update&#x60; allows you to subscribe or unsubscribe a user for income webhook notifications. If a user is subscribed, on significant changes to the user&#39;s income profile, you will receive a &#x60;BANK_INCOME_REFRESH_UPDATE&#x60; webhook, prompting you to refresh bank income data for the user.
2210
2550
  # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
2211
2551
  # @param [Hash] opts the optional parameters
2212
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2552
+ # @return [Array<(CreditBankIncomeWebhookUpdateResponse, Integer, Hash)>] CreditBankIncomeWebhookUpdateResponse data, response status code and response headers
2213
2553
  def credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts = {})
2214
2554
  if @api_client.config.debugging
2215
2555
  @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_webhook_update ...'
@@ -2241,7 +2581,7 @@ module Plaid
2241
2581
  post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_webhook_update_request)
2242
2582
 
2243
2583
  # return_type
2244
- return_type = opts[:debug_return_type]
2584
+ return_type = opts[:debug_return_type] || 'CreditBankIncomeWebhookUpdateResponse'
2245
2585
 
2246
2586
  # auth_names
2247
2587
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
@@ -2875,6 +3215,74 @@ module Plaid
2875
3215
  return data, status_code, headers
2876
3216
  end
2877
3217
 
3218
+ # Retrieve the pdf reports associated with a relay token that was shared with you (beta)
3219
+ # `/credit/relay/pdf/get` allows third parties to receive a pdf report that was shared with them, using a `relay_token` that was created by the report owner. The `/credit/relay/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/credit/relay/pdf/get`, you must first create the Asset Report using `/credit/relay/create` and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/credit/relay/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
3220
+ # @param credit_relay_pdf_get_request [CreditRelayPDFGetRequest]
3221
+ # @param [Hash] opts the optional parameters
3222
+ # @return [File]
3223
+ def credit_relay_pdf_get(credit_relay_pdf_get_request, opts = {})
3224
+ data, _status_code, _headers = credit_relay_pdf_get_with_http_info(credit_relay_pdf_get_request, opts)
3225
+ data
3226
+ end
3227
+
3228
+ # Retrieve the pdf reports associated with a relay token that was shared with you (beta)
3229
+ # &#x60;/credit/relay/pdf/get&#x60; allows third parties to receive a pdf report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner. The &#x60;/credit/relay/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/credit/relay/pdf/get&#x60;, you must first create the Asset Report using &#x60;/credit/relay/create&#x60; and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/credit/relay/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
3230
+ # @param credit_relay_pdf_get_request [CreditRelayPDFGetRequest]
3231
+ # @param [Hash] opts the optional parameters
3232
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
3233
+ def credit_relay_pdf_get_with_http_info(credit_relay_pdf_get_request, opts = {})
3234
+ if @api_client.config.debugging
3235
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_relay_pdf_get ...'
3236
+ end
3237
+ # verify the required parameter 'credit_relay_pdf_get_request' is set
3238
+ if @api_client.config.client_side_validation && credit_relay_pdf_get_request.nil?
3239
+ fail ArgumentError, "Missing the required parameter 'credit_relay_pdf_get_request' when calling PlaidApi.credit_relay_pdf_get"
3240
+ end
3241
+ # resource path
3242
+ local_var_path = '/credit/relay/pdf/get'
3243
+
3244
+ # query parameters
3245
+ query_params = opts[:query_params] || {}
3246
+
3247
+ # header parameters
3248
+ header_params = opts[:header_params] || {}
3249
+ # HTTP header 'Accept' (if needed)
3250
+ header_params['Accept'] = @api_client.select_header_accept(['application/pdf'])
3251
+ # HTTP header 'Content-Type'
3252
+ content_type = @api_client.select_header_content_type(['application/json'])
3253
+ if !content_type.nil?
3254
+ header_params['Content-Type'] = content_type
3255
+ end
3256
+
3257
+ # form parameters
3258
+ form_params = opts[:form_params] || {}
3259
+
3260
+ # http body (model)
3261
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_relay_pdf_get_request)
3262
+
3263
+ # return_type
3264
+ return_type = opts[:debug_return_type] || 'File'
3265
+
3266
+ # auth_names
3267
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3268
+
3269
+ new_options = opts.merge(
3270
+ :operation => :"PlaidApi.credit_relay_pdf_get",
3271
+ :header_params => header_params,
3272
+ :query_params => query_params,
3273
+ :form_params => form_params,
3274
+ :body => post_body,
3275
+ :auth_names => auth_names,
3276
+ :return_type => return_type
3277
+ )
3278
+
3279
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3280
+ if @api_client.config.debugging
3281
+ @api_client.config.logger.debug "API called: PlaidApi#credit_relay_pdf_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3282
+ end
3283
+ return data, status_code, headers
3284
+ end
3285
+
2878
3286
  # Refresh a report of a relay token (beta)
2879
3287
  # The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
2880
3288
  # @param credit_relay_refresh_request [CreditRelayRefreshRequest]
@@ -8315,8 +8723,76 @@ module Plaid
8315
8723
  return data, status_code, headers
8316
8724
  end
8317
8725
 
8726
+ # Update a processor token's webhook URL
8727
+ # This endpoint allows you to update the webhook URL associated with a processor token. This request triggers a `WEBHOOK_UPDATE_ACKNOWLEDGED` webhook to the newly specified webhook URL.
8728
+ # @param processor_token_webhook_update_request [ProcessorTokenWebhookUpdateRequest]
8729
+ # @param [Hash] opts the optional parameters
8730
+ # @return [ProcessorTokenWebhookUpdateResponse]
8731
+ def processor_token_webhook_update(processor_token_webhook_update_request, opts = {})
8732
+ data, _status_code, _headers = processor_token_webhook_update_with_http_info(processor_token_webhook_update_request, opts)
8733
+ data
8734
+ end
8735
+
8736
+ # Update a processor token&#39;s webhook URL
8737
+ # This endpoint allows you to update the webhook URL associated with a processor token. This request triggers a &#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60; webhook to the newly specified webhook URL.
8738
+ # @param processor_token_webhook_update_request [ProcessorTokenWebhookUpdateRequest]
8739
+ # @param [Hash] opts the optional parameters
8740
+ # @return [Array<(ProcessorTokenWebhookUpdateResponse, Integer, Hash)>] ProcessorTokenWebhookUpdateResponse data, response status code and response headers
8741
+ def processor_token_webhook_update_with_http_info(processor_token_webhook_update_request, opts = {})
8742
+ if @api_client.config.debugging
8743
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_webhook_update ...'
8744
+ end
8745
+ # verify the required parameter 'processor_token_webhook_update_request' is set
8746
+ if @api_client.config.client_side_validation && processor_token_webhook_update_request.nil?
8747
+ fail ArgumentError, "Missing the required parameter 'processor_token_webhook_update_request' when calling PlaidApi.processor_token_webhook_update"
8748
+ end
8749
+ # resource path
8750
+ local_var_path = '/processor/token/webhook/update'
8751
+
8752
+ # query parameters
8753
+ query_params = opts[:query_params] || {}
8754
+
8755
+ # header parameters
8756
+ header_params = opts[:header_params] || {}
8757
+ # HTTP header 'Accept' (if needed)
8758
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8759
+ # HTTP header 'Content-Type'
8760
+ content_type = @api_client.select_header_content_type(['application/json'])
8761
+ if !content_type.nil?
8762
+ header_params['Content-Type'] = content_type
8763
+ end
8764
+
8765
+ # form parameters
8766
+ form_params = opts[:form_params] || {}
8767
+
8768
+ # http body (model)
8769
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_webhook_update_request)
8770
+
8771
+ # return_type
8772
+ return_type = opts[:debug_return_type] || 'ProcessorTokenWebhookUpdateResponse'
8773
+
8774
+ # auth_names
8775
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8776
+
8777
+ new_options = opts.merge(
8778
+ :operation => :"PlaidApi.processor_token_webhook_update",
8779
+ :header_params => header_params,
8780
+ :query_params => query_params,
8781
+ :form_params => form_params,
8782
+ :body => post_body,
8783
+ :auth_names => auth_names,
8784
+ :return_type => return_type
8785
+ )
8786
+
8787
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8788
+ if @api_client.config.debugging
8789
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8790
+ end
8791
+ return data, status_code, headers
8792
+ end
8793
+
8318
8794
  # Get transaction data
8319
- # The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
8795
+ # The `/processor/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/processor/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/processor/transactions/get` will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the `/processor/transactions/refresh` endpoint. Note that data may not be immediately available to `/processor/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/processor/transactions/get`, if it wasn't. If no transaction history is ready when `/processor/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8320
8796
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
8321
8797
  # @param [Hash] opts the optional parameters
8322
8798
  # @return [ProcessorTransactionsGetResponse]
@@ -8326,7 +8802,7 @@ module Plaid
8326
8802
  end
8327
8803
 
8328
8804
  # Get transaction data
8329
- # The &#x60;/processor/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/processor/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/processor/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
8805
+ # The &#x60;/processor/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/processor/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with a processor token, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/processor/transactions/get&#x60; will be the data available for the processor token as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, you can use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/processor/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/processor/transactions/get&#x60;, if it wasn&#39;t. If no transaction history is ready when &#x60;/processor/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8330
8806
  # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
8331
8807
  # @param [Hash] opts the optional parameters
8332
8808
  # @return [Array<(ProcessorTransactionsGetResponse, Integer, Hash)>] ProcessorTransactionsGetResponse data, response status code and response headers
@@ -8384,7 +8860,7 @@ module Plaid
8384
8860
  end
8385
8861
 
8386
8862
  # Fetch recurring transaction streams
8387
- # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8863
+ # The `/processor/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/processor/transactions/get` or `/processor/transactions/sync`). Once all historical transactions have been fetched, call `/processor/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using `/processor/transactions/sync` listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the `historical_update_complete` field in the payload is `true`. If using `/processor/transactions/get`, listen for the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call `/processor/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8388
8864
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
8389
8865
  # @param [Hash] opts the optional parameters
8390
8866
  # @return [ProcessorTransactionsRecurringGetResponse]
@@ -8394,7 +8870,7 @@ module Plaid
8394
8870
  end
8395
8871
 
8396
8872
  # Fetch recurring transaction streams
8397
- # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8873
+ # The &#x60;/processor/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is offered as an add-on to Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on a processor token that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;). Once all historical transactions have been fetched, call &#x60;/processor/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. To know when historical transactions have been fetched, if you are using &#x60;/processor/transactions/sync&#x60; listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#SyncUpdatesAvailableWebhook-historical-update-complete) webhook and check that the &#x60;historical_update_complete&#x60; field in the payload is &#x60;true&#x60;. If using &#x60;/processor/transactions/get&#x60;, listen for the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook. After the initial call, you can call &#x60;/processor/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8398
8874
  # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
8399
8875
  # @param [Hash] opts the optional parameters
8400
8876
  # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
@@ -8452,7 +8928,7 @@ module Plaid
8452
8928
  end
8453
8929
 
8454
8930
  # Refresh transaction data
8455
- # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on an Item from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8931
+ # `/processor/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling `/processor/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/processor/transactions/sync` and `/processor/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/processor/transactions/get` or `/processor/transactions/sync`. Note that the `/processor/transactions/refresh` endpoint is not supported for Capital One (`ins_128026`) and will result in a `PRODUCT_NOT_SUPPORTED` error if called on a processor token from that institution. `/processor/transactions/refresh` is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8456
8932
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
8457
8933
  # @param [Hash] opts the optional parameters
8458
8934
  # @return [ProcessorTransactionsRefreshResponse]
@@ -8462,7 +8938,7 @@ module Plaid
8462
8938
  end
8463
8939
 
8464
8940
  # Refresh transaction data
8465
- # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on an Item from that institution. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8941
+ # &#x60;/processor/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for a processor token. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled processor token. If changes to transactions are discovered after calling &#x60;/processor/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/processor/transactions/sync&#x60; and &#x60;/processor/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/processor/transactions/get&#x60; or &#x60;/processor/transactions/sync&#x60;. Note that the &#x60;/processor/transactions/refresh&#x60; endpoint is not supported for Capital One (&#x60;ins_128026&#x60;) and will result in a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error if called on a processor token from that institution. &#x60;/processor/transactions/refresh&#x60; is offered as an add-on to Transactions and has a separate [fee model](/docs/account/billing/#per-request-flat-fee). To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager.
8466
8942
  # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
8467
8943
  # @param [Hash] opts the optional parameters
8468
8944
  # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
@@ -8519,8 +8995,8 @@ module Plaid
8519
8995
  return data, status_code, headers
8520
8996
  end
8521
8997
 
8522
- # Get incremental transaction updates on an Item
8523
- # This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
8998
+ # Get incremental transaction updates on a processor token
8999
+ # This endpoint replaces `/processor/transactions/get` and its associated webhooks for most common use-cases. The `/processor/transactions/sync` endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/processor/transactions/sync` provides the same functionality as `/processor/transactions/get` and can be used instead of `/processor/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/processor/transactions/sync` for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that processor token. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/processor/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/processor/transactions/sync` fails when retrieving a paginated update, which can occur as a result of the [`TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION`](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/processor/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the `/processor/transactions/refresh` endpoint. Note that for newly created processor tokens, data may not be immediately available to `/processor/transactions/sync`. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the [`/processor/token/webhook/update`](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8524
9000
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
8525
9001
  # @param [Hash] opts the optional parameters
8526
9002
  # @return [ProcessorTransactionsSyncResponse]
@@ -8529,8 +9005,8 @@ module Plaid
8529
9005
  data
8530
9006
  end
8531
9007
 
8532
- # Get incremental transaction updates on an Item
8533
- # This endpoint replaces &#x60;/processor/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/processor/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/processor/transactions/sync&#x60; provides the same functionality as &#x60;/processor/transactions/get&#x60; and can be used instead of &#x60;/processor/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/processor/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/processor/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update, which can occur as a result of the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/processor/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/processor/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available.
9008
+ # Get incremental transaction updates on a processor token
9009
+ # This endpoint replaces &#x60;/processor/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/processor/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with a processor token and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/processor/transactions/sync&#x60; provides the same functionality as &#x60;/processor/transactions/get&#x60; and can be used instead of &#x60;/processor/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/processor/transactions/sync&#x60; for a processor token, the endpoint will return all historical transactions data associated with that processor token up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that processor token. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with a processor token, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/processor/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/processor/transactions/sync&#x60; fails when retrieving a paginated update, which can occur as a result of the [&#x60;TRANSACTIONS_SYNC_MUTATION_DURING_PAGINATION&#x60;](https://plaid.com/docs/errors/transactions/#transactions_sync_mutation_during_pagination) error, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/processor/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. To force Plaid to check for new transactions, use the &#x60;/processor/transactions/refresh&#x60; endpoint. Note that for newly created processor tokens, data may not be immediately available to &#x60;/processor/transactions/sync&#x60;. Plaid begins preparing transactions data when the corresponding Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To receive Transactions webhooks for a processor token, set its webhook URL via the [&#x60;/processor/token/webhook/update&#x60;](https://plaid.com/docs/api/processors/#processortokenwebhookupdate) endpoint.
8534
9010
  # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
8535
9011
  # @param [Hash] opts the optional parameters
8536
9012
  # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
@@ -10151,6 +10627,142 @@ module Plaid
10151
10627
  return data, status_code, headers
10152
10628
  end
10153
10629
 
10630
+ # Retrieve a single statement.
10631
+ # The `/statements/download` endpoint retrieves a single statement.
10632
+ # @param statements_download_request [StatementsDownloadRequest]
10633
+ # @param [Hash] opts the optional parameters
10634
+ # @return [File]
10635
+ def statements_download(statements_download_request, opts = {})
10636
+ data, _status_code, _headers = statements_download_with_http_info(statements_download_request, opts)
10637
+ data
10638
+ end
10639
+
10640
+ # Retrieve a single statement.
10641
+ # The &#x60;/statements/download&#x60; endpoint retrieves a single statement.
10642
+ # @param statements_download_request [StatementsDownloadRequest]
10643
+ # @param [Hash] opts the optional parameters
10644
+ # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
10645
+ def statements_download_with_http_info(statements_download_request, opts = {})
10646
+ if @api_client.config.debugging
10647
+ @api_client.config.logger.debug 'Calling API: PlaidApi.statements_download ...'
10648
+ end
10649
+ # verify the required parameter 'statements_download_request' is set
10650
+ if @api_client.config.client_side_validation && statements_download_request.nil?
10651
+ fail ArgumentError, "Missing the required parameter 'statements_download_request' when calling PlaidApi.statements_download"
10652
+ end
10653
+ # resource path
10654
+ local_var_path = '/statements/download'
10655
+
10656
+ # query parameters
10657
+ query_params = opts[:query_params] || {}
10658
+
10659
+ # header parameters
10660
+ header_params = opts[:header_params] || {}
10661
+ # HTTP header 'Accept' (if needed)
10662
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10663
+ # HTTP header 'Content-Type'
10664
+ content_type = @api_client.select_header_content_type(['application/json'])
10665
+ if !content_type.nil?
10666
+ header_params['Content-Type'] = content_type
10667
+ end
10668
+
10669
+ # form parameters
10670
+ form_params = opts[:form_params] || {}
10671
+
10672
+ # http body (model)
10673
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_download_request)
10674
+
10675
+ # return_type
10676
+ return_type = opts[:debug_return_type] || 'File'
10677
+
10678
+ # auth_names
10679
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10680
+
10681
+ new_options = opts.merge(
10682
+ :operation => :"PlaidApi.statements_download",
10683
+ :header_params => header_params,
10684
+ :query_params => query_params,
10685
+ :form_params => form_params,
10686
+ :body => post_body,
10687
+ :auth_names => auth_names,
10688
+ :return_type => return_type
10689
+ )
10690
+
10691
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10692
+ if @api_client.config.debugging
10693
+ @api_client.config.logger.debug "API called: PlaidApi#statements_download\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10694
+ end
10695
+ return data, status_code, headers
10696
+ end
10697
+
10698
+ # Retrieve a list of all statements associated with the provided item.
10699
+ # The `/statements/list` endpoint retrieves a list of all statements associated with the provided item.
10700
+ # @param statements_list_request [StatementsListRequest]
10701
+ # @param [Hash] opts the optional parameters
10702
+ # @return [StatementsListResponse]
10703
+ def statements_list(statements_list_request, opts = {})
10704
+ data, _status_code, _headers = statements_list_with_http_info(statements_list_request, opts)
10705
+ data
10706
+ end
10707
+
10708
+ # Retrieve a list of all statements associated with the provided item.
10709
+ # The &#x60;/statements/list&#x60; endpoint retrieves a list of all statements associated with the provided item.
10710
+ # @param statements_list_request [StatementsListRequest]
10711
+ # @param [Hash] opts the optional parameters
10712
+ # @return [Array<(StatementsListResponse, Integer, Hash)>] StatementsListResponse data, response status code and response headers
10713
+ def statements_list_with_http_info(statements_list_request, opts = {})
10714
+ if @api_client.config.debugging
10715
+ @api_client.config.logger.debug 'Calling API: PlaidApi.statements_list ...'
10716
+ end
10717
+ # verify the required parameter 'statements_list_request' is set
10718
+ if @api_client.config.client_side_validation && statements_list_request.nil?
10719
+ fail ArgumentError, "Missing the required parameter 'statements_list_request' when calling PlaidApi.statements_list"
10720
+ end
10721
+ # resource path
10722
+ local_var_path = '/statements/list'
10723
+
10724
+ # query parameters
10725
+ query_params = opts[:query_params] || {}
10726
+
10727
+ # header parameters
10728
+ header_params = opts[:header_params] || {}
10729
+ # HTTP header 'Accept' (if needed)
10730
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10731
+ # HTTP header 'Content-Type'
10732
+ content_type = @api_client.select_header_content_type(['application/json'])
10733
+ if !content_type.nil?
10734
+ header_params['Content-Type'] = content_type
10735
+ end
10736
+
10737
+ # form parameters
10738
+ form_params = opts[:form_params] || {}
10739
+
10740
+ # http body (model)
10741
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(statements_list_request)
10742
+
10743
+ # return_type
10744
+ return_type = opts[:debug_return_type] || 'StatementsListResponse'
10745
+
10746
+ # auth_names
10747
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10748
+
10749
+ new_options = opts.merge(
10750
+ :operation => :"PlaidApi.statements_list",
10751
+ :header_params => header_params,
10752
+ :query_params => query_params,
10753
+ :form_params => form_params,
10754
+ :body => post_body,
10755
+ :auth_names => auth_names,
10756
+ :return_type => return_type
10757
+ )
10758
+
10759
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10760
+ if @api_client.config.debugging
10761
+ @api_client.config.logger.debug "API called: PlaidApi#statements_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10762
+ end
10763
+ return data, status_code, headers
10764
+ end
10765
+
10154
10766
  # enhance locally-held transaction data
10155
10767
  # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
10156
10768
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]