plaid 19.0.0 → 20.0.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1229) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +104 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/README.md +2 -2
  6. data/lib/plaid/api/plaid_api.rb +419 -29
  7. data/lib/plaid/api_client.rb +2 -2
  8. data/lib/plaid/api_error.rb +1 -1
  9. data/lib/plaid/configuration.rb +1 -1
  10. data/lib/plaid/models/account_access.rb +1 -1
  11. data/lib/plaid/models/account_assets.rb +1 -1
  12. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  13. data/lib/plaid/models/account_balance.rb +1 -1
  14. data/lib/plaid/models/account_base.rb +1 -1
  15. data/lib/plaid/models/account_filter.rb +1 -1
  16. data/lib/plaid/models/account_filters_response.rb +1 -1
  17. data/lib/plaid/models/account_identity.rb +1 -1
  18. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  20. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  21. data/lib/plaid/models/account_product_access.rb +1 -1
  22. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  23. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  24. data/lib/plaid/models/account_subtype.rb +1 -1
  25. data/lib/plaid/models/account_type.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  30. data/lib/plaid/models/accounts_get_response.rb +1 -1
  31. data/lib/plaid/models/ach_class.rb +1 -1
  32. data/lib/plaid/models/action_state.rb +1 -1
  33. data/lib/plaid/models/activity.rb +1 -1
  34. data/lib/plaid/models/activity_type.rb +1 -1
  35. data/lib/plaid/models/address.rb +1 -1
  36. data/lib/plaid/models/address_data.rb +1 -1
  37. data/lib/plaid/models/address_data_nullable.rb +1 -1
  38. data/lib/plaid/models/address_match_score.rb +1 -1
  39. data/lib/plaid/models/address_nullable.rb +1 -1
  40. data/lib/plaid/models/address_purpose_label.rb +1 -1
  41. data/lib/plaid/models/application.rb +1 -1
  42. data/lib/plaid/models/application_get_request.rb +1 -1
  43. data/lib/plaid/models/application_get_response.rb +1 -1
  44. data/lib/plaid/models/apr.rb +1 -1
  45. data/lib/plaid/models/asset.rb +1 -1
  46. data/lib/plaid/models/asset_detail.rb +1 -1
  47. data/lib/plaid/models/asset_holder.rb +1 -1
  48. data/lib/plaid/models/asset_holder_name.rb +1 -1
  49. data/lib/plaid/models/asset_owner.rb +1 -1
  50. data/lib/plaid/models/asset_owners.rb +1 -1
  51. data/lib/plaid/models/asset_report.rb +1 -1
  52. data/lib/plaid/models/asset_report_add_ons.rb +1 -1
  53. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  55. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  56. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  60. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  62. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  63. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  64. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  67. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  68. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  69. data/lib/plaid/models/asset_report_item.rb +1 -1
  70. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  72. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  74. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  75. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  76. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  77. data/lib/plaid/models/asset_report_transaction.rb +44 -99
  78. data/lib/plaid/models/asset_report_transaction_type.rb +41 -0
  79. data/lib/plaid/models/asset_report_user.rb +1 -1
  80. data/lib/plaid/models/asset_transaction.rb +1 -1
  81. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  82. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  83. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  84. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  85. data/lib/plaid/models/asset_transactions.rb +1 -1
  86. data/lib/plaid/models/asset_type.rb +1 -1
  87. data/lib/plaid/models/assets.rb +1 -1
  88. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  89. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  90. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  91. data/lib/plaid/models/auth_get_request.rb +1 -1
  92. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  93. data/lib/plaid/models/auth_get_response.rb +1 -1
  94. data/lib/plaid/models/auth_metadata.rb +1 -1
  95. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  96. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  97. data/lib/plaid/models/bank_income_refresh_complete_result.rb +39 -0
  98. data/lib/plaid/models/bank_income_refresh_complete_webhook.rb +283 -0
  99. data/lib/plaid/models/bank_income_refresh_update_webhook.rb +269 -0
  100. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  101. data/lib/plaid/models/bank_transfer.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  134. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  135. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +1 -1
  136. data/lib/plaid/models/categories_get_response.rb +1 -1
  137. data/lib/plaid/models/category.rb +1 -1
  138. data/lib/plaid/models/cause.rb +1 -1
  139. data/lib/plaid/models/cause_all_of.rb +1 -1
  140. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  141. data/lib/plaid/models/client_provided_enriched_transaction.rb +42 -2
  142. data/lib/plaid/models/client_provided_raw_transaction.rb +1 -1
  143. data/lib/plaid/models/client_provided_transaction.rb +42 -2
  144. data/lib/plaid/models/client_provided_transaction_location.rb +1 -1
  145. data/lib/plaid/models/connected_application.rb +1 -1
  146. data/lib/plaid/models/counterparty.rb +1 -1
  147. data/lib/plaid/models/counterparty_type.rb +2 -1
  148. data/lib/plaid/models/country_code.rb +1 -1
  149. data/lib/plaid/models/credit1099.rb +1 -1
  150. data/lib/plaid/models/credit1099_filer.rb +1 -1
  151. data/lib/plaid/models/credit1099_payer.rb +1 -1
  152. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  153. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  154. data/lib/plaid/models/credit_ach_class.rb +40 -0
  155. data/lib/plaid/models/credit_amount_with_currency.rb +1 -1
  156. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  157. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  158. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  159. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  160. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +1 -1
  161. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +1 -1
  162. data/lib/plaid/models/credit_bank_employer.rb +1 -1
  163. data/lib/plaid/models/credit_bank_employment.rb +1 -1
  164. data/lib/plaid/models/credit_bank_employment_get_request.rb +1 -1
  165. data/lib/plaid/models/credit_bank_employment_get_response.rb +1 -1
  166. data/lib/plaid/models/credit_bank_employment_item.rb +1 -1
  167. data/lib/plaid/models/credit_bank_employment_report.rb +1 -1
  168. data/lib/plaid/models/credit_bank_employment_warning.rb +1 -1
  169. data/lib/plaid/models/credit_bank_employment_warning_type.rb +1 -1
  170. data/lib/plaid/models/credit_bank_income.rb +1 -1
  171. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  172. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  173. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  174. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  175. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  176. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  177. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  178. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  179. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  180. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  181. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  182. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  183. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  184. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +5 -15
  185. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  186. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  187. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  188. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  189. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  190. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  191. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  192. data/lib/plaid/models/credit_bank_income_webhook_update_request.rb +260 -0
  193. data/lib/plaid/models/credit_bank_statement_upload_account_owner.rb +235 -0
  194. data/lib/plaid/models/credit_bank_statement_upload_account_owner_address.rb +265 -0
  195. data/lib/plaid/models/credit_bank_statement_upload_bank_account.rb +296 -0
  196. data/lib/plaid/models/credit_bank_statement_upload_bank_account_period.rb +254 -0
  197. data/lib/plaid/models/credit_bank_statement_upload_item.rb +262 -0
  198. data/lib/plaid/models/credit_bank_statement_upload_object.rb +269 -0
  199. data/lib/plaid/models/credit_bank_statement_upload_transaction.rb +254 -0
  200. data/lib/plaid/models/credit_bank_statements_uploads_get_request.rb +245 -0
  201. data/lib/plaid/models/credit_bank_statements_uploads_get_response.rb +242 -0
  202. data/lib/plaid/models/credit_card_liability.rb +1 -1
  203. data/lib/plaid/models/credit_category.rb +1 -1
  204. data/lib/plaid/models/credit_document_metadata.rb +18 -7
  205. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  206. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  207. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  208. data/lib/plaid/models/credit_employment_item.rb +1 -1
  209. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  210. data/lib/plaid/models/credit_filter.rb +1 -1
  211. data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +1 -1
  212. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +1 -1
  213. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +1 -1
  214. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +1 -1
  215. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +1 -1
  216. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +1 -1
  217. data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +1 -1
  218. data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +1 -1
  219. data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +1 -1
  220. data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +1 -1
  221. data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +1 -1
  222. data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +1 -1
  223. data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +1 -1
  224. data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +1 -1
  225. data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +1 -1
  226. data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +1 -1
  227. data/lib/plaid/models/credit_freddie_mac_party_voa24.rb +1 -1
  228. data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +1 -1
  229. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +1 -1
  230. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +1 -1
  231. data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +1 -1
  232. data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +1 -1
  233. data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +1 -1
  234. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +1 -1
  235. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +1 -1
  236. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +1 -1
  237. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +1 -1
  238. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +1 -1
  239. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +1 -1
  240. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +1 -1
  241. data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +1 -1
  242. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +1 -1
  243. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  244. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  245. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  246. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  247. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  248. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  249. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  250. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +1 -1
  251. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  252. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  253. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  254. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  255. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  256. data/lib/plaid/models/credit_payroll_income_refresh_request_options.rb +1 -1
  257. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  258. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  259. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  260. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  261. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  262. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  263. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  264. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  265. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  266. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  267. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  268. data/lib/plaid/models/credit_session.rb +1 -1
  269. data/lib/plaid/models/credit_session_bank_employment_result.rb +1 -1
  270. data/lib/plaid/models/credit_session_bank_employment_status.rb +1 -1
  271. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  272. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  273. data/lib/plaid/models/credit_session_document_income_result.rb +20 -5
  274. data/lib/plaid/models/credit_session_error.rb +1 -1
  275. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  276. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  277. data/lib/plaid/models/credit_session_results.rb +1 -1
  278. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  279. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  280. data/lib/plaid/models/credit_w2.rb +1 -1
  281. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  282. data/lib/plaid/models/dashboard_user.rb +1 -1
  283. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  284. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  285. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  286. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  287. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  288. data/lib/plaid/models/date_range.rb +1 -1
  289. data/lib/plaid/models/deductions.rb +1 -1
  290. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  291. data/lib/plaid/models/deductions_total.rb +1 -1
  292. data/lib/plaid/models/default_update_webhook.rb +1 -1
  293. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  294. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  295. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  296. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  297. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  298. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  299. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  300. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  301. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  302. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  303. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  304. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  305. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  306. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  307. data/lib/plaid/models/depository_filter.rb +1 -1
  308. data/lib/plaid/models/detailed_originator.rb +1 -1
  309. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  310. data/lib/plaid/models/doc_type.rb +1 -1
  311. data/lib/plaid/models/document_analysis.rb +1 -1
  312. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  313. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  314. data/lib/plaid/models/document_metadata.rb +1 -1
  315. data/lib/plaid/models/document_name_match_code.rb +1 -1
  316. data/lib/plaid/models/document_risk_signal.rb +1 -1
  317. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  318. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  319. data/lib/plaid/models/document_risk_summary.rb +1 -1
  320. data/lib/plaid/models/document_status.rb +1 -1
  321. data/lib/plaid/models/documentary_verification.rb +1 -1
  322. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  323. data/lib/plaid/models/earnings.rb +1 -1
  324. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  325. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  326. data/lib/plaid/models/earnings_total.rb +1 -1
  327. data/lib/plaid/models/email.rb +1 -1
  328. data/lib/plaid/models/email_address_match_score.rb +1 -1
  329. data/lib/plaid/models/employee.rb +1 -1
  330. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  331. data/lib/plaid/models/employer.rb +1 -1
  332. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  333. data/lib/plaid/models/employer_verification.rb +1 -1
  334. data/lib/plaid/models/employers_search_request.rb +1 -1
  335. data/lib/plaid/models/employers_search_response.rb +1 -1
  336. data/lib/plaid/models/employment_details.rb +1 -1
  337. data/lib/plaid/models/employment_source_type.rb +1 -1
  338. data/lib/plaid/models/employment_verification.rb +1 -1
  339. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  340. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  341. data/lib/plaid/models/employment_verification_status.rb +1 -1
  342. data/lib/plaid/models/enhancements.rb +1 -1
  343. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  344. data/lib/plaid/models/enrichments.rb +1 -1
  345. data/lib/plaid/models/entity_document.rb +1 -1
  346. data/lib/plaid/models/entity_document_type.rb +1 -1
  347. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  348. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  349. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  350. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  351. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  352. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  353. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  354. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  355. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  356. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  357. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  358. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  359. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  360. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  361. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  362. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  363. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  364. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  365. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  366. data/lib/plaid/models/expiration_date.rb +1 -1
  367. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  368. data/lib/plaid/models/external_payment_options.rb +1 -1
  369. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  370. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  371. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  372. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  373. data/lib/plaid/models/fallback_auth_microdeposit_auto_verified_webhook.rb +1 -1
  374. data/lib/plaid/models/fallback_auth_microdeposit_verification_expired_webhook.rb +1 -1
  375. data/lib/plaid/models/fdx_content_types.rb +1 -1
  376. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  377. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  378. data/lib/plaid/models/fdx_initiator_fi_attribute.rb +1 -1
  379. data/lib/plaid/models/fdx_notification.rb +1 -1
  380. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  381. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  382. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  383. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  384. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  385. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  386. data/lib/plaid/models/fdx_party.rb +1 -1
  387. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  388. data/lib/plaid/models/fdx_party_type.rb +1 -1
  389. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  390. data/lib/plaid/models/form1099_type.rb +1 -1
  391. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  392. data/lib/plaid/models/health_incident.rb +1 -1
  393. data/lib/plaid/models/historical_balance.rb +1 -1
  394. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  395. data/lib/plaid/models/holding.rb +1 -1
  396. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  397. data/lib/plaid/models/holdings_override.rb +1 -1
  398. data/lib/plaid/models/id_number_type.rb +1 -1
  399. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  400. data/lib/plaid/models/identity_get_request.rb +1 -1
  401. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  402. data/lib/plaid/models/identity_get_response.rb +1 -1
  403. data/lib/plaid/models/identity_match_request.rb +1 -1
  404. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  405. data/lib/plaid/models/identity_match_response.rb +1 -1
  406. data/lib/plaid/models/identity_match_user.rb +1 -1
  407. data/lib/plaid/models/identity_refresh_request.rb +245 -0
  408. data/lib/plaid/models/{asset_report_transaction_all_of.rb → identity_refresh_response.rb} +18 -23
  409. data/lib/plaid/models/identity_update_types.rb +1 -1
  410. data/lib/plaid/models/identity_verification.rb +1 -1
  411. data/lib/plaid/models/identity_verification_create_request.rb +31 -8
  412. data/lib/plaid/models/identity_verification_create_request_user.rb +299 -0
  413. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  414. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  415. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  416. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  417. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  418. data/lib/plaid/models/identity_verification_request_user.rb +3 -39
  419. data/lib/plaid/models/identity_verification_request_user_name.rb +1 -1
  420. data/lib/plaid/models/identity_verification_response_user_name.rb +1 -1
  421. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  422. data/lib/plaid/models/identity_verification_retry_request.rb +12 -2
  423. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  424. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  425. data/lib/plaid/models/identity_verification_status.rb +1 -1
  426. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  427. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  428. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  429. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  430. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  431. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  432. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  433. data/lib/plaid/models/image_quality.rb +1 -1
  434. data/lib/plaid/models/incident_update.rb +1 -1
  435. data/lib/plaid/models/income_breakdown.rb +1 -1
  436. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  437. data/lib/plaid/models/income_override.rb +1 -1
  438. data/lib/plaid/models/income_summary.rb +1 -1
  439. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  440. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  441. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  442. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  443. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  444. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  445. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  446. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  447. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  448. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  449. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  450. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  451. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  452. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  453. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  454. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  455. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  456. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  457. data/lib/plaid/models/income_verification_risk_signals_status_webhook.rb +2 -2
  458. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  459. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  460. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  461. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  462. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  463. data/lib/plaid/models/individual_name.rb +1 -1
  464. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  465. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  466. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  467. data/lib/plaid/models/inflow_model.rb +1 -1
  468. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  469. data/lib/plaid/models/institution.rb +2 -2
  470. data/lib/plaid/models/institution_status.rb +1 -1
  471. data/lib/plaid/models/institution_supported_networks.rb +1 -1
  472. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  473. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  474. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  475. data/lib/plaid/models/institutions_get_request.rb +1 -1
  476. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  477. data/lib/plaid/models/institutions_get_response.rb +1 -1
  478. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  479. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  480. data/lib/plaid/models/institutions_search_request.rb +1 -1
  481. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  482. data/lib/plaid/models/institutions_search_response.rb +1 -1
  483. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  484. data/lib/plaid/models/investment_filter.rb +1 -1
  485. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  486. data/lib/plaid/models/investment_transaction.rb +1 -1
  487. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  488. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  489. data/lib/plaid/models/investments_auth_get_numbers.rb +221 -0
  490. data/lib/plaid/models/investments_auth_get_request.rb +254 -0
  491. data/lib/plaid/models/investments_auth_get_request_options.rb +222 -0
  492. data/lib/plaid/models/investments_auth_get_response.rb +321 -0
  493. data/lib/plaid/models/investments_auth_owner.rb +232 -0
  494. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  495. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  496. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  497. data/lib/plaid/models/investments_refresh_request.rb +1 -1
  498. data/lib/plaid/models/investments_refresh_response.rb +1 -1
  499. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  500. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  501. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  502. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  503. data/lib/plaid/models/issuing_country.rb +1 -1
  504. data/lib/plaid/models/item.rb +3 -3
  505. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  506. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  507. data/lib/plaid/models/item_activity_list_request.rb +1 -1
  508. data/lib/plaid/models/item_activity_list_response.rb +6 -1
  509. data/lib/plaid/models/item_application_list_request.rb +1 -1
  510. data/lib/plaid/models/item_application_list_response.rb +1 -1
  511. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  512. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  513. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  514. data/lib/plaid/models/item_error_webhook.rb +1 -1
  515. data/lib/plaid/models/item_get_request.rb +1 -1
  516. data/lib/plaid/models/item_get_response.rb +1 -1
  517. data/lib/plaid/models/item_import_request.rb +1 -1
  518. data/lib/plaid/models/item_import_request_options.rb +1 -1
  519. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  520. data/lib/plaid/models/item_import_response.rb +1 -1
  521. data/lib/plaid/models/item_login_repaired_webhook.rb +1 -1
  522. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  523. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  524. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  525. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  526. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  527. data/lib/plaid/models/item_remove_request.rb +1 -1
  528. data/lib/plaid/models/item_remove_response.rb +1 -1
  529. data/lib/plaid/models/item_status.rb +1 -1
  530. data/lib/plaid/models/item_status_investments.rb +1 -1
  531. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  532. data/lib/plaid/models/item_status_nullable.rb +1 -1
  533. data/lib/plaid/models/item_status_transactions.rb +1 -1
  534. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  535. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  536. data/lib/plaid/models/jwk_public_key.rb +1 -1
  537. data/lib/plaid/models/jwt_header.rb +1 -1
  538. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  539. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  540. data/lib/plaid/models/kyc_check_details.rb +1 -1
  541. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  542. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  543. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  544. data/lib/plaid/models/last_data_access_times.rb +1 -1
  545. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  546. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  547. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  548. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  549. data/lib/plaid/models/liabilities_object.rb +1 -1
  550. data/lib/plaid/models/liability_override.rb +1 -1
  551. data/lib/plaid/models/link_callback_metadata.rb +1 -1
  552. data/lib/plaid/models/link_delivery_account.rb +1 -1
  553. data/lib/plaid/models/link_delivery_callback_webhook.rb +2 -2
  554. data/lib/plaid/models/link_delivery_communication_method.rb +2 -2
  555. data/lib/plaid/models/link_delivery_create_request.rb +2 -2
  556. data/lib/plaid/models/link_delivery_create_response.rb +3 -3
  557. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  558. data/lib/plaid/models/link_delivery_get_request.rb +2 -2
  559. data/lib/plaid/models/link_delivery_get_response.rb +5 -5
  560. data/lib/plaid/models/link_delivery_institution.rb +1 -1
  561. data/lib/plaid/models/link_delivery_metadata.rb +1 -1
  562. data/lib/plaid/models/link_delivery_options.rb +2 -2
  563. data/lib/plaid/models/link_delivery_recipient.rb +2 -2
  564. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  565. data/lib/plaid/models/link_delivery_verification_status.rb +1 -1
  566. data/lib/plaid/models/link_delivery_webhook_callback_type.rb +1 -1
  567. data/lib/plaid/models/link_delivery_webhook_communication_method.rb +3 -3
  568. data/lib/plaid/models/link_delivery_webhook_delivery_status.rb +3 -3
  569. data/lib/plaid/models/link_event.rb +1 -1
  570. data/lib/plaid/models/link_event_metadata.rb +1 -1
  571. data/lib/plaid/models/link_event_name.rb +1 -1
  572. data/lib/plaid/models/link_events_webhook.rb +1 -1
  573. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  574. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  575. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  576. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  577. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  578. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  579. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  580. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  581. data/lib/plaid/models/link_token_create_request.rb +28 -7
  582. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  583. data/lib/plaid/models/link_token_create_request_auth.rb +24 -2
  584. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  585. data/lib/plaid/models/link_token_create_request_employment.rb +1 -1
  586. data/lib/plaid/models/link_token_create_request_employment_bank_income.rb +1 -1
  587. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  588. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  589. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  590. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  591. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  592. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  593. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  594. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  595. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  596. data/lib/plaid/models/link_token_create_response.rb +1 -1
  597. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  598. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  599. data/lib/plaid/models/link_token_get_request.rb +1 -1
  600. data/lib/plaid/models/link_token_get_response.rb +1 -1
  601. data/lib/plaid/models/link_token_investments.rb +1 -1
  602. data/lib/plaid/models/link_token_investments_auth.rb +236 -0
  603. data/lib/plaid/models/link_user_delivery_status_webhook.rb +2 -2
  604. data/lib/plaid/models/loan.rb +1 -1
  605. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  606. data/lib/plaid/models/loan_filter.rb +1 -1
  607. data/lib/plaid/models/loan_identifier.rb +1 -1
  608. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  609. data/lib/plaid/models/loan_identifiers.rb +1 -1
  610. data/lib/plaid/models/loans.rb +1 -1
  611. data/lib/plaid/models/location.rb +1 -1
  612. data/lib/plaid/models/match_summary.rb +1 -1
  613. data/lib/plaid/models/match_summary_code.rb +1 -1
  614. data/lib/plaid/models/meta.rb +1 -1
  615. data/lib/plaid/models/mfa.rb +1 -1
  616. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  617. data/lib/plaid/models/mortgage_liability.rb +1 -1
  618. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  619. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  620. data/lib/plaid/models/name_match_score.rb +1 -1
  621. data/lib/plaid/models/net_pay.rb +1 -1
  622. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  623. data/lib/plaid/models/numbers.rb +1 -1
  624. data/lib/plaid/models/numbers_acats.rb +257 -0
  625. data/lib/plaid/models/numbers_ach.rb +1 -1
  626. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  627. data/lib/plaid/models/numbers_bacs.rb +1 -1
  628. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  629. data/lib/plaid/models/numbers_eft.rb +1 -1
  630. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  631. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  632. data/lib/plaid/models/numbers_international.rb +1 -1
  633. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  634. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  635. data/lib/plaid/models/originator.rb +1 -1
  636. data/lib/plaid/models/originator_expected_transfer_frequency.rb +1 -1
  637. data/lib/plaid/models/override_account_type.rb +1 -1
  638. data/lib/plaid/models/override_accounts.rb +1 -1
  639. data/lib/plaid/models/owner.rb +1 -1
  640. data/lib/plaid/models/owner_override.rb +1 -1
  641. data/lib/plaid/models/ownership_type.rb +1 -1
  642. data/lib/plaid/models/parties.rb +1 -1
  643. data/lib/plaid/models/partner_customer_create_request.rb +1 -1
  644. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  645. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  646. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  647. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  648. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  649. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +1 -1
  650. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +1 -1
  651. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  652. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  653. data/lib/plaid/models/partner_end_customer.rb +1 -1
  654. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  655. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  656. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  657. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +1 -1
  658. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +1 -1
  659. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +1 -1
  660. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +1 -1
  661. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +1 -1
  662. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_values.rb +1 -1
  663. data/lib/plaid/models/partner_end_customer_o_auth_status_updated_webhook.rb +1 -1
  664. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +1 -1
  665. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  666. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  667. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  668. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  669. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  670. data/lib/plaid/models/party.rb +1 -1
  671. data/lib/plaid/models/party_individual.rb +1 -1
  672. data/lib/plaid/models/party_role_type.rb +1 -1
  673. data/lib/plaid/models/pay.rb +1 -1
  674. data/lib/plaid/models/pay_frequency.rb +1 -1
  675. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  676. data/lib/plaid/models/pay_period_details.rb +1 -1
  677. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  678. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  679. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  680. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  681. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  682. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  683. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  684. data/lib/plaid/models/payment_amount.rb +1 -1
  685. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  686. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  687. data/lib/plaid/models/payment_amount_refunded.rb +1 -1
  688. data/lib/plaid/models/payment_amount_to_refund.rb +1 -1
  689. data/lib/plaid/models/payment_channel.rb +1 -1
  690. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  691. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  692. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  693. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  694. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  695. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  696. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  697. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  698. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  699. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  700. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  701. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  702. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  703. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  704. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  705. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  706. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  707. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  708. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  709. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  710. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  711. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  712. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  713. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  714. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  715. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  716. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  717. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  718. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  719. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  720. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  721. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  722. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  723. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  724. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  725. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  726. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  727. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  728. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  729. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  730. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  731. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  732. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  733. data/lib/plaid/models/payment_meta.rb +1 -1
  734. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  735. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  736. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  737. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  738. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  739. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  740. data/lib/plaid/models/payment_profile_status.rb +1 -1
  741. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  742. data/lib/plaid/models/payment_scheme.rb +1 -1
  743. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  744. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  745. data/lib/plaid/models/payroll_income_object.rb +1 -1
  746. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  747. data/lib/plaid/models/payroll_item.rb +1 -1
  748. data/lib/plaid/models/payroll_item_status.rb +1 -1
  749. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  750. data/lib/plaid/models/paystub.rb +1 -1
  751. data/lib/plaid/models/paystub_address.rb +1 -1
  752. data/lib/plaid/models/paystub_deduction.rb +1 -1
  753. data/lib/plaid/models/paystub_details.rb +1 -1
  754. data/lib/plaid/models/paystub_employer.rb +1 -1
  755. data/lib/plaid/models/paystub_override.rb +1 -1
  756. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  757. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  758. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  759. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  760. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  761. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  762. data/lib/plaid/models/personal_finance_category.rb +1 -1
  763. data/lib/plaid/models/phone_number.rb +1 -1
  764. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  765. data/lib/plaid/models/phone_type.rb +1 -1
  766. data/lib/plaid/models/physical_document_category.rb +1 -1
  767. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  768. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  769. data/lib/plaid/models/physical_document_images.rb +1 -1
  770. data/lib/plaid/models/plaid_error.rb +1 -1
  771. data/lib/plaid/models/plaid_error_type.rb +1 -1
  772. data/lib/plaid/models/platform_ids.rb +1 -1
  773. data/lib/plaid/models/po_box_status.rb +1 -1
  774. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  775. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  776. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  777. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  778. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  779. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  780. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  781. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  782. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  783. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  784. data/lib/plaid/models/processor_identity_match_request.rb +1 -1
  785. data/lib/plaid/models/processor_identity_match_response.rb +1 -1
  786. data/lib/plaid/models/processor_number.rb +1 -1
  787. data/lib/plaid/models/processor_signal_decision_report_request.rb +1 -1
  788. data/lib/plaid/models/processor_signal_decision_report_response.rb +1 -1
  789. data/lib/plaid/models/processor_signal_evaluate_request.rb +2 -19
  790. data/lib/plaid/models/processor_signal_evaluate_response.rb +2 -2
  791. data/lib/plaid/models/processor_signal_return_report_request.rb +1 -1
  792. data/lib/plaid/models/processor_signal_return_report_response.rb +1 -1
  793. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  794. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  795. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  796. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  797. data/lib/plaid/models/processor_token_permissions_get_request.rb +1 -1
  798. data/lib/plaid/models/processor_token_permissions_get_response.rb +1 -1
  799. data/lib/plaid/models/processor_token_permissions_set_request.rb +1 -1
  800. data/lib/plaid/models/processor_token_permissions_set_response.rb +1 -1
  801. data/lib/plaid/models/processor_transactions_get_request.rb +1 -1
  802. data/lib/plaid/models/processor_transactions_get_response.rb +1 -1
  803. data/lib/plaid/models/processor_transactions_recurring_get_request.rb +1 -1
  804. data/lib/plaid/models/processor_transactions_recurring_get_response.rb +1 -1
  805. data/lib/plaid/models/processor_transactions_refresh_request.rb +1 -1
  806. data/lib/plaid/models/processor_transactions_refresh_response.rb +1 -1
  807. data/lib/plaid/models/processor_transactions_sync_request.rb +1 -1
  808. data/lib/plaid/models/processor_transactions_sync_response.rb +1 -1
  809. data/lib/plaid/models/product_access.rb +1 -1
  810. data/lib/plaid/models/product_permissions_required_auth_webhook.rb +269 -0
  811. data/lib/plaid/models/product_permissions_required_identity_webhook.rb +269 -0
  812. data/lib/plaid/models/product_status.rb +1 -1
  813. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  814. data/lib/plaid/models/products.rb +2 -1
  815. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  816. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  817. data/lib/plaid/models/proxy_type.rb +1 -1
  818. data/lib/plaid/models/pslf_status.rb +1 -1
  819. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  820. data/lib/plaid/models/recipient_bacs.rb +1 -1
  821. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  822. data/lib/plaid/models/recurrence.rb +1 -1
  823. data/lib/plaid/models/recurring_cancelled_webhook.rb +1 -1
  824. data/lib/plaid/models/recurring_new_transfer_webhook.rb +1 -1
  825. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  826. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  827. data/lib/plaid/models/recurring_transfer.rb +1 -1
  828. data/lib/plaid/models/recurring_transfer_nullable.rb +1 -1
  829. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +1 -1
  830. data/lib/plaid/models/removed_transaction.rb +1 -1
  831. data/lib/plaid/models/report_type.rb +1 -1
  832. data/lib/plaid/models/reporting_information.rb +1 -1
  833. data/lib/plaid/models/risk_check_behavior.rb +1 -1
  834. data/lib/plaid/models/risk_check_behavior_bot_detected_label.rb +1 -1
  835. data/lib/plaid/models/risk_check_behavior_fraud_ring_detected_label.rb +1 -1
  836. data/lib/plaid/models/risk_check_behavior_user_interactions_label.rb +1 -1
  837. data/lib/plaid/models/risk_check_details.rb +15 -5
  838. data/lib/plaid/models/risk_check_device.rb +1 -1
  839. data/lib/plaid/models/risk_check_email.rb +1 -1
  840. data/lib/plaid/models/risk_check_email_domain_is_custom.rb +1 -1
  841. data/lib/plaid/models/risk_check_email_domain_is_disposable.rb +1 -1
  842. data/lib/plaid/models/risk_check_email_domain_is_free_provider.rb +1 -1
  843. data/lib/plaid/models/risk_check_email_is_deliverable_status.rb +1 -1
  844. data/lib/plaid/models/risk_check_email_top_level_domain_is_suspicious.rb +1 -1
  845. data/lib/plaid/models/risk_check_identity_abuse_signals.rb +230 -0
  846. data/lib/plaid/models/risk_check_linked_service.rb +1 -1
  847. data/lib/plaid/models/risk_check_phone.rb +1 -1
  848. data/lib/plaid/models/risk_check_stolen_identity.rb +220 -0
  849. data/lib/plaid/models/risk_check_synthetic_identity.rb +220 -0
  850. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  851. data/lib/plaid/models/role.rb +1 -1
  852. data/lib/plaid/models/role_detail.rb +1 -1
  853. data/lib/plaid/models/roles.rb +1 -1
  854. data/lib/plaid/models/sandbox_bank_income_fire_webhook_request.rb +268 -0
  855. data/lib/plaid/models/sandbox_bank_income_fire_webhook_response.rb +225 -0
  856. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_code.rb +39 -0
  857. data/lib/plaid/models/sandbox_bank_income_webhook_fire_request_webhook_fields.rb +234 -0
  858. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  859. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  860. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  861. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  862. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  863. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  864. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  865. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  866. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  867. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  868. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  869. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  870. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  871. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  872. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  873. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  874. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  875. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  876. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  877. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  878. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  879. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  880. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  881. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  882. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  883. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  884. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  885. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  886. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +13 -2
  887. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  888. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +16 -5
  889. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  890. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +1 -1
  891. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  892. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +3 -7
  893. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  894. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +1 -1
  895. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  896. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +1 -1
  897. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +1 -1
  898. data/lib/plaid/models/scopes.rb +1 -1
  899. data/lib/plaid/models/scopes_context.rb +1 -1
  900. data/lib/plaid/models/scopes_nullable.rb +1 -1
  901. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  902. data/lib/plaid/models/screening_hit_data.rb +1 -1
  903. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  904. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  905. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  906. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  907. data/lib/plaid/models/security.rb +1 -1
  908. data/lib/plaid/models/security_override.rb +1 -1
  909. data/lib/plaid/models/selfie_analysis.rb +2 -2
  910. data/lib/plaid/models/selfie_analysis_document_comparison.rb +1 -1
  911. data/lib/plaid/models/selfie_capture.rb +1 -1
  912. data/lib/plaid/models/selfie_check.rb +1 -1
  913. data/lib/plaid/models/selfie_check_selfie.rb +1 -1
  914. data/lib/plaid/models/selfie_check_status.rb +1 -1
  915. data/lib/plaid/models/selfie_status.rb +1 -1
  916. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  917. data/lib/plaid/models/service.rb +1 -1
  918. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  919. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  920. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  921. data/lib/plaid/models/servicer_address_data.rb +1 -1
  922. data/lib/plaid/models/services.rb +1 -1
  923. data/lib/plaid/models/signal_address_data.rb +1 -1
  924. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  925. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  926. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  927. data/lib/plaid/models/signal_device.rb +1 -1
  928. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  929. data/lib/plaid/models/signal_evaluate_request.rb +2 -19
  930. data/lib/plaid/models/signal_evaluate_response.rb +2 -2
  931. data/lib/plaid/models/signal_insights.rb +240 -0
  932. data/lib/plaid/models/signal_payment_method.rb +1 -1
  933. data/lib/plaid/models/signal_person_name.rb +1 -1
  934. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  935. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  936. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  937. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  938. data/lib/plaid/models/signal_scores.rb +1 -1
  939. data/lib/plaid/models/signal_user.rb +1 -1
  940. data/lib/plaid/models/signal_warning.rb +1 -1
  941. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  942. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  943. data/lib/plaid/models/source.rb +1 -1
  944. data/lib/plaid/models/standalone_account_type.rb +1 -1
  945. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  946. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  947. data/lib/plaid/models/status.rb +1 -1
  948. data/lib/plaid/models/statuses.rb +1 -1
  949. data/lib/plaid/models/strategy.rb +1 -1
  950. data/lib/plaid/models/student_loan.rb +1 -1
  951. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  952. data/lib/plaid/models/student_loan_status.rb +1 -1
  953. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  954. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  955. data/lib/plaid/models/taxform.rb +1 -1
  956. data/lib/plaid/models/taxpayer_id.rb +1 -1
  957. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  958. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  959. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  960. data/lib/plaid/models/total.rb +1 -1
  961. data/lib/plaid/models/total_canonical_description.rb +1 -1
  962. data/lib/plaid/models/transaction.rb +7 -7
  963. data/lib/plaid/models/transaction_all_of.rb +4 -4
  964. data/lib/plaid/models/transaction_base.rb +4 -4
  965. data/lib/plaid/models/transaction_code.rb +1 -1
  966. data/lib/plaid/models/transaction_counterparty.rb +1 -1
  967. data/lib/plaid/models/transaction_data.rb +1 -1
  968. data/lib/plaid/models/transaction_override.rb +1 -1
  969. data/lib/plaid/models/transaction_stream.rb +3 -3
  970. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  971. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  972. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  973. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  974. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  975. data/lib/plaid/models/transactions_enrich_get_request.rb +1 -1
  976. data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
  977. data/lib/plaid/models/transactions_enrich_request_options.rb +1 -1
  978. data/lib/plaid/models/transactions_get_request.rb +1 -1
  979. data/lib/plaid/models/transactions_get_request_options.rb +2 -2
  980. data/lib/plaid/models/transactions_get_response.rb +1 -1
  981. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  982. data/lib/plaid/models/transactions_recurring_get_request_options.rb +2 -2
  983. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  984. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  985. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  986. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  987. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  988. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  989. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  990. data/lib/plaid/models/transactions_rules_create_request.rb +2 -2
  991. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  992. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  993. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  994. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  995. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  996. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  997. data/lib/plaid/models/transactions_sync_request_options.rb +2 -2
  998. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  999. data/lib/plaid/models/transfer.rb +1 -1
  1000. data/lib/plaid/models/transfer_authorization.rb +12 -2
  1001. data/lib/plaid/models/transfer_authorization_create_request.rb +21 -10
  1002. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  1003. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  1004. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  1005. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  1006. data/lib/plaid/models/transfer_authorization_device.rb +3 -3
  1007. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  1008. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  1009. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  1010. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  1011. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  1012. data/lib/plaid/models/transfer_balance.rb +1 -1
  1013. data/lib/plaid/models/transfer_balance_get_request.rb +1 -1
  1014. data/lib/plaid/models/transfer_balance_get_response.rb +1 -1
  1015. data/lib/plaid/models/transfer_balance_type.rb +1 -1
  1016. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  1017. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  1018. data/lib/plaid/models/transfer_capabilities_get_request.rb +1 -1
  1019. data/lib/plaid/models/transfer_capabilities_get_response.rb +1 -1
  1020. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +1 -1
  1021. data/lib/plaid/models/transfer_configuration_get_request.rb +1 -1
  1022. data/lib/plaid/models/transfer_configuration_get_response.rb +62 -2
  1023. data/lib/plaid/models/transfer_create_request.rb +16 -5
  1024. data/lib/plaid/models/transfer_create_response.rb +1 -1
  1025. data/lib/plaid/models/transfer_credit_funds_source.rb +1 -1
  1026. data/lib/plaid/models/transfer_credit_usage_configuration.rb +3 -3
  1027. data/lib/plaid/models/transfer_debit_usage_configuration.rb +1 -1
  1028. data/lib/plaid/models/transfer_device.rb +1 -1
  1029. data/lib/plaid/models/transfer_diligence_document_upload_request.rb +254 -0
  1030. data/lib/plaid/models/transfer_diligence_document_upload_response.rb +225 -0
  1031. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  1032. data/lib/plaid/models/transfer_diligence_submit_request.rb +1 -1
  1033. data/lib/plaid/models/transfer_diligence_submit_response.rb +1 -1
  1034. data/lib/plaid/models/transfer_document_purpose.rb +38 -0
  1035. data/lib/plaid/models/transfer_event.rb +1 -1
  1036. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  1037. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  1038. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  1039. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  1040. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  1041. data/lib/plaid/models/transfer_event_type.rb +1 -1
  1042. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  1043. data/lib/plaid/models/transfer_expected_sweep_settlement_schedule_item.rb +1 -1
  1044. data/lib/plaid/models/transfer_failure.rb +1 -1
  1045. data/lib/plaid/models/transfer_get_request.rb +1 -1
  1046. data/lib/plaid/models/transfer_get_response.rb +1 -1
  1047. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  1048. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  1049. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  1050. data/lib/plaid/models/transfer_intent_create_network.rb +1 -1
  1051. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  1052. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  1053. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  1054. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  1055. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  1056. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  1057. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  1058. data/lib/plaid/models/transfer_list_request.rb +1 -1
  1059. data/lib/plaid/models/transfer_list_response.rb +1 -1
  1060. data/lib/plaid/models/transfer_metrics_get_request.rb +1 -1
  1061. data/lib/plaid/models/transfer_metrics_get_response.rb +32 -2
  1062. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  1063. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  1064. data/lib/plaid/models/transfer_network.rb +1 -1
  1065. data/lib/plaid/models/transfer_originator_address.rb +1 -1
  1066. data/lib/plaid/models/transfer_originator_create_request.rb +1 -1
  1067. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  1068. data/lib/plaid/models/transfer_originator_diligence.rb +52 -1
  1069. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  1070. data/lib/plaid/models/transfer_originator_get_response.rb +1 -1
  1071. data/lib/plaid/models/transfer_originator_list_request.rb +1 -1
  1072. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  1073. data/lib/plaid/models/transfer_questionnaire_create_request.rb +1 -1
  1074. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  1075. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -1
  1076. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  1077. data/lib/plaid/models/transfer_recurring_create_request.rb +2 -2
  1078. data/lib/plaid/models/transfer_recurring_create_response.rb +1 -1
  1079. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -1
  1080. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  1081. data/lib/plaid/models/transfer_recurring_list_request.rb +1 -1
  1082. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  1083. data/lib/plaid/models/transfer_recurring_schedule.rb +1 -1
  1084. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  1085. data/lib/plaid/models/transfer_refund.rb +1 -1
  1086. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  1087. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  1088. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  1089. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  1090. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  1091. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  1092. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  1093. data/lib/plaid/models/transfer_repayment.rb +1 -1
  1094. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  1095. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  1096. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  1097. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  1098. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  1099. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  1100. data/lib/plaid/models/transfer_status.rb +1 -1
  1101. data/lib/plaid/models/transfer_sweep.rb +1 -1
  1102. data/lib/plaid/models/transfer_sweep_get_request.rb +2 -2
  1103. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  1104. data/lib/plaid/models/transfer_sweep_list_request.rb +13 -2
  1105. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  1106. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  1107. data/lib/plaid/models/transfer_test_clock.rb +1 -1
  1108. data/lib/plaid/models/transfer_type.rb +1 -1
  1109. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  1110. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  1111. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  1112. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  1113. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  1114. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  1115. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  1116. data/lib/plaid/models/user_address.rb +1 -1
  1117. data/lib/plaid/models/user_create_request.rb +1 -1
  1118. data/lib/plaid/models/user_create_response.rb +1 -1
  1119. data/lib/plaid/models/user_custom_password.rb +1 -1
  1120. data/lib/plaid/models/user_id_number.rb +1 -1
  1121. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  1122. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  1123. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  1124. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  1125. data/lib/plaid/models/validation_source.rb +1 -1
  1126. data/lib/plaid/models/validation_sources.rb +1 -1
  1127. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  1128. data/lib/plaid/models/verification_of_asset.rb +1 -1
  1129. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  1130. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  1131. data/lib/plaid/models/verification_status.rb +1 -1
  1132. data/lib/plaid/models/w2.rb +1 -1
  1133. data/lib/plaid/models/w2_box12.rb +1 -1
  1134. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  1135. data/lib/plaid/models/wallet.rb +1 -1
  1136. data/lib/plaid/models/wallet_balance.rb +1 -1
  1137. data/lib/plaid/models/wallet_create_request.rb +1 -1
  1138. data/lib/plaid/models/wallet_create_response.rb +1 -1
  1139. data/lib/plaid/models/wallet_get_request.rb +1 -1
  1140. data/lib/plaid/models/wallet_get_response.rb +1 -1
  1141. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1142. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1143. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1144. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1145. data/lib/plaid/models/wallet_payment_scheme.rb +41 -0
  1146. data/lib/plaid/models/wallet_status.rb +1 -1
  1147. data/lib/plaid/models/wallet_transaction.rb +12 -2
  1148. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1149. data/lib/plaid/models/wallet_transaction_counterparty.rb +26 -5
  1150. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1151. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1152. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1153. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1154. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1155. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1156. data/lib/plaid/models/wallet_transaction_get_response.rb +12 -2
  1157. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1158. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1159. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1160. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1161. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1162. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1163. data/lib/plaid/models/warning.rb +1 -1
  1164. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1165. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1166. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1167. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1168. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1169. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1170. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1171. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1172. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1173. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1174. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1175. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1176. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1177. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1178. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1179. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1180. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1181. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1182. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1183. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1184. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1185. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1186. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1187. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1188. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1189. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1190. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1191. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1192. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1193. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1194. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1195. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1196. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1197. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1198. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1199. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1200. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1201. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1202. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1203. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1204. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1205. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1206. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1207. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1208. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1209. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1210. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1211. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1212. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1213. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1214. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1215. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1216. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1217. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1218. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1219. data/lib/plaid/models/webhook_type.rb +1 -1
  1220. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1221. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1222. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1223. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1224. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1225. data/lib/plaid/version.rb +2 -2
  1226. data/lib/plaid.rb +40 -2
  1227. data/plaid.gemspec +1 -1
  1228. data/test/test_identity_verification.rb +8 -3
  1229. metadata +41 -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.370.0
6
+ The version of the OpenAPI document: 2020-09-14_1.385.1
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -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 `/categories/get` 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 `/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.
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
@@ -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]
@@ -2425,7 +2555,7 @@ module Plaid
2425
2555
  end
2426
2556
 
2427
2557
  # Retrieve fraud insights for a user's manually uploaded document(s).
2428
- # `/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` 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.
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.
2429
2559
  # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
2430
2560
  # @param [Hash] opts the optional parameters
2431
2561
  # @return [CreditPayrollIncomeRiskSignalsGetResponse]
@@ -2435,7 +2565,7 @@ module Plaid
2435
2565
  end
2436
2566
 
2437
2567
  # Retrieve fraud insights for a user&#39;s manually uploaded document(s).
2438
- # &#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&#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.
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.
2439
2569
  # @param credit_payroll_income_risk_signals_get_request [CreditPayrollIncomeRiskSignalsGetRequest]
2440
2570
  # @param [Hash] opts the optional parameters
2441
2571
  # @return [Array<(CreditPayrollIncomeRiskSignalsGetResponse, Integer, Hash)>] CreditPayrollIncomeRiskSignalsGetResponse data, response status code and response headers
@@ -3594,6 +3724,71 @@ module Plaid
3594
3724
  return data, status_code, headers
3595
3725
  end
3596
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
+
3597
3792
  # Create a new identity verification
3598
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.
3599
3794
  # @param identity_verification_create_request [IdentityVerificationCreateRequest]
@@ -4374,6 +4569,71 @@ module Plaid
4374
4569
  return data, status_code, headers
4375
4570
  end
4376
4571
 
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]
4575
+ # @param [Hash] opts the optional parameters
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)
4579
+ data
4580
+ end
4581
+
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]
4585
+ # @param [Hash] opts the optional parameters
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 = {})
4588
+ if @api_client.config.debugging
4589
+ @api_client.config.logger.debug 'Calling API: PlaidApi.investments_auth_get ...'
4590
+ end
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"
4594
+ end
4595
+ # resource path
4596
+ local_var_path = '/investments/auth/get'
4597
+
4598
+ # query parameters
4599
+ query_params = opts[:query_params] || {}
4600
+
4601
+ # header parameters
4602
+ header_params = opts[:header_params] || {}
4603
+ # HTTP header 'Accept' (if needed)
4604
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4605
+ # HTTP header 'Content-Type'
4606
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4607
+
4608
+ # form parameters
4609
+ form_params = opts[:form_params] || {}
4610
+
4611
+ # http body (model)
4612
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(investments_auth_get_request)
4613
+
4614
+ # return_type
4615
+ return_type = opts[:debug_return_type] || 'InvestmentsAuthGetResponse'
4616
+
4617
+ # auth_names
4618
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4619
+
4620
+ new_options = opts.merge(
4621
+ :operation => :"PlaidApi.investments_auth_get",
4622
+ :header_params => header_params,
4623
+ :query_params => query_params,
4624
+ :form_params => form_params,
4625
+ :body => post_body,
4626
+ :auth_names => auth_names,
4627
+ :return_type => return_type
4628
+ )
4629
+
4630
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4631
+ if @api_client.config.debugging
4632
+ @api_client.config.logger.debug "API called: PlaidApi#investments_auth_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4633
+ end
4634
+ return data, status_code, headers
4635
+ end
4636
+
4377
4637
  # Get Investment holdings
4378
4638
  # The `/investments/holdings/get` endpoint allows developers to receive user-authorized stock position data for `investment`-type accounts.
4379
4639
  # @param investments_holdings_get_request [InvestmentsHoldingsGetRequest]
@@ -4960,7 +5220,7 @@ module Plaid
4960
5220
  end
4961
5221
 
4962
5222
  # Import Item
4963
- # `/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.
4964
5224
  # @param item_import_request [ItemImportRequest]
4965
5225
  # @param [Hash] opts the optional parameters
4966
5226
  # @return [ItemImportResponse]
@@ -4970,7 +5230,7 @@ module Plaid
4970
5230
  end
4971
5231
 
4972
5232
  # Import Item
4973
- # &#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.
4974
5234
  # @param item_import_request [ItemImportRequest]
4975
5235
  # @param [Hash] opts the optional parameters
4976
5236
  # @return [Array<(ItemImportResponse, Integer, Hash)>] ItemImportResponse data, response status code and response headers
@@ -5284,8 +5544,8 @@ module Plaid
5284
5544
  return data, status_code, headers
5285
5545
  end
5286
5546
 
5287
- # Create Link Delivery session
5288
- # 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.
5289
5549
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5290
5550
  # @param [Hash] opts the optional parameters
5291
5551
  # @return [LinkDeliveryCreateResponse]
@@ -5294,8 +5554,8 @@ module Plaid
5294
5554
  data
5295
5555
  end
5296
5556
 
5297
- # Create Link Delivery session
5298
- # 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.
5299
5559
  # @param link_delivery_create_request [LinkDeliveryCreateRequest]
5300
5560
  # @param [Hash] opts the optional parameters
5301
5561
  # @return [Array<(LinkDeliveryCreateResponse, Integer, Hash)>] LinkDeliveryCreateResponse data, response status code and response headers
@@ -5349,8 +5609,8 @@ module Plaid
5349
5609
  return data, status_code, headers
5350
5610
  end
5351
5611
 
5352
- # Get Link Delivery session
5353
- # 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.
5354
5614
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5355
5615
  # @param [Hash] opts the optional parameters
5356
5616
  # @return [LinkDeliveryGetResponse]
@@ -5359,8 +5619,8 @@ module Plaid
5359
5619
  data
5360
5620
  end
5361
5621
 
5362
- # Get Link Delivery session
5363
- # 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.
5364
5624
  # @param link_delivery_get_request [LinkDeliveryGetRequest]
5365
5625
  # @param [Hash] opts the optional parameters
5366
5626
  # @return [Array<(LinkDeliveryGetResponse, Integer, Hash)>] LinkDeliveryGetResponse data, response status code and response headers
@@ -7300,7 +7560,7 @@ module Plaid
7300
7560
  end
7301
7561
 
7302
7562
  # Evaluate a planned ACH transaction
7303
- # 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.
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. To reduce this latency, you can call `/signal/prepare` on the Item before you need to request Signal data.
7304
7564
  # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7305
7565
  # @param [Hash] opts the optional parameters
7306
7566
  # @return [ProcessorSignalEvaluateResponse]
@@ -7310,7 +7570,7 @@ module Plaid
7310
7570
  end
7311
7571
 
7312
7572
  # Evaluate a planned ACH transaction
7313
- # 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.
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. To reduce this latency, you can call &#x60;/signal/prepare&#x60; on the Item before you need to request Signal data.
7314
7574
  # @param processor_signal_evaluate_request [ProcessorSignalEvaluateRequest]
7315
7575
  # @param [Hash] opts the optional parameters
7316
7576
  # @return [Array<(ProcessorSignalEvaluateResponse, Integer, Hash)>] ProcessorSignalEvaluateResponse data, response status code and response headers
@@ -7430,7 +7690,7 @@ module Plaid
7430
7690
  end
7431
7691
 
7432
7692
  # Create Stripe bank account token
7433
- # 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`.'
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`.
7434
7694
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
7435
7695
  # @param [Hash] opts the optional parameters
7436
7696
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -7440,7 +7700,7 @@ module Plaid
7440
7700
  end
7441
7701
 
7442
7702
  # Create Stripe bank account token
7443
- # 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;
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;.
7444
7704
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
7445
7705
  # @param [Hash] opts the optional parameters
7446
7706
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -7949,6 +8209,71 @@ module Plaid
7949
8209
  return data, status_code, headers
7950
8210
  end
7951
8211
 
8212
+ # Manually fire a bank income webhook in sandbox
8213
+ # Use the `/sandbox/bank_income/fire_webhook` endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
8214
+ # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
8215
+ # @param [Hash] opts the optional parameters
8216
+ # @return [SandboxBankIncomeFireWebhookResponse]
8217
+ def sandbox_bank_income_fire_webhook(sandbox_bank_income_fire_webhook_request, opts = {})
8218
+ data, _status_code, _headers = sandbox_bank_income_fire_webhook_with_http_info(sandbox_bank_income_fire_webhook_request, opts)
8219
+ data
8220
+ end
8221
+
8222
+ # Manually fire a bank income webhook in sandbox
8223
+ # Use the &#x60;/sandbox/bank_income/fire_webhook&#x60; endpoint to manually trigger a Bank Income webhook in the Sandbox environment.
8224
+ # @param sandbox_bank_income_fire_webhook_request [SandboxBankIncomeFireWebhookRequest]
8225
+ # @param [Hash] opts the optional parameters
8226
+ # @return [Array<(SandboxBankIncomeFireWebhookResponse, Integer, Hash)>] SandboxBankIncomeFireWebhookResponse data, response status code and response headers
8227
+ def sandbox_bank_income_fire_webhook_with_http_info(sandbox_bank_income_fire_webhook_request, opts = {})
8228
+ if @api_client.config.debugging
8229
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_bank_income_fire_webhook ...'
8230
+ end
8231
+ # verify the required parameter 'sandbox_bank_income_fire_webhook_request' is set
8232
+ if @api_client.config.client_side_validation && sandbox_bank_income_fire_webhook_request.nil?
8233
+ fail ArgumentError, "Missing the required parameter 'sandbox_bank_income_fire_webhook_request' when calling PlaidApi.sandbox_bank_income_fire_webhook"
8234
+ end
8235
+ # resource path
8236
+ local_var_path = '/sandbox/bank_income/fire_webhook'
8237
+
8238
+ # query parameters
8239
+ query_params = opts[:query_params] || {}
8240
+
8241
+ # header parameters
8242
+ header_params = opts[:header_params] || {}
8243
+ # HTTP header 'Accept' (if needed)
8244
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8245
+ # HTTP header 'Content-Type'
8246
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8247
+
8248
+ # form parameters
8249
+ form_params = opts[:form_params] || {}
8250
+
8251
+ # http body (model)
8252
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_bank_income_fire_webhook_request)
8253
+
8254
+ # return_type
8255
+ return_type = opts[:debug_return_type] || 'SandboxBankIncomeFireWebhookResponse'
8256
+
8257
+ # auth_names
8258
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8259
+
8260
+ new_options = opts.merge(
8261
+ :operation => :"PlaidApi.sandbox_bank_income_fire_webhook",
8262
+ :header_params => header_params,
8263
+ :query_params => query_params,
8264
+ :form_params => form_params,
8265
+ :body => post_body,
8266
+ :auth_names => auth_names,
8267
+ :return_type => return_type
8268
+ )
8269
+
8270
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8271
+ if @api_client.config.debugging
8272
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_bank_income_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8273
+ end
8274
+ return data, status_code, headers
8275
+ end
8276
+
7952
8277
  # Manually fire a Bank Transfer webhook
7953
8278
  # Use the `/sandbox/bank_transfer/fire_webhook` endpoint to manually trigger a Bank Transfers webhook in the Sandbox environment.
7954
8279
  # @param sandbox_bank_transfer_fire_webhook_request [SandboxBankTransferFireWebhookRequest]
@@ -8080,7 +8405,7 @@ module Plaid
8080
8405
  end
8081
8406
 
8082
8407
  # Manually fire an Income webhook
8083
- # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger an Income webhook in the Sandbox environment.
8408
+ # Use the `/sandbox/income/fire_webhook` endpoint to manually trigger a Payroll Income webhook in the Sandbox environment.
8084
8409
  # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
8085
8410
  # @param [Hash] opts the optional parameters
8086
8411
  # @return [SandboxIncomeFireWebhookResponse]
@@ -8090,7 +8415,7 @@ module Plaid
8090
8415
  end
8091
8416
 
8092
8417
  # Manually fire an Income webhook
8093
- # Use the &#x60;/sandbox/income/fire_webhook&#x60; endpoint to manually trigger an Income webhook in the Sandbox environment.
8418
+ # Use the &#x60;/sandbox/income/fire_webhook&#x60; endpoint to manually trigger a Payroll Income webhook in the Sandbox environment.
8094
8419
  # @param sandbox_income_fire_webhook_request [SandboxIncomeFireWebhookRequest]
8095
8420
  # @param [Hash] opts the optional parameters
8096
8421
  # @return [Array<(SandboxIncomeFireWebhookResponse, Integer, Hash)>] SandboxIncomeFireWebhookResponse data, response status code and response headers
@@ -9510,7 +9835,7 @@ module Plaid
9510
9835
  end
9511
9836
 
9512
9837
  # Get transaction data
9513
- # 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.
9838
+ # 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.
9514
9839
  # @param transactions_get_request [TransactionsGetRequest]
9515
9840
  # @param [Hash] opts the optional parameters
9516
9841
  # @return [TransactionsGetResponse]
@@ -9520,7 +9845,7 @@ module Plaid
9520
9845
  end
9521
9846
 
9522
9847
  # Get transaction data
9523
- # 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.
9848
+ # 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.
9524
9849
  # @param transactions_get_request [TransactionsGetRequest]
9525
9850
  # @param [Hash] opts the optional parameters
9526
9851
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -9965,7 +10290,7 @@ module Plaid
9965
10290
  end
9966
10291
 
9967
10292
  # Create a transfer authorization
9968
- # 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. 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`.
10293
+ # 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.
9969
10294
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9970
10295
  # @param [Hash] opts the optional parameters
9971
10296
  # @return [TransferAuthorizationCreateResponse]
@@ -9975,7 +10300,7 @@ module Plaid
9975
10300
  end
9976
10301
 
9977
10302
  # Create a transfer authorization
9978
- # 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. 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;.
10303
+ # 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.
9979
10304
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9980
10305
  # @param [Hash] opts the optional parameters
9981
10306
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -10354,6 +10679,71 @@ module Plaid
10354
10679
  return data, status_code, headers
10355
10680
  end
10356
10681
 
10682
+ # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
10683
+ # Third-party sender customers can use `/transfer/diligence/document/upload` endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the `client_id` in the `PLAID-CLIENT-ID` header and `secret` in the `PLAID-SECRET` header.
10684
+ # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
10685
+ # @param [Hash] opts the optional parameters
10686
+ # @return [TransferDiligenceDocumentUploadResponse]
10687
+ def transfer_diligence_document_upload(transfer_diligence_document_upload_request, opts = {})
10688
+ data, _status_code, _headers = transfer_diligence_document_upload_with_http_info(transfer_diligence_document_upload_request, opts)
10689
+ data
10690
+ end
10691
+
10692
+ # This endpoint allows third-party sender customers to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data.
10693
+ # Third-party sender customers can use &#x60;/transfer/diligence/document/upload&#x60; endpoint to upload a document on behalf of its end customer (i.e. originator) to Plaid. You’ll need to send a request of type multipart/form-data. You must provide the &#x60;client_id&#x60; in the &#x60;PLAID-CLIENT-ID&#x60; header and &#x60;secret&#x60; in the &#x60;PLAID-SECRET&#x60; header.
10694
+ # @param transfer_diligence_document_upload_request [TransferDiligenceDocumentUploadRequest]
10695
+ # @param [Hash] opts the optional parameters
10696
+ # @return [Array<(TransferDiligenceDocumentUploadResponse, Integer, Hash)>] TransferDiligenceDocumentUploadResponse data, response status code and response headers
10697
+ def transfer_diligence_document_upload_with_http_info(transfer_diligence_document_upload_request, opts = {})
10698
+ if @api_client.config.debugging
10699
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_diligence_document_upload ...'
10700
+ end
10701
+ # verify the required parameter 'transfer_diligence_document_upload_request' is set
10702
+ if @api_client.config.client_side_validation && transfer_diligence_document_upload_request.nil?
10703
+ fail ArgumentError, "Missing the required parameter 'transfer_diligence_document_upload_request' when calling PlaidApi.transfer_diligence_document_upload"
10704
+ end
10705
+ # resource path
10706
+ local_var_path = '/transfer/diligence/document/upload'
10707
+
10708
+ # query parameters
10709
+ query_params = opts[:query_params] || {}
10710
+
10711
+ # header parameters
10712
+ header_params = opts[:header_params] || {}
10713
+ # HTTP header 'Accept' (if needed)
10714
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10715
+ # HTTP header 'Content-Type'
10716
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10717
+
10718
+ # form parameters
10719
+ form_params = opts[:form_params] || {}
10720
+
10721
+ # http body (model)
10722
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_diligence_document_upload_request)
10723
+
10724
+ # return_type
10725
+ return_type = opts[:debug_return_type] || 'TransferDiligenceDocumentUploadResponse'
10726
+
10727
+ # auth_names
10728
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10729
+
10730
+ new_options = opts.merge(
10731
+ :operation => :"PlaidApi.transfer_diligence_document_upload",
10732
+ :header_params => header_params,
10733
+ :query_params => query_params,
10734
+ :form_params => form_params,
10735
+ :body => post_body,
10736
+ :auth_names => auth_names,
10737
+ :return_type => return_type
10738
+ )
10739
+
10740
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10741
+ if @api_client.config.debugging
10742
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_diligence_document_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10743
+ end
10744
+ return data, status_code, headers
10745
+ end
10746
+
10357
10747
  # Submit transfer diligence on behalf of the end customer (i.e. the originator).
10358
10748
  # Use the `/transfer/diligence/submit` endpoint to submit transfer diligence on behalf of the originator.
10359
10749
  # @param transfer_diligence_submit_request [TransferDiligenceSubmitRequest]
@@ -10485,7 +10875,7 @@ module Plaid
10485
10875
  end
10486
10876
 
10487
10877
  # Sync transfer events
10488
- # `/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/).
10878
+ # `/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.
10489
10879
  # @param transfer_event_sync_request [TransferEventSyncRequest]
10490
10880
  # @param [Hash] opts the optional parameters
10491
10881
  # @return [TransferEventSyncResponse]
@@ -10495,7 +10885,7 @@ module Plaid
10495
10885
  end
10496
10886
 
10497
10887
  # Sync transfer events
10498
- # &#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/).
10888
+ # &#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.
10499
10889
  # @param transfer_event_sync_request [TransferEventSyncRequest]
10500
10890
  # @param [Hash] opts the optional parameters
10501
10891
  # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers