plaid 17.1.0 → 17.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1087) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +250 -0
  3. data/Gemfile.lock +2 -2
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +442 -52
  6. data/lib/plaid/api_client.rb +11 -4
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +1 -1
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +1 -1
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +1 -1
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  20. data/lib/plaid/models/account_product_access.rb +1 -1
  21. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  22. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  23. data/lib/plaid/models/account_subtype.rb +1 -1
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/{transaction_frequency.rb → action_state.rb} +7 -6
  32. data/lib/plaid/models/activity.rb +303 -0
  33. data/lib/plaid/models/activity_type.rb +47 -0
  34. data/lib/plaid/models/address.rb +1 -1
  35. data/lib/plaid/models/address_data.rb +1 -1
  36. data/lib/plaid/models/address_data_nullable.rb +1 -1
  37. data/lib/plaid/models/address_match_score.rb +1 -1
  38. data/lib/plaid/models/address_nullable.rb +1 -1
  39. data/lib/plaid/models/address_purpose_label.rb +1 -1
  40. data/lib/plaid/models/application.rb +1 -1
  41. data/lib/plaid/models/application_get_request.rb +1 -1
  42. data/lib/plaid/models/application_get_response.rb +1 -1
  43. data/lib/plaid/models/apr.rb +1 -1
  44. data/lib/plaid/models/asset.rb +2 -2
  45. data/lib/plaid/models/asset_detail.rb +3 -3
  46. data/lib/plaid/models/asset_holder.rb +2 -2
  47. data/lib/plaid/models/asset_holder_name.rb +2 -2
  48. data/lib/plaid/models/asset_owner.rb +2 -2
  49. data/lib/plaid/models/asset_owners.rb +2 -2
  50. data/lib/plaid/models/asset_report.rb +1 -1
  51. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  53. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  55. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  56. data/lib/plaid/models/asset_report_create_request.rb +14 -5
  57. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  58. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  59. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  62. data/lib/plaid/models/asset_report_freddie_get_request.rb +2 -2
  63. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  65. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  66. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  67. data/lib/plaid/models/asset_report_item.rb +1 -1
  68. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  69. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  70. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  72. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  73. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  74. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  75. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  76. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  77. data/lib/plaid/models/asset_report_user.rb +1 -1
  78. data/lib/plaid/models/asset_transaction.rb +2 -2
  79. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  80. data/lib/plaid/models/asset_transaction_description.rb +2 -2
  81. data/lib/plaid/models/asset_transaction_detail.rb +4 -4
  82. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  83. data/lib/plaid/models/asset_transactions.rb +2 -2
  84. data/lib/plaid/models/asset_type.rb +1 -1
  85. data/lib/plaid/models/assets.rb +3 -3
  86. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  87. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  88. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  89. data/lib/plaid/models/auth_get_request.rb +1 -1
  90. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  91. data/lib/plaid/models/auth_get_response.rb +1 -1
  92. data/lib/plaid/models/auth_metadata.rb +1 -1
  93. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  94. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  95. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  96. data/lib/plaid/models/bank_transfer.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  129. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  130. data/lib/plaid/models/bank_transfers_events_update_webhook_for_auth.rb +254 -0
  131. data/lib/plaid/models/categories_get_response.rb +1 -1
  132. data/lib/plaid/models/category.rb +1 -1
  133. data/lib/plaid/models/cause.rb +1 -1
  134. data/lib/plaid/models/cause_all_of.rb +1 -1
  135. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  136. data/lib/plaid/models/client_provided_enriched_transaction.rb +2 -2
  137. data/lib/plaid/models/client_provided_raw_transaction.rb +2 -2
  138. data/lib/plaid/models/client_provided_transaction.rb +40 -6
  139. data/lib/plaid/models/client_provided_transaction_location.rb +260 -0
  140. data/lib/plaid/models/connected_application.rb +1 -1
  141. data/lib/plaid/models/counterparty.rb +27 -5
  142. data/lib/plaid/models/counterparty_type.rb +3 -2
  143. data/lib/plaid/models/country_code.rb +1 -1
  144. data/lib/plaid/models/credit1099.rb +1 -1
  145. data/lib/plaid/models/credit1099_filer.rb +1 -1
  146. data/lib/plaid/models/credit1099_payer.rb +1 -1
  147. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  148. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  149. data/lib/plaid/models/credit_amount_with_currency.rb +242 -0
  150. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  151. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  152. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  153. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  154. data/lib/plaid/models/credit_audit_copy_token_update_request.rb +262 -0
  155. data/lib/plaid/models/credit_audit_copy_token_update_response.rb +225 -0
  156. data/lib/plaid/models/credit_bank_income.rb +1 -1
  157. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  158. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  159. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  160. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  161. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  162. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  163. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  164. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  165. data/lib/plaid/models/credit_bank_income_historical_summary.rb +17 -5
  166. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  167. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  168. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  169. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  170. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  171. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  172. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  173. data/lib/plaid/models/credit_bank_income_summary.rb +17 -5
  174. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  175. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  176. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  177. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  178. data/lib/plaid/models/credit_card_liability.rb +1 -1
  179. data/lib/plaid/models/credit_category.rb +1 -1
  180. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  181. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  182. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  183. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  184. data/lib/plaid/models/credit_employment_item.rb +1 -1
  185. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  186. data/lib/plaid/models/credit_filter.rb +1 -1
  187. data/lib/plaid/models/credit_freddie_mac_asset_detail_voe25.rb +317 -0
  188. data/lib/plaid/models/credit_freddie_mac_asset_transaction_detail_voe25.rb +323 -0
  189. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voa24.rb +241 -0
  190. data/lib/plaid/models/credit_freddie_mac_asset_transaction_voe25.rb +241 -0
  191. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voa24.rb +226 -0
  192. data/lib/plaid/models/credit_freddie_mac_asset_transactions_voe25.rb +226 -0
  193. data/lib/plaid/models/credit_freddie_mac_asset_voa24.rb +280 -0
  194. data/lib/plaid/models/credit_freddie_mac_asset_voe25.rb +266 -0
  195. data/lib/plaid/models/credit_freddie_mac_assets_voa24.rb +227 -0
  196. data/lib/plaid/models/credit_freddie_mac_assets_voe25.rb +227 -0
  197. data/lib/plaid/models/credit_freddie_mac_individual_name_voa24.rb +250 -0
  198. data/lib/plaid/models/credit_freddie_mac_loan_identifiers_voa24.rb +226 -0
  199. data/lib/plaid/models/credit_freddie_mac_loan_voa24.rb +239 -0
  200. data/lib/plaid/models/credit_freddie_mac_loans_voa24.rb +224 -0
  201. data/lib/plaid/models/credit_freddie_mac_parties_voa24.rb +226 -0
  202. data/lib/plaid/models/credit_freddie_mac_party_individual_voa24.rb +224 -0
  203. data/lib/plaid/models/{payment_limits.rb → credit_freddie_mac_party_voa24.rb} +33 -36
  204. data/lib/plaid/models/credit_freddie_mac_reporting_information_voa24.rb +245 -0
  205. data/lib/plaid/models/credit_freddie_mac_reports_get_request.rb +245 -0
  206. data/lib/plaid/models/credit_freddie_mac_reports_get_response.rb +253 -0
  207. data/lib/plaid/models/credit_freddie_mac_service_voa24.rb +240 -0
  208. data/lib/plaid/models/credit_freddie_mac_service_voe25.rb +240 -0
  209. data/lib/plaid/models/credit_freddie_mac_services_voa24.rb +224 -0
  210. data/lib/plaid/models/credit_freddie_mac_services_voe25.rb +224 -0
  211. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voa24.rb +224 -0
  212. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_response_voe25.rb +224 -0
  213. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voa24.rb +252 -0
  214. data/lib/plaid/models/credit_freddie_mac_verification_of_asset_voe25.rb +252 -0
  215. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_deal_voa24.rb +252 -0
  216. data/lib/plaid/models/credit_freddie_mac_verification_of_assets_voa24.rb +219 -0
  217. data/lib/plaid/models/credit_freddie_verification_of_employment_deal_voe25.rb +252 -0
  218. data/lib/plaid/models/credit_freddie_verification_of_employment_voe25.rb +219 -0
  219. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  220. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  221. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  222. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  223. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  224. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  225. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  226. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +40 -0
  227. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  228. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  229. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  230. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  231. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  232. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  233. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  234. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  235. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  236. data/lib/plaid/models/credit_relay_create_request.rb +2 -2
  237. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  238. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  239. data/lib/plaid/models/credit_relay_refresh_request.rb +2 -2
  240. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  241. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  242. data/lib/plaid/models/credit_relay_remove_response.rb +2 -2
  243. data/lib/plaid/models/credit_session.rb +1 -1
  244. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  245. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  246. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  247. data/lib/plaid/models/credit_session_error.rb +1 -1
  248. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  249. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  250. data/lib/plaid/models/credit_session_results.rb +1 -1
  251. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  252. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  253. data/lib/plaid/models/credit_w2.rb +1 -1
  254. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  255. data/lib/plaid/models/dashboard_user.rb +1 -1
  256. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  257. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  258. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  259. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  260. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  261. data/lib/plaid/models/date_range.rb +1 -1
  262. data/lib/plaid/models/deductions.rb +1 -1
  263. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  264. data/lib/plaid/models/deductions_total.rb +1 -1
  265. data/lib/plaid/models/default_update_webhook.rb +1 -1
  266. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  267. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  268. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  269. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  270. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  271. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  272. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  273. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  274. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  275. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  276. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  277. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  278. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  279. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  280. data/lib/plaid/models/depository_filter.rb +1 -1
  281. data/lib/plaid/models/{disbursement_limits.rb → detailed_originator.rb} +34 -36
  282. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  283. data/lib/plaid/models/doc_type.rb +1 -1
  284. data/lib/plaid/models/document_analysis.rb +1 -1
  285. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  286. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  287. data/lib/plaid/models/document_metadata.rb +1 -1
  288. data/lib/plaid/models/document_name_match_code.rb +1 -1
  289. data/lib/plaid/models/document_risk_signal.rb +1 -1
  290. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  291. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  292. data/lib/plaid/models/document_risk_summary.rb +1 -1
  293. data/lib/plaid/models/document_status.rb +1 -1
  294. data/lib/plaid/models/documentary_verification.rb +1 -1
  295. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  296. data/lib/plaid/models/earnings.rb +1 -1
  297. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  298. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  299. data/lib/plaid/models/earnings_total.rb +1 -1
  300. data/lib/plaid/models/email.rb +1 -1
  301. data/lib/plaid/models/email_address_match_score.rb +1 -1
  302. data/lib/plaid/models/employee.rb +1 -1
  303. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  304. data/lib/plaid/models/employer.rb +1 -1
  305. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  306. data/lib/plaid/models/employer_verification.rb +1 -1
  307. data/lib/plaid/models/employers_search_request.rb +1 -1
  308. data/lib/plaid/models/employers_search_response.rb +1 -1
  309. data/lib/plaid/models/employment_details.rb +1 -1
  310. data/lib/plaid/models/employment_verification.rb +1 -1
  311. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  312. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  313. data/lib/plaid/models/employment_verification_status.rb +1 -1
  314. data/lib/plaid/models/enhancements.rb +4 -4
  315. data/lib/plaid/models/enrich_transaction_direction.rb +1 -1
  316. data/lib/plaid/models/enrichments.rb +61 -56
  317. data/lib/plaid/models/entity_document.rb +1 -1
  318. data/lib/plaid/models/entity_document_type.rb +1 -1
  319. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  320. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  321. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  322. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  323. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  324. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  325. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  326. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  327. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  328. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  329. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  330. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  331. data/lib/plaid/models/entity_watchlist_code.rb +2 -1
  332. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  333. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  334. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  335. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  336. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  337. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  338. data/lib/plaid/models/expiration_date.rb +1 -1
  339. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  340. data/lib/plaid/models/external_payment_options.rb +1 -1
  341. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  342. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  343. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  344. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  345. data/lib/plaid/models/fdx_content_types.rb +1 -1
  346. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  347. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  348. data/lib/plaid/models/fdx_notification.rb +1 -1
  349. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  350. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  351. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  352. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  353. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  354. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  355. data/lib/plaid/models/fdx_party.rb +1 -1
  356. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  357. data/lib/plaid/models/fdx_party_type.rb +1 -1
  358. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  359. data/lib/plaid/models/form1099_type.rb +1 -1
  360. data/lib/plaid/models/freddie_report_type.rb +38 -0
  361. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  362. data/lib/plaid/models/health_incident.rb +1 -1
  363. data/lib/plaid/models/historical_balance.rb +1 -1
  364. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  365. data/lib/plaid/models/holding.rb +2 -2
  366. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  367. data/lib/plaid/models/holdings_override.rb +1 -1
  368. data/lib/plaid/models/id_number_type.rb +1 -1
  369. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  370. data/lib/plaid/models/identity_get_request.rb +1 -1
  371. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  372. data/lib/plaid/models/identity_get_response.rb +1 -1
  373. data/lib/plaid/models/identity_match_request.rb +1 -1
  374. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  375. data/lib/plaid/models/identity_match_response.rb +1 -1
  376. data/lib/plaid/models/identity_match_user.rb +1 -1
  377. data/lib/plaid/models/identity_update_types.rb +1 -1
  378. data/lib/plaid/models/identity_verification.rb +1 -1
  379. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  380. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  381. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  382. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  383. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  384. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  385. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  386. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  387. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  388. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  389. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  390. data/lib/plaid/models/identity_verification_status.rb +1 -1
  391. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  392. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  393. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  394. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  395. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  396. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  397. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  398. data/lib/plaid/models/image_quality.rb +1 -1
  399. data/lib/plaid/models/incident_update.rb +1 -1
  400. data/lib/plaid/models/income_breakdown.rb +1 -1
  401. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  402. data/lib/plaid/models/income_override.rb +1 -1
  403. data/lib/plaid/models/income_summary.rb +1 -1
  404. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  405. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  406. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  407. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  408. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  409. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  410. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  411. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  412. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  413. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  414. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  415. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  416. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  417. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  418. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  419. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  420. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  421. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  422. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  423. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  424. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  425. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  426. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  427. data/lib/plaid/models/individual_name.rb +1 -1
  428. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  429. data/lib/plaid/models/individual_watchlist_code.rb +4 -2
  430. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  431. data/lib/plaid/models/inflow_model.rb +1 -1
  432. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  433. data/lib/plaid/models/institution.rb +1 -1
  434. data/lib/plaid/models/institution_status.rb +1 -1
  435. data/lib/plaid/models/institution_supported_networks.rb +224 -0
  436. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  437. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  438. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  439. data/lib/plaid/models/institutions_get_request.rb +1 -1
  440. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  441. data/lib/plaid/models/institutions_get_response.rb +1 -1
  442. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  443. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  444. data/lib/plaid/models/institutions_search_request.rb +1 -1
  445. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  446. data/lib/plaid/models/institutions_search_response.rb +1 -1
  447. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  448. data/lib/plaid/models/investment_filter.rb +1 -1
  449. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  450. data/lib/plaid/models/investment_transaction.rb +2 -2
  451. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  452. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  453. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  454. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  455. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  456. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  457. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  458. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  459. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  460. data/lib/plaid/models/issuing_country.rb +1 -1
  461. data/lib/plaid/models/item.rb +1 -1
  462. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  463. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  464. data/lib/plaid/models/item_activity_list_request.rb +287 -0
  465. data/lib/plaid/models/item_activity_list_response.rb +247 -0
  466. data/lib/plaid/models/item_application_list_request.rb +1 -1
  467. data/lib/plaid/models/item_application_list_response.rb +1 -1
  468. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  469. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  470. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  471. data/lib/plaid/models/item_error_webhook.rb +1 -1
  472. data/lib/plaid/models/item_get_request.rb +1 -1
  473. data/lib/plaid/models/item_get_response.rb +1 -1
  474. data/lib/plaid/models/item_import_request.rb +1 -1
  475. data/lib/plaid/models/item_import_request_options.rb +1 -1
  476. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  477. data/lib/plaid/models/item_import_response.rb +1 -1
  478. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  479. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  480. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  481. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  482. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  483. data/lib/plaid/models/item_remove_request.rb +1 -1
  484. data/lib/plaid/models/item_remove_response.rb +1 -1
  485. data/lib/plaid/models/item_status.rb +1 -1
  486. data/lib/plaid/models/item_status_investments.rb +1 -1
  487. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  488. data/lib/plaid/models/item_status_nullable.rb +1 -1
  489. data/lib/plaid/models/item_status_transactions.rb +1 -1
  490. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  491. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  492. data/lib/plaid/models/jwk_public_key.rb +3 -3
  493. data/lib/plaid/models/jwt_header.rb +1 -1
  494. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  495. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  496. data/lib/plaid/models/kyc_check_details.rb +1 -1
  497. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  498. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  499. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  500. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  501. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  502. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  503. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  504. data/lib/plaid/models/liabilities_object.rb +1 -1
  505. data/lib/plaid/models/liability_override.rb +1 -1
  506. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  507. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  508. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  509. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  510. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  511. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  512. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  513. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  514. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  515. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  516. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  517. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  518. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  519. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  520. data/lib/plaid/models/link_token_create_request.rb +1 -1
  521. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  522. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  523. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  524. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  525. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  526. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +6 -1
  527. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +6 -4
  528. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  529. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  530. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  531. data/lib/plaid/models/link_token_create_request_user.rb +4 -1
  532. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  533. data/lib/plaid/models/link_token_create_response.rb +1 -1
  534. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  535. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  536. data/lib/plaid/models/link_token_get_request.rb +1 -1
  537. data/lib/plaid/models/link_token_get_response.rb +1 -1
  538. data/lib/plaid/models/link_token_investments.rb +1 -1
  539. data/lib/plaid/models/loan.rb +1 -1
  540. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  541. data/lib/plaid/models/loan_filter.rb +1 -1
  542. data/lib/plaid/models/loan_identifier.rb +1 -1
  543. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  544. data/lib/plaid/models/loan_identifiers.rb +1 -1
  545. data/lib/plaid/models/loans.rb +1 -1
  546. data/lib/plaid/models/location.rb +1 -1
  547. data/lib/plaid/models/match_summary.rb +1 -1
  548. data/lib/plaid/models/match_summary_code.rb +1 -1
  549. data/lib/plaid/models/meta.rb +1 -1
  550. data/lib/plaid/models/mfa.rb +1 -1
  551. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  552. data/lib/plaid/models/mortgage_liability.rb +1 -1
  553. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  554. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  555. data/lib/plaid/models/name_match_score.rb +1 -1
  556. data/lib/plaid/models/net_pay.rb +1 -1
  557. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  558. data/lib/plaid/models/numbers.rb +1 -1
  559. data/lib/plaid/models/numbers_ach.rb +1 -1
  560. data/lib/plaid/models/numbers_ach_nullable.rb +1 -1
  561. data/lib/plaid/models/numbers_bacs.rb +1 -1
  562. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  563. data/lib/plaid/models/numbers_eft.rb +1 -1
  564. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  565. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  566. data/lib/plaid/models/numbers_international.rb +1 -1
  567. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  568. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  569. data/lib/plaid/models/originator.rb +1 -1
  570. data/lib/plaid/models/override_account_type.rb +1 -1
  571. data/lib/plaid/models/override_accounts.rb +1 -1
  572. data/lib/plaid/models/owner.rb +1 -1
  573. data/lib/plaid/models/owner_override.rb +1 -1
  574. data/lib/plaid/models/ownership_type.rb +1 -1
  575. data/lib/plaid/models/parties.rb +1 -1
  576. data/lib/plaid/models/partner_customer_create_request.rb +15 -6
  577. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  578. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  579. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  580. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  581. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  582. data/lib/plaid/models/partner_customer_o_auth_institutions_get_request.rb +244 -0
  583. data/lib/plaid/models/partner_customer_o_auth_institutions_get_response.rb +250 -0
  584. data/lib/plaid/models/partner_customer_remove_request.rb +1 -1
  585. data/lib/plaid/models/partner_customer_remove_response.rb +1 -1
  586. data/lib/plaid/models/partner_end_customer.rb +1 -1
  587. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  588. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +1 -1
  589. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  590. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +246 -0
  591. data/lib/plaid/models/partner_end_customer_flowdown_status.rb +41 -0
  592. data/lib/plaid/models/partner_end_customer_o_auth_institution.rb +259 -0
  593. data/lib/plaid/models/partner_end_customer_o_auth_institution_application_status.rb +42 -0
  594. data/lib/plaid/models/partner_end_customer_o_auth_institution_environments.rb +228 -0
  595. data/lib/plaid/models/partner_end_customer_questionnaire_status.rb +40 -0
  596. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  597. data/lib/plaid/models/partner_end_customer_status.rb +3 -3
  598. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  599. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  600. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  601. data/lib/plaid/models/party.rb +1 -1
  602. data/lib/plaid/models/party_individual.rb +2 -2
  603. data/lib/plaid/models/party_role_type.rb +1 -1
  604. data/lib/plaid/models/pay.rb +1 -1
  605. data/lib/plaid/models/pay_frequency.rb +1 -1
  606. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  607. data/lib/plaid/models/pay_period_details.rb +1 -1
  608. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  609. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  610. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  611. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  612. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  613. data/lib/plaid/models/pay_stub_pay_period_details.rb +11 -2
  614. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  615. data/lib/plaid/models/payment_amount.rb +1 -1
  616. data/lib/plaid/models/payment_amount_currency.rb +1 -3
  617. data/lib/plaid/models/payment_amount_nullable.rb +1 -1
  618. data/lib/plaid/models/payment_amount_refunded.rb +2 -2
  619. data/lib/plaid/models/payment_amount_to_refund.rb +2 -2
  620. data/lib/plaid/models/payment_channel.rb +1 -1
  621. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  622. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  623. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  624. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  625. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  626. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  627. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  628. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  629. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  630. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  631. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  632. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  633. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  634. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  635. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  636. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  637. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  638. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  639. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  640. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  641. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  642. data/lib/plaid/models/payment_initiation_payment.rb +1 -1
  643. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  644. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  645. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  646. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  647. data/lib/plaid/models/payment_initiation_payment_get_response.rb +1 -1
  648. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  649. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  650. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  651. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  652. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  653. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  654. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  655. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  656. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  657. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  658. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  659. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  660. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  661. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  662. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  663. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  664. data/lib/plaid/models/payment_meta.rb +1 -1
  665. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  666. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  667. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  668. data/lib/plaid/models/payment_profile_get_response.rb +1 -1
  669. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  670. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  671. data/lib/plaid/models/payment_profile_status.rb +1 -1
  672. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  673. data/lib/plaid/models/payment_scheme.rb +3 -2
  674. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  675. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  676. data/lib/plaid/models/payroll_income_object.rb +1 -1
  677. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  678. data/lib/plaid/models/payroll_item.rb +1 -1
  679. data/lib/plaid/models/payroll_item_status.rb +1 -1
  680. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  681. data/lib/plaid/models/paystub.rb +1 -1
  682. data/lib/plaid/models/paystub_address.rb +1 -1
  683. data/lib/plaid/models/paystub_deduction.rb +1 -1
  684. data/lib/plaid/models/paystub_details.rb +1 -1
  685. data/lib/plaid/models/paystub_employer.rb +1 -1
  686. data/lib/plaid/models/paystub_override.rb +1 -1
  687. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  688. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  689. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  690. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  691. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  692. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  693. data/lib/plaid/models/personal_finance_category.rb +1 -1
  694. data/lib/plaid/models/phone_number.rb +1 -1
  695. data/lib/plaid/models/phone_number_match_score.rb +1 -1
  696. data/lib/plaid/models/phone_type.rb +1 -1
  697. data/lib/plaid/models/physical_document_category.rb +1 -1
  698. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  699. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  700. data/lib/plaid/models/physical_document_images.rb +1 -1
  701. data/lib/plaid/models/plaid_error.rb +1 -1
  702. data/lib/plaid/models/plaid_error_type.rb +1 -1
  703. data/lib/plaid/models/platform_ids.rb +1 -1
  704. data/lib/plaid/models/po_box_status.rb +1 -1
  705. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  706. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  707. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  708. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  709. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  710. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  711. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  712. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  713. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  714. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  715. data/lib/plaid/models/processor_number.rb +1 -1
  716. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  717. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  718. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  719. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  720. data/lib/plaid/models/product_access.rb +1 -1
  721. data/lib/plaid/models/product_status.rb +1 -1
  722. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  723. data/lib/plaid/models/products.rb +1 -1
  724. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  725. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  726. data/lib/plaid/models/pslf_status.rb +1 -1
  727. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  728. data/lib/plaid/models/recipient_bacs.rb +1 -1
  729. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  730. data/lib/plaid/models/recurring_cancelled_webhook.rb +269 -0
  731. data/lib/plaid/models/recurring_new_transfer_webhook.rb +284 -0
  732. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  733. data/lib/plaid/models/recurring_transactions_update_webhook.rb +2 -2
  734. data/lib/plaid/models/recurring_transfer.rb +29 -24
  735. data/lib/plaid/models/recurring_transfer_nullable.rb +443 -0
  736. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +307 -0
  737. data/lib/plaid/models/removed_transaction.rb +1 -1
  738. data/lib/plaid/models/report_type.rb +1 -1
  739. data/lib/plaid/models/reporting_information.rb +2 -2
  740. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  741. data/lib/plaid/models/role.rb +2 -2
  742. data/lib/plaid/models/role_detail.rb +2 -2
  743. data/lib/plaid/models/roles.rb +2 -2
  744. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  745. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  746. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  747. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  748. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  749. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  750. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  751. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  752. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  753. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  754. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  755. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  756. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  757. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  758. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  759. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  760. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  761. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  762. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  763. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  764. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  765. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  766. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  767. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  768. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  769. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  770. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  771. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  772. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  773. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  774. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  775. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  776. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +15 -21
  777. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +1 -1
  778. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +12 -22
  779. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +1 -1
  780. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +4 -10
  781. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +1 -1
  782. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +320 -0
  783. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +241 -0
  784. data/lib/plaid/models/scopes.rb +1 -1
  785. data/lib/plaid/models/scopes_context.rb +1 -1
  786. data/lib/plaid/models/scopes_nullable.rb +1 -1
  787. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  788. data/lib/plaid/models/screening_hit_data.rb +1 -1
  789. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  790. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  791. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  792. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  793. data/lib/plaid/models/security.rb +5 -5
  794. data/lib/plaid/models/security_override.rb +3 -3
  795. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  796. data/lib/plaid/models/service.rb +1 -1
  797. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  798. data/lib/plaid/models/service_product_fulfillment_detail.rb +2 -2
  799. data/lib/plaid/models/service_product_fulfillment_identifier.rb +2 -1
  800. data/lib/plaid/models/servicer_address_data.rb +1 -1
  801. data/lib/plaid/models/services.rb +1 -1
  802. data/lib/plaid/models/signal_address_data.rb +1 -1
  803. data/lib/plaid/models/signal_decision_outcome.rb +1 -1
  804. data/lib/plaid/models/signal_decision_report_request.rb +1 -1
  805. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  806. data/lib/plaid/models/signal_device.rb +1 -1
  807. data/lib/plaid/models/signal_evaluate_core_attributes.rb +1 -1
  808. data/lib/plaid/models/signal_evaluate_request.rb +2 -2
  809. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  810. data/lib/plaid/models/signal_payment_method.rb +1 -1
  811. data/lib/plaid/models/signal_person_name.rb +1 -1
  812. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  813. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  814. data/lib/plaid/models/signal_return_report_request.rb +1 -1
  815. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  816. data/lib/plaid/models/signal_scores.rb +1 -1
  817. data/lib/plaid/models/signal_user.rb +1 -1
  818. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  819. data/lib/plaid/models/single_document_risk_signal.rb +1 -1
  820. data/lib/plaid/models/source.rb +1 -1
  821. data/lib/plaid/models/standalone_account_type.rb +1 -1
  822. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  823. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  824. data/lib/plaid/models/status.rb +2 -2
  825. data/lib/plaid/models/statuses.rb +1 -1
  826. data/lib/plaid/models/strategy.rb +1 -1
  827. data/lib/plaid/models/student_loan.rb +1 -1
  828. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  829. data/lib/plaid/models/student_loan_status.rb +1 -1
  830. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  831. data/lib/plaid/models/sync_updates_available_webhook.rb +1 -1
  832. data/lib/plaid/models/taxform.rb +1 -1
  833. data/lib/plaid/models/taxpayer_id.rb +1 -1
  834. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  835. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  836. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  837. data/lib/plaid/models/total.rb +1 -1
  838. data/lib/plaid/models/total_canonical_description.rb +1 -1
  839. data/lib/plaid/models/transaction.rb +50 -6
  840. data/lib/plaid/models/transaction_all_of.rb +28 -6
  841. data/lib/plaid/models/transaction_base.rb +24 -2
  842. data/lib/plaid/models/transaction_code.rb +1 -1
  843. data/lib/plaid/models/transaction_counterparty.rb +261 -0
  844. data/lib/plaid/models/transaction_data.rb +1 -1
  845. data/lib/plaid/models/transaction_override.rb +1 -1
  846. data/lib/plaid/models/transaction_stream.rb +1 -1
  847. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  848. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  849. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  850. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  851. data/lib/plaid/models/transactions_enhance_get_response.rb +1 -1
  852. data/lib/plaid/models/transactions_enrich_get_request.rb +8 -11
  853. data/lib/plaid/models/transactions_enrich_get_response.rb +1 -1
  854. data/lib/plaid/models/transactions_enrich_request_options.rb +222 -0
  855. data/lib/plaid/models/transactions_get_request.rb +1 -1
  856. data/lib/plaid/models/transactions_get_request_options.rb +17 -5
  857. data/lib/plaid/models/transactions_get_response.rb +1 -1
  858. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  859. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  860. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  861. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  862. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  863. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  864. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  865. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  866. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  867. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  868. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  869. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  870. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  871. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  872. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  873. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  874. data/lib/plaid/models/transactions_sync_request_options.rb +17 -5
  875. data/lib/plaid/models/transactions_sync_response.rb +1 -1
  876. data/lib/plaid/models/transfer.rb +16 -5
  877. data/lib/plaid/models/transfer_authorization.rb +1 -1
  878. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  879. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  880. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  881. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  882. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  883. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  884. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  885. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  886. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  887. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  888. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  889. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  890. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  891. data/lib/plaid/models/transfer_capabilities_get_request.rb +260 -0
  892. data/lib/plaid/models/transfer_capabilities_get_response.rb +239 -0
  893. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +222 -0
  894. data/lib/plaid/models/transfer_create_request.rb +1 -1
  895. data/lib/plaid/models/transfer_create_response.rb +1 -1
  896. data/lib/plaid/models/transfer_device.rb +1 -1
  897. data/lib/plaid/models/transfer_diligence_status.rb +1 -1
  898. data/lib/plaid/models/transfer_event.rb +1 -1
  899. data/lib/plaid/models/transfer_event_list_request.rb +1 -1
  900. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  901. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  902. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  903. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  904. data/lib/plaid/models/transfer_event_type.rb +1 -1
  905. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  906. data/lib/plaid/models/transfer_failure.rb +1 -1
  907. data/lib/plaid/models/transfer_get_request.rb +1 -1
  908. data/lib/plaid/models/transfer_get_response.rb +1 -1
  909. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  910. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  911. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  912. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  913. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  914. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  915. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  916. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  917. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  918. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  919. data/lib/plaid/models/transfer_list_request.rb +1 -1
  920. data/lib/plaid/models/transfer_list_response.rb +1 -1
  921. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  922. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  923. data/lib/plaid/models/transfer_network.rb +1 -1
  924. data/lib/plaid/models/transfer_originator_create_request.rb +22 -1
  925. data/lib/plaid/models/transfer_originator_create_response.rb +1 -1
  926. data/lib/plaid/models/transfer_originator_get_request.rb +1 -1
  927. data/lib/plaid/models/transfer_originator_get_response.rb +2 -2
  928. data/lib/plaid/models/transfer_originator_list_request.rb +5 -3
  929. data/lib/plaid/models/transfer_originator_list_response.rb +1 -1
  930. data/lib/plaid/models/transfer_questionnaire_create_request.rb +5 -47
  931. data/lib/plaid/models/transfer_questionnaire_create_response.rb +1 -1
  932. data/lib/plaid/models/transfer_recurring_cancel_request.rb +1 -11
  933. data/lib/plaid/models/transfer_recurring_cancel_response.rb +1 -1
  934. data/lib/plaid/models/transfer_recurring_create_request.rb +27 -14
  935. data/lib/plaid/models/transfer_recurring_create_response.rb +25 -6
  936. data/lib/plaid/models/transfer_recurring_get_request.rb +1 -11
  937. data/lib/plaid/models/transfer_recurring_get_response.rb +1 -1
  938. data/lib/plaid/models/transfer_recurring_list_request.rb +18 -28
  939. data/lib/plaid/models/transfer_recurring_list_response.rb +1 -1
  940. data/lib/plaid/models/transfer_recurring_schedule.rb +22 -2
  941. data/lib/plaid/models/transfer_recurring_status.rb +1 -1
  942. data/lib/plaid/models/transfer_refund.rb +1 -1
  943. data/lib/plaid/models/transfer_refund_cancel_request.rb +1 -1
  944. data/lib/plaid/models/transfer_refund_cancel_response.rb +1 -1
  945. data/lib/plaid/models/transfer_refund_create_request.rb +1 -1
  946. data/lib/plaid/models/transfer_refund_create_response.rb +1 -1
  947. data/lib/plaid/models/transfer_refund_get_request.rb +1 -1
  948. data/lib/plaid/models/transfer_refund_get_response.rb +1 -1
  949. data/lib/plaid/models/transfer_refund_status.rb +1 -1
  950. data/lib/plaid/models/transfer_repayment.rb +1 -1
  951. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  952. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  953. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  954. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  955. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  956. data/lib/plaid/models/transfer_schedule_interval_unit.rb +1 -1
  957. data/lib/plaid/models/transfer_status.rb +1 -1
  958. data/lib/plaid/models/transfer_sweep.rb +1 -1
  959. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  960. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  961. data/lib/plaid/models/transfer_sweep_list_request.rb +1 -1
  962. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  963. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  964. data/lib/plaid/models/transfer_test_clock.rb +17 -13
  965. data/lib/plaid/models/transfer_type.rb +1 -1
  966. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  967. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  968. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  969. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  970. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  971. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  972. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  973. data/lib/plaid/models/user_address.rb +1 -1
  974. data/lib/plaid/models/user_create_request.rb +1 -1
  975. data/lib/plaid/models/user_create_response.rb +1 -1
  976. data/lib/plaid/models/user_custom_password.rb +1 -1
  977. data/lib/plaid/models/user_id_number.rb +1 -1
  978. data/lib/plaid/models/user_name.rb +1 -1
  979. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  980. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  981. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  982. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  983. data/lib/plaid/models/validation_source.rb +4 -4
  984. data/lib/plaid/models/validation_sources.rb +3 -3
  985. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  986. data/lib/plaid/models/verification_of_asset.rb +2 -2
  987. data/lib/plaid/models/verification_of_asset_response.rb +2 -2
  988. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  989. data/lib/plaid/models/verification_status.rb +1 -1
  990. data/lib/plaid/models/w2.rb +1 -1
  991. data/lib/plaid/models/w2_box12.rb +1 -1
  992. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  993. data/lib/plaid/models/wallet.rb +1 -1
  994. data/lib/plaid/models/wallet_balance.rb +1 -1
  995. data/lib/plaid/models/wallet_create_request.rb +1 -1
  996. data/lib/plaid/models/wallet_create_response.rb +1 -1
  997. data/lib/plaid/models/wallet_get_request.rb +1 -1
  998. data/lib/plaid/models/wallet_get_response.rb +1 -1
  999. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  1000. data/lib/plaid/models/wallet_list_request.rb +1 -1
  1001. data/lib/plaid/models/wallet_list_response.rb +1 -1
  1002. data/lib/plaid/models/wallet_numbers.rb +1 -1
  1003. data/lib/plaid/models/wallet_transaction.rb +4 -4
  1004. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  1005. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  1006. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  1007. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  1008. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  1009. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  1010. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  1011. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  1012. data/lib/plaid/models/wallet_transaction_get_response.rb +4 -4
  1013. data/lib/plaid/models/wallet_transaction_list_request.rb +1 -1
  1014. data/lib/plaid/models/wallet_transaction_list_request_options.rb +1 -1
  1015. data/lib/plaid/models/wallet_transaction_list_response.rb +1 -1
  1016. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  1017. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  1018. data/lib/plaid/models/wallet_transactions_list_request.rb +1 -1
  1019. data/lib/plaid/models/warning.rb +1 -1
  1020. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  1021. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  1022. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  1023. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  1024. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  1025. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  1026. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  1027. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  1028. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  1029. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  1030. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  1031. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  1032. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  1033. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  1034. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  1035. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  1036. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  1037. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  1038. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  1039. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  1040. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  1041. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  1042. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  1043. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  1044. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  1045. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  1046. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  1047. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  1048. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1049. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1050. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1051. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1052. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1053. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1054. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1055. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1056. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1057. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1058. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1059. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1060. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1061. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1062. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1063. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1064. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1065. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1066. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1067. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1068. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1069. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1070. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1071. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1072. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1073. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1074. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1075. data/lib/plaid/models/webhook_type.rb +1 -1
  1076. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1077. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1078. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1079. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1080. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1081. data/lib/plaid/version.rb +2 -2
  1082. data/lib/plaid.rb +66 -4
  1083. data/plaid.gemspec +1 -1
  1084. data/templates/ruby/api_client_faraday_partial.mustache +9 -2
  1085. data/test/test_enrich.rb +60 -0
  1086. data/test/test_payment_initiation.rb +2 -2
  1087. metadata +68 -5
@@ -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.205.3
6
+ The version of the OpenAPI document: 2020-09-14_1.214.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -1060,7 +1060,7 @@ module Plaid
1060
1060
  end
1061
1061
 
1062
1062
  # List bank transfer events
1063
- # Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
1063
+ # Use the `/bank_transfer/event/list` endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
1064
1064
  # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1065
1065
  # @param [Hash] opts the optional parameters
1066
1066
  # @return [BankTransferEventListResponse]
@@ -1070,7 +1070,7 @@ module Plaid
1070
1070
  end
1071
1071
 
1072
1072
  # List bank transfer events
1073
- # Use the `/bank_transfer/event/list` endpoint to get a list of bank transfer events based on specified filter criteria.
1073
+ # Use the `/bank_transfer/event/list` endpoint to get a list of ACH or bank transfer events based on specified filter criteria.
1074
1074
  # @param bank_transfer_event_list_request [BankTransferEventListRequest]
1075
1075
  # @param [Hash] opts the optional parameters
1076
1076
  # @return [Array<(BankTransferEventListResponse, Integer, Hash)>] BankTransferEventListResponse data, response status code and response headers
@@ -1125,7 +1125,7 @@ module Plaid
1125
1125
  end
1126
1126
 
1127
1127
  # Sync bank transfer events
1128
- # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. Use the `/bank_transfer/event/sync` endpoint to guarantee you have seen all bank transfer events.
1128
+ # `/bank_transfer/event/sync` allows you to request up to the next 25 bank transfer events that happened after a specific `event_id`. 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/).
1129
1129
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1130
1130
  # @param [Hash] opts the optional parameters
1131
1131
  # @return [BankTransferEventSyncResponse]
@@ -1135,7 +1135,7 @@ module Plaid
1135
1135
  end
1136
1136
 
1137
1137
  # Sync bank transfer events
1138
- # &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 bank transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/bank_transfer/event/sync&#x60; endpoint to guarantee you have seen all bank transfer events.
1138
+ # &#x60;/bank_transfer/event/sync&#x60; allows you to request up to the next 25 bank transfer events that happened after a specific &#x60;event_id&#x60;. 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/).
1139
1139
  # @param bank_transfer_event_sync_request [BankTransferEventSyncRequest]
1140
1140
  # @param [Hash] opts the optional parameters
1141
1141
  # @return [Array<(BankTransferEventSyncResponse, Integer, Hash)>] BankTransferEventSyncResponse data, response status code and response headers
@@ -1774,6 +1774,71 @@ module Plaid
1774
1774
  return data, status_code, headers
1775
1775
  end
1776
1776
 
1777
+ # Update an Audit Copy Token
1778
+ # The `/credit/audit_copy_token/update` endpoint updates the Audit Copy Token by adding the report tokens in the `report_tokens` field to the `audit_copy_token`. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the `report_tokens` field.
1779
+ # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
1780
+ # @param [Hash] opts the optional parameters
1781
+ # @return [CreditAuditCopyTokenUpdateResponse]
1782
+ def credit_audit_copy_token_update(credit_audit_copy_token_update_request, opts = {})
1783
+ data, _status_code, _headers = credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts)
1784
+ data
1785
+ end
1786
+
1787
+ # Update an Audit Copy Token
1788
+ # The &#x60;/credit/audit_copy_token/update&#x60; endpoint updates the Audit Copy Token by adding the report tokens in the &#x60;report_tokens&#x60; field to the &#x60;audit_copy_token&#x60;. If the Audit Copy Token already contains a report of a certain type, it will be replaced with the token provided in the &#x60;report_tokens&#x60; field.
1789
+ # @param credit_audit_copy_token_update_request [CreditAuditCopyTokenUpdateRequest]
1790
+ # @param [Hash] opts the optional parameters
1791
+ # @return [Array<(CreditAuditCopyTokenUpdateResponse, Integer, Hash)>] CreditAuditCopyTokenUpdateResponse data, response status code and response headers
1792
+ def credit_audit_copy_token_update_with_http_info(credit_audit_copy_token_update_request, opts = {})
1793
+ if @api_client.config.debugging
1794
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_audit_copy_token_update ...'
1795
+ end
1796
+ # verify the required parameter 'credit_audit_copy_token_update_request' is set
1797
+ if @api_client.config.client_side_validation && credit_audit_copy_token_update_request.nil?
1798
+ fail ArgumentError, "Missing the required parameter 'credit_audit_copy_token_update_request' when calling PlaidApi.credit_audit_copy_token_update"
1799
+ end
1800
+ # resource path
1801
+ local_var_path = '/credit/audit_copy_token/update'
1802
+
1803
+ # query parameters
1804
+ query_params = opts[:query_params] || {}
1805
+
1806
+ # header parameters
1807
+ header_params = opts[:header_params] || {}
1808
+ # HTTP header 'Accept' (if needed)
1809
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1810
+ # HTTP header 'Content-Type'
1811
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
1812
+
1813
+ # form parameters
1814
+ form_params = opts[:form_params] || {}
1815
+
1816
+ # http body (model)
1817
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_audit_copy_token_update_request)
1818
+
1819
+ # return_type
1820
+ return_type = opts[:debug_return_type] || 'CreditAuditCopyTokenUpdateResponse'
1821
+
1822
+ # auth_names
1823
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1824
+
1825
+ new_options = opts.merge(
1826
+ :operation => :"PlaidApi.credit_audit_copy_token_update",
1827
+ :header_params => header_params,
1828
+ :query_params => query_params,
1829
+ :form_params => form_params,
1830
+ :body => post_body,
1831
+ :auth_names => auth_names,
1832
+ :return_type => return_type
1833
+ )
1834
+
1835
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1836
+ if @api_client.config.debugging
1837
+ @api_client.config.logger.debug "API called: PlaidApi#credit_audit_copy_token_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1838
+ end
1839
+ return data, status_code, headers
1840
+ end
1841
+
1777
1842
  # Retrieve information from the bank accounts used for income verification
1778
1843
  # `/credit/bank_income/get` returns the bank income report(s) for a specified user.
1779
1844
  # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
@@ -1906,26 +1971,26 @@ module Plaid
1906
1971
 
1907
1972
  # Refresh a user's bank income information
1908
1973
  # `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
1909
- # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
1974
+ # @param request_body [Hash<String, Object>]
1910
1975
  # @param [Hash] opts the optional parameters
1911
1976
  # @return [CreditBankIncomeRefreshResponse]
1912
- def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
1913
- data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
1977
+ def credit_bank_income_refresh(request_body, opts = {})
1978
+ data, _status_code, _headers = credit_bank_income_refresh_with_http_info(request_body, opts)
1914
1979
  data
1915
1980
  end
1916
1981
 
1917
1982
  # Refresh a user&#39;s bank income information
1918
1983
  # &#x60;/credit/bank_income/refresh&#x60; refreshes the bank income report data for a specific user.
1919
- # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
1984
+ # @param request_body [Hash<String, Object>]
1920
1985
  # @param [Hash] opts the optional parameters
1921
1986
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
1922
- def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
1987
+ def credit_bank_income_refresh_with_http_info(request_body, opts = {})
1923
1988
  if @api_client.config.debugging
1924
1989
  @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
1925
1990
  end
1926
- # verify the required parameter 'credit_bank_income_refresh_request' is set
1927
- if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
1928
- fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
1991
+ # verify the required parameter 'request_body' is set
1992
+ if @api_client.config.client_side_validation && request_body.nil?
1993
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_bank_income_refresh"
1929
1994
  end
1930
1995
  # resource path
1931
1996
  local_var_path = '/credit/bank_income/refresh'
@@ -1944,7 +2009,7 @@ module Plaid
1944
2009
  form_params = opts[:form_params] || {}
1945
2010
 
1946
2011
  # http body (model)
1947
- post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
1948
2013
 
1949
2014
  # return_type
1950
2015
  return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
@@ -2034,6 +2099,71 @@ module Plaid
2034
2099
  return data, status_code, headers
2035
2100
  end
2036
2101
 
2102
+ # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
2103
+ # The `credit/asset_report/freddie_mac/get` endpoint retrieves the Verification of Assets and Verification of Employment reports.
2104
+ # @param request_body [Hash<String, Object>]
2105
+ # @param [Hash] opts the optional parameters
2106
+ # @return [CreditFreddieMacReportsGetResponse]
2107
+ def credit_freddie_mac_reports_get(request_body, opts = {})
2108
+ data, _status_code, _headers = credit_freddie_mac_reports_get_with_http_info(request_body, opts)
2109
+ data
2110
+ end
2111
+
2112
+ # Retrieve an Asset Report with Freddie Mac format (aka VOA - Verification Of Assets), and a Verification Of Employment (VOE) report if this one is available. Only Freddie Mac can use this endpoint.
2113
+ # The &#x60;credit/asset_report/freddie_mac/get&#x60; endpoint retrieves the Verification of Assets and Verification of Employment reports.
2114
+ # @param request_body [Hash<String, Object>]
2115
+ # @param [Hash] opts the optional parameters
2116
+ # @return [Array<(CreditFreddieMacReportsGetResponse, Integer, Hash)>] CreditFreddieMacReportsGetResponse data, response status code and response headers
2117
+ def credit_freddie_mac_reports_get_with_http_info(request_body, opts = {})
2118
+ if @api_client.config.debugging
2119
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_freddie_mac_reports_get ...'
2120
+ end
2121
+ # verify the required parameter 'request_body' is set
2122
+ if @api_client.config.client_side_validation && request_body.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_freddie_mac_reports_get"
2124
+ end
2125
+ # resource path
2126
+ local_var_path = '/credit/freddie_mac/reports/get'
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(request_body)
2143
+
2144
+ # return_type
2145
+ return_type = opts[:debug_return_type] || 'CreditFreddieMacReportsGetResponse'
2146
+
2147
+ # auth_names
2148
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2149
+
2150
+ new_options = opts.merge(
2151
+ :operation => :"PlaidApi.credit_freddie_mac_reports_get",
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_freddie_mac_reports_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2163
+ end
2164
+ return data, status_code, headers
2165
+ end
2166
+
2037
2167
  # Retrieve a user's payroll information
2038
2168
  # This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
2039
2169
  # @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
@@ -2229,8 +2359,8 @@ module Plaid
2229
2359
  return data, status_code, headers
2230
2360
  end
2231
2361
 
2232
- # Create a `relay_token` to share an Asset Report with a partner client
2233
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party to whom you want to grant access to the Report.
2362
+ # Create a relay token to share an Asset Report with a partner client (beta)
2363
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
2234
2364
  # @param credit_relay_create_request [CreditRelayCreateRequest]
2235
2365
  # @param [Hash] opts the optional parameters
2236
2366
  # @return [CreditRelayCreateResponse]
@@ -2239,8 +2369,8 @@ module Plaid
2239
2369
  data
2240
2370
  end
2241
2371
 
2242
- # Create a &#x60;relay_token&#x60; to share an Asset Report with a partner client
2243
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in &#x60;/asset_report/create&#x60;. To grant access to an Asset Report to a third party, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;secondary_client_id&#x60;, for example &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;relay_token&#x60; for each third party to whom you want to grant access to the Report.
2372
+ # Create a relay token to share an Asset Report with a partner client (beta)
2373
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in &#x60;/asset_report/create&#x60;. To grant a third party access to an Asset Report, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to your third party. Each third party has its own &#x60;secondary_client_id&#x60;; for example, &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;relay_token&#x60; for each third party that needs access to the report on your behalf.
2244
2374
  # @param credit_relay_create_request [CreditRelayCreateRequest]
2245
2375
  # @param [Hash] opts the optional parameters
2246
2376
  # @return [Array<(CreditRelayCreateResponse, Integer, Hash)>] CreditRelayCreateResponse data, response status code and response headers
@@ -2294,8 +2424,8 @@ module Plaid
2294
2424
  return data, status_code, headers
2295
2425
  end
2296
2426
 
2297
- # Retrieve the reports associated with a Relay token that was shared with you
2298
- # `/credit/relay/get` allows third parties to get a report that was shared with them, using an `relay_token` that was created by the report owner.
2427
+ # Retrieve the reports associated with a relay token that was shared with you (beta)
2428
+ # `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
2299
2429
  # @param credit_relay_get_request [CreditRelayGetRequest]
2300
2430
  # @param [Hash] opts the optional parameters
2301
2431
  # @return [AssetReportGetResponse]
@@ -2304,8 +2434,8 @@ module Plaid
2304
2434
  data
2305
2435
  end
2306
2436
 
2307
- # Retrieve the reports associated with a Relay token that was shared with you
2308
- # &#x60;/credit/relay/get&#x60; allows third parties to get a report that was shared with them, using an &#x60;relay_token&#x60; that was created by the report owner.
2437
+ # Retrieve the reports associated with a relay token that was shared with you (beta)
2438
+ # &#x60;/credit/relay/get&#x60; allows third parties to receive a report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner.
2309
2439
  # @param credit_relay_get_request [CreditRelayGetRequest]
2310
2440
  # @param [Hash] opts the optional parameters
2311
2441
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -2359,8 +2489,8 @@ module Plaid
2359
2489
  return data, status_code, headers
2360
2490
  end
2361
2491
 
2362
- # Refresh a report of a Relay Token
2363
- # The `/credit/relay/refresh` endpoint allows third parties to refresh an report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
2492
+ # Refresh a report of a relay token (beta)
2493
+ # The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
2364
2494
  # @param credit_relay_refresh_request [CreditRelayRefreshRequest]
2365
2495
  # @param [Hash] opts the optional parameters
2366
2496
  # @return [CreditRelayRefreshResponse]
@@ -2369,8 +2499,8 @@ module Plaid
2369
2499
  data
2370
2500
  end
2371
2501
 
2372
- # Refresh a report of a Relay Token
2373
- # The &#x60;/credit/relay/refresh&#x60; endpoint allows third parties to refresh an report that was relayed to them, using a &#x60;relay_token&#x60; that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
2502
+ # Refresh a report of a relay token (beta)
2503
+ # The &#x60;/credit/relay/refresh&#x60; endpoint allows third parties to refresh a report that was relayed to them, using a &#x60;relay_token&#x60; that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the &#x60;days_requested&#x60; value of the original report.
2374
2504
  # @param credit_relay_refresh_request [CreditRelayRefreshRequest]
2375
2505
  # @param [Hash] opts the optional parameters
2376
2506
  # @return [Array<(CreditRelayRefreshResponse, Integer, Hash)>] CreditRelayRefreshResponse data, response status code and response headers
@@ -2424,8 +2554,8 @@ module Plaid
2424
2554
  return data, status_code, headers
2425
2555
  end
2426
2556
 
2427
- # Remove Credit Relay Token
2428
- # The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`, meaning the third party holding the token will no longer be able to use it to access the reports to which the `relay_token` gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token.
2557
+ # Remove relay token (beta)
2558
+ # The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`.
2429
2559
  # @param credit_relay_remove_request [CreditRelayRemoveRequest]
2430
2560
  # @param [Hash] opts the optional parameters
2431
2561
  # @return [CreditRelayRemoveResponse]
@@ -2434,8 +2564,8 @@ module Plaid
2434
2564
  data
2435
2565
  end
2436
2566
 
2437
- # Remove Credit Relay Token
2438
- # The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;, meaning the third party holding the token will no longer be able to use it to access the reports to which the &#x60;relay_token&#x60; gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given &#x60;relay_token.
2567
+ # Remove relay token (beta)
2568
+ # The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;. The third party holding the token will no longer be able to access or refresh the reports which the &#x60;relay_token&#x60; gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given &#x60;relay_token&#x60;.
2439
2569
  # @param credit_relay_remove_request [CreditRelayRemoveRequest]
2440
2570
  # @param [Hash] opts the optional parameters
2441
2571
  # @return [Array<(CreditRelayRemoveResponse, Integer, Hash)>] CreditRelayRemoveResponse data, response status code and response headers
@@ -4180,7 +4310,7 @@ module Plaid
4180
4310
  end
4181
4311
 
4182
4312
  # Get investment transactions
4183
- # The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions.
4313
+ # The `/investments/transactions/get` endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the `total_investment_transactions` response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when `/investments/transactions/get` is first called, Plaid will wait for the data. For this reason, calling `/investments/transactions/get` immediately after Link may take up to one to two minutes to return.
4184
4314
  # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4185
4315
  # @param [Hash] opts the optional parameters
4186
4316
  # @return [InvestmentsTransactionsGetResponse]
@@ -4190,7 +4320,7 @@ module Plaid
4190
4320
  end
4191
4321
 
4192
4322
  # Get investment transactions
4193
- # The &#x60;/investments/transactions/get&#x60; endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions.
4323
+ # The &#x60;/investments/transactions/get&#x60; endpoint allows developers to retrieve up to 24 months of user-authorized transaction data for investment accounts. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Due to the potentially large number of investment transactions associated with an Item, results are paginated. Manipulate the count and offset parameters in conjunction with the &#x60;total_investment_transactions&#x60; response body field to fetch all available investment transactions. Note that Investments does not have a webhook to indicate when initial transaction data has loaded. Instead, if transactions data is not ready when &#x60;/investments/transactions/get&#x60; is first called, Plaid will wait for the data. For this reason, calling &#x60;/investments/transactions/get&#x60; immediately after Link may take up to one to two minutes to return.
4194
4324
  # @param investments_transactions_get_request [InvestmentsTransactionsGetRequest]
4195
4325
  # @param [Hash] opts the optional parameters
4196
4326
  # @return [Array<(InvestmentsTransactionsGetResponse, Integer, Hash)>] InvestmentsTransactionsGetResponse data, response status code and response headers
@@ -4309,6 +4439,71 @@ module Plaid
4309
4439
  return data, status_code, headers
4310
4440
  end
4311
4441
 
4442
+ # List a historical log of user consent events
4443
+ # List a historical log of user consent events
4444
+ # @param item_activity_list_request [ItemActivityListRequest]
4445
+ # @param [Hash] opts the optional parameters
4446
+ # @return [ItemActivityListResponse]
4447
+ def item_activity_list(item_activity_list_request, opts = {})
4448
+ data, _status_code, _headers = item_activity_list_with_http_info(item_activity_list_request, opts)
4449
+ data
4450
+ end
4451
+
4452
+ # List a historical log of user consent events
4453
+ # List a historical log of user consent events
4454
+ # @param item_activity_list_request [ItemActivityListRequest]
4455
+ # @param [Hash] opts the optional parameters
4456
+ # @return [Array<(ItemActivityListResponse, Integer, Hash)>] ItemActivityListResponse data, response status code and response headers
4457
+ def item_activity_list_with_http_info(item_activity_list_request, opts = {})
4458
+ if @api_client.config.debugging
4459
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_activity_list ...'
4460
+ end
4461
+ # verify the required parameter 'item_activity_list_request' is set
4462
+ if @api_client.config.client_side_validation && item_activity_list_request.nil?
4463
+ fail ArgumentError, "Missing the required parameter 'item_activity_list_request' when calling PlaidApi.item_activity_list"
4464
+ end
4465
+ # resource path
4466
+ local_var_path = '/item/activity/list'
4467
+
4468
+ # query parameters
4469
+ query_params = opts[:query_params] || {}
4470
+
4471
+ # header parameters
4472
+ header_params = opts[:header_params] || {}
4473
+ # HTTP header 'Accept' (if needed)
4474
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
4475
+ # HTTP header 'Content-Type'
4476
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
4477
+
4478
+ # form parameters
4479
+ form_params = opts[:form_params] || {}
4480
+
4481
+ # http body (model)
4482
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_activity_list_request)
4483
+
4484
+ # return_type
4485
+ return_type = opts[:debug_return_type] || 'ItemActivityListResponse'
4486
+
4487
+ # auth_names
4488
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
4489
+
4490
+ new_options = opts.merge(
4491
+ :operation => :"PlaidApi.item_activity_list",
4492
+ :header_params => header_params,
4493
+ :query_params => query_params,
4494
+ :form_params => form_params,
4495
+ :body => post_body,
4496
+ :auth_names => auth_names,
4497
+ :return_type => return_type
4498
+ )
4499
+
4500
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
4501
+ if @api_client.config.debugging
4502
+ @api_client.config.logger.debug "API called: PlaidApi#item_activity_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4503
+ end
4504
+ return data, status_code, headers
4505
+ end
4506
+
4312
4507
  # List a user’s connected applications
4313
4508
  # List a user’s connected applications
4314
4509
  # @param item_application_list_request [ItemApplicationListRequest]
@@ -5414,6 +5609,71 @@ module Plaid
5414
5609
  return data, status_code, headers
5415
5610
  end
5416
5611
 
5612
+ # Returns OAuth-institution registration information for a given end customer.
5613
+ # The `/partner/customer/oauth_institutions/get` endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
5614
+ # @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
5615
+ # @param [Hash] opts the optional parameters
5616
+ # @return [PartnerCustomerOAuthInstitutionsGetResponse]
5617
+ def partner_customer_oauth_institutions_get(partner_customer_o_auth_institutions_get_request, opts = {})
5618
+ data, _status_code, _headers = partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts)
5619
+ data
5620
+ end
5621
+
5622
+ # Returns OAuth-institution registration information for a given end customer.
5623
+ # The &#x60;/partner/customer/oauth_institutions/get&#x60; endpoint is used by reseller partners to retrieve OAuth-institution registration information about a single end customer.
5624
+ # @param partner_customer_o_auth_institutions_get_request [PartnerCustomerOAuthInstitutionsGetRequest]
5625
+ # @param [Hash] opts the optional parameters
5626
+ # @return [Array<(PartnerCustomerOAuthInstitutionsGetResponse, Integer, Hash)>] PartnerCustomerOAuthInstitutionsGetResponse data, response status code and response headers
5627
+ def partner_customer_oauth_institutions_get_with_http_info(partner_customer_o_auth_institutions_get_request, opts = {})
5628
+ if @api_client.config.debugging
5629
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_oauth_institutions_get ...'
5630
+ end
5631
+ # verify the required parameter 'partner_customer_o_auth_institutions_get_request' is set
5632
+ if @api_client.config.client_side_validation && partner_customer_o_auth_institutions_get_request.nil?
5633
+ fail ArgumentError, "Missing the required parameter 'partner_customer_o_auth_institutions_get_request' when calling PlaidApi.partner_customer_oauth_institutions_get"
5634
+ end
5635
+ # resource path
5636
+ local_var_path = '/partner/customer/oauth_institutions/get'
5637
+
5638
+ # query parameters
5639
+ query_params = opts[:query_params] || {}
5640
+
5641
+ # header parameters
5642
+ header_params = opts[:header_params] || {}
5643
+ # HTTP header 'Accept' (if needed)
5644
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5645
+ # HTTP header 'Content-Type'
5646
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5647
+
5648
+ # form parameters
5649
+ form_params = opts[:form_params] || {}
5650
+
5651
+ # http body (model)
5652
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_o_auth_institutions_get_request)
5653
+
5654
+ # return_type
5655
+ return_type = opts[:debug_return_type] || 'PartnerCustomerOAuthInstitutionsGetResponse'
5656
+
5657
+ # auth_names
5658
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5659
+
5660
+ new_options = opts.merge(
5661
+ :operation => :"PlaidApi.partner_customer_oauth_institutions_get",
5662
+ :header_params => header_params,
5663
+ :query_params => query_params,
5664
+ :form_params => form_params,
5665
+ :body => post_body,
5666
+ :auth_names => auth_names,
5667
+ :return_type => return_type
5668
+ )
5669
+
5670
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5671
+ if @api_client.config.debugging
5672
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_oauth_institutions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5673
+ end
5674
+ return data, status_code, headers
5675
+ end
5676
+
5417
5677
  # Removes a Plaid reseller's end customer.
5418
5678
  # The `/partner/customer/remove` endpoint is used by reseller partners to remove an end customer. Removing an end customer will remove it from view in the Plaid Dashboard and deactivate its API keys. This endpoint can only be used to remove an end customer that has not yet been enabled in Production.
5419
5679
  # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
@@ -5740,7 +6000,7 @@ module Plaid
5740
6000
  end
5741
6001
 
5742
6002
  # Create a payment
5743
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
6003
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
5744
6004
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
5745
6005
  # @param [Hash] opts the optional parameters
5746
6006
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -5750,7 +6010,7 @@ module Plaid
5750
6010
  end
5751
6011
 
5752
6012
  # Create a payment
5753
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
6013
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
5754
6014
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
5755
6015
  # @param [Hash] opts the optional parameters
5756
6016
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -5935,7 +6195,7 @@ module Plaid
5935
6195
  end
5936
6196
 
5937
6197
  # Reverse an existing payment
5938
- # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use `/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
6198
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
5939
6199
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5940
6200
  # @param [Hash] opts the optional parameters
5941
6201
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -5945,7 +6205,7 @@ module Plaid
5945
6205
  end
5946
6206
 
5947
6207
  # Reverse an existing payment
5948
- # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use &#x60;/wallet/transaction/execute&#x60;, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
6208
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
5949
6209
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5950
6210
  # @param [Hash] opts the optional parameters
5951
6211
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -6000,7 +6260,7 @@ module Plaid
6000
6260
  end
6001
6261
 
6002
6262
  # Create payment recipient
6003
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
6263
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
6004
6264
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
6005
6265
  # @param [Hash] opts the optional parameters
6006
6266
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -6010,7 +6270,7 @@ module Plaid
6010
6270
  end
6011
6271
 
6012
6272
  # Create payment recipient
6013
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
6273
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
6014
6274
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
6015
6275
  # @param [Hash] opts the optional parameters
6016
6276
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -7755,7 +8015,7 @@ module Plaid
7755
8015
  end
7756
8016
 
7757
8017
  # Advance a test clock
7758
- # Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `frozen_timestamp` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `frozen_timestamp`, but may never go back to a lower `frozen_timestamp`. If a test clock is advanced from T1 to T2, we will simulate the changes that ought to occur during the period of (T1, T2]. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `frozen_timestamp` = t + 15 days, 2 new originations should be created, along with the webhook events. The timestamps of the objects and webhook events created/updated in step 2 should also fall in (T1, T2] time range. The advancement of the test clock from its current `frozen_timestamp` should be limited such that there are no more than 20 originations resulted from the advance operation on each `recurring_transfer` associated with this `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `frozen_timestamp` up to 80 weeks on each advance call.
8018
+ # Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
7759
8019
  # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7760
8020
  # @param [Hash] opts the optional parameters
7761
8021
  # @return [SandboxTransferTestClockAdvanceResponse]
@@ -7765,7 +8025,7 @@ module Plaid
7765
8025
  end
7766
8026
 
7767
8027
  # Advance a test clock
7768
- # Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;frozen_timestamp&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;frozen_timestamp&#x60;, but may never go back to a lower &#x60;frozen_timestamp&#x60;. If a test clock is advanced from T1 to T2, we will simulate the changes that ought to occur during the period of (T1, T2]. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;frozen_timestamp&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The timestamps of the objects and webhook events created/updated in step 2 should also fall in (T1, T2] time range. The advancement of the test clock from its current &#x60;frozen_timestamp&#x60; should be limited such that there are no more than 20 originations resulted from the advance operation on each &#x60;recurring_transfer&#x60; associated with this &#x60;test_clock&#x60;. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;frozen_timestamp&#x60; up to 80 weeks on each advance call.
8028
+ # Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;virtual_time&#x60;, but may never go back to a lower &#x60;virtual_time&#x60;. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;virtual_time&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current &#x60;virtual_time&#x60; should be limited such that there are no more than 20 originations resulting from the advance operation on each &#x60;recurring_transfer&#x60; associated with the &#x60;test_clock&#x60;. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;virtual_time&#x60; up to 80 weeks on each API call.
7769
8029
  # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7770
8030
  # @param [Hash] opts the optional parameters
7771
8031
  # @return [Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>] SandboxTransferTestClockAdvanceResponse data, response status code and response headers
@@ -7820,7 +8080,7 @@ module Plaid
7820
8080
  end
7821
8081
 
7822
8082
  # Create a test clock
7823
- # Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `frozen_timestamp` field indicating the current timestamp of the timeline. Test clock allows clients to easily test and integrate with recurring transfer product in sandbox environment. A test clock can be associated with up to 5 recurring transfers.
8083
+ # Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
7824
8084
  # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7825
8085
  # @param [Hash] opts the optional parameters
7826
8086
  # @return [SandboxTransferTestClockCreateResponse]
@@ -7830,7 +8090,7 @@ module Plaid
7830
8090
  end
7831
8091
 
7832
8092
  # Create a test clock
7833
- # Use the &#x60;/sandbox/transfer/test_clock/create&#x60; endpoint to create a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;frozen_timestamp&#x60; field indicating the current timestamp of the timeline. Test clock allows clients to easily test and integrate with recurring transfer product in sandbox environment. A test clock can be associated with up to 5 recurring transfers.
8093
+ # Use the &#x60;/sandbox/transfer/test_clock/create&#x60; endpoint to create a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;virtual_time&#x60; field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
7834
8094
  # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7835
8095
  # @param [Hash] opts the optional parameters
7836
8096
  # @return [Array<(SandboxTransferTestClockCreateResponse, Integer, Hash)>] SandboxTransferTestClockCreateResponse 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
+ # List test clocks
8213
+ # Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
8214
+ # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
8215
+ # @param [Hash] opts the optional parameters
8216
+ # @return [SandboxTransferTestClockListResponse]
8217
+ def sandbox_transfer_test_clock_list(sandbox_transfer_test_clock_list_request, opts = {})
8218
+ data, _status_code, _headers = sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts)
8219
+ data
8220
+ end
8221
+
8222
+ # List test clocks
8223
+ # Use the &#x60;/sandbox/transfer/test_clock/list&#x60; endpoint to see a list of all your test clocks in the Sandbox environment, by ascending &#x60;virtual_time&#x60;. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired test clocks.
8224
+ # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
8225
+ # @param [Hash] opts the optional parameters
8226
+ # @return [Array<(SandboxTransferTestClockListResponse, Integer, Hash)>] SandboxTransferTestClockListResponse data, response status code and response headers
8227
+ def sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts = {})
8228
+ if @api_client.config.debugging
8229
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_list ...'
8230
+ end
8231
+ # verify the required parameter 'sandbox_transfer_test_clock_list_request' is set
8232
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_list_request.nil?
8233
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_list_request' when calling PlaidApi.sandbox_transfer_test_clock_list"
8234
+ end
8235
+ # resource path
8236
+ local_var_path = '/sandbox/transfer/test_clock/list'
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_transfer_test_clock_list_request)
8253
+
8254
+ # return_type
8255
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockListResponse'
8256
+
8257
+ # auth_names
8258
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8259
+
8260
+ new_options = opts.merge(
8261
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_list",
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_transfer_test_clock_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8273
+ end
8274
+ return data, status_code, headers
8275
+ end
8276
+
7952
8277
  # Report whether you initiated an ACH transaction
7953
8278
  # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
7954
8279
  # @param signal_decision_report_request [SignalDecisionReportRequest]
@@ -8210,7 +8535,7 @@ module Plaid
8210
8535
  end
8211
8536
 
8212
8537
  # enhance locally-held transaction data
8213
- # The '/beta/transactions/v1/enhance' endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8538
+ # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8214
8539
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8215
8540
  # @param [Hash] opts the optional parameters
8216
8541
  # @return [TransactionsEnhanceGetResponse]
@@ -8220,7 +8545,7 @@ module Plaid
8220
8545
  end
8221
8546
 
8222
8547
  # enhance locally-held transaction data
8223
- # The &#39;/beta/transactions/v1/enhance&#39; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8548
+ # The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8224
8549
  # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8225
8550
  # @param [Hash] opts the optional parameters
8226
8551
  # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
@@ -8275,7 +8600,7 @@ module Plaid
8275
8600
  end
8276
8601
 
8277
8602
  # Enrich locally-held transaction data
8278
- # The '/transactions/enrich' endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact transactions-feedback@plaid.com
8603
+ # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8279
8604
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8280
8605
  # @param [Hash] opts the optional parameters
8281
8606
  # @return [TransactionsEnrichGetResponse]
@@ -8285,7 +8610,7 @@ module Plaid
8285
8610
  end
8286
8611
 
8287
8612
  # Enrich locally-held transaction data
8288
- # The &#39;/transactions/enrich&#39; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact transactions-feedback@plaid.com
8613
+ # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8289
8614
  # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8290
8615
  # @param [Hash] opts the optional parameters
8291
8616
  # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
@@ -8405,7 +8730,7 @@ module Plaid
8405
8730
  end
8406
8731
 
8407
8732
  # Fetch recurring transaction streams
8408
- # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. Note that unlike `/transactions/get`, `/transactions/recurring/get` will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in `/link/token/create`, or after Link, by calling `/transactions/get`) before calling this endpoint. Data is available to `/transactions/recurring/get` approximately 5 seconds after the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
8733
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get`). After the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8409
8734
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8410
8735
  # @param [Hash] opts the optional parameters
8411
8736
  # @return [TransactionsRecurringGetResponse]
@@ -8415,7 +8740,7 @@ module Plaid
8415
8740
  end
8416
8741
 
8417
8742
  # Fetch recurring transaction streams
8418
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. Note that unlike &#x60;/transactions/get&#x60;, &#x60;/transactions/recurring/get&#x60; will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;, or after Link, by calling &#x60;/transactions/get&#x60;) before calling this endpoint. Data is available to &#x60;/transactions/recurring/get&#x60; approximately 5 seconds after the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
8743
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60;). After the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8419
8744
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8420
8745
  # @param [Hash] opts the optional parameters
8421
8746
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -8730,7 +9055,7 @@ module Plaid
8730
9055
  end
8731
9056
 
8732
9057
  # Get incremental transaction updates on an Item
8733
- # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9058
+ # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8734
9059
  # @param transactions_sync_request [TransactionsSyncRequest]
8735
9060
  # @param [Hash] opts the optional parameters
8736
9061
  # @return [TransactionsSyncResponse]
@@ -8740,7 +9065,7 @@ module Plaid
8740
9065
  end
8741
9066
 
8742
9067
  # Get incremental transaction updates on an Item
8743
- # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
9068
+ # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8744
9069
  # @param transactions_sync_request [TransactionsSyncRequest]
8745
9070
  # @param [Hash] opts the optional parameters
8746
9071
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -8924,6 +9249,71 @@ module Plaid
8924
9249
  return data, status_code, headers
8925
9250
  end
8926
9251
 
9252
+ # Get RTP eligibility information of a transfer
9253
+ # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
9254
+ # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
9255
+ # @param [Hash] opts the optional parameters
9256
+ # @return [TransferCapabilitiesGetResponse]
9257
+ def transfer_capabilities_get(transfer_capabilities_get_request, opts = {})
9258
+ data, _status_code, _headers = transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts)
9259
+ data
9260
+ end
9261
+
9262
+ # Get RTP eligibility information of a transfer
9263
+ # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer.
9264
+ # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
9265
+ # @param [Hash] opts the optional parameters
9266
+ # @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
9267
+ def transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts = {})
9268
+ if @api_client.config.debugging
9269
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_capabilities_get ...'
9270
+ end
9271
+ # verify the required parameter 'transfer_capabilities_get_request' is set
9272
+ if @api_client.config.client_side_validation && transfer_capabilities_get_request.nil?
9273
+ fail ArgumentError, "Missing the required parameter 'transfer_capabilities_get_request' when calling PlaidApi.transfer_capabilities_get"
9274
+ end
9275
+ # resource path
9276
+ local_var_path = '/transfer/capabilities/get'
9277
+
9278
+ # query parameters
9279
+ query_params = opts[:query_params] || {}
9280
+
9281
+ # header parameters
9282
+ header_params = opts[:header_params] || {}
9283
+ # HTTP header 'Accept' (if needed)
9284
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9285
+ # HTTP header 'Content-Type'
9286
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9287
+
9288
+ # form parameters
9289
+ form_params = opts[:form_params] || {}
9290
+
9291
+ # http body (model)
9292
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_capabilities_get_request)
9293
+
9294
+ # return_type
9295
+ return_type = opts[:debug_return_type] || 'TransferCapabilitiesGetResponse'
9296
+
9297
+ # auth_names
9298
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9299
+
9300
+ new_options = opts.merge(
9301
+ :operation => :"PlaidApi.transfer_capabilities_get",
9302
+ :header_params => header_params,
9303
+ :query_params => query_params,
9304
+ :form_params => form_params,
9305
+ :body => post_body,
9306
+ :auth_names => auth_names,
9307
+ :return_type => return_type
9308
+ )
9309
+
9310
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9311
+ if @api_client.config.debugging
9312
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_capabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9313
+ end
9314
+ return data, status_code, headers
9315
+ end
9316
+
8927
9317
  # Create a transfer
8928
9318
  # Use the `/transfer/create` endpoint to initiate a new transfer.
8929
9319
  # @param transfer_create_request [TransferCreateRequest]
@@ -9055,7 +9445,7 @@ module Plaid
9055
9445
  end
9056
9446
 
9057
9447
  # Sync transfer events
9058
- # `/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.
9448
+ # `/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/).
9059
9449
  # @param transfer_event_sync_request [TransferEventSyncRequest]
9060
9450
  # @param [Hash] opts the optional parameters
9061
9451
  # @return [TransferEventSyncResponse]
@@ -9065,7 +9455,7 @@ module Plaid
9065
9455
  end
9066
9456
 
9067
9457
  # Sync transfer events
9068
- # &#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.
9458
+ # &#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/).
9069
9459
  # @param transfer_event_sync_request [TransferEventSyncRequest]
9070
9460
  # @param [Hash] opts the optional parameters
9071
9461
  # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers