plaid 18.1.0 → 19.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1215) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +190 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +1212 -237
  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 +1 -1
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +1 -1
  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 +1 -1
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  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 +3 -3
  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_nullable.rb +1 -1
  37. data/lib/plaid/models/address_match_score.rb +2 -2
  38. data/lib/plaid/models/address_nullable.rb +1 -1
  39. data/lib/plaid/models/address_purpose_label.rb +1 -1
  40. data/lib/plaid/models/application.rb +1 -1
  41. data/lib/plaid/models/application_get_request.rb +1 -1
  42. data/lib/plaid/models/application_get_response.rb +1 -1
  43. data/lib/plaid/models/apr.rb +1 -1
  44. data/lib/plaid/models/asset.rb +1 -1
  45. data/lib/plaid/models/asset_detail.rb +1 -1
  46. data/lib/plaid/models/asset_holder.rb +1 -1
  47. data/lib/plaid/models/asset_holder_name.rb +1 -1
  48. data/lib/plaid/models/asset_owner.rb +1 -1
  49. data/lib/plaid/models/asset_owners.rb +1 -1
  50. data/lib/plaid/models/asset_report.rb +1 -1
  51. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  53. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  57. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  58. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  59. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  60. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  61. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  62. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  63. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  64. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  65. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  67. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  68. data/lib/plaid/models/asset_report_item.rb +1 -1
  69. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  71. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  72. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  73. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  75. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  76. data/lib/plaid/models/asset_report_transaction.rb +3 -3
  77. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  78. data/lib/plaid/models/asset_report_user.rb +1 -1
  79. data/lib/plaid/models/asset_transaction.rb +1 -1
  80. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  81. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  82. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  83. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  84. data/lib/plaid/models/asset_transactions.rb +1 -1
  85. data/lib/plaid/models/asset_type.rb +1 -1
  86. data/lib/plaid/models/assets.rb +1 -1
  87. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  88. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  89. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  90. data/lib/plaid/models/auth_get_request.rb +1 -1
  91. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  92. data/lib/plaid/models/auth_get_response.rb +1 -1
  93. data/lib/plaid/models/auth_metadata.rb +1 -1
  94. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  95. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  96. data/lib/plaid/models/bank_income_refresh_complete_result.rb +39 -0
  97. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +283 -0
  98. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +269 -0
  99. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  100. data/lib/plaid/models/bank_transfer.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  133. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  134. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  135. data/lib/plaid/models/categories_get_response.rb +1 -1
  136. data/lib/plaid/models/category.rb +1 -1
  137. data/lib/plaid/models/cause.rb +2 -2
  138. data/lib/plaid/models/cause_all_of.rb +1 -1
  139. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  140. data/lib/plaid/models/client_provided_enriched_transaction.rb +42 -2
  141. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  142. data/lib/plaid/models/client_provided_transaction.rb +42 -2
  143. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  144. data/lib/plaid/models/connected_application.rb +1 -1
  145. data/lib/plaid/models/counterparty.rb +1 -1
  146. data/lib/plaid/models/counterparty_type.rb +2 -1
  147. data/lib/plaid/models/country_code.rb +1 -1
  148. data/lib/plaid/models/credit1099.rb +1 -1
  149. data/lib/plaid/models/credit1099_filer.rb +1 -1
  150. data/lib/plaid/models/credit1099_payer.rb +1 -1
  151. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  152. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  153. data/lib/plaid/models/credit_ach_class.rb +40 -0
  154. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  155. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  156. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  157. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  158. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  159. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  160. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  161. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  162. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  163. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  164. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  165. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  166. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  167. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  168. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  169. data/lib/plaid/models/credit_bank_income.rb +1 -1
  170. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  171. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  172. data/lib/plaid/models/credit_bank_income_category.rb +2 -1
  173. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  174. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  175. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  176. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  177. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  178. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  179. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  180. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  181. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  182. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  183. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +5 -15
  184. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  185. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  186. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  187. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  188. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  189. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  190. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  191. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +260 -0
  192. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +235 -0
  193. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +265 -0
  194. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +285 -0
  195. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +254 -0
  196. data/lib/plaid/models/credit_bank_statement_upload_item.rb +262 -0
  197. data/lib/plaid/models/credit_bank_statement_upload_object.rb +269 -0
  198. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +243 -0
  199. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +245 -0
  200. data/lib/plaid/models/{transfer_expected_settlement_schedule_item.rb → credit_bank_statements_uploads_get_response.rb} +28 -26
  201. data/lib/plaid/models/credit_card_liability.rb +1 -1
  202. data/lib/plaid/models/credit_category.rb +1 -1
  203. data/lib/plaid/models/credit_document_metadata.rb +18 -7
  204. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  205. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  206. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  207. data/lib/plaid/models/credit_employment_item.rb +1 -1
  208. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  209. data/lib/plaid/models/credit_filter.rb +1 -1
  210. data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +1 -1
  211. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +1 -1
  212. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +1 -1
  213. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +1 -1
  214. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +1 -1
  215. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +1 -1
  216. data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +1 -1
  217. data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +1 -1
  218. data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +1 -1
  219. data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +1 -1
  220. data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +1 -1
  221. data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +1 -1
  222. data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +1 -1
  223. data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +1 -1
  224. data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +1 -1
  225. data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +1 -1
  226. data/lib/plaid/models/credit_freddie_mac_party_voa24.rb +1 -1
  227. data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +1 -1
  228. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  229. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  230. data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +1 -1
  231. data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +1 -1
  232. data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +1 -1
  233. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +1 -1
  234. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +1 -1
  235. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +1 -1
  236. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +1 -1
  237. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +1 -1
  238. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +1 -1
  239. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +1 -1
  240. data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +1 -1
  241. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +1 -1
  242. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  243. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  244. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  245. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  246. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  247. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  248. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  249. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  250. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  251. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  252. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  253. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  254. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  255. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  256. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  257. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +2 -2
  258. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +2 -2
  259. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  260. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  261. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  262. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  263. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  264. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  265. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  266. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  267. data/lib/plaid/models/credit_session.rb +1 -1
  268. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  269. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  270. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  271. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  272. data/lib/plaid/models/credit_session_document_income_result.rb +20 -5
  273. data/lib/plaid/models/credit_session_error.rb +1 -1
  274. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  275. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  276. data/lib/plaid/models/credit_session_results.rb +1 -1
  277. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  278. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  279. data/lib/plaid/models/credit_w2.rb +1 -1
  280. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  281. data/lib/plaid/models/dashboard_user.rb +1 -1
  282. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  283. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  284. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  285. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  286. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  287. data/lib/plaid/models/date_range.rb +1 -1
  288. data/lib/plaid/models/deductions.rb +1 -1
  289. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  290. data/lib/plaid/models/deductions_total.rb +1 -1
  291. data/lib/plaid/models/default_update_webhook.rb +1 -1
  292. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  293. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  294. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  295. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  296. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  297. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  298. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  299. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  300. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  301. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  302. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  303. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  304. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  305. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  306. data/lib/plaid/models/depository_filter.rb +1 -1
  307. data/lib/plaid/models/detailed_originator.rb +1 -1
  308. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  309. data/lib/plaid/models/doc_type.rb +1 -1
  310. data/lib/plaid/models/document_analysis.rb +1 -1
  311. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  312. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  313. data/lib/plaid/models/document_metadata.rb +2 -2
  314. data/lib/plaid/models/document_name_match_code.rb +1 -1
  315. data/lib/plaid/models/document_risk_signal.rb +1 -1
  316. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  317. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  318. data/lib/plaid/models/document_risk_summary.rb +1 -1
  319. data/lib/plaid/models/document_status.rb +1 -1
  320. data/lib/plaid/models/documentary_verification.rb +1 -1
  321. data/lib/plaid/models/documentary_verification_document.rb +2 -2
  322. data/lib/plaid/models/earnings.rb +1 -1
  323. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  324. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  325. data/lib/plaid/models/earnings_total.rb +1 -1
  326. data/lib/plaid/models/email.rb +1 -1
  327. data/lib/plaid/models/email_address_match_score.rb +2 -2
  328. data/lib/plaid/models/employee.rb +1 -1
  329. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  330. data/lib/plaid/models/employer.rb +1 -1
  331. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  332. data/lib/plaid/models/employer_verification.rb +1 -1
  333. data/lib/plaid/models/employers_search_request.rb +1 -1
  334. data/lib/plaid/models/employers_search_response.rb +1 -1
  335. data/lib/plaid/models/employment_details.rb +1 -1
  336. data/lib/plaid/models/employment_source_type.rb +1 -1
  337. data/lib/plaid/models/employment_verification.rb +1 -1
  338. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  339. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  340. data/lib/plaid/models/employment_verification_status.rb +1 -1
  341. data/lib/plaid/models/enhancements.rb +1 -1
  342. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  343. data/lib/plaid/models/enrichments.rb +1 -1
  344. data/lib/plaid/models/entity_document.rb +1 -1
  345. data/lib/plaid/models/entity_document_type.rb +1 -1
  346. data/lib/plaid/models/entity_screening_hit_analysis.rb +2 -2
  347. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  348. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  349. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  350. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  351. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  352. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  353. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  354. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  355. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  356. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  357. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  358. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  359. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  360. data/lib/plaid/models/entity_watchlist_screening.rb +2 -2
  361. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  362. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  363. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +2 -2
  364. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  365. data/lib/plaid/models/expiration_date.rb +1 -1
  366. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  367. data/lib/plaid/models/external_payment_options.rb +1 -1
  368. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  369. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  370. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  371. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  372. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  373. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  374. data/lib/plaid/models/fdx_content_types.rb +1 -1
  375. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  376. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  377. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +228 -0
  378. data/lib/plaid/models/fdx_notification.rb +1 -1
  379. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  380. data/lib/plaid/models/fdx_notification_payload.rb +5 -3
  381. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  382. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  383. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  384. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  385. data/lib/plaid/models/fdx_party.rb +1 -1
  386. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  387. data/lib/plaid/models/fdx_party_type.rb +1 -1
  388. data/lib/plaid/models/fdxfi_attribute.rb +11 -1
  389. data/lib/plaid/models/form1099_type.rb +1 -1
  390. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  391. data/lib/plaid/models/health_incident.rb +1 -1
  392. data/lib/plaid/models/historical_balance.rb +1 -1
  393. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  394. data/lib/plaid/models/holding.rb +1 -1
  395. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  396. data/lib/plaid/models/holdings_override.rb +1 -1
  397. data/lib/plaid/models/id_number_type.rb +1 -1
  398. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  399. data/lib/plaid/models/identity_get_request.rb +1 -1
  400. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  401. data/lib/plaid/models/identity_get_response.rb +1 -1
  402. data/lib/plaid/models/identity_match_request.rb +2 -12
  403. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  404. data/lib/plaid/models/identity_match_response.rb +1 -1
  405. data/lib/plaid/models/identity_match_user.rb +2 -2
  406. data/lib/plaid/models/identity_refresh_request.rb +245 -0
  407. data/lib/plaid/models/identity_refresh_response.rb +225 -0
  408. data/lib/plaid/models/identity_update_types.rb +1 -1
  409. data/lib/plaid/models/identity_verification.rb +13 -3
  410. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  411. data/lib/plaid/models/identity_verification_create_response.rb +13 -3
  412. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  413. data/lib/plaid/models/identity_verification_get_response.rb +13 -3
  414. data/lib/plaid/models/identity_verification_list_request.rb +2 -2
  415. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  416. data/lib/plaid/models/identity_verification_request_user.rb +3 -3
  417. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  418. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  419. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  420. data/lib/plaid/models/identity_verification_retry_request.rb +2 -2
  421. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  422. data/lib/plaid/models/identity_verification_retry_response.rb +13 -3
  423. data/lib/plaid/models/identity_verification_status.rb +1 -1
  424. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  425. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  426. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  427. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  428. data/lib/plaid/models/identity_verification_template_reference.rb +2 -2
  429. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  430. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  431. data/lib/plaid/models/image_quality.rb +1 -1
  432. data/lib/plaid/models/incident_update.rb +1 -1
  433. data/lib/plaid/models/income_breakdown.rb +1 -1
  434. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  435. data/lib/plaid/models/income_override.rb +1 -1
  436. data/lib/plaid/models/income_summary.rb +1 -1
  437. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  438. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  439. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  440. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  441. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  442. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  443. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  444. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  445. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  446. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  447. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  448. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  449. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  450. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  451. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  452. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  453. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  454. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  455. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +289 -0
  456. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  457. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  458. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  459. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  460. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  461. data/lib/plaid/models/individual_name.rb +1 -1
  462. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  463. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  464. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  465. data/lib/plaid/models/inflow_model.rb +1 -1
  466. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  467. data/lib/plaid/models/institution.rb +2 -2
  468. data/lib/plaid/models/institution_status.rb +1 -1
  469. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  470. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  471. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  472. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  473. data/lib/plaid/models/institutions_get_request.rb +1 -1
  474. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  475. data/lib/plaid/models/institutions_get_response.rb +1 -1
  476. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  477. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  478. data/lib/plaid/models/institutions_search_request.rb +1 -1
  479. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  480. data/lib/plaid/models/institutions_search_response.rb +1 -1
  481. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  482. data/lib/plaid/models/investment_filter.rb +1 -1
  483. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  484. data/lib/plaid/models/investment_transaction.rb +1 -1
  485. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  486. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  487. data/lib/plaid/models/investments_auth_get_numbers.rb +221 -0
  488. data/lib/plaid/models/investments_auth_get_request.rb +254 -0
  489. data/lib/plaid/models/investments_auth_get_request_options.rb +222 -0
  490. data/lib/plaid/models/investments_auth_get_response.rb +321 -0
  491. data/lib/plaid/models/investments_auth_owner.rb +232 -0
  492. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  493. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  494. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  495. data/lib/plaid/models/investments_refresh_request.rb +245 -0
  496. data/lib/plaid/models/investments_refresh_response.rb +225 -0
  497. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  498. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  499. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  500. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  501. data/lib/plaid/models/issuing_country.rb +1 -1
  502. data/lib/plaid/models/item.rb +3 -3
  503. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  504. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  505. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  506. data/lib/plaid/models/item_activity_list_response.rb +6 -1
  507. data/lib/plaid/models/item_application_list_request.rb +1 -1
  508. data/lib/plaid/models/item_application_list_response.rb +1 -1
  509. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  510. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  511. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  512. data/lib/plaid/models/item_error_webhook.rb +1 -1
  513. data/lib/plaid/models/item_get_request.rb +1 -1
  514. data/lib/plaid/models/item_get_response.rb +1 -1
  515. data/lib/plaid/models/item_import_request.rb +1 -1
  516. data/lib/plaid/models/item_import_request_options.rb +1 -1
  517. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  518. data/lib/plaid/models/item_import_response.rb +1 -1
  519. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  520. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  521. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  522. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  523. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  524. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  525. data/lib/plaid/models/item_remove_request.rb +1 -1
  526. data/lib/plaid/models/item_remove_response.rb +1 -1
  527. data/lib/plaid/models/item_status.rb +1 -1
  528. data/lib/plaid/models/item_status_investments.rb +1 -1
  529. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  530. data/lib/plaid/models/item_status_nullable.rb +1 -1
  531. data/lib/plaid/models/item_status_transactions.rb +1 -1
  532. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  533. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  534. data/lib/plaid/models/jwk_public_key.rb +1 -1
  535. data/lib/plaid/models/jwt_header.rb +1 -1
  536. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  537. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  538. data/lib/plaid/models/kyc_check_details.rb +1 -1
  539. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  540. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  541. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  542. data/lib/plaid/models/last_data_access_times.rb +1 -1
  543. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  544. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  545. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  546. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  547. data/lib/plaid/models/liabilities_object.rb +1 -1
  548. data/lib/plaid/models/liability_override.rb +1 -1
  549. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  550. data/lib/plaid/models/link_delivery_account.rb +1 -1
  551. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  552. data/lib/plaid/models/link_delivery_communication_method.rb +2 -2
  553. data/lib/plaid/models/link_delivery_create_request.rb +2 -2
  554. data/lib/plaid/models/link_delivery_create_response.rb +3 -3
  555. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  556. data/lib/plaid/models/link_delivery_get_request.rb +2 -2
  557. data/lib/plaid/models/link_delivery_get_response.rb +5 -5
  558. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  559. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  560. data/lib/plaid/models/link_delivery_options.rb +2 -2
  561. data/lib/plaid/models/link_delivery_recipient.rb +2 -2
  562. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  563. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  564. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  565. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +3 -3
  566. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +3 -3
  567. data/lib/plaid/models/link_event.rb +255 -0
  568. data/lib/plaid/models/link_event_metadata.rb +365 -0
  569. data/lib/plaid/models/link_event_name.rb +1 -1
  570. data/lib/plaid/models/link_events_webhook.rb +287 -0
  571. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  572. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  573. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  574. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  575. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  576. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  577. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  578. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  579. data/lib/plaid/models/link_token_create_request.rb +27 -6
  580. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  581. data/lib/plaid/models/link_token_create_request_auth.rb +24 -2
  582. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  583. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  584. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  585. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  586. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  587. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  588. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  589. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  590. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  591. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  592. data/lib/plaid/models/link_token_create_request_user.rb +5 -7
  593. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  594. data/lib/plaid/models/link_token_create_response.rb +1 -1
  595. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  596. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  597. data/lib/plaid/models/link_token_get_request.rb +1 -1
  598. data/lib/plaid/models/link_token_get_response.rb +1 -1
  599. data/lib/plaid/models/link_token_investments.rb +1 -1
  600. data/lib/plaid/models/link_token_investments_auth.rb +236 -0
  601. data/lib/plaid/models/link_user_delivery_status_webhook.rb +2 -2
  602. data/lib/plaid/models/loan.rb +1 -1
  603. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  604. data/lib/plaid/models/loan_filter.rb +1 -1
  605. data/lib/plaid/models/loan_identifier.rb +1 -1
  606. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  607. data/lib/plaid/models/loan_identifiers.rb +1 -1
  608. data/lib/plaid/models/loans.rb +1 -1
  609. data/lib/plaid/models/location.rb +1 -1
  610. data/lib/plaid/models/match_summary.rb +1 -1
  611. data/lib/plaid/models/match_summary_code.rb +1 -1
  612. data/lib/plaid/models/meta.rb +1 -1
  613. data/lib/plaid/models/mfa.rb +1 -1
  614. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  615. data/lib/plaid/models/mortgage_liability.rb +1 -1
  616. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  617. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  618. data/lib/plaid/models/name_match_score.rb +2 -2
  619. data/lib/plaid/models/net_pay.rb +1 -1
  620. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  621. data/lib/plaid/models/numbers.rb +1 -1
  622. data/lib/plaid/models/numbers_acats.rb +257 -0
  623. data/lib/plaid/models/numbers_ach.rb +1 -1
  624. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  625. data/lib/plaid/models/numbers_bacs.rb +1 -1
  626. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  627. data/lib/plaid/models/numbers_eft.rb +1 -1
  628. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  629. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  630. data/lib/plaid/models/numbers_international.rb +1 -1
  631. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  632. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  633. data/lib/plaid/models/originator.rb +1 -1
  634. data/lib/plaid/models/originator_expected_transfer_frequency.rb +41 -0
  635. data/lib/plaid/models/override_account_type.rb +1 -1
  636. data/lib/plaid/models/override_accounts.rb +1 -1
  637. data/lib/plaid/models/owner.rb +1 -1
  638. data/lib/plaid/models/owner_override.rb +1 -1
  639. data/lib/plaid/models/ownership_type.rb +1 -1
  640. data/lib/plaid/models/parties.rb +1 -1
  641. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  642. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  643. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  644. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  645. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  646. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  647. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  648. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  649. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  650. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  651. data/lib/plaid/models/partner_end_customer.rb +1 -1
  652. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  653. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  654. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  655. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  656. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  657. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  658. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  659. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  660. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  661. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  662. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  663. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  664. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  665. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  666. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  667. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  668. data/lib/plaid/models/party.rb +1 -1
  669. data/lib/plaid/models/party_individual.rb +1 -1
  670. data/lib/plaid/models/party_role_type.rb +1 -1
  671. data/lib/plaid/models/pay.rb +1 -1
  672. data/lib/plaid/models/pay_frequency.rb +1 -1
  673. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  674. data/lib/plaid/models/pay_period_details.rb +1 -1
  675. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  676. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  677. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  678. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  679. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  680. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  681. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  682. data/lib/plaid/models/payment_amount.rb +1 -1
  683. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  684. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  685. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  686. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  687. data/lib/plaid/models/payment_channel.rb +1 -1
  688. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  689. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  690. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  691. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  692. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  693. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  694. data/lib/plaid/models/payment_initiation_address.rb +2 -2
  695. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  696. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  697. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  698. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  699. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  700. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  701. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  702. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  703. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  704. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  705. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  706. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  707. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  708. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  709. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  710. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  711. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  712. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  713. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  714. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  715. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  716. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  717. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  718. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  719. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  720. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  721. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  722. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  723. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  724. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  725. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  726. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  727. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  728. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  729. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  730. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  731. data/lib/plaid/models/payment_meta.rb +1 -1
  732. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  733. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  734. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  735. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  736. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  737. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  738. data/lib/plaid/models/payment_profile_status.rb +1 -1
  739. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  740. data/lib/plaid/models/payment_scheme.rb +1 -1
  741. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  742. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  743. data/lib/plaid/models/payroll_income_object.rb +1 -1
  744. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  745. data/lib/plaid/models/payroll_item.rb +1 -1
  746. data/lib/plaid/models/payroll_item_status.rb +1 -1
  747. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  748. data/lib/plaid/models/paystub.rb +1 -1
  749. data/lib/plaid/models/paystub_address.rb +1 -1
  750. data/lib/plaid/models/paystub_deduction.rb +1 -1
  751. data/lib/plaid/models/paystub_details.rb +1 -1
  752. data/lib/plaid/models/paystub_employer.rb +1 -1
  753. data/lib/plaid/models/paystub_override.rb +1 -1
  754. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  755. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  756. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  757. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  758. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  759. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  760. data/lib/plaid/models/personal_finance_category.rb +1 -1
  761. data/lib/plaid/models/phone_number.rb +1 -1
  762. data/lib/plaid/models/phone_number_match_score.rb +2 -2
  763. data/lib/plaid/models/phone_type.rb +1 -1
  764. data/lib/plaid/models/physical_document_category.rb +1 -1
  765. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  766. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  767. data/lib/plaid/models/physical_document_images.rb +1 -1
  768. data/lib/plaid/models/plaid_error.rb +2 -2
  769. data/lib/plaid/models/plaid_error_type.rb +1 -1
  770. data/lib/plaid/models/platform_ids.rb +1 -1
  771. data/lib/plaid/models/po_box_status.rb +1 -1
  772. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  773. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  774. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  775. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  776. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  777. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  778. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  779. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  780. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  781. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  782. data/lib/plaid/models/processor_identity_match_request.rb +254 -0
  783. data/lib/plaid/models/processor_identity_match_response.rb +239 -0
  784. data/lib/plaid/models/processor_number.rb +1 -1
  785. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  786. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  787. data/lib/plaid/models/processor_signal_evaluate_request.rb +1 -1
  788. data/lib/plaid/models/processor_signal_evaluate_response.rb +17 -5
  789. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  790. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  791. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  792. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  793. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  794. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  795. data/lib/plaid/models/processor_token_permissions_get_request.rb +245 -0
  796. data/lib/plaid/models/processor_token_permissions_get_response.rb +242 -0
  797. data/lib/plaid/models/processor_token_permissions_set_request.rb +262 -0
  798. data/lib/plaid/models/processor_token_permissions_set_response.rb +225 -0
  799. data/lib/plaid/models/processor_transactions_get_request.rb +284 -0
  800. data/lib/plaid/models/processor_transactions_get_response.rb +288 -0
  801. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +271 -0
  802. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +274 -0
  803. data/lib/plaid/models/processor_transactions_refresh_request.rb +245 -0
  804. data/lib/plaid/models/processor_transactions_refresh_response.rb +225 -0
  805. data/lib/plaid/models/processor_transactions_sync_request.rb +302 -0
  806. data/lib/plaid/models/processor_transactions_sync_response.rb +306 -0
  807. data/lib/plaid/models/product_access.rb +1 -1
  808. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +269 -0
  809. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +269 -0
  810. data/lib/plaid/models/product_status.rb +1 -1
  811. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  812. data/lib/plaid/models/products.rb +2 -1
  813. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  814. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  815. data/lib/plaid/models/proxy_type.rb +1 -1
  816. data/lib/plaid/models/pslf_status.rb +3 -3
  817. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  818. data/lib/plaid/models/recipient_bacs.rb +1 -1
  819. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  820. data/lib/plaid/models/recurrence.rb +1 -1
  821. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  822. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  823. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  824. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  825. data/lib/plaid/models/recurring_transfer.rb +1 -1
  826. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  827. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  828. data/lib/plaid/models/removed_transaction.rb +1 -1
  829. data/lib/plaid/models/report_type.rb +1 -1
  830. data/lib/plaid/models/reporting_information.rb +1 -1
  831. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  832. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  833. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  834. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  835. data/lib/plaid/models/risk_check_details.rb +1 -1
  836. data/lib/plaid/models/risk_check_device.rb +1 -1
  837. data/lib/plaid/models/risk_check_email.rb +2 -1
  838. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  839. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  840. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  841. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  842. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  843. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  844. data/lib/plaid/models/risk_check_phone.rb +2 -1
  845. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  846. data/lib/plaid/models/role.rb +1 -1
  847. data/lib/plaid/models/role_detail.rb +1 -1
  848. data/lib/plaid/models/roles.rb +1 -1
  849. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  850. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  851. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  852. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  853. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  854. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  855. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  856. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  857. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  858. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  859. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  860. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  861. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  862. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  863. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  864. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  865. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  866. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  867. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  868. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  869. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  870. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  871. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  872. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  873. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  874. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  875. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  876. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  877. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +13 -2
  878. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  879. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +16 -5
  880. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  881. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  882. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  883. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +3 -7
  884. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  885. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  886. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  887. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  888. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  889. data/lib/plaid/models/scopes.rb +1 -1
  890. data/lib/plaid/models/scopes_context.rb +1 -1
  891. data/lib/plaid/models/scopes_nullable.rb +1 -1
  892. data/lib/plaid/models/screening_hit_analysis.rb +2 -2
  893. data/lib/plaid/models/screening_hit_data.rb +1 -1
  894. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  895. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  896. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  897. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  898. data/lib/plaid/models/security.rb +1 -1
  899. data/lib/plaid/models/security_override.rb +1 -1
  900. data/lib/plaid/models/selfie_analysis.rb +224 -0
  901. data/lib/plaid/models/selfie_analysis_document_comparison.rb +40 -0
  902. data/lib/plaid/models/selfie_capture.rb +232 -0
  903. data/lib/plaid/models/selfie_check.rb +241 -0
  904. data/lib/plaid/models/selfie_check_selfie.rb +267 -0
  905. data/lib/plaid/models/selfie_check_status.rb +39 -0
  906. data/lib/plaid/models/selfie_status.rb +39 -0
  907. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  908. data/lib/plaid/models/service.rb +1 -1
  909. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  910. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  911. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  912. data/lib/plaid/models/servicer_address_data.rb +1 -1
  913. data/lib/plaid/models/services.rb +1 -1
  914. data/lib/plaid/models/signal_address_data.rb +1 -1
  915. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  916. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  917. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  918. data/lib/plaid/models/signal_device.rb +1 -1
  919. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  920. data/lib/plaid/models/signal_evaluate_request.rb +1 -1
  921. data/lib/plaid/models/signal_evaluate_response.rb +7 -2
  922. data/lib/plaid/models/signal_payment_method.rb +1 -1
  923. data/lib/plaid/models/signal_person_name.rb +1 -1
  924. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  925. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  926. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  927. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  928. data/lib/plaid/models/signal_scores.rb +1 -1
  929. data/lib/plaid/models/signal_user.rb +1 -1
  930. data/lib/plaid/models/signal_warning.rb +4 -4
  931. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  932. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  933. data/lib/plaid/models/source.rb +1 -1
  934. data/lib/plaid/models/standalone_account_type.rb +1 -1
  935. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  936. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  937. data/lib/plaid/models/status.rb +1 -1
  938. data/lib/plaid/models/statuses.rb +1 -1
  939. data/lib/plaid/models/strategy.rb +1 -1
  940. data/lib/plaid/models/student_loan.rb +1 -1
  941. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  942. data/lib/plaid/models/student_loan_status.rb +1 -1
  943. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  944. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  945. data/lib/plaid/models/taxform.rb +1 -1
  946. data/lib/plaid/models/taxpayer_id.rb +1 -1
  947. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  948. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  949. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  950. data/lib/plaid/models/total.rb +1 -1
  951. data/lib/plaid/models/total_canonical_description.rb +1 -1
  952. data/lib/plaid/models/transaction.rb +3 -3
  953. data/lib/plaid/models/transaction_all_of.rb +1 -1
  954. data/lib/plaid/models/transaction_base.rb +3 -3
  955. data/lib/plaid/models/transaction_code.rb +1 -1
  956. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  957. data/lib/plaid/models/transaction_data.rb +1 -1
  958. data/lib/plaid/models/transaction_override.rb +1 -1
  959. data/lib/plaid/models/transaction_stream.rb +3 -3
  960. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  961. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  962. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  963. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  964. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  965. data/lib/plaid/models/transactions_enrich_get_request.rb +1 -1
  966. data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
  967. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  968. data/lib/plaid/models/transactions_get_request.rb +1 -1
  969. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  970. data/lib/plaid/models/transactions_get_response.rb +1 -1
  971. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  972. data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
  973. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  974. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  975. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  976. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  977. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  978. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  979. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  980. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  981. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  982. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  983. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  984. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  985. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  986. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  987. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  988. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  989. data/lib/plaid/models/transfer.rb +20 -25
  990. data/lib/plaid/models/transfer_authorization.rb +1 -1
  991. data/lib/plaid/models/transfer_authorization_create_request.rb +19 -9
  992. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  993. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  994. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  995. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  996. data/lib/plaid/models/transfer_authorization_device.rb +3 -3
  997. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  998. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  999. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1000. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +18 -12
  1001. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1002. data/lib/plaid/models/transfer_balance.rb +239 -0
  1003. data/lib/plaid/models/transfer_balance_get_request.rb +244 -0
  1004. data/lib/plaid/models/transfer_balance_get_response.rb +239 -0
  1005. data/lib/plaid/models/transfer_balance_type.rb +39 -0
  1006. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1007. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1008. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1009. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1010. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1011. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1012. data/lib/plaid/models/transfer_configuration_get_response.rb +1 -1
  1013. data/lib/plaid/models/transfer_create_request.rb +22 -11
  1014. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1015. data/lib/plaid/models/transfer_credit_funds_source.rb +41 -0
  1016. data/lib/plaid/models/transfer_credit_usage_configuration.rb +286 -0
  1017. data/lib/plaid/models/transfer_debit_usage_configuration.rb +286 -0
  1018. data/lib/plaid/models/transfer_device.rb +1 -1
  1019. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1020. data/lib/plaid/models/transfer_diligence_submit_request.rb +259 -0
  1021. data/lib/plaid/models/transfer_diligence_submit_response.rb +225 -0
  1022. data/lib/plaid/models/transfer_event.rb +3 -7
  1023. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1024. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1025. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1026. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1027. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1028. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1029. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1030. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +240 -0
  1031. data/lib/plaid/models/transfer_failure.rb +1 -1
  1032. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1033. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1034. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1035. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1036. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1037. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1038. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1039. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1040. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1041. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1042. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1043. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1044. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1045. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1046. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1047. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1048. data/lib/plaid/models/transfer_metrics_get_response.rb +1 -1
  1049. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1050. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1051. data/lib/plaid/models/transfer_network.rb +1 -1
  1052. data/lib/plaid/models/transfer_originator_address.rb +281 -0
  1053. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1054. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1055. data/lib/plaid/models/transfer_originator_diligence.rb +355 -0
  1056. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1057. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1058. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1059. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1060. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1061. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1062. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1063. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1064. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
  1065. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1066. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1067. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1068. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1069. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1070. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1071. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1072. data/lib/plaid/models/transfer_refund.rb +1 -1
  1073. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1074. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1075. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1076. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1077. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1078. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1079. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1080. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1081. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1082. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1083. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1084. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1085. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1086. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1087. data/lib/plaid/models/transfer_status.rb +1 -1
  1088. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1089. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  1090. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1091. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  1092. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1093. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1094. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1095. data/lib/plaid/models/transfer_type.rb +1 -1
  1096. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1097. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1098. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1099. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1100. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1101. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1102. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1103. data/lib/plaid/models/user_address.rb +1 -1
  1104. data/lib/plaid/models/user_create_request.rb +1 -1
  1105. data/lib/plaid/models/user_create_response.rb +1 -1
  1106. data/lib/plaid/models/user_custom_password.rb +1 -1
  1107. data/lib/plaid/models/user_id_number.rb +1 -1
  1108. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  1109. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1110. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1111. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1112. data/lib/plaid/models/validation_source.rb +1 -1
  1113. data/lib/plaid/models/validation_sources.rb +1 -1
  1114. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1115. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1116. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1117. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1118. data/lib/plaid/models/verification_status.rb +1 -1
  1119. data/lib/plaid/models/w2.rb +1 -1
  1120. data/lib/plaid/models/w2_box12.rb +1 -1
  1121. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1122. data/lib/plaid/models/wallet.rb +1 -1
  1123. data/lib/plaid/models/wallet_balance.rb +1 -1
  1124. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1125. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1126. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1127. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1128. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1129. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1130. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1131. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1132. data/lib/plaid/models/wallet_payment_scheme.rb +41 -0
  1133. data/lib/plaid/models/wallet_status.rb +1 -1
  1134. data/lib/plaid/models/wallet_transaction.rb +12 -2
  1135. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1136. data/lib/plaid/models/wallet_transaction_counterparty.rb +26 -5
  1137. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1138. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1139. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1140. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1141. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1142. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1143. data/lib/plaid/models/wallet_transaction_get_response.rb +12 -2
  1144. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1145. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1146. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1147. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1148. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1149. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1150. data/lib/plaid/models/warning.rb +1 -1
  1151. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1152. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1153. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1154. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +2 -2
  1155. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +2 -2
  1156. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1157. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +2 -2
  1158. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1159. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1160. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1161. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1162. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +2 -2
  1163. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1164. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1165. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1166. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1167. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1168. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1169. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1170. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1171. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1172. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +2 -2
  1173. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1174. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +2 -2
  1175. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1176. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1177. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1178. data/lib/plaid/models/watchlist_screening_individual.rb +2 -2
  1179. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +2 -2
  1180. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +2 -2
  1181. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1182. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +2 -2
  1183. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1184. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1185. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1186. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1187. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +2 -2
  1188. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1189. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1190. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1191. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1192. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1193. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1194. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1195. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1196. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1197. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +2 -2
  1198. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1199. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +2 -2
  1200. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1201. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1202. data/lib/plaid/models/watchlist_screening_search_terms.rb +2 -2
  1203. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1204. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1205. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1206. data/lib/plaid/models/webhook_type.rb +2 -1
  1207. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1208. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1209. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1210. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1211. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1212. data/lib/plaid/version.rb +2 -2
  1213. data/lib/plaid.rb +68 -2
  1214. data/plaid.gemspec +1 -1
  1215. metadata +69 -3
@@ -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.345.1
6
+ The version of the OpenAPI document: 2020-09-14_1.379.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -605,7 +605,7 @@ module Plaid
605
605
  end
606
606
 
607
607
  # Retrieve a PDF Asset Report
608
- # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/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. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. 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. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
608
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/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. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. 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. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
609
609
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
610
610
  # @param [Hash] opts the optional parameters
611
611
  # @return [File]
@@ -615,7 +615,7 @@ module Plaid
615
615
  end
616
616
 
617
617
  # Retrieve a PDF Asset Report
618
- # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/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. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. 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. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
618
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/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. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. 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. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
619
619
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
620
620
  # @param [Hash] opts the optional parameters
621
621
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -1514,8 +1514,8 @@ module Plaid
1514
1514
  return data, status_code, headers
1515
1515
  end
1516
1516
 
1517
- # Get Categories
1518
- # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1517
+ # Get categories
1518
+ # 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.
1519
1519
  # @param body [Object]
1520
1520
  # @param [Hash] opts the optional parameters
1521
1521
  # @return [CategoriesGetResponse]
@@ -1524,8 +1524,8 @@ module Plaid
1524
1524
  data
1525
1525
  end
1526
1526
 
1527
- # Get Categories
1528
- # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1527
+ # Get categories
1528
+ # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication. All implementations are recommended to use the newer &#x60;personal_finance_category&#x60; taxonomy instead of the older &#x60;category&#x60; taxonomy supported by this endpoint. The [&#x60;personal_finance_category taxonomy&#x60; CSV file](https://plaid.com/documents/transactions-personal-finance-category-taxonomy.csv) is available for download and is not accessible via API.
1529
1529
  # @param body [Object]
1530
1530
  # @param [Hash] opts the optional parameters
1531
1531
  # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
@@ -2036,26 +2036,26 @@ module Plaid
2036
2036
 
2037
2037
  # Refresh a user's bank income information
2038
2038
  # `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
2039
- # @param request_body [Hash<String, Object>]
2039
+ # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
2040
2040
  # @param [Hash] opts the optional parameters
2041
2041
  # @return [CreditBankIncomeRefreshResponse]
2042
- def credit_bank_income_refresh(request_body, opts = {})
2043
- data, _status_code, _headers = credit_bank_income_refresh_with_http_info(request_body, opts)
2042
+ def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
2043
+ data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
2044
2044
  data
2045
2045
  end
2046
2046
 
2047
2047
  # Refresh a user&#39;s bank income information
2048
2048
  # &#x60;/credit/bank_income/refresh&#x60; refreshes the bank income report data for a specific user.
2049
- # @param request_body [Hash<String, Object>]
2049
+ # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
2050
2050
  # @param [Hash] opts the optional parameters
2051
2051
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
2052
- def credit_bank_income_refresh_with_http_info(request_body, opts = {})
2052
+ def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
2053
2053
  if @api_client.config.debugging
2054
2054
  @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
2055
2055
  end
2056
- # verify the required parameter 'request_body' is set
2057
- if @api_client.config.client_side_validation && request_body.nil?
2058
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_bank_income_refresh"
2056
+ # verify the required parameter 'credit_bank_income_refresh_request' is set
2057
+ if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
2058
+ fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
2059
2059
  end
2060
2060
  # resource path
2061
2061
  local_var_path = '/credit/bank_income/refresh'
@@ -2074,7 +2074,7 @@ module Plaid
2074
2074
  form_params = opts[:form_params] || {}
2075
2075
 
2076
2076
  # http body (model)
2077
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
2077
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)
2078
2078
 
2079
2079
  # return_type
2080
2080
  return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
@@ -2099,6 +2099,136 @@ module Plaid
2099
2099
  return data, status_code, headers
2100
2100
  end
2101
2101
 
2102
+ # Subscribe and unsubscribe to proactive notifications for a user's income profile
2103
+ # `/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.
2104
+ # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
2105
+ # @param [Hash] opts the optional parameters
2106
+ # @return [nil]
2107
+ def credit_bank_income_webhook_update(credit_bank_income_webhook_update_request, opts = {})
2108
+ credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts)
2109
+ nil
2110
+ end
2111
+
2112
+ # Subscribe and unsubscribe to proactive notifications for a user&#39;s income profile
2113
+ # &#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.
2114
+ # @param credit_bank_income_webhook_update_request [CreditBankIncomeWebhookUpdateRequest]
2115
+ # @param [Hash] opts the optional parameters
2116
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
2117
+ def credit_bank_income_webhook_update_with_http_info(credit_bank_income_webhook_update_request, opts = {})
2118
+ if @api_client.config.debugging
2119
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_webhook_update ...'
2120
+ end
2121
+ # verify the required parameter 'credit_bank_income_webhook_update_request' is set
2122
+ if @api_client.config.client_side_validation && credit_bank_income_webhook_update_request.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'credit_bank_income_webhook_update_request' when calling PlaidApi.credit_bank_income_webhook_update"
2124
+ end
2125
+ # resource path
2126
+ local_var_path = '/credit/bank_income/webhook/update'
2127
+
2128
+ # query parameters
2129
+ query_params = opts[:query_params] || {}
2130
+
2131
+ # header parameters
2132
+ header_params = opts[:header_params] || {}
2133
+ # HTTP header 'Accept' (if needed)
2134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2135
+ # HTTP header 'Content-Type'
2136
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2137
+
2138
+ # form parameters
2139
+ form_params = opts[:form_params] || {}
2140
+
2141
+ # http body (model)
2142
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_webhook_update_request)
2143
+
2144
+ # return_type
2145
+ return_type = opts[:debug_return_type]
2146
+
2147
+ # auth_names
2148
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2149
+
2150
+ new_options = opts.merge(
2151
+ :operation => :"PlaidApi.credit_bank_income_webhook_update",
2152
+ :header_params => header_params,
2153
+ :query_params => query_params,
2154
+ :form_params => form_params,
2155
+ :body => post_body,
2156
+ :auth_names => auth_names,
2157
+ :return_type => return_type
2158
+ )
2159
+
2160
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2161
+ if @api_client.config.debugging
2162
+ @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2163
+ end
2164
+ return data, status_code, headers
2165
+ end
2166
+
2167
+ # Retrieve data for a user's uploaded bank statements
2168
+ # `/credit/bank_statements/uploads/get` returns data from user-uploaded bank statements.
2169
+ # @param credit_bank_statements_uploads_get_request [CreditBankStatementsUploadsGetRequest]
2170
+ # @param [Hash] opts the optional parameters
2171
+ # @return [CreditBankStatementsUploadsGetResponse]
2172
+ def credit_bank_statements_uploads_get(credit_bank_statements_uploads_get_request, opts = {})
2173
+ data, _status_code, _headers = credit_bank_statements_uploads_get_with_http_info(credit_bank_statements_uploads_get_request, opts)
2174
+ data
2175
+ end
2176
+
2177
+ # Retrieve data for a user&#39;s uploaded bank statements
2178
+ # &#x60;/credit/bank_statements/uploads/get&#x60; returns data from user-uploaded bank statements.
2179
+ # @param credit_bank_statements_uploads_get_request [CreditBankStatementsUploadsGetRequest]
2180
+ # @param [Hash] opts the optional parameters
2181
+ # @return [Array<(CreditBankStatementsUploadsGetResponse, Integer, Hash)>] CreditBankStatementsUploadsGetResponse data, response status code and response headers
2182
+ def credit_bank_statements_uploads_get_with_http_info(credit_bank_statements_uploads_get_request, opts = {})
2183
+ if @api_client.config.debugging
2184
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_statements_uploads_get ...'
2185
+ end
2186
+ # verify the required parameter 'credit_bank_statements_uploads_get_request' is set
2187
+ if @api_client.config.client_side_validation && credit_bank_statements_uploads_get_request.nil?
2188
+ fail ArgumentError, "Missing the required parameter 'credit_bank_statements_uploads_get_request' when calling PlaidApi.credit_bank_statements_uploads_get"
2189
+ end
2190
+ # resource path
2191
+ local_var_path = '/credit/bank_statements/uploads/get'
2192
+
2193
+ # query parameters
2194
+ query_params = opts[:query_params] || {}
2195
+
2196
+ # header parameters
2197
+ header_params = opts[:header_params] || {}
2198
+ # HTTP header 'Accept' (if needed)
2199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2200
+ # HTTP header 'Content-Type'
2201
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2202
+
2203
+ # form parameters
2204
+ form_params = opts[:form_params] || {}
2205
+
2206
+ # http body (model)
2207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_statements_uploads_get_request)
2208
+
2209
+ # return_type
2210
+ return_type = opts[:debug_return_type] || 'CreditBankStatementsUploadsGetResponse'
2211
+
2212
+ # auth_names
2213
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2214
+
2215
+ new_options = opts.merge(
2216
+ :operation => :"PlaidApi.credit_bank_statements_uploads_get",
2217
+ :header_params => header_params,
2218
+ :query_params => query_params,
2219
+ :form_params => form_params,
2220
+ :body => post_body,
2221
+ :auth_names => auth_names,
2222
+ :return_type => return_type
2223
+ )
2224
+
2225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2226
+ if @api_client.config.debugging
2227
+ @api_client.config.logger.debug "API called: PlaidApi#credit_bank_statements_uploads_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2228
+ end
2229
+ return data, status_code, headers
2230
+ end
2231
+
2102
2232
  # Retrieve a summary of an individual's employment information
2103
2233
  # `/credit/employment/get` returns a list of items with employment information from a user's payroll provider that was verified by an end user.
2104
2234
  # @param credit_employment_get_request [CreditEmploymentGetRequest]
@@ -2166,26 +2296,26 @@ module Plaid
2166
2296
 
2167
2297
  # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
2168
2298
  # The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
2169
- # @param request_body [Hash<String, Object>]
2299
+ # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
2170
2300
  # @param [Hash] opts the optional parameters
2171
2301
  # @return [CreditFreddieMacReportsGetResponse]
2172
- def credit_freddie_mac_reports_get(request_body, opts = {})
2173
- data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(request_body, opts)
2302
+ def credit_freddie_mac_reports_get(credit_freddie_mac_reports_get_request, opts = {})
2303
+ data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts)
2174
2304
  data
2175
2305
  end
2176
2306
 
2177
2307
  # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
2178
2308
  # The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.
2179
- # @param request_body [Hash<String, Object>]
2309
+ # @param credit_freddie_mac_reports_get_request [CreditFreddieMacReportsGetRequest]
2180
2310
  # @param [Hash] opts the optional parameters
2181
2311
  # @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
2182
- def credit_freddie_mac_reports_get_with_http_info(request_body, opts = {})
2312
+ def credit_freddie_mac_reports_get_with_http_info(credit_freddie_mac_reports_get_request, opts = {})
2183
2313
  if @api_client.config.debugging
2184
2314
  @api_client.config.logger.debug 'Calling API: PlaidApi.credit_freddie_mac_reports_get ...'
2185
2315
  end
2186
- # verify the required parameter 'request_body' is set
2187
- if @api_client.config.client_side_validation && request_body.nil?
2188
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_freddie_mac_reports_get"
2316
+ # verify the required parameter 'credit_freddie_mac_reports_get_request' is set
2317
+ if @api_client.config.client_side_validation && credit_freddie_mac_reports_get_request.nil?
2318
+ fail ArgumentError, "Missing the required parameter 'credit_freddie_mac_reports_get_request' when calling PlaidApi.credit_freddie_mac_reports_get"
2189
2319
  end
2190
2320
  # resource path
2191
2321
  local_var_path = '/credit/freddie_mac/reports/get'
@@ -2204,7 +2334,7 @@ module Plaid
2204
2334
  form_params = opts[:form_params] || {}
2205
2335
 
2206
2336
  # http body (model)
2207
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
2337
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_freddie_mac_reports_get_request)
2208
2338
 
2209
2339
  # return_type
2210
2340
  return_type = opts[:debug_return_type] || 'CreditFreddieMacReportsGetResponse'
@@ -2424,6 +2554,71 @@ module Plaid
2424
2554
  return data, status_code, headers
2425
2555
  end
2426
2556
 
2557
+ # Retrieve fraud insights for a user's manually uploaded document(s).
2558
+ # `/credit/payroll_income/risk_signals/get` can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. `/credit/payroll_income/risk_signals/get` can be called at any time after the `INCOME_VERIFICATION_RISK_SIGNALS` webhook has been fired. `/credit/payroll_income/risk_signals/get` is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
2559
+ # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
2560
+ # @param [Hash] opts the optional parameters
2561
+ # @return [CreditPayrollIncomeRiskSignalsGetResponse]
2562
+ def credit_payroll_income_risk_signals_get(credit_payroll_income_risk_signals_get_request, opts = {})
2563
+ data, _status_code, _headers = credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts)
2564
+ data
2565
+ end
2566
+
2567
+ # Retrieve fraud insights for a user&#39;s manually uploaded document(s).
2568
+ # &#x60;/credit/payroll_income/risk_signals/get&#x60; can be used as part of the Document Income flow to assess a user-uploaded document for signs of potential fraud or tampering. It returns a risk score for each uploaded document that indicates the likelihood of the document being fraudulent, in addition to details on the individual risk signals contributing to the score. &#x60;/credit/payroll_income/risk_signals/get&#x60; can be called at any time after the &#x60;INCOME_VERIFICATION_RISK_SIGNALS&#x60; webhook has been fired. &#x60;/credit/payroll_income/risk_signals/get&#x60; is offered as an add-on to Document Income and is billed separately. To request access to this endpoint, submit a product access request or contact your Plaid account manager.
2569
+ # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
2570
+ # @param [Hash] opts the optional parameters
2571
+ # @return [Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>] CreditPayrollIncomeRiskSignalsGetResponse data, response status code and response headers
2572
+ def credit_payroll_income_risk_signals_get_with_http_info(credit_payroll_income_risk_signals_get_request, opts = {})
2573
+ if @api_client.config.debugging
2574
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_risk_signals_get ...'
2575
+ end
2576
+ # verify the required parameter 'credit_payroll_income_risk_signals_get_request' is set
2577
+ if @api_client.config.client_side_validation && credit_payroll_income_risk_signals_get_request.nil?
2578
+ fail ArgumentError, "Missing the required parameter 'credit_payroll_income_risk_signals_get_request' when calling PlaidApi.credit_payroll_income_risk_signals_get"
2579
+ end
2580
+ # resource path
2581
+ local_var_path = '/credit/payroll_income/risk_signals/get'
2582
+
2583
+ # query parameters
2584
+ query_params = opts[:query_params] || {}
2585
+
2586
+ # header parameters
2587
+ header_params = opts[:header_params] || {}
2588
+ # HTTP header 'Accept' (if needed)
2589
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2590
+ # HTTP header 'Content-Type'
2591
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2592
+
2593
+ # form parameters
2594
+ form_params = opts[:form_params] || {}
2595
+
2596
+ # http body (model)
2597
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_risk_signals_get_request)
2598
+
2599
+ # return_type
2600
+ return_type = opts[:debug_return_type] || 'CreditPayrollIncomeRiskSignalsGetResponse'
2601
+
2602
+ # auth_names
2603
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2604
+
2605
+ new_options = opts.merge(
2606
+ :operation => :"PlaidApi.credit_payroll_income_risk_signals_get",
2607
+ :header_params => header_params,
2608
+ :query_params => query_params,
2609
+ :form_params => form_params,
2610
+ :body => post_body,
2611
+ :auth_names => auth_names,
2612
+ :return_type => return_type
2613
+ )
2614
+
2615
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2616
+ if @api_client.config.debugging
2617
+ @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_risk_signals_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2618
+ end
2619
+ return data, status_code, headers
2620
+ end
2621
+
2427
2622
  # Create a relay token to share an Asset Report with a partner client (beta)
2428
2623
  # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
2429
2624
  # @param credit_relay_create_request [CreditRelayCreateRequest]
@@ -3529,8 +3724,73 @@ module Plaid
3529
3724
  return data, status_code, headers
3530
3725
  end
3531
3726
 
3727
+ # Refresh identity data
3728
+ # `/identity/refresh` is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling `/identity/refresh`, Plaid will fire a webhook [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/identity/#default_update). `/identity/refresh` is offered as an add-on to Identity 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.
3729
+ # @param identity_refresh_request [IdentityRefreshRequest]
3730
+ # @param [Hash] opts the optional parameters
3731
+ # @return [IdentityRefreshResponse]
3732
+ def identity_refresh(identity_refresh_request, opts = {})
3733
+ data, _status_code, _headers = identity_refresh_with_http_info(identity_refresh_request, opts)
3734
+ data
3735
+ end
3736
+
3737
+ # Refresh identity data
3738
+ # &#x60;/identity/refresh&#x60; is an optional endpoint for users of the Identity product. It initiates an on-demand extraction to fetch the most up to date Identity information from the Financial Institution. This on-demand extraction takes place in addition to the periodic extractions that automatically occur any Identity-enabled Item. If changes to Identity are discovered after calling &#x60;/identity/refresh&#x60;, Plaid will fire a webhook [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/identity/#default_update). &#x60;/identity/refresh&#x60; is offered as an add-on to Identity 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.
3739
+ # @param identity_refresh_request [IdentityRefreshRequest]
3740
+ # @param [Hash] opts the optional parameters
3741
+ # @return [Array<(IdentityRefreshResponse, Integer, Hash)>] IdentityRefreshResponse data, response status code and response headers
3742
+ def identity_refresh_with_http_info(identity_refresh_request, opts = {})
3743
+ if @api_client.config.debugging
3744
+ @api_client.config.logger.debug 'Calling API: PlaidApi.identity_refresh ...'
3745
+ end
3746
+ # verify the required parameter 'identity_refresh_request' is set
3747
+ if @api_client.config.client_side_validation && identity_refresh_request.nil?
3748
+ fail ArgumentError, "Missing the required parameter 'identity_refresh_request' when calling PlaidApi.identity_refresh"
3749
+ end
3750
+ # resource path
3751
+ local_var_path = '/identity/refresh'
3752
+
3753
+ # query parameters
3754
+ query_params = opts[:query_params] || {}
3755
+
3756
+ # header parameters
3757
+ header_params = opts[:header_params] || {}
3758
+ # HTTP header 'Accept' (if needed)
3759
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3760
+ # HTTP header 'Content-Type'
3761
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3762
+
3763
+ # form parameters
3764
+ form_params = opts[:form_params] || {}
3765
+
3766
+ # http body (model)
3767
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(identity_refresh_request)
3768
+
3769
+ # return_type
3770
+ return_type = opts[:debug_return_type] || 'IdentityRefreshResponse'
3771
+
3772
+ # auth_names
3773
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3774
+
3775
+ new_options = opts.merge(
3776
+ :operation => :"PlaidApi.identity_refresh",
3777
+ :header_params => header_params,
3778
+ :query_params => query_params,
3779
+ :form_params => form_params,
3780
+ :body => post_body,
3781
+ :auth_names => auth_names,
3782
+ :return_type => return_type
3783
+ )
3784
+
3785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3786
+ if @api_client.config.debugging
3787
+ @api_client.config.logger.debug "API called: PlaidApi#identity_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3788
+ end
3789
+ return data, status_code, headers
3790
+ end
3791
+
3532
3792
  # Create a new identity verification
3533
- # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code.
3793
+ # Create a new Identity Verification for the user specified by the `client_user_id` field. The requirements and behavior of the verification are determined by the `template_id` provided. If you don't know whether the associated user already has an active Identity Verification, you can specify `\"is_idempotent\": true` in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated `client_user_id` and `template_id`. If an Identity Verification is found, it will be returned unmodified with an `200 OK` HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
3534
3794
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
3535
3795
  # @param [Hash] opts the optional parameters
3536
3796
  # @return [IdentityVerificationCreateResponse]
@@ -3540,7 +3800,7 @@ module Plaid
3540
3800
  end
3541
3801
 
3542
3802
  # Create a new identity verification
3543
- # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code.
3803
+ # Create a new Identity Verification for the user specified by the &#x60;client_user_id&#x60; field. The requirements and behavior of the verification are determined by the &#x60;template_id&#x60; provided. If you don&#39;t know whether the associated user already has an active Identity Verification, you can specify &#x60;\&quot;is_idempotent\&quot;: true&#x60; in the request body. With idempotency enabled, a new Identity Verification will only be created if one does not already exist for the associated &#x60;client_user_id&#x60; and &#x60;template_id&#x60;. If an Identity Verification is found, it will be returned unmodified with an &#x60;200 OK&#x60; HTTP status code. You can also use this endpoint to supply information you already have collected about the user; if any of these fields are specified, the screens prompting the user to enter them will be skipped during the Link flow.
3544
3804
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
3545
3805
  # @param [Hash] opts the optional parameters
3546
3806
  # @return [Array<(IdentityVerificationCreateResponse, Integer, Hash)>] IdentityVerificationCreateResponse data, response status code and response headers
@@ -4051,26 +4311,26 @@ module Plaid
4051
4311
 
4052
4312
  # (Deprecated) Retrieve information from the tax documents used for income verification
4053
4313
  # `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
4054
- # @param request_body [Hash<String, Object>]
4314
+ # @param income_verification_taxforms_get_request [IncomeVerificationTaxformsGetRequest]
4055
4315
  # @param [Hash] opts the optional parameters
4056
4316
  # @return [IncomeVerificationTaxformsGetResponse]
4057
- def income_verification_taxforms_get(request_body, opts = {})
4058
- data, _status_code, _headers = income_verification_taxforms_get_with_http_info(request_body, opts)
4317
+ def income_verification_taxforms_get(income_verification_taxforms_get_request, opts = {})
4318
+ data, _status_code, _headers = income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts)
4059
4319
  data
4060
4320
  end
4061
4321
 
4062
4322
  # (Deprecated) Retrieve information from the tax documents used for income verification
4063
4323
  # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from forms that were used to verify an end user&#39;&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use &#x60;/credit/payroll_income/get&#x60; instead.
4064
- # @param request_body [Hash<String, Object>]
4324
+ # @param income_verification_taxforms_get_request [IncomeVerificationTaxformsGetRequest]
4065
4325
  # @param [Hash] opts the optional parameters
4066
4326
  # @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
4067
- def income_verification_taxforms_get_with_http_info(request_body, opts = {})
4327
+ def income_verification_taxforms_get_with_http_info(income_verification_taxforms_get_request, opts = {})
4068
4328
  if @api_client.config.debugging
4069
4329
  @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_taxforms_get ...'
4070
4330
  end
4071
- # verify the required parameter 'request_body' is set
4072
- if @api_client.config.client_side_validation && request_body.nil?
4073
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.income_verification_taxforms_get"
4331
+ # verify the required parameter 'income_verification_taxforms_get_request' is set
4332
+ if @api_client.config.client_side_validation && income_verification_taxforms_get_request.nil?
4333
+ fail ArgumentError, "Missing the required parameter 'income_verification_taxforms_get_request' when calling PlaidApi.income_verification_taxforms_get"
4074
4334
  end
4075
4335
  # resource path
4076
4336
  local_var_path = '/income/verification/taxforms/get'
@@ -4089,7 +4349,7 @@ module Plaid
4089
4349
  form_params = opts[:form_params] || {}
4090
4350
 
4091
4351
  # http body (model)
4092
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
4352
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_taxforms_get_request)
4093
4353
 
4094
4354
  # return_type
4095
4355
  return_type = opts[:debug_return_type] || 'IncomeVerificationTaxformsGetResponse'
@@ -4309,31 +4569,31 @@ module Plaid
4309
4569
  return data, status_code, headers
4310
4570
  end
4311
4571
 
4312
- # Get Investment holdings
4313
- # The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
4314
- # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
4572
+ # Get data needed to authorize an investments transfer
4573
+ # The `/investments/auth/get` endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings
4574
+ # @param investments_auth_get_request [InvestmentsAuthGetRequest]
4315
4575
  # @param [Hash] opts the optional parameters
4316
- # @return [InvestmentsHoldingsGetResponse]
4317
- def investments_holdings_get(investments_holdings_get_request, opts = {})
4318
- data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
4576
+ # @return [InvestmentsAuthGetResponse]
4577
+ def investments_auth_get(investments_auth_get_request, opts = {})
4578
+ data, _status_code, _headers = investments_auth_get_with_http_info(investments_auth_get_request, opts)
4319
4579
  data
4320
4580
  end
4321
4581
 
4322
- # Get Investment holdings
4323
- # The &#x60;/investments/holdings/get&#x60; endpoint allows developers to receive user-authorized stock position data for &#x60;investment&#x60;-type accounts.
4324
- # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
4582
+ # Get data needed to authorize an investments transfer
4583
+ # The &#x60;/investments/auth/get&#x60; endpoint allows developers to receive user-authorized data to facilitate the transfer of holdings
4584
+ # @param investments_auth_get_request [InvestmentsAuthGetRequest]
4325
4585
  # @param [Hash] opts the optional parameters
4326
- # @return [Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>] InvestmentsHoldingsGetResponse data, response status code and response headers
4327
- def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
4586
+ # @return [Array<(InvestmentsAuthGetResponse, Integer, Hash)>] InvestmentsAuthGetResponse data, response status code and response headers
4587
+ def investments_auth_get_with_http_info(investments_auth_get_request, opts = {})
4328
4588
  if @api_client.config.debugging
4329
- @api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
4589
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_auth_get ...'
4330
4590
  end
4331
- # verify the required parameter 'investments_holdings_get_request' is set
4332
- if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
4333
- fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
4591
+ # verify the required parameter 'investments_auth_get_request' is set
4592
+ if @api_client.config.client_side_validation && investments_auth_get_request.nil?
4593
+ fail ArgumentError, "Missing the required parameter 'investments_auth_get_request' when calling PlaidApi.investments_auth_get"
4334
4594
  end
4335
4595
  # resource path
4336
- local_var_path = '/investments/holdings/get'
4596
+ local_var_path = '/investments/auth/get'
4337
4597
 
4338
4598
  # query parameters
4339
4599
  query_params = opts[:query_params] || {}
@@ -4349,16 +4609,16 @@ module Plaid
4349
4609
  form_params = opts[:form_params] || {}
4350
4610
 
4351
4611
  # http body (model)
4352
- post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)
4612
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_auth_get_request)
4353
4613
 
4354
4614
  # return_type
4355
- return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'
4615
+ return_type = opts[:debug_return_type] || 'InvestmentsAuthGetResponse'
4356
4616
 
4357
4617
  # auth_names
4358
4618
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4359
4619
 
4360
4620
  new_options = opts.merge(
4361
- :operation => :"PlaidApi.investments_holdings_get",
4621
+ :operation => :"PlaidApi.investments_auth_get",
4362
4622
  :header_params => header_params,
4363
4623
  :query_params => query_params,
4364
4624
  :form_params => form_params,
@@ -4369,36 +4629,36 @@ module Plaid
4369
4629
 
4370
4630
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4371
4631
  if @api_client.config.debugging
4372
- @api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4632
+ @api_client.config.logger.debug "API called: PlaidApi#investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4373
4633
  end
4374
4634
  return data, status_code, headers
4375
4635
  end
4376
4636
 
4377
- # Get investment transactions
4378
- # The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
4379
- # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4637
+ # Get Investment holdings
4638
+ # The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
4639
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
4380
4640
  # @param [Hash] opts the optional parameters
4381
- # @return [InvestmentsTransactionsGetResponse]
4382
- def investments_transactions_get(investments_transactions_get_request, opts = {})
4383
- data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
4641
+ # @return [InvestmentsHoldingsGetResponse]
4642
+ def investments_holdings_get(investments_holdings_get_request, opts = {})
4643
+ data, _status_code, _headers = investments_holdings_get_with_http_info(investments_holdings_get_request, opts)
4384
4644
  data
4385
4645
  end
4386
4646
 
4387
- # Get investment transactions
4388
- # The &#x60;/investments/transactions/get&#x60; endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when &#x60;/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return.
4389
- # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4647
+ # Get Investment holdings
4648
+ # The &#x60;/investments/holdings/get&#x60; endpoint allows developers to receive user-authorized stock position data for &#x60;investment&#x60;-type accounts.
4649
+ # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
4390
4650
  # @param [Hash] opts the optional parameters
4391
- # @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
4392
- def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
4651
+ # @return [Array<(InvestmentsHoldingsGetResponse, Integer, Hash)>] InvestmentsHoldingsGetResponse data, response status code and response headers
4652
+ def investments_holdings_get_with_http_info(investments_holdings_get_request, opts = {})
4393
4653
  if @api_client.config.debugging
4394
- @api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
4654
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_holdings_get ...'
4395
4655
  end
4396
- # verify the required parameter 'investments_transactions_get_request' is set
4397
- if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
4398
- fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
4656
+ # verify the required parameter 'investments_holdings_get_request' is set
4657
+ if @api_client.config.client_side_validation && investments_holdings_get_request.nil?
4658
+ fail ArgumentError, "Missing the required parameter 'investments_holdings_get_request' when calling PlaidApi.investments_holdings_get"
4399
4659
  end
4400
4660
  # resource path
4401
- local_var_path = '/investments/transactions/get'
4661
+ local_var_path = '/investments/holdings/get'
4402
4662
 
4403
4663
  # query parameters
4404
4664
  query_params = opts[:query_params] || {}
@@ -4414,16 +4674,146 @@ module Plaid
4414
4674
  form_params = opts[:form_params] || {}
4415
4675
 
4416
4676
  # http body (model)
4417
- post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)
4677
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_holdings_get_request)
4418
4678
 
4419
4679
  # return_type
4420
- return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'
4680
+ return_type = opts[:debug_return_type] || 'InvestmentsHoldingsGetResponse'
4421
4681
 
4422
4682
  # auth_names
4423
4683
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4424
4684
 
4425
4685
  new_options = opts.merge(
4426
- :operation => :"PlaidApi.investments_transactions_get",
4686
+ :operation => :"PlaidApi.investments_holdings_get",
4687
+ :header_params => header_params,
4688
+ :query_params => query_params,
4689
+ :form_params => form_params,
4690
+ :body => post_body,
4691
+ :auth_names => auth_names,
4692
+ :return_type => return_type
4693
+ )
4694
+
4695
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4696
+ if @api_client.config.debugging
4697
+ @api_client.config.logger.debug "API called: PlaidApi#investments_holdings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4698
+ end
4699
+ return data, status_code, headers
4700
+ end
4701
+
4702
+ # Refresh investment data
4703
+ # `/investments/refresh` is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment 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 Investments-enabled Item. If changes to investments are discovered after calling `/investments/refresh`, Plaid will fire webhooks: [`HOLDINGS: DEFAULT_UPDATE`](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling `/investments/holdings/get` and `/investments/transactions/get`. \"Note that the `/investments/refresh` endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a `PRODUCT_NOT_SUPPORTED` error. `/investments/refresh` is offered as an add-on to Investments 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.
4704
+ # @param investments_refresh_request [InvestmentsRefreshRequest]
4705
+ # @param [Hash] opts the optional parameters
4706
+ # @return [InvestmentsRefreshResponse]
4707
+ def investments_refresh(investments_refresh_request, opts = {})
4708
+ data, _status_code, _headers = investments_refresh_with_http_info(investments_refresh_request, opts)
4709
+ data
4710
+ end
4711
+
4712
+ # Refresh investment data
4713
+ # &#x60;/investments/refresh&#x60; is an optional endpoint for users of the Investments product. It initiates an on-demand extraction to fetch the newest investments, holdings and investment 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 Investments-enabled Item. If changes to investments are discovered after calling &#x60;/investments/refresh&#x60;, Plaid will fire webhooks: [&#x60;HOLDINGS: DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/investments/#holdings-default_update) if any new holdings are detected, and [INVESTMENTS_TRANSACTIONS: DEFAULT_UPDATE](https://plaid.com/docs/api/products/investments/#investments_transactions-default_update) if any new investment transactions are detected. Updated holdings and investment transactions can be fetched by calling &#x60;/investments/holdings/get&#x60; and &#x60;/investments/transactions/get&#x60;. \&quot;Note that the &#x60;/investments/refresh&#x60; endpoint is not supported by all institutions. If called on an Item from an institution that does not support this functionality, it will return a &#x60;PRODUCT_NOT_SUPPORTED&#x60; error. &#x60;/investments/refresh&#x60; is offered as an add-on to Investments 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.
4714
+ # @param investments_refresh_request [InvestmentsRefreshRequest]
4715
+ # @param [Hash] opts the optional parameters
4716
+ # @return [Array<(InvestmentsRefreshResponse, Integer, Hash)>] InvestmentsRefreshResponse data, response status code and response headers
4717
+ def investments_refresh_with_http_info(investments_refresh_request, opts = {})
4718
+ if @api_client.config.debugging
4719
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_refresh ...'
4720
+ end
4721
+ # verify the required parameter 'investments_refresh_request' is set
4722
+ if @api_client.config.client_side_validation && investments_refresh_request.nil?
4723
+ fail ArgumentError, "Missing the required parameter 'investments_refresh_request' when calling PlaidApi.investments_refresh"
4724
+ end
4725
+ # resource path
4726
+ local_var_path = '/investments/refresh'
4727
+
4728
+ # query parameters
4729
+ query_params = opts[:query_params] || {}
4730
+
4731
+ # header parameters
4732
+ header_params = opts[:header_params] || {}
4733
+ # HTTP header 'Accept' (if needed)
4734
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4735
+ # HTTP header 'Content-Type'
4736
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4737
+
4738
+ # form parameters
4739
+ form_params = opts[:form_params] || {}
4740
+
4741
+ # http body (model)
4742
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_refresh_request)
4743
+
4744
+ # return_type
4745
+ return_type = opts[:debug_return_type] || 'InvestmentsRefreshResponse'
4746
+
4747
+ # auth_names
4748
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4749
+
4750
+ new_options = opts.merge(
4751
+ :operation => :"PlaidApi.investments_refresh",
4752
+ :header_params => header_params,
4753
+ :query_params => query_params,
4754
+ :form_params => form_params,
4755
+ :body => post_body,
4756
+ :auth_names => auth_names,
4757
+ :return_type => return_type
4758
+ )
4759
+
4760
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4761
+ if @api_client.config.debugging
4762
+ @api_client.config.logger.debug "API called: PlaidApi#investments_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4763
+ end
4764
+ return data, status_code, headers
4765
+ end
4766
+
4767
+ # Get investment transactions
4768
+ # The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
4769
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4770
+ # @param [Hash] opts the optional parameters
4771
+ # @return [InvestmentsTransactionsGetResponse]
4772
+ def investments_transactions_get(investments_transactions_get_request, opts = {})
4773
+ data, _status_code, _headers = investments_transactions_get_with_http_info(investments_transactions_get_request, opts)
4774
+ data
4775
+ end
4776
+
4777
+ # Get investment transactions
4778
+ # The &#x60;/investments/transactions/get&#x60; endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when &#x60;/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return.
4779
+ # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4780
+ # @param [Hash] opts the optional parameters
4781
+ # @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
4782
+ def investments_transactions_get_with_http_info(investments_transactions_get_request, opts = {})
4783
+ if @api_client.config.debugging
4784
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_transactions_get ...'
4785
+ end
4786
+ # verify the required parameter 'investments_transactions_get_request' is set
4787
+ if @api_client.config.client_side_validation && investments_transactions_get_request.nil?
4788
+ fail ArgumentError, "Missing the required parameter 'investments_transactions_get_request' when calling PlaidApi.investments_transactions_get"
4789
+ end
4790
+ # resource path
4791
+ local_var_path = '/investments/transactions/get'
4792
+
4793
+ # query parameters
4794
+ query_params = opts[:query_params] || {}
4795
+
4796
+ # header parameters
4797
+ header_params = opts[:header_params] || {}
4798
+ # HTTP header 'Accept' (if needed)
4799
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4800
+ # HTTP header 'Content-Type'
4801
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4802
+
4803
+ # form parameters
4804
+ form_params = opts[:form_params] || {}
4805
+
4806
+ # http body (model)
4807
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_transactions_get_request)
4808
+
4809
+ # return_type
4810
+ return_type = opts[:debug_return_type] || 'InvestmentsTransactionsGetResponse'
4811
+
4812
+ # auth_names
4813
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4814
+
4815
+ new_options = opts.merge(
4816
+ :operation => :"PlaidApi.investments_transactions_get",
4427
4817
  :header_params => header_params,
4428
4818
  :query_params => query_params,
4429
4819
  :form_params => form_params,
@@ -4830,7 +5220,7 @@ module Plaid
4830
5220
  end
4831
5221
 
4832
5222
  # Import Item
4833
- # `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (`target_account_id`).
5223
+ # `/item/import` creates an Item via your Plaid Exchange Integration and returns an `access_token`. As part of an `/item/import` request, you will include a User ID (`user_auth.user_id`) and Authentication Token (`user_auth.auth_token`) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via `/item/import`, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.
4834
5224
  # @param item_import_request [ItemImportRequest]
4835
5225
  # @param [Hash] opts the optional parameters
4836
5226
  # @return [ItemImportResponse]
@@ -4840,7 +5230,7 @@ module Plaid
4840
5230
  end
4841
5231
 
4842
5232
  # Import Item
4843
- # &#x60;/item/import&#x60; creates an Item via your Plaid Exchange Integration and returns an &#x60;access_token&#x60;. As part of an &#x60;/item/import&#x60; request, you will include a User ID (&#x60;user_auth.user_id&#x60;) and Authentication Token (&#x60;user_auth.auth_token&#x60;) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via &#x60;/item/import&#x60;, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated. This will automatically generate the Plaid native account ID for the account the user will switch their direct deposit to (&#x60;target_account_id&#x60;).
5233
+ # &#x60;/item/import&#x60; creates an Item via your Plaid Exchange Integration and returns an &#x60;access_token&#x60;. As part of an &#x60;/item/import&#x60; request, you will include a User ID (&#x60;user_auth.user_id&#x60;) and Authentication Token (&#x60;user_auth.auth_token&#x60;) that enable data aggregation through your Plaid Exchange API endpoints. These authentication principals are to be chosen by you. Upon creating an Item via &#x60;/item/import&#x60;, Plaid will automatically begin an extraction of that Item through the Plaid Exchange infrastructure you have already integrated.
4844
5234
  # @param item_import_request [ItemImportRequest]
4845
5235
  # @param [Hash] opts the optional parameters
4846
5236
  # @return [Array<(ItemImportResponse, Integer, Hash)>] ItemImportResponse data, response status code and response headers
@@ -5154,8 +5544,8 @@ module Plaid
5154
5544
  return data, status_code, headers
5155
5545
  end
5156
5546
 
5157
- # Create Link Delivery session
5158
- # Use the `/link_delivery/create` endpoint to create a Link Delivery session.
5547
+ # Create Hosted Link session
5548
+ # Use the `/link_delivery/create` endpoint to create a Hosted Link session.
5159
5549
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5160
5550
  # @param [Hash] opts the optional parameters
5161
5551
  # @return [LinkDeliveryCreateResponse]
@@ -5164,8 +5554,8 @@ module Plaid
5164
5554
  data
5165
5555
  end
5166
5556
 
5167
- # Create Link Delivery session
5168
- # Use the &#x60;/link_delivery/create&#x60; endpoint to create a Link Delivery session.
5557
+ # Create Hosted Link session
5558
+ # Use the &#x60;/link_delivery/create&#x60; endpoint to create a Hosted Link session.
5169
5559
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5170
5560
  # @param [Hash] opts the optional parameters
5171
5561
  # @return [Array<(LinkDeliveryCreateResponse, Integer, Hash)>] LinkDeliveryCreateResponse data, response status code and response headers
@@ -5219,8 +5609,8 @@ module Plaid
5219
5609
  return data, status_code, headers
5220
5610
  end
5221
5611
 
5222
- # Get Link Delivery session
5223
- # Use the `/link_delivery/get` endpoint to get the status of a Link Delivery session.
5612
+ # Get Hosted Link session
5613
+ # Use the `/link_delivery/get` endpoint to get the status of a Hosted Link session.
5224
5614
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5225
5615
  # @param [Hash] opts the optional parameters
5226
5616
  # @return [LinkDeliveryGetResponse]
@@ -5229,8 +5619,8 @@ module Plaid
5229
5619
  data
5230
5620
  end
5231
5621
 
5232
- # Get Link Delivery session
5233
- # Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Link Delivery session.
5622
+ # Get Hosted Link session
5623
+ # Use the &#x60;/link_delivery/get&#x60; endpoint to get the status of a Hosted Link session.
5234
5624
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5235
5625
  # @param [Hash] opts the optional parameters
5236
5626
  # @return [Array<(LinkDeliveryGetResponse, Integer, Hash)>] LinkDeliveryGetResponse data, response status code and response headers
@@ -6909,31 +7299,486 @@ module Plaid
6909
7299
  return data, status_code, headers
6910
7300
  end
6911
7301
 
6912
- # Create a bank transfer as a processor
6913
- # Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
6914
- # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
7302
+ # Create a bank transfer as a processor
7303
+ # Use the `/processor/bank_transfer/create` endpoint to initiate a new bank transfer as a processor
7304
+ # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
7305
+ # @param [Hash] opts the optional parameters
7306
+ # @return [ProcessorBankTransferCreateResponse]
7307
+ def processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {})
7308
+ data, _status_code, _headers = processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts)
7309
+ data
7310
+ end
7311
+
7312
+ # Create a bank transfer as a processor
7313
+ # Use the &#x60;/processor/bank_transfer/create&#x60; endpoint to initiate a new bank transfer as a processor
7314
+ # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
7315
+ # @param [Hash] opts the optional parameters
7316
+ # @return [Array<(ProcessorBankTransferCreateResponse, Integer, Hash)>] ProcessorBankTransferCreateResponse data, response status code and response headers
7317
+ def processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {})
7318
+ if @api_client.config.debugging
7319
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_bank_transfer_create ...'
7320
+ end
7321
+ # verify the required parameter 'processor_bank_transfer_create_request' is set
7322
+ if @api_client.config.client_side_validation && processor_bank_transfer_create_request.nil?
7323
+ fail ArgumentError, "Missing the required parameter 'processor_bank_transfer_create_request' when calling PlaidApi.processor_bank_transfer_create"
7324
+ end
7325
+ # resource path
7326
+ local_var_path = '/processor/bank_transfer/create'
7327
+
7328
+ # query parameters
7329
+ query_params = opts[:query_params] || {}
7330
+
7331
+ # header parameters
7332
+ header_params = opts[:header_params] || {}
7333
+ # HTTP header 'Accept' (if needed)
7334
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7335
+ # HTTP header 'Content-Type'
7336
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7337
+
7338
+ # form parameters
7339
+ form_params = opts[:form_params] || {}
7340
+
7341
+ # http body (model)
7342
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_bank_transfer_create_request)
7343
+
7344
+ # return_type
7345
+ return_type = opts[:debug_return_type] || 'ProcessorBankTransferCreateResponse'
7346
+
7347
+ # auth_names
7348
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7349
+
7350
+ new_options = opts.merge(
7351
+ :operation => :"PlaidApi.processor_bank_transfer_create",
7352
+ :header_params => header_params,
7353
+ :query_params => query_params,
7354
+ :form_params => form_params,
7355
+ :body => post_body,
7356
+ :auth_names => auth_names,
7357
+ :return_type => return_type
7358
+ )
7359
+
7360
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7361
+ if @api_client.config.debugging
7362
+ @api_client.config.logger.debug "API called: PlaidApi#processor_bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7363
+ end
7364
+ return data, status_code, headers
7365
+ end
7366
+
7367
+ # Retrieve Identity data
7368
+ # The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
7369
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
7370
+ # @param [Hash] opts the optional parameters
7371
+ # @return [ProcessorIdentityGetResponse]
7372
+ def processor_identity_get(processor_identity_get_request, opts = {})
7373
+ data, _status_code, _headers = processor_identity_get_with_http_info(processor_identity_get_request, opts)
7374
+ data
7375
+ end
7376
+
7377
+ # Retrieve Identity data
7378
+ # The &#x60;/processor/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
7379
+ # @param processor_identity_get_request [ProcessorIdentityGetRequest]
7380
+ # @param [Hash] opts the optional parameters
7381
+ # @return [Array<(ProcessorIdentityGetResponse, Integer, Hash)>] ProcessorIdentityGetResponse data, response status code and response headers
7382
+ def processor_identity_get_with_http_info(processor_identity_get_request, opts = {})
7383
+ if @api_client.config.debugging
7384
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_get ...'
7385
+ end
7386
+ # verify the required parameter 'processor_identity_get_request' is set
7387
+ if @api_client.config.client_side_validation && processor_identity_get_request.nil?
7388
+ fail ArgumentError, "Missing the required parameter 'processor_identity_get_request' when calling PlaidApi.processor_identity_get"
7389
+ end
7390
+ # resource path
7391
+ local_var_path = '/processor/identity/get'
7392
+
7393
+ # query parameters
7394
+ query_params = opts[:query_params] || {}
7395
+
7396
+ # header parameters
7397
+ header_params = opts[:header_params] || {}
7398
+ # HTTP header 'Accept' (if needed)
7399
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7400
+ # HTTP header 'Content-Type'
7401
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7402
+
7403
+ # form parameters
7404
+ form_params = opts[:form_params] || {}
7405
+
7406
+ # http body (model)
7407
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_get_request)
7408
+
7409
+ # return_type
7410
+ return_type = opts[:debug_return_type] || 'ProcessorIdentityGetResponse'
7411
+
7412
+ # auth_names
7413
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7414
+
7415
+ new_options = opts.merge(
7416
+ :operation => :"PlaidApi.processor_identity_get",
7417
+ :header_params => header_params,
7418
+ :query_params => query_params,
7419
+ :form_params => form_params,
7420
+ :body => post_body,
7421
+ :auth_names => auth_names,
7422
+ :return_type => return_type
7423
+ )
7424
+
7425
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7426
+ if @api_client.config.debugging
7427
+ @api_client.config.logger.debug "API called: PlaidApi#processor_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7428
+ end
7429
+ return data, status_code, headers
7430
+ end
7431
+
7432
+ # Retrieve identity match score
7433
+ # The `/processor/identity/match` endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder's financial institution. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
7434
+ # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
7435
+ # @param [Hash] opts the optional parameters
7436
+ # @return [ProcessorIdentityMatchResponse]
7437
+ def processor_identity_match(processor_identity_match_request, opts = {})
7438
+ data, _status_code, _headers = processor_identity_match_with_http_info(processor_identity_match_request, opts)
7439
+ data
7440
+ end
7441
+
7442
+ # Retrieve identity match score
7443
+ # The &#x60;/processor/identity/match&#x60; endpoint generates a match score, which indicates how well the provided identity data matches the identity information on file with the account holder&#39;s financial institution. This request may take some time to complete if Identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
7444
+ # @param processor_identity_match_request [ProcessorIdentityMatchRequest]
7445
+ # @param [Hash] opts the optional parameters
7446
+ # @return [Array<(ProcessorIdentityMatchResponse, Integer, Hash)>] ProcessorIdentityMatchResponse data, response status code and response headers
7447
+ def processor_identity_match_with_http_info(processor_identity_match_request, opts = {})
7448
+ if @api_client.config.debugging
7449
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_match ...'
7450
+ end
7451
+ # verify the required parameter 'processor_identity_match_request' is set
7452
+ if @api_client.config.client_side_validation && processor_identity_match_request.nil?
7453
+ fail ArgumentError, "Missing the required parameter 'processor_identity_match_request' when calling PlaidApi.processor_identity_match"
7454
+ end
7455
+ # resource path
7456
+ local_var_path = '/processor/identity/match'
7457
+
7458
+ # query parameters
7459
+ query_params = opts[:query_params] || {}
7460
+
7461
+ # header parameters
7462
+ header_params = opts[:header_params] || {}
7463
+ # HTTP header 'Accept' (if needed)
7464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7465
+ # HTTP header 'Content-Type'
7466
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7467
+
7468
+ # form parameters
7469
+ form_params = opts[:form_params] || {}
7470
+
7471
+ # http body (model)
7472
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_match_request)
7473
+
7474
+ # return_type
7475
+ return_type = opts[:debug_return_type] || 'ProcessorIdentityMatchResponse'
7476
+
7477
+ # auth_names
7478
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7479
+
7480
+ new_options = opts.merge(
7481
+ :operation => :"PlaidApi.processor_identity_match",
7482
+ :header_params => header_params,
7483
+ :query_params => query_params,
7484
+ :form_params => form_params,
7485
+ :body => post_body,
7486
+ :auth_names => auth_names,
7487
+ :return_type => return_type
7488
+ )
7489
+
7490
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7491
+ if @api_client.config.debugging
7492
+ @api_client.config.logger.debug "API called: PlaidApi#processor_identity_match\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7493
+ end
7494
+ return data, status_code, headers
7495
+ end
7496
+
7497
+ # Report whether you initiated an ACH transaction
7498
+ # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
7499
+ # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7500
+ # @param [Hash] opts the optional parameters
7501
+ # @return [ProcessorSignalDecisionReportResponse]
7502
+ def processor_signal_decision_report(processor_signal_decision_report_request, opts = {})
7503
+ data, _status_code, _headers = processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts)
7504
+ data
7505
+ end
7506
+
7507
+ # Report whether you initiated an ACH transaction
7508
+ # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
7509
+ # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7510
+ # @param [Hash] opts the optional parameters
7511
+ # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
7512
+ def processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts = {})
7513
+ if @api_client.config.debugging
7514
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_decision_report ...'
7515
+ end
7516
+ # verify the required parameter 'processor_signal_decision_report_request' is set
7517
+ if @api_client.config.client_side_validation && processor_signal_decision_report_request.nil?
7518
+ fail ArgumentError, "Missing the required parameter 'processor_signal_decision_report_request' when calling PlaidApi.processor_signal_decision_report"
7519
+ end
7520
+ # resource path
7521
+ local_var_path = '/processor/signal/decision/report'
7522
+
7523
+ # query parameters
7524
+ query_params = opts[:query_params] || {}
7525
+
7526
+ # header parameters
7527
+ header_params = opts[:header_params] || {}
7528
+ # HTTP header 'Accept' (if needed)
7529
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7530
+ # HTTP header 'Content-Type'
7531
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7532
+
7533
+ # form parameters
7534
+ form_params = opts[:form_params] || {}
7535
+
7536
+ # http body (model)
7537
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_decision_report_request)
7538
+
7539
+ # return_type
7540
+ return_type = opts[:debug_return_type] || 'ProcessorSignalDecisionReportResponse'
7541
+
7542
+ # auth_names
7543
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7544
+
7545
+ new_options = opts.merge(
7546
+ :operation => :"PlaidApi.processor_signal_decision_report",
7547
+ :header_params => header_params,
7548
+ :query_params => query_params,
7549
+ :form_params => form_params,
7550
+ :body => post_body,
7551
+ :auth_names => auth_names,
7552
+ :return_type => return_type
7553
+ )
7554
+
7555
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7556
+ if @api_client.config.debugging
7557
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7558
+ end
7559
+ return data, status_code, headers
7560
+ end
7561
+
7562
+ # Evaluate a planned ACH transaction
7563
+ # Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7564
+ # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7565
+ # @param [Hash] opts the optional parameters
7566
+ # @return [ProcessorSignalEvaluateResponse]
7567
+ def processor_signal_evaluate(processor_signal_evaluate_request, opts = {})
7568
+ data, _status_code, _headers = processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts)
7569
+ data
7570
+ end
7571
+
7572
+ # Evaluate a planned ACH transaction
7573
+ # Use &#x60;/processor/signal/evaluate&#x60; to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/processor/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7574
+ # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7575
+ # @param [Hash] opts the optional parameters
7576
+ # @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
7577
+ def processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts = {})
7578
+ if @api_client.config.debugging
7579
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_evaluate ...'
7580
+ end
7581
+ # verify the required parameter 'processor_signal_evaluate_request' is set
7582
+ if @api_client.config.client_side_validation && processor_signal_evaluate_request.nil?
7583
+ fail ArgumentError, "Missing the required parameter 'processor_signal_evaluate_request' when calling PlaidApi.processor_signal_evaluate"
7584
+ end
7585
+ # resource path
7586
+ local_var_path = '/processor/signal/evaluate'
7587
+
7588
+ # query parameters
7589
+ query_params = opts[:query_params] || {}
7590
+
7591
+ # header parameters
7592
+ header_params = opts[:header_params] || {}
7593
+ # HTTP header 'Accept' (if needed)
7594
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7595
+ # HTTP header 'Content-Type'
7596
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7597
+
7598
+ # form parameters
7599
+ form_params = opts[:form_params] || {}
7600
+
7601
+ # http body (model)
7602
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_evaluate_request)
7603
+
7604
+ # return_type
7605
+ return_type = opts[:debug_return_type] || 'ProcessorSignalEvaluateResponse'
7606
+
7607
+ # auth_names
7608
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7609
+
7610
+ new_options = opts.merge(
7611
+ :operation => :"PlaidApi.processor_signal_evaluate",
7612
+ :header_params => header_params,
7613
+ :query_params => query_params,
7614
+ :form_params => form_params,
7615
+ :body => post_body,
7616
+ :auth_names => auth_names,
7617
+ :return_type => return_type
7618
+ )
7619
+
7620
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7621
+ if @api_client.config.debugging
7622
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7623
+ end
7624
+ return data, status_code, headers
7625
+ end
7626
+
7627
+ # Report a return for an ACH transaction
7628
+ # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7629
+ # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
7630
+ # @param [Hash] opts the optional parameters
7631
+ # @return [ProcessorSignalReturnReportResponse]
7632
+ def processor_signal_return_report(processor_signal_return_report_request, opts = {})
7633
+ data, _status_code, _headers = processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts)
7634
+ data
7635
+ end
7636
+
7637
+ # Report a return for an ACH transaction
7638
+ # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7639
+ # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
7640
+ # @param [Hash] opts the optional parameters
7641
+ # @return [Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>] ProcessorSignalReturnReportResponse data, response status code and response headers
7642
+ def processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts = {})
7643
+ if @api_client.config.debugging
7644
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_return_report ...'
7645
+ end
7646
+ # verify the required parameter 'processor_signal_return_report_request' is set
7647
+ if @api_client.config.client_side_validation && processor_signal_return_report_request.nil?
7648
+ fail ArgumentError, "Missing the required parameter 'processor_signal_return_report_request' when calling PlaidApi.processor_signal_return_report"
7649
+ end
7650
+ # resource path
7651
+ local_var_path = '/processor/signal/return/report'
7652
+
7653
+ # query parameters
7654
+ query_params = opts[:query_params] || {}
7655
+
7656
+ # header parameters
7657
+ header_params = opts[:header_params] || {}
7658
+ # HTTP header 'Accept' (if needed)
7659
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7660
+ # HTTP header 'Content-Type'
7661
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7662
+
7663
+ # form parameters
7664
+ form_params = opts[:form_params] || {}
7665
+
7666
+ # http body (model)
7667
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_return_report_request)
7668
+
7669
+ # return_type
7670
+ return_type = opts[:debug_return_type] || 'ProcessorSignalReturnReportResponse'
7671
+
7672
+ # auth_names
7673
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7674
+
7675
+ new_options = opts.merge(
7676
+ :operation => :"PlaidApi.processor_signal_return_report",
7677
+ :header_params => header_params,
7678
+ :query_params => query_params,
7679
+ :form_params => form_params,
7680
+ :body => post_body,
7681
+ :auth_names => auth_names,
7682
+ :return_type => return_type
7683
+ )
7684
+
7685
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7686
+ if @api_client.config.debugging
7687
+ @api_client.config.logger.debug "API called: PlaidApi#processor_signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7688
+ end
7689
+ return data, status_code, headers
7690
+ end
7691
+
7692
+ # Create Stripe bank account token
7693
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.
7694
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
7695
+ # @param [Hash] opts the optional parameters
7696
+ # @return [ProcessorStripeBankAccountTokenCreateResponse]
7697
+ def processor_stripe_bank_account_token_create(processor_stripe_bank_account_token_create_request, opts = {})
7698
+ data, _status_code, _headers = processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts)
7699
+ data
7700
+ end
7701
+
7702
+ # Create Stripe bank account token
7703
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user&#39;s bank account information changes or they revoke Plaid&#39;s permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new &#x60;access_token&#x60;. Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.
7704
+ # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
7705
+ # @param [Hash] opts the optional parameters
7706
+ # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
7707
+ def processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts = {})
7708
+ if @api_client.config.debugging
7709
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_stripe_bank_account_token_create ...'
7710
+ end
7711
+ # verify the required parameter 'processor_stripe_bank_account_token_create_request' is set
7712
+ if @api_client.config.client_side_validation && processor_stripe_bank_account_token_create_request.nil?
7713
+ fail ArgumentError, "Missing the required parameter 'processor_stripe_bank_account_token_create_request' when calling PlaidApi.processor_stripe_bank_account_token_create"
7714
+ end
7715
+ # resource path
7716
+ local_var_path = '/processor/stripe/bank_account_token/create'
7717
+
7718
+ # query parameters
7719
+ query_params = opts[:query_params] || {}
7720
+
7721
+ # header parameters
7722
+ header_params = opts[:header_params] || {}
7723
+ # HTTP header 'Accept' (if needed)
7724
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7725
+ # HTTP header 'Content-Type'
7726
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7727
+
7728
+ # form parameters
7729
+ form_params = opts[:form_params] || {}
7730
+
7731
+ # http body (model)
7732
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_stripe_bank_account_token_create_request)
7733
+
7734
+ # return_type
7735
+ return_type = opts[:debug_return_type] || 'ProcessorStripeBankAccountTokenCreateResponse'
7736
+
7737
+ # auth_names
7738
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7739
+
7740
+ new_options = opts.merge(
7741
+ :operation => :"PlaidApi.processor_stripe_bank_account_token_create",
7742
+ :header_params => header_params,
7743
+ :query_params => query_params,
7744
+ :form_params => form_params,
7745
+ :body => post_body,
7746
+ :auth_names => auth_names,
7747
+ :return_type => return_type
7748
+ )
7749
+
7750
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7751
+ if @api_client.config.debugging
7752
+ @api_client.config.logger.debug "API called: PlaidApi#processor_stripe_bank_account_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7753
+ end
7754
+ return data, status_code, headers
7755
+ end
7756
+
7757
+ # Create processor token
7758
+ # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
7759
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
6915
7760
  # @param [Hash] opts the optional parameters
6916
- # @return [ProcessorBankTransferCreateResponse]
6917
- def processor_bank_transfer_create(processor_bank_transfer_create_request, opts = {})
6918
- data, _status_code, _headers = processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts)
7761
+ # @return [ProcessorTokenCreateResponse]
7762
+ def processor_token_create(processor_token_create_request, opts = {})
7763
+ data, _status_code, _headers = processor_token_create_with_http_info(processor_token_create_request, opts)
6919
7764
  data
6920
7765
  end
6921
7766
 
6922
- # Create a bank transfer as a processor
6923
- # Use the &#x60;/processor/bank_transfer/create&#x60; endpoint to initiate a new bank transfer as a processor
6924
- # @param processor_bank_transfer_create_request [ProcessorBankTransferCreateRequest]
7767
+ # Create processor token
7768
+ # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new &#x60;access_token&#x60;. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.
7769
+ # @param processor_token_create_request [ProcessorTokenCreateRequest]
6925
7770
  # @param [Hash] opts the optional parameters
6926
- # @return [Array<(ProcessorBankTransferCreateResponse, Integer, Hash)>] ProcessorBankTransferCreateResponse data, response status code and response headers
6927
- def processor_bank_transfer_create_with_http_info(processor_bank_transfer_create_request, opts = {})
7771
+ # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
7772
+ def processor_token_create_with_http_info(processor_token_create_request, opts = {})
6928
7773
  if @api_client.config.debugging
6929
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_bank_transfer_create ...'
7774
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_create ...'
6930
7775
  end
6931
- # verify the required parameter 'processor_bank_transfer_create_request' is set
6932
- if @api_client.config.client_side_validation && processor_bank_transfer_create_request.nil?
6933
- fail ArgumentError, "Missing the required parameter 'processor_bank_transfer_create_request' when calling PlaidApi.processor_bank_transfer_create"
7776
+ # verify the required parameter 'processor_token_create_request' is set
7777
+ if @api_client.config.client_side_validation && processor_token_create_request.nil?
7778
+ fail ArgumentError, "Missing the required parameter 'processor_token_create_request' when calling PlaidApi.processor_token_create"
6934
7779
  end
6935
7780
  # resource path
6936
- local_var_path = '/processor/bank_transfer/create'
7781
+ local_var_path = '/processor/token/create'
6937
7782
 
6938
7783
  # query parameters
6939
7784
  query_params = opts[:query_params] || {}
@@ -6949,16 +7794,16 @@ module Plaid
6949
7794
  form_params = opts[:form_params] || {}
6950
7795
 
6951
7796
  # http body (model)
6952
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_bank_transfer_create_request)
7797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_create_request)
6953
7798
 
6954
7799
  # return_type
6955
- return_type = opts[:debug_return_type] || 'ProcessorBankTransferCreateResponse'
7800
+ return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
6956
7801
 
6957
7802
  # auth_names
6958
7803
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6959
7804
 
6960
7805
  new_options = opts.merge(
6961
- :operation => :"PlaidApi.processor_bank_transfer_create",
7806
+ :operation => :"PlaidApi.processor_token_create",
6962
7807
  :header_params => header_params,
6963
7808
  :query_params => query_params,
6964
7809
  :form_params => form_params,
@@ -6969,36 +7814,36 @@ module Plaid
6969
7814
 
6970
7815
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6971
7816
  if @api_client.config.debugging
6972
- @api_client.config.logger.debug "API called: PlaidApi#processor_bank_transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7817
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6973
7818
  end
6974
7819
  return data, status_code, headers
6975
7820
  end
6976
7821
 
6977
- # Retrieve Identity data
6978
- # The `/processor/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
6979
- # @param processor_identity_get_request [ProcessorIdentityGetRequest]
7822
+ # Get a processor token's product permissions
7823
+ # Used to get a processor token's product permissions. The `products` field will be an empty list if the processor can access all available products.
7824
+ # @param processor_token_permissions_get_request [ProcessorTokenPermissionsGetRequest]
6980
7825
  # @param [Hash] opts the optional parameters
6981
- # @return [ProcessorIdentityGetResponse]
6982
- def processor_identity_get(processor_identity_get_request, opts = {})
6983
- data, _status_code, _headers = processor_identity_get_with_http_info(processor_identity_get_request, opts)
7826
+ # @return [ProcessorTokenPermissionsGetResponse]
7827
+ def processor_token_permissions_get(processor_token_permissions_get_request, opts = {})
7828
+ data, _status_code, _headers = processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts)
6984
7829
  data
6985
7830
  end
6986
7831
 
6987
- # Retrieve Identity data
6988
- # The &#x60;/processor/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses.
6989
- # @param processor_identity_get_request [ProcessorIdentityGetRequest]
7832
+ # Get a processor token&#39;s product permissions
7833
+ # Used to get a processor token&#39;s product permissions. The &#x60;products&#x60; field will be an empty list if the processor can access all available products.
7834
+ # @param processor_token_permissions_get_request [ProcessorTokenPermissionsGetRequest]
6990
7835
  # @param [Hash] opts the optional parameters
6991
- # @return [Array<(ProcessorIdentityGetResponse, Integer, Hash)>] ProcessorIdentityGetResponse data, response status code and response headers
6992
- def processor_identity_get_with_http_info(processor_identity_get_request, opts = {})
7836
+ # @return [Array<(ProcessorTokenPermissionsGetResponse, Integer, Hash)>] ProcessorTokenPermissionsGetResponse data, response status code and response headers
7837
+ def processor_token_permissions_get_with_http_info(processor_token_permissions_get_request, opts = {})
6993
7838
  if @api_client.config.debugging
6994
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_identity_get ...'
7839
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_get ...'
6995
7840
  end
6996
- # verify the required parameter 'processor_identity_get_request' is set
6997
- if @api_client.config.client_side_validation && processor_identity_get_request.nil?
6998
- fail ArgumentError, "Missing the required parameter 'processor_identity_get_request' when calling PlaidApi.processor_identity_get"
7841
+ # verify the required parameter 'processor_token_permissions_get_request' is set
7842
+ if @api_client.config.client_side_validation && processor_token_permissions_get_request.nil?
7843
+ fail ArgumentError, "Missing the required parameter 'processor_token_permissions_get_request' when calling PlaidApi.processor_token_permissions_get"
6999
7844
  end
7000
7845
  # resource path
7001
- local_var_path = '/processor/identity/get'
7846
+ local_var_path = '/processor/token/permissions/get'
7002
7847
 
7003
7848
  # query parameters
7004
7849
  query_params = opts[:query_params] || {}
@@ -7014,16 +7859,16 @@ module Plaid
7014
7859
  form_params = opts[:form_params] || {}
7015
7860
 
7016
7861
  # http body (model)
7017
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_identity_get_request)
7862
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_get_request)
7018
7863
 
7019
7864
  # return_type
7020
- return_type = opts[:debug_return_type] || 'ProcessorIdentityGetResponse'
7865
+ return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsGetResponse'
7021
7866
 
7022
7867
  # auth_names
7023
7868
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7024
7869
 
7025
7870
  new_options = opts.merge(
7026
- :operation => :"PlaidApi.processor_identity_get",
7871
+ :operation => :"PlaidApi.processor_token_permissions_get",
7027
7872
  :header_params => header_params,
7028
7873
  :query_params => query_params,
7029
7874
  :form_params => form_params,
@@ -7034,36 +7879,36 @@ module Plaid
7034
7879
 
7035
7880
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7036
7881
  if @api_client.config.debugging
7037
- @api_client.config.logger.debug "API called: PlaidApi#processor_identity_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7882
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7038
7883
  end
7039
7884
  return data, status_code, headers
7040
7885
  end
7041
7886
 
7042
- # Report whether you initiated an ACH transaction
7043
- # After calling `/processor/signal/evaluate`, call `/processor/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
7044
- # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7887
+ # Control a processor's access to products
7888
+ # Used to control a processor's access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor's needs change.
7889
+ # @param processor_token_permissions_set_request [ProcessorTokenPermissionsSetRequest]
7045
7890
  # @param [Hash] opts the optional parameters
7046
- # @return [ProcessorSignalDecisionReportResponse]
7047
- def processor_signal_decision_report(processor_signal_decision_report_request, opts = {})
7048
- data, _status_code, _headers = processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts)
7891
+ # @return [ProcessorTokenPermissionsSetResponse]
7892
+ def processor_token_permissions_set(processor_token_permissions_set_request, opts = {})
7893
+ data, _status_code, _headers = processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts)
7049
7894
  data
7050
7895
  end
7051
7896
 
7052
- # Report whether you initiated an ACH transaction
7053
- # After calling &#x60;/processor/signal/evaluate&#x60;, call &#x60;/processor/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
7054
- # @param processor_signal_decision_report_request [ProcessorSignalDecisionReportRequest]
7897
+ # Control a processor&#39;s access to products
7898
+ # Used to control a processor&#39;s access to products on the given processor token. By default, a processor will have access to all available products on the corresponding item. To restrict access to a particular set of products, call this endpoint with the desired products. To restore access to all available products, call this endpoint with an empty list. This endpoint can be called multiple times as your needs and your processor&#39;s needs change.
7899
+ # @param processor_token_permissions_set_request [ProcessorTokenPermissionsSetRequest]
7055
7900
  # @param [Hash] opts the optional parameters
7056
- # @return [Array<(ProcessorSignalDecisionReportResponse, Integer, Hash)>] ProcessorSignalDecisionReportResponse data, response status code and response headers
7057
- def processor_signal_decision_report_with_http_info(processor_signal_decision_report_request, opts = {})
7901
+ # @return [Array<(ProcessorTokenPermissionsSetResponse, Integer, Hash)>] ProcessorTokenPermissionsSetResponse data, response status code and response headers
7902
+ def processor_token_permissions_set_with_http_info(processor_token_permissions_set_request, opts = {})
7058
7903
  if @api_client.config.debugging
7059
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_decision_report ...'
7904
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_permissions_set ...'
7060
7905
  end
7061
- # verify the required parameter 'processor_signal_decision_report_request' is set
7062
- if @api_client.config.client_side_validation && processor_signal_decision_report_request.nil?
7063
- fail ArgumentError, "Missing the required parameter 'processor_signal_decision_report_request' when calling PlaidApi.processor_signal_decision_report"
7906
+ # verify the required parameter 'processor_token_permissions_set_request' is set
7907
+ if @api_client.config.client_side_validation && processor_token_permissions_set_request.nil?
7908
+ fail ArgumentError, "Missing the required parameter 'processor_token_permissions_set_request' when calling PlaidApi.processor_token_permissions_set"
7064
7909
  end
7065
7910
  # resource path
7066
- local_var_path = '/processor/signal/decision/report'
7911
+ local_var_path = '/processor/token/permissions/set'
7067
7912
 
7068
7913
  # query parameters
7069
7914
  query_params = opts[:query_params] || {}
@@ -7079,16 +7924,16 @@ module Plaid
7079
7924
  form_params = opts[:form_params] || {}
7080
7925
 
7081
7926
  # http body (model)
7082
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_decision_report_request)
7927
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_permissions_set_request)
7083
7928
 
7084
7929
  # return_type
7085
- return_type = opts[:debug_return_type] || 'ProcessorSignalDecisionReportResponse'
7930
+ return_type = opts[:debug_return_type] || 'ProcessorTokenPermissionsSetResponse'
7086
7931
 
7087
7932
  # auth_names
7088
7933
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7089
7934
 
7090
7935
  new_options = opts.merge(
7091
- :operation => :"PlaidApi.processor_signal_decision_report",
7936
+ :operation => :"PlaidApi.processor_token_permissions_set",
7092
7937
  :header_params => header_params,
7093
7938
  :query_params => query_params,
7094
7939
  :form_params => form_params,
@@ -7099,36 +7944,36 @@ module Plaid
7099
7944
 
7100
7945
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7101
7946
  if @api_client.config.debugging
7102
- @api_client.config.logger.debug "API called: PlaidApi#processor_signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7947
+ @api_client.config.logger.debug "API called: PlaidApi#processor_token_permissions_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7103
7948
  end
7104
7949
  return data, status_code, headers
7105
7950
  end
7106
7951
 
7107
- # Evaluate a planned ACH transaction
7108
- # Use `/processor/signal/evaluate` to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/processor/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7109
- # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7952
+ # Get transaction data
7953
+ # 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.
7954
+ # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
7110
7955
  # @param [Hash] opts the optional parameters
7111
- # @return [ProcessorSignalEvaluateResponse]
7112
- def processor_signal_evaluate(processor_signal_evaluate_request, opts = {})
7113
- data, _status_code, _headers = processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts)
7956
+ # @return [ProcessorTransactionsGetResponse]
7957
+ def processor_transactions_get(processor_transactions_get_request, opts = {})
7958
+ data, _status_code, _headers = processor_transactions_get_with_http_info(processor_transactions_get_request, opts)
7114
7959
  data
7115
7960
  end
7116
7961
 
7117
- # Evaluate a planned ACH transaction
7118
- # Use &#x60;/processor/signal/evaluate&#x60; to evaluate a planned ACH transaction as a processor to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/processor/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7119
- # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7962
+ # Get transaction data
7963
+ # 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.
7964
+ # @param processor_transactions_get_request [ProcessorTransactionsGetRequest]
7120
7965
  # @param [Hash] opts the optional parameters
7121
- # @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
7122
- def processor_signal_evaluate_with_http_info(processor_signal_evaluate_request, opts = {})
7966
+ # @return [Array<(ProcessorTransactionsGetResponse, Integer, Hash)>] ProcessorTransactionsGetResponse data, response status code and response headers
7967
+ def processor_transactions_get_with_http_info(processor_transactions_get_request, opts = {})
7123
7968
  if @api_client.config.debugging
7124
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_evaluate ...'
7969
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_get ...'
7125
7970
  end
7126
- # verify the required parameter 'processor_signal_evaluate_request' is set
7127
- if @api_client.config.client_side_validation && processor_signal_evaluate_request.nil?
7128
- fail ArgumentError, "Missing the required parameter 'processor_signal_evaluate_request' when calling PlaidApi.processor_signal_evaluate"
7971
+ # verify the required parameter 'processor_transactions_get_request' is set
7972
+ if @api_client.config.client_side_validation && processor_transactions_get_request.nil?
7973
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_get_request' when calling PlaidApi.processor_transactions_get"
7129
7974
  end
7130
7975
  # resource path
7131
- local_var_path = '/processor/signal/evaluate'
7976
+ local_var_path = '/processor/transactions/get'
7132
7977
 
7133
7978
  # query parameters
7134
7979
  query_params = opts[:query_params] || {}
@@ -7144,16 +7989,16 @@ module Plaid
7144
7989
  form_params = opts[:form_params] || {}
7145
7990
 
7146
7991
  # http body (model)
7147
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_evaluate_request)
7992
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_get_request)
7148
7993
 
7149
7994
  # return_type
7150
- return_type = opts[:debug_return_type] || 'ProcessorSignalEvaluateResponse'
7995
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsGetResponse'
7151
7996
 
7152
7997
  # auth_names
7153
7998
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7154
7999
 
7155
8000
  new_options = opts.merge(
7156
- :operation => :"PlaidApi.processor_signal_evaluate",
8001
+ :operation => :"PlaidApi.processor_transactions_get",
7157
8002
  :header_params => header_params,
7158
8003
  :query_params => query_params,
7159
8004
  :form_params => form_params,
@@ -7164,36 +8009,36 @@ module Plaid
7164
8009
 
7165
8010
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7166
8011
  if @api_client.config.debugging
7167
- @api_client.config.logger.debug "API called: PlaidApi#processor_signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8012
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7168
8013
  end
7169
8014
  return data, status_code, headers
7170
8015
  end
7171
8016
 
7172
- # Report a return for an ACH transaction
7173
- # Call the `/processor/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/processor/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7174
- # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
8017
+ # Fetch recurring transaction streams
8018
+ # 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.
8019
+ # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
7175
8020
  # @param [Hash] opts the optional parameters
7176
- # @return [ProcessorSignalReturnReportResponse]
7177
- def processor_signal_return_report(processor_signal_return_report_request, opts = {})
7178
- data, _status_code, _headers = processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts)
8021
+ # @return [ProcessorTransactionsRecurringGetResponse]
8022
+ def processor_transactions_recurring_get(processor_transactions_recurring_get_request, opts = {})
8023
+ data, _status_code, _headers = processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts)
7179
8024
  data
7180
8025
  end
7181
8026
 
7182
- # Report a return for an ACH transaction
7183
- # Call the &#x60;/processor/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/processor/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7184
- # @param processor_signal_return_report_request [ProcessorSignalReturnReportRequest]
8027
+ # Fetch recurring transaction streams
8028
+ # 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.
8029
+ # @param processor_transactions_recurring_get_request [ProcessorTransactionsRecurringGetRequest]
7185
8030
  # @param [Hash] opts the optional parameters
7186
- # @return [Array<(ProcessorSignalReturnReportResponse, Integer, Hash)>] ProcessorSignalReturnReportResponse data, response status code and response headers
7187
- def processor_signal_return_report_with_http_info(processor_signal_return_report_request, opts = {})
8031
+ # @return [Array<(ProcessorTransactionsRecurringGetResponse, Integer, Hash)>] ProcessorTransactionsRecurringGetResponse data, response status code and response headers
8032
+ def processor_transactions_recurring_get_with_http_info(processor_transactions_recurring_get_request, opts = {})
7188
8033
  if @api_client.config.debugging
7189
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_signal_return_report ...'
8034
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_recurring_get ...'
7190
8035
  end
7191
- # verify the required parameter 'processor_signal_return_report_request' is set
7192
- if @api_client.config.client_side_validation && processor_signal_return_report_request.nil?
7193
- fail ArgumentError, "Missing the required parameter 'processor_signal_return_report_request' when calling PlaidApi.processor_signal_return_report"
8036
+ # verify the required parameter 'processor_transactions_recurring_get_request' is set
8037
+ if @api_client.config.client_side_validation && processor_transactions_recurring_get_request.nil?
8038
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_recurring_get_request' when calling PlaidApi.processor_transactions_recurring_get"
7194
8039
  end
7195
8040
  # resource path
7196
- local_var_path = '/processor/signal/return/report'
8041
+ local_var_path = '/processor/transactions/recurring/get'
7197
8042
 
7198
8043
  # query parameters
7199
8044
  query_params = opts[:query_params] || {}
@@ -7209,16 +8054,16 @@ module Plaid
7209
8054
  form_params = opts[:form_params] || {}
7210
8055
 
7211
8056
  # http body (model)
7212
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_signal_return_report_request)
8057
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_recurring_get_request)
7213
8058
 
7214
8059
  # return_type
7215
- return_type = opts[:debug_return_type] || 'ProcessorSignalReturnReportResponse'
8060
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsRecurringGetResponse'
7216
8061
 
7217
8062
  # auth_names
7218
8063
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7219
8064
 
7220
8065
  new_options = opts.merge(
7221
- :operation => :"PlaidApi.processor_signal_return_report",
8066
+ :operation => :"PlaidApi.processor_transactions_recurring_get",
7222
8067
  :header_params => header_params,
7223
8068
  :query_params => query_params,
7224
8069
  :form_params => form_params,
@@ -7229,36 +8074,36 @@ module Plaid
7229
8074
 
7230
8075
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7231
8076
  if @api_client.config.debugging
7232
- @api_client.config.logger.debug "API called: PlaidApi#processor_signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8077
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7233
8078
  end
7234
8079
  return data, status_code, headers
7235
8080
  end
7236
8081
 
7237
- # Create Stripe bank account token
7238
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
7239
- # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
8082
+ # Refresh transaction data
8083
+ # `/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.
8084
+ # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
7240
8085
  # @param [Hash] opts the optional parameters
7241
- # @return [ProcessorStripeBankAccountTokenCreateResponse]
7242
- def processor_stripe_bank_account_token_create(processor_stripe_bank_account_token_create_request, opts = {})
7243
- data, _status_code, _headers = processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts)
8086
+ # @return [ProcessorTransactionsRefreshResponse]
8087
+ def processor_transactions_refresh(processor_transactions_refresh_request, opts = {})
8088
+ data, _status_code, _headers = processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts)
7244
8089
  data
7245
8090
  end
7246
8091
 
7247
- # Create Stripe bank account token
7248
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user&#39;s bank account information changes or they revoke Plaid&#39;s permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new &#x60;access_token&#x60;. Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.&#39;
7249
- # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
8092
+ # Refresh transaction data
8093
+ # &#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.
8094
+ # @param processor_transactions_refresh_request [ProcessorTransactionsRefreshRequest]
7250
8095
  # @param [Hash] opts the optional parameters
7251
- # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
7252
- def processor_stripe_bank_account_token_create_with_http_info(processor_stripe_bank_account_token_create_request, opts = {})
8096
+ # @return [Array<(ProcessorTransactionsRefreshResponse, Integer, Hash)>] ProcessorTransactionsRefreshResponse data, response status code and response headers
8097
+ def processor_transactions_refresh_with_http_info(processor_transactions_refresh_request, opts = {})
7253
8098
  if @api_client.config.debugging
7254
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_stripe_bank_account_token_create ...'
8099
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_refresh ...'
7255
8100
  end
7256
- # verify the required parameter 'processor_stripe_bank_account_token_create_request' is set
7257
- if @api_client.config.client_side_validation && processor_stripe_bank_account_token_create_request.nil?
7258
- fail ArgumentError, "Missing the required parameter 'processor_stripe_bank_account_token_create_request' when calling PlaidApi.processor_stripe_bank_account_token_create"
8101
+ # verify the required parameter 'processor_transactions_refresh_request' is set
8102
+ if @api_client.config.client_side_validation && processor_transactions_refresh_request.nil?
8103
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_refresh_request' when calling PlaidApi.processor_transactions_refresh"
7259
8104
  end
7260
8105
  # resource path
7261
- local_var_path = '/processor/stripe/bank_account_token/create'
8106
+ local_var_path = '/processor/transactions/refresh'
7262
8107
 
7263
8108
  # query parameters
7264
8109
  query_params = opts[:query_params] || {}
@@ -7274,16 +8119,16 @@ module Plaid
7274
8119
  form_params = opts[:form_params] || {}
7275
8120
 
7276
8121
  # http body (model)
7277
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_stripe_bank_account_token_create_request)
8122
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_refresh_request)
7278
8123
 
7279
8124
  # return_type
7280
- return_type = opts[:debug_return_type] || 'ProcessorStripeBankAccountTokenCreateResponse'
8125
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsRefreshResponse'
7281
8126
 
7282
8127
  # auth_names
7283
8128
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7284
8129
 
7285
8130
  new_options = opts.merge(
7286
- :operation => :"PlaidApi.processor_stripe_bank_account_token_create",
8131
+ :operation => :"PlaidApi.processor_transactions_refresh",
7287
8132
  :header_params => header_params,
7288
8133
  :query_params => query_params,
7289
8134
  :form_params => form_params,
@@ -7294,36 +8139,36 @@ module Plaid
7294
8139
 
7295
8140
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7296
8141
  if @api_client.config.debugging
7297
- @api_client.config.logger.debug "API called: PlaidApi#processor_stripe_bank_account_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8142
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7298
8143
  end
7299
8144
  return data, status_code, headers
7300
8145
  end
7301
8146
 
7302
- # Create processor token
7303
- # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new `access_token`. Processor tokens can also be revoked, using `/item/remove`.
7304
- # @param processor_token_create_request [ProcessorTokenCreateRequest]
8147
+ # Get incremental transaction updates on an Item
8148
+ # 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.
8149
+ # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
7305
8150
  # @param [Hash] opts the optional parameters
7306
- # @return [ProcessorTokenCreateResponse]
7307
- def processor_token_create(processor_token_create_request, opts = {})
7308
- data, _status_code, _headers = processor_token_create_with_http_info(processor_token_create_request, opts)
8151
+ # @return [ProcessorTransactionsSyncResponse]
8152
+ def processor_transactions_sync(processor_transactions_sync_request, opts = {})
8153
+ data, _status_code, _headers = processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts)
7309
8154
  data
7310
8155
  end
7311
8156
 
7312
- # Create processor token
7313
- # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations. Once created, a processor token for a given Item cannot be modified or updated. If the account must be linked to a new or different partner resource, create a new Item by having the user go through the Link flow again; a new processor token can then be created from the new &#x60;access_token&#x60;. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.
7314
- # @param processor_token_create_request [ProcessorTokenCreateRequest]
8157
+ # Get incremental transaction updates on an Item
8158
+ # 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.
8159
+ # @param processor_transactions_sync_request [ProcessorTransactionsSyncRequest]
7315
8160
  # @param [Hash] opts the optional parameters
7316
- # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
7317
- def processor_token_create_with_http_info(processor_token_create_request, opts = {})
8161
+ # @return [Array<(ProcessorTransactionsSyncResponse, Integer, Hash)>] ProcessorTransactionsSyncResponse data, response status code and response headers
8162
+ def processor_transactions_sync_with_http_info(processor_transactions_sync_request, opts = {})
7318
8163
  if @api_client.config.debugging
7319
- @api_client.config.logger.debug 'Calling API: PlaidApi.processor_token_create ...'
8164
+ @api_client.config.logger.debug 'Calling API: PlaidApi.processor_transactions_sync ...'
7320
8165
  end
7321
- # verify the required parameter 'processor_token_create_request' is set
7322
- if @api_client.config.client_side_validation && processor_token_create_request.nil?
7323
- fail ArgumentError, "Missing the required parameter 'processor_token_create_request' when calling PlaidApi.processor_token_create"
8166
+ # verify the required parameter 'processor_transactions_sync_request' is set
8167
+ if @api_client.config.client_side_validation && processor_transactions_sync_request.nil?
8168
+ fail ArgumentError, "Missing the required parameter 'processor_transactions_sync_request' when calling PlaidApi.processor_transactions_sync"
7324
8169
  end
7325
8170
  # resource path
7326
- local_var_path = '/processor/token/create'
8171
+ local_var_path = '/processor/transactions/sync'
7327
8172
 
7328
8173
  # query parameters
7329
8174
  query_params = opts[:query_params] || {}
@@ -7339,16 +8184,16 @@ module Plaid
7339
8184
  form_params = opts[:form_params] || {}
7340
8185
 
7341
8186
  # http body (model)
7342
- post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_token_create_request)
8187
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(processor_transactions_sync_request)
7343
8188
 
7344
8189
  # return_type
7345
- return_type = opts[:debug_return_type] || 'ProcessorTokenCreateResponse'
8190
+ return_type = opts[:debug_return_type] || 'ProcessorTransactionsSyncResponse'
7346
8191
 
7347
8192
  # auth_names
7348
8193
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7349
8194
 
7350
8195
  new_options = opts.merge(
7351
- :operation => :"PlaidApi.processor_token_create",
8196
+ :operation => :"PlaidApi.processor_transactions_sync",
7352
8197
  :header_params => header_params,
7353
8198
  :query_params => query_params,
7354
8199
  :form_params => form_params,
@@ -7359,7 +8204,7 @@ module Plaid
7359
8204
 
7360
8205
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7361
8206
  if @api_client.config.debugging
7362
- @api_client.config.logger.debug "API called: PlaidApi#processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8207
+ @api_client.config.logger.debug "API called: PlaidApi#processor_transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7363
8208
  end
7364
8209
  return data, status_code, headers
7365
8210
  end
@@ -7560,7 +8405,7 @@ module Plaid
7560
8405
  end
7561
8406
 
7562
8407
  # Fire a test webhook
7563
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
8408
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `PRODUCT_READY`: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `ERROR`: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7564
8409
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
7565
8410
  # @param [Hash] opts the optional parameters
7566
8411
  # @return [SandboxItemFireWebhookResponse]
@@ -7570,7 +8415,7 @@ module Plaid
7570
8415
  end
7571
8416
 
7572
8417
  # Fire a test webhook
7573
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
8418
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;PRODUCT_READY&#x60;: Assets webhook to be fired when a given asset report has been successfully generated. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;ERROR&#x60;: Assets webhook to be fired when asset report generation has failed. If the Item does not support Assets, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7574
8419
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
7575
8420
  # @param [Hash] opts the optional parameters
7576
8421
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -8860,7 +9705,7 @@ module Plaid
8860
9705
  end
8861
9706
 
8862
9707
  # Enrich locally-held transaction data
8863
- # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. To request access to Enrich, reach out to your Plaid point of contact or send a note to enrich-feedback@plaid.com
9708
+ # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
8864
9709
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8865
9710
  # @param [Hash] opts the optional parameters
8866
9711
  # @return [TransactionsEnrichGetResponse]
@@ -8870,7 +9715,7 @@ module Plaid
8870
9715
  end
8871
9716
 
8872
9717
  # Enrich locally-held transaction data
8873
- # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. To request access to Enrich, reach out to your Plaid point of contact or send a note to enrich-feedback@plaid.com
9718
+ # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources.
8874
9719
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8875
9720
  # @param [Hash] opts the optional parameters
8876
9721
  # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
@@ -8925,7 +9770,7 @@ module Plaid
8925
9770
  end
8926
9771
 
8927
9772
  # Get transaction data
8928
- # The `/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). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. 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 `/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 `/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 `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
9773
+ # Note: All new implementations are encouraged to use `/transactions/sync` rather than `/transactions/get`. `/transactions/sync` provides the same functionality as `/transactions/get` and improves developer ease-of-use for handling transactions updates. The `/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). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. 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 `/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 `/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 `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
8929
9774
  # @param transactions_get_request [TransactionsGetRequest]
8930
9775
  # @param [Hash] opts the optional parameters
8931
9776
  # @return [TransactionsGetResponse]
@@ -8935,7 +9780,7 @@ module Plaid
8935
9780
  end
8936
9781
 
8937
9782
  # Get transaction data
8938
- # The &#x60;/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). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. 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;/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;/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;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/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;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
9783
+ # Note: All new implementations are encouraged to use &#x60;/transactions/sync&#x60; rather than &#x60;/transactions/get&#x60;. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and improves developer ease-of-use for handling transactions updates. The &#x60;/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). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. 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;/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;/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;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/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;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
8939
9784
  # @param transactions_get_request [TransactionsGetRequest]
8940
9785
  # @param [Hash] opts the optional parameters
8941
9786
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -9315,7 +10160,7 @@ module Plaid
9315
10160
  end
9316
10161
 
9317
10162
  # Get incremental transaction updates on an Item
9318
- # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/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. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/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 `/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 `/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 `/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, `/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 `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/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. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
10163
+ # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/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. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/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 `/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 `/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 `/transactions/sync` fails due to 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, `/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 `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/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. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9319
10164
  # @param transactions_sync_request [TransactionsSyncRequest]
9320
10165
  # @param [Hash] opts the optional parameters
9321
10166
  # @return [TransactionsSyncResponse]
@@ -9325,7 +10170,7 @@ module Plaid
9325
10170
  end
9326
10171
 
9327
10172
  # Get incremental transaction updates on an Item
9328
- # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/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;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/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;/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;/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;/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;/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;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/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. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
10173
+ # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/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;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/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;/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;/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;/transactions/sync&#x60; fails due to 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;/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;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/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. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9329
10174
  # @param transactions_sync_request [TransactionsSyncRequest]
9330
10175
  # @param [Hash] opts the optional parameters
9331
10176
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -9380,7 +10225,7 @@ module Plaid
9380
10225
  end
9381
10226
 
9382
10227
  # Create a transfer authorization
9383
- # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
10228
+ # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. The fields `device.ip_address` and `device.user_agent` are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device.
9384
10229
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9385
10230
  # @param [Hash] opts the optional parameters
9386
10231
  # @return [TransferAuthorizationCreateResponse]
@@ -9390,7 +10235,7 @@ module Plaid
9390
10235
  end
9391
10236
 
9392
10237
  # Create a transfer authorization
9393
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60; are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : &#x60;idempotency_key&#x60;, &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.
10238
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. The fields &#x60;device.ip_address&#x60; and &#x60;device.user_agent&#x60; are required for all sessions where the end-user is present. For example, when a user is authorizing a one-time payment from their device.
9394
10239
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9395
10240
  # @param [Hash] opts the optional parameters
9396
10241
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -9444,6 +10289,71 @@ module Plaid
9444
10289
  return data, status_code, headers
9445
10290
  end
9446
10291
 
10292
+ # Retrieve a balance held with Plaid
10293
+ # Use the `/transfer/balance/get` endpoint to view a balance held with Plaid.
10294
+ # @param transfer_balance_get_request [TransferBalanceGetRequest]
10295
+ # @param [Hash] opts the optional parameters
10296
+ # @return [TransferBalanceGetResponse]
10297
+ def transfer_balance_get(transfer_balance_get_request, opts = {})
10298
+ data, _status_code, _headers = transfer_balance_get_with_http_info(transfer_balance_get_request, opts)
10299
+ data
10300
+ end
10301
+
10302
+ # Retrieve a balance held with Plaid
10303
+ # Use the &#x60;/transfer/balance/get&#x60; endpoint to view a balance held with Plaid.
10304
+ # @param transfer_balance_get_request [TransferBalanceGetRequest]
10305
+ # @param [Hash] opts the optional parameters
10306
+ # @return [Array<(TransferBalanceGetResponse, Integer, Hash)>] TransferBalanceGetResponse data, response status code and response headers
10307
+ def transfer_balance_get_with_http_info(transfer_balance_get_request, opts = {})
10308
+ if @api_client.config.debugging
10309
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_balance_get ...'
10310
+ end
10311
+ # verify the required parameter 'transfer_balance_get_request' is set
10312
+ if @api_client.config.client_side_validation && transfer_balance_get_request.nil?
10313
+ fail ArgumentError, "Missing the required parameter 'transfer_balance_get_request' when calling PlaidApi.transfer_balance_get"
10314
+ end
10315
+ # resource path
10316
+ local_var_path = '/transfer/balance/get'
10317
+
10318
+ # query parameters
10319
+ query_params = opts[:query_params] || {}
10320
+
10321
+ # header parameters
10322
+ header_params = opts[:header_params] || {}
10323
+ # HTTP header 'Accept' (if needed)
10324
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10325
+ # HTTP header 'Content-Type'
10326
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10327
+
10328
+ # form parameters
10329
+ form_params = opts[:form_params] || {}
10330
+
10331
+ # http body (model)
10332
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_balance_get_request)
10333
+
10334
+ # return_type
10335
+ return_type = opts[:debug_return_type] || 'TransferBalanceGetResponse'
10336
+
10337
+ # auth_names
10338
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10339
+
10340
+ new_options = opts.merge(
10341
+ :operation => :"PlaidApi.transfer_balance_get",
10342
+ :header_params => header_params,
10343
+ :query_params => query_params,
10344
+ :form_params => form_params,
10345
+ :body => post_body,
10346
+ :auth_names => auth_names,
10347
+ :return_type => return_type
10348
+ )
10349
+
10350
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10351
+ if @api_client.config.debugging
10352
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_balance_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10353
+ end
10354
+ return data, status_code, headers
10355
+ end
10356
+
9447
10357
  # Cancel a transfer
9448
10358
  # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
9449
10359
  # @param transfer_cancel_request [TransferCancelRequest]
@@ -9704,6 +10614,71 @@ module Plaid
9704
10614
  return data, status_code, headers
9705
10615
  end
9706
10616
 
10617
+ # Submit transfer diligence on behalf of the end customer (i.e. the originator).
10618
+ # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
10619
+ # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
10620
+ # @param [Hash] opts the optional parameters
10621
+ # @return [TransferDiligenceSubmitResponse]
10622
+ def transfer_diligence_submit(transfer_diligence_submit_request, opts = {})
10623
+ data, _status_code, _headers = transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts)
10624
+ data
10625
+ end
10626
+
10627
+ # Submit transfer diligence on behalf of the end customer (i.e. the originator).
10628
+ # Use the &#x60;/transfer/diligence/submit&#x60; endpoint to submit transfer diligence on behalf of the originator.
10629
+ # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
10630
+ # @param [Hash] opts the optional parameters
10631
+ # @return [Array<(TransferDiligenceSubmitResponse, Integer, Hash)>] TransferDiligenceSubmitResponse data, response status code and response headers
10632
+ def transfer_diligence_submit_with_http_info(transfer_diligence_submit_request, opts = {})
10633
+ if @api_client.config.debugging
10634
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_diligence_submit ...'
10635
+ end
10636
+ # verify the required parameter 'transfer_diligence_submit_request' is set
10637
+ if @api_client.config.client_side_validation && transfer_diligence_submit_request.nil?
10638
+ fail ArgumentError, "Missing the required parameter 'transfer_diligence_submit_request' when calling PlaidApi.transfer_diligence_submit"
10639
+ end
10640
+ # resource path
10641
+ local_var_path = '/transfer/diligence/submit'
10642
+
10643
+ # query parameters
10644
+ query_params = opts[:query_params] || {}
10645
+
10646
+ # header parameters
10647
+ header_params = opts[:header_params] || {}
10648
+ # HTTP header 'Accept' (if needed)
10649
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10650
+ # HTTP header 'Content-Type'
10651
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10652
+
10653
+ # form parameters
10654
+ form_params = opts[:form_params] || {}
10655
+
10656
+ # http body (model)
10657
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_diligence_submit_request)
10658
+
10659
+ # return_type
10660
+ return_type = opts[:debug_return_type] || 'TransferDiligenceSubmitResponse'
10661
+
10662
+ # auth_names
10663
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10664
+
10665
+ new_options = opts.merge(
10666
+ :operation => :"PlaidApi.transfer_diligence_submit",
10667
+ :header_params => header_params,
10668
+ :query_params => query_params,
10669
+ :form_params => form_params,
10670
+ :body => post_body,
10671
+ :auth_names => auth_names,
10672
+ :return_type => return_type
10673
+ )
10674
+
10675
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10676
+ if @api_client.config.debugging
10677
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_diligence_submit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10678
+ end
10679
+ return data, status_code, headers
10680
+ end
10681
+
9707
10682
  # List transfer events
9708
10683
  # Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
9709
10684
  # @param transfer_event_list_request [TransferEventListRequest]
@@ -9770,7 +10745,7 @@ module Plaid
9770
10745
  end
9771
10746
 
9772
10747
  # Sync transfer events
9773
- # `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
10748
+ # `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
9774
10749
  # @param transfer_event_sync_request [TransferEventSyncRequest]
9775
10750
  # @param [Hash] opts the optional parameters
9776
10751
  # @return [TransferEventSyncResponse]
@@ -9780,7 +10755,7 @@ module Plaid
9780
10755
  end
9781
10756
 
9782
10757
  # Sync transfer events
9783
- # &#x60;/transfer/event/sync&#x60; allows you to request up to the next 25 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events. When using Auth with micro-deposit verification enabled, this endpoint can be used to fetch status updates on ACH micro-deposits. For more details, see [micro-deposit events](https://www.plaid.com/docs/auth/coverage/microdeposit-events/).
10758
+ # &#x60;/transfer/event/sync&#x60; allows you to request up to the next 25 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events.
9784
10759
  # @param transfer_event_sync_request [TransferEventSyncRequest]
9785
10760
  # @param [Hash] opts the optional parameters
9786
10761
  # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers