plaid 17.0.0 → 17.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1022) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +96 -0
  3. data/Gemfile.lock +3 -3
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +1344 -304
  6. data/lib/plaid/api_client.rb +2 -2
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +1 -1
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +1 -1
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +1 -1
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  20. data/lib/plaid/models/account_product_access.rb +1 -1
  21. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  22. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  23. data/lib/plaid/models/account_subtype.rb +1 -1
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/address.rb +1 -1
  32. data/lib/plaid/models/address_data.rb +1 -1
  33. data/lib/plaid/models/address_data_nullable.rb +1 -1
  34. data/lib/plaid/models/address_match_score.rb +1 -1
  35. data/lib/plaid/models/address_nullable.rb +1 -1
  36. data/lib/plaid/models/address_purpose_label.rb +1 -1
  37. data/lib/plaid/models/application.rb +1 -1
  38. data/lib/plaid/models/application_get_request.rb +1 -1
  39. data/lib/plaid/models/application_get_response.rb +1 -1
  40. data/lib/plaid/models/apr.rb +1 -1
  41. data/lib/plaid/models/asset.rb +1 -1
  42. data/lib/plaid/models/asset_detail.rb +1 -1
  43. data/lib/plaid/models/asset_holder.rb +1 -1
  44. data/lib/plaid/models/asset_holder_name.rb +1 -1
  45. data/lib/plaid/models/asset_owner.rb +1 -1
  46. data/lib/plaid/models/asset_owners.rb +1 -1
  47. data/lib/plaid/models/asset_report.rb +1 -1
  48. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  49. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  50. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  51. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  53. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  55. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  56. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  57. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_freddie.rb +1 -1
  59. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  60. data/lib/plaid/models/asset_report_freddie_get_response.rb +1 -1
  61. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  62. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  63. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  64. data/lib/plaid/models/asset_report_item.rb +1 -1
  65. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  66. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  67. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  69. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  70. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  71. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  73. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  74. data/lib/plaid/models/asset_report_user.rb +1 -1
  75. data/lib/plaid/models/asset_transaction.rb +1 -1
  76. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  77. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  78. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  79. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  80. data/lib/plaid/models/asset_transactions.rb +1 -1
  81. data/lib/plaid/models/asset_type.rb +1 -1
  82. data/lib/plaid/models/assets.rb +1 -1
  83. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  84. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  85. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  86. data/lib/plaid/models/auth_get_request.rb +1 -1
  87. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  88. data/lib/plaid/models/auth_get_response.rb +1 -1
  89. data/lib/plaid/models/auth_metadata.rb +1 -1
  90. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  91. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  92. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  93. data/lib/plaid/models/bank_transfer.rb +1 -1
  94. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  95. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  126. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  127. data/lib/plaid/models/categories_get_response.rb +1 -1
  128. data/lib/plaid/models/category.rb +1 -1
  129. data/lib/plaid/models/cause.rb +1 -1
  130. data/lib/plaid/models/cause_all_of.rb +1 -1
  131. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  132. data/lib/plaid/models/client_provided_enriched_transaction.rb +293 -0
  133. data/lib/plaid/models/client_provided_raw_transaction.rb +4 -4
  134. data/lib/plaid/models/client_provided_transaction.rb +279 -0
  135. data/lib/plaid/models/connected_application.rb +1 -1
  136. data/lib/plaid/models/counterparty.rb +1 -1
  137. data/lib/plaid/models/counterparty_type.rb +1 -1
  138. data/lib/plaid/models/country_code.rb +1 -1
  139. data/lib/plaid/models/credit1099.rb +1 -1
  140. data/lib/plaid/models/credit1099_filer.rb +1 -1
  141. data/lib/plaid/models/credit1099_payer.rb +1 -1
  142. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  143. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  144. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  145. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  146. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  147. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  148. data/lib/plaid/models/credit_bank_income.rb +1 -1
  149. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  150. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  151. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  152. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  153. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  154. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  155. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  156. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  157. data/lib/plaid/models/credit_bank_income_historical_summary.rb +1 -1
  158. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  159. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  160. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  161. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  162. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  163. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  164. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  165. data/lib/plaid/models/credit_bank_income_summary.rb +1 -1
  166. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  167. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  168. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  169. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  170. data/lib/plaid/models/credit_card_liability.rb +1 -1
  171. data/lib/plaid/models/credit_category.rb +1 -1
  172. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  173. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  174. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  175. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  176. data/lib/plaid/models/credit_employment_item.rb +1 -1
  177. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  178. data/lib/plaid/models/credit_filter.rb +1 -1
  179. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  180. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  181. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  182. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  183. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  184. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  185. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  186. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  187. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  188. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  189. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  190. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  191. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  192. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  193. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  194. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  195. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  196. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  197. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  198. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  199. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  200. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  201. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  202. data/lib/plaid/models/credit_session.rb +1 -1
  203. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  204. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  205. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  206. data/lib/plaid/models/credit_session_error.rb +1 -1
  207. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  208. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  209. data/lib/plaid/models/credit_session_results.rb +1 -1
  210. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  211. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  212. data/lib/plaid/models/credit_w2.rb +1 -1
  213. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  214. data/lib/plaid/models/dashboard_user.rb +1 -1
  215. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  216. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  217. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  218. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  219. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  220. data/lib/plaid/models/date_range.rb +1 -1
  221. data/lib/plaid/models/deductions.rb +1 -1
  222. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  223. data/lib/plaid/models/deductions_total.rb +1 -1
  224. data/lib/plaid/models/default_update_webhook.rb +1 -1
  225. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  226. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  227. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  228. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  229. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  230. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  231. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  232. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  233. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  234. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  235. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  236. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  237. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  238. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  239. data/lib/plaid/models/depository_filter.rb +1 -1
  240. data/lib/plaid/models/disbursement_limits.rb +255 -0
  241. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  242. data/lib/plaid/models/doc_type.rb +1 -1
  243. data/lib/plaid/models/document_analysis.rb +1 -1
  244. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  245. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  246. data/lib/plaid/models/document_metadata.rb +1 -1
  247. data/lib/plaid/models/document_name_match_code.rb +1 -1
  248. data/lib/plaid/models/document_risk_signal.rb +17 -6
  249. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  250. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  251. data/lib/plaid/models/document_risk_summary.rb +221 -0
  252. data/lib/plaid/models/document_status.rb +1 -1
  253. data/lib/plaid/models/documentary_verification.rb +1 -1
  254. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  255. data/lib/plaid/models/earnings.rb +1 -1
  256. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  257. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  258. data/lib/plaid/models/earnings_total.rb +1 -1
  259. data/lib/plaid/models/email.rb +1 -1
  260. data/lib/plaid/models/email_address_match_score.rb +9 -9
  261. data/lib/plaid/models/employee.rb +1 -1
  262. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  263. data/lib/plaid/models/employer.rb +1 -1
  264. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  265. data/lib/plaid/models/employer_verification.rb +1 -1
  266. data/lib/plaid/models/employers_search_request.rb +1 -1
  267. data/lib/plaid/models/employers_search_response.rb +1 -1
  268. data/lib/plaid/models/employment_details.rb +1 -1
  269. data/lib/plaid/models/employment_verification.rb +1 -1
  270. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  271. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  272. data/lib/plaid/models/employment_verification_status.rb +1 -1
  273. data/lib/plaid/models/enhancements.rb +1 -1
  274. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  275. data/lib/plaid/models/enrichments.rb +342 -0
  276. data/lib/plaid/models/entity_document.rb +1 -1
  277. data/lib/plaid/models/entity_document_type.rb +1 -1
  278. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  279. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  280. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  281. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  282. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  283. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  284. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  285. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  286. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  287. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  288. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  289. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  290. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  291. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  292. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  293. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  294. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  295. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  296. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  297. data/lib/plaid/models/expiration_date.rb +1 -1
  298. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  299. data/lib/plaid/models/external_payment_options.rb +1 -1
  300. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  301. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  302. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  303. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  304. data/lib/plaid/models/fdx_content_types.rb +1 -1
  305. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  306. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  307. data/lib/plaid/models/fdx_notification.rb +1 -1
  308. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  309. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  310. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  311. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  312. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  313. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  314. data/lib/plaid/models/fdx_party.rb +1 -1
  315. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  316. data/lib/plaid/models/fdx_party_type.rb +1 -1
  317. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  318. data/lib/plaid/models/form1099_type.rb +1 -1
  319. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  320. data/lib/plaid/models/health_incident.rb +1 -1
  321. data/lib/plaid/models/historical_balance.rb +1 -1
  322. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  323. data/lib/plaid/models/holding.rb +1 -1
  324. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  325. data/lib/plaid/models/holdings_override.rb +1 -1
  326. data/lib/plaid/models/id_number_type.rb +1 -1
  327. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  328. data/lib/plaid/models/identity_get_request.rb +1 -1
  329. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  330. data/lib/plaid/models/identity_get_response.rb +1 -1
  331. data/lib/plaid/models/identity_match_request.rb +1 -1
  332. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  333. data/lib/plaid/models/identity_match_response.rb +1 -1
  334. data/lib/plaid/models/identity_match_user.rb +1 -1
  335. data/lib/plaid/models/identity_update_types.rb +1 -1
  336. data/lib/plaid/models/identity_verification.rb +1 -1
  337. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  338. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  339. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  340. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  341. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  342. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  343. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  344. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  345. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  346. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  347. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  348. data/lib/plaid/models/identity_verification_status.rb +1 -1
  349. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  350. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  351. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  352. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  353. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  354. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  355. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  356. data/lib/plaid/models/image_quality.rb +1 -1
  357. data/lib/plaid/models/incident_update.rb +1 -1
  358. data/lib/plaid/models/income_breakdown.rb +1 -1
  359. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  360. data/lib/plaid/models/income_override.rb +1 -1
  361. data/lib/plaid/models/income_summary.rb +1 -1
  362. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  363. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  364. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  365. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  366. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  367. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  368. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  369. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  370. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  371. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  372. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  373. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  374. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  375. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  376. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  377. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  378. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  379. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  380. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  381. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  382. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  383. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  384. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  385. data/lib/plaid/models/individual_name.rb +1 -1
  386. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  387. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  388. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  389. data/lib/plaid/models/inflow_model.rb +1 -1
  390. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  391. data/lib/plaid/models/institution.rb +1 -1
  392. data/lib/plaid/models/institution_status.rb +9 -1
  393. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  394. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  395. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  396. data/lib/plaid/models/institutions_get_request.rb +1 -1
  397. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  398. data/lib/plaid/models/institutions_get_response.rb +1 -1
  399. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  400. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  401. data/lib/plaid/models/institutions_search_request.rb +1 -1
  402. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  403. data/lib/plaid/models/institutions_search_response.rb +1 -1
  404. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  405. data/lib/plaid/models/investment_filter.rb +1 -1
  406. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  407. data/lib/plaid/models/investment_transaction.rb +1 -1
  408. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  409. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  410. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  411. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  412. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  413. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  414. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  415. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  416. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  417. data/lib/plaid/models/issuing_country.rb +1 -1
  418. data/lib/plaid/models/item.rb +1 -1
  419. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  420. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  421. data/lib/plaid/models/item_application_list_request.rb +1 -1
  422. data/lib/plaid/models/item_application_list_response.rb +1 -1
  423. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  424. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  425. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  426. data/lib/plaid/models/item_error_webhook.rb +1 -1
  427. data/lib/plaid/models/item_get_request.rb +1 -1
  428. data/lib/plaid/models/item_get_response.rb +1 -1
  429. data/lib/plaid/models/item_import_request.rb +1 -1
  430. data/lib/plaid/models/item_import_request_options.rb +1 -1
  431. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  432. data/lib/plaid/models/item_import_response.rb +1 -1
  433. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  434. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  435. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  436. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  437. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  438. data/lib/plaid/models/item_remove_request.rb +1 -1
  439. data/lib/plaid/models/item_remove_response.rb +1 -1
  440. data/lib/plaid/models/item_status.rb +1 -1
  441. data/lib/plaid/models/item_status_investments.rb +1 -1
  442. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  443. data/lib/plaid/models/item_status_nullable.rb +1 -1
  444. data/lib/plaid/models/item_status_transactions.rb +1 -1
  445. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  446. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  447. data/lib/plaid/models/jwk_public_key.rb +1 -1
  448. data/lib/plaid/models/jwt_header.rb +1 -1
  449. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  450. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  451. data/lib/plaid/models/kyc_check_details.rb +1 -1
  452. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  453. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  454. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  455. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  456. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  457. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  458. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  459. data/lib/plaid/models/liabilities_object.rb +1 -1
  460. data/lib/plaid/models/liability_override.rb +1 -1
  461. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  462. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  463. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  464. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  465. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  466. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  467. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  468. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  469. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  470. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  471. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  472. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  473. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  474. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  475. data/lib/plaid/models/link_token_create_request.rb +2 -2
  476. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  477. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  478. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  479. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  480. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  481. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  482. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  483. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  484. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  485. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  486. data/lib/plaid/models/link_token_create_request_user.rb +1 -2
  487. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  488. data/lib/plaid/models/link_token_create_response.rb +1 -1
  489. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  490. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  491. data/lib/plaid/models/link_token_get_request.rb +1 -1
  492. data/lib/plaid/models/link_token_get_response.rb +1 -1
  493. data/lib/plaid/models/link_token_investments.rb +1 -1
  494. data/lib/plaid/models/loan.rb +1 -1
  495. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  496. data/lib/plaid/models/loan_filter.rb +1 -1
  497. data/lib/plaid/models/loan_identifier.rb +1 -1
  498. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  499. data/lib/plaid/models/loan_identifiers.rb +1 -1
  500. data/lib/plaid/models/loans.rb +1 -1
  501. data/lib/plaid/models/location.rb +1 -1
  502. data/lib/plaid/models/match_summary.rb +1 -1
  503. data/lib/plaid/models/match_summary_code.rb +1 -1
  504. data/lib/plaid/models/meta.rb +1 -1
  505. data/lib/plaid/models/mfa.rb +1 -1
  506. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  507. data/lib/plaid/models/mortgage_liability.rb +1 -1
  508. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  509. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  510. data/lib/plaid/models/name_match_score.rb +1 -1
  511. data/lib/plaid/models/net_pay.rb +1 -1
  512. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  513. data/lib/plaid/models/numbers.rb +1 -1
  514. data/lib/plaid/models/numbers_ach.rb +28 -6
  515. data/lib/plaid/models/numbers_ach_nullable.rb +28 -6
  516. data/lib/plaid/models/numbers_bacs.rb +1 -1
  517. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  518. data/lib/plaid/models/numbers_eft.rb +1 -1
  519. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  520. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  521. data/lib/plaid/models/numbers_international.rb +1 -1
  522. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  523. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  524. data/lib/plaid/models/originator.rb +239 -0
  525. data/lib/plaid/models/override_account_type.rb +1 -1
  526. data/lib/plaid/models/override_accounts.rb +1 -1
  527. data/lib/plaid/models/owner.rb +1 -1
  528. data/lib/plaid/models/owner_override.rb +1 -1
  529. data/lib/plaid/models/ownership_type.rb +1 -1
  530. data/lib/plaid/models/parties.rb +1 -1
  531. data/lib/plaid/models/partner_customer_create_request.rb +15 -6
  532. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  533. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  534. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  535. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  536. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  537. data/lib/plaid/models/partner_customer_remove_request.rb +244 -0
  538. data/lib/plaid/models/partner_customer_remove_response.rb +220 -0
  539. data/lib/plaid/models/partner_end_customer.rb +1 -1
  540. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  541. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +238 -0
  542. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  543. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  544. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  545. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  546. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  547. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  548. data/lib/plaid/models/party.rb +1 -1
  549. data/lib/plaid/models/party_individual.rb +1 -1
  550. data/lib/plaid/models/party_role_type.rb +1 -1
  551. data/lib/plaid/models/pay.rb +1 -1
  552. data/lib/plaid/models/pay_frequency.rb +1 -1
  553. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  554. data/lib/plaid/models/pay_period_details.rb +1 -1
  555. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  556. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  557. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  558. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  559. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  560. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  561. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  562. data/lib/plaid/models/payment_amount.rb +1 -1
  563. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  564. data/lib/plaid/models/payment_amount_nullable.rb +239 -0
  565. data/lib/plaid/models/payment_amount_refunded.rb +246 -0
  566. data/lib/plaid/models/payment_amount_to_refund.rb +246 -0
  567. data/lib/plaid/models/payment_channel.rb +1 -1
  568. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  569. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  570. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  571. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  572. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  573. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  574. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  575. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  576. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  577. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  578. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  579. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  580. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  581. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  582. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  583. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  584. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  585. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  586. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  587. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  588. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  589. data/lib/plaid/models/payment_initiation_payment.rb +26 -6
  590. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  591. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  592. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  593. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  594. data/lib/plaid/models/payment_initiation_payment_get_response.rb +22 -2
  595. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  596. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  597. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +14 -5
  598. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  599. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  600. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  601. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  602. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  603. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  604. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  605. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  606. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  607. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  608. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  609. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  610. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  611. data/lib/plaid/models/payment_limits.rb +255 -0
  612. data/lib/plaid/models/payment_meta.rb +1 -1
  613. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  614. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  615. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  616. data/lib/plaid/models/payment_profile_get_response.rb +13 -2
  617. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  618. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  619. data/lib/plaid/models/payment_profile_status.rb +1 -1
  620. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  621. data/lib/plaid/models/payment_scheme.rb +1 -1
  622. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  623. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  624. data/lib/plaid/models/payroll_income_object.rb +1 -1
  625. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  626. data/lib/plaid/models/payroll_item.rb +32 -2
  627. data/lib/plaid/models/payroll_item_status.rb +1 -1
  628. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  629. data/lib/plaid/models/paystub.rb +1 -1
  630. data/lib/plaid/models/paystub_address.rb +1 -1
  631. data/lib/plaid/models/paystub_deduction.rb +1 -1
  632. data/lib/plaid/models/paystub_details.rb +1 -1
  633. data/lib/plaid/models/paystub_employer.rb +1 -1
  634. data/lib/plaid/models/paystub_override.rb +1 -1
  635. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  636. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  637. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  638. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  639. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  640. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  641. data/lib/plaid/models/personal_finance_category.rb +1 -1
  642. data/lib/plaid/models/phone_number.rb +1 -1
  643. data/lib/plaid/models/phone_number_match_score.rb +9 -9
  644. data/lib/plaid/models/phone_type.rb +1 -1
  645. data/lib/plaid/models/physical_document_category.rb +1 -1
  646. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  647. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  648. data/lib/plaid/models/physical_document_images.rb +1 -1
  649. data/lib/plaid/models/plaid_error.rb +1 -1
  650. data/lib/plaid/models/plaid_error_type.rb +1 -1
  651. data/lib/plaid/models/platform_ids.rb +1 -1
  652. data/lib/plaid/models/po_box_status.rb +1 -1
  653. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  654. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  655. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  656. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  657. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  658. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  659. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  660. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  661. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  662. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  663. data/lib/plaid/models/processor_number.rb +1 -1
  664. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  665. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  666. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  667. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  668. data/lib/plaid/models/product_access.rb +1 -1
  669. data/lib/plaid/models/product_status.rb +1 -1
  670. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  671. data/lib/plaid/models/products.rb +1 -1
  672. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  673. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  674. data/lib/plaid/models/pslf_status.rb +1 -1
  675. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  676. data/lib/plaid/models/recipient_bacs.rb +1 -1
  677. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  678. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  679. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  680. data/lib/plaid/models/recurring_transfer.rb +431 -0
  681. data/lib/plaid/models/removed_transaction.rb +1 -1
  682. data/lib/plaid/models/report_type.rb +1 -1
  683. data/lib/plaid/models/reporting_information.rb +1 -1
  684. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  685. data/lib/plaid/models/role.rb +1 -1
  686. data/lib/plaid/models/role_detail.rb +1 -1
  687. data/lib/plaid/models/roles.rb +1 -1
  688. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  689. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  690. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  691. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  692. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  693. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  694. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  695. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  696. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  697. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  698. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  699. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  700. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  701. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  702. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  703. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  704. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  705. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  706. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  707. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  708. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  709. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  710. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  711. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  712. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  713. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  714. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  715. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  716. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  717. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  718. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  719. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  720. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +266 -0
  721. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +225 -0
  722. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +255 -0
  723. data/lib/plaid/models/{income_verification_refresh_response.rb → sandbox_transfer_test_clock_create_response.rb} +23 -23
  724. data/lib/plaid/models/{income_verification_refresh_request.rb → sandbox_transfer_test_clock_get_request.rb} +24 -25
  725. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +239 -0
  726. data/lib/plaid/models/scopes.rb +1 -1
  727. data/lib/plaid/models/scopes_context.rb +1 -1
  728. data/lib/plaid/models/scopes_nullable.rb +1 -1
  729. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  730. data/lib/plaid/models/screening_hit_data.rb +1 -1
  731. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  732. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  733. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  734. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  735. data/lib/plaid/models/security.rb +3 -3
  736. data/lib/plaid/models/security_override.rb +3 -3
  737. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  738. data/lib/plaid/models/service.rb +1 -1
  739. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  740. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  741. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  742. data/lib/plaid/models/servicer_address_data.rb +1 -1
  743. data/lib/plaid/models/services.rb +1 -1
  744. data/lib/plaid/models/signal_address_data.rb +1 -1
  745. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  746. data/lib/plaid/models/signal_decision_report_request.rb +39 -8
  747. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  748. data/lib/plaid/models/signal_device.rb +1 -1
  749. data/lib/plaid/models/signal_evaluate_core_attributes.rb +17 -6
  750. data/lib/plaid/models/signal_evaluate_request.rb +26 -4
  751. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  752. data/lib/plaid/models/signal_payment_method.rb +43 -0
  753. data/lib/plaid/models/signal_person_name.rb +1 -1
  754. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  755. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  756. data/lib/plaid/models/signal_return_report_request.rb +17 -6
  757. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  758. data/lib/plaid/models/signal_scores.rb +1 -1
  759. data/lib/plaid/models/signal_user.rb +1 -1
  760. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  761. data/lib/plaid/models/single_document_risk_signal.rb +19 -5
  762. data/lib/plaid/models/source.rb +1 -1
  763. data/lib/plaid/models/standalone_account_type.rb +1 -1
  764. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  765. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  766. data/lib/plaid/models/status.rb +1 -1
  767. data/lib/plaid/models/statuses.rb +1 -1
  768. data/lib/plaid/models/strategy.rb +1 -1
  769. data/lib/plaid/models/student_loan.rb +2 -2
  770. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  771. data/lib/plaid/models/student_loan_status.rb +1 -1
  772. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  773. data/lib/plaid/models/sync_updates_available_webhook.rb +2 -2
  774. data/lib/plaid/models/taxform.rb +1 -1
  775. data/lib/plaid/models/taxpayer_id.rb +1 -1
  776. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  777. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  778. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  779. data/lib/plaid/models/total.rb +1 -1
  780. data/lib/plaid/models/total_canonical_description.rb +1 -1
  781. data/lib/plaid/models/transaction.rb +2 -2
  782. data/lib/plaid/models/transaction_all_of.rb +2 -2
  783. data/lib/plaid/models/transaction_base.rb +1 -1
  784. data/lib/plaid/models/transaction_code.rb +1 -1
  785. data/lib/plaid/models/transaction_data.rb +1 -1
  786. data/lib/plaid/models/transaction_frequency.rb +41 -0
  787. data/lib/plaid/models/transaction_override.rb +1 -1
  788. data/lib/plaid/models/transaction_stream.rb +1 -1
  789. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  790. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  791. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  792. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  793. data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
  794. data/lib/plaid/models/transactions_enrich_get_request.rb +274 -0
  795. data/lib/plaid/models/transactions_enrich_get_response.rb +237 -0
  796. data/lib/plaid/models/transactions_get_request.rb +1 -1
  797. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  798. data/lib/plaid/models/transactions_get_response.rb +1 -1
  799. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  800. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  801. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  802. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  803. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  804. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  805. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  806. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  807. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  808. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  809. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  810. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  811. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  812. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  813. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  814. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  815. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  816. data/lib/plaid/models/transactions_sync_response.rb +3 -3
  817. data/lib/plaid/models/transfer.rb +34 -11
  818. data/lib/plaid/models/transfer_authorization.rb +1 -1
  819. data/lib/plaid/models/transfer_authorization_create_request.rb +17 -6
  820. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  821. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  822. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  823. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  824. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  825. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  826. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  827. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  828. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +16 -10
  829. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  830. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  831. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  832. data/lib/plaid/models/transfer_create_request.rb +1 -1
  833. data/lib/plaid/models/transfer_create_response.rb +1 -1
  834. data/lib/plaid/models/transfer_device.rb +240 -0
  835. data/lib/plaid/models/transfer_diligence_status.rb +40 -0
  836. data/lib/plaid/models/transfer_event.rb +28 -6
  837. data/lib/plaid/models/transfer_event_list_request.rb +17 -6
  838. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  839. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  840. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  841. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  842. data/lib/plaid/models/transfer_event_type.rb +1 -1
  843. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  844. data/lib/plaid/models/transfer_failure.rb +1 -1
  845. data/lib/plaid/models/transfer_get_request.rb +1 -1
  846. data/lib/plaid/models/transfer_get_response.rb +1 -1
  847. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  848. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  849. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  850. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  851. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  852. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  853. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  854. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  855. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  856. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  857. data/lib/plaid/models/transfer_list_request.rb +17 -6
  858. data/lib/plaid/models/transfer_list_response.rb +1 -1
  859. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  860. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  861. data/lib/plaid/models/transfer_network.rb +1 -1
  862. data/lib/plaid/models/transfer_originator_create_request.rb +245 -0
  863. data/lib/plaid/models/transfer_originator_create_response.rb +255 -0
  864. data/lib/plaid/models/transfer_originator_get_request.rb +245 -0
  865. data/lib/plaid/models/transfer_originator_get_response.rb +239 -0
  866. data/lib/plaid/models/transfer_originator_list_request.rb +297 -0
  867. data/lib/plaid/models/transfer_originator_list_response.rb +241 -0
  868. data/lib/plaid/models/transfer_questionnaire_create_request.rb +302 -0
  869. data/lib/plaid/models/transfer_questionnaire_create_response.rb +240 -0
  870. data/lib/plaid/models/transfer_recurring_cancel_request.rb +255 -0
  871. data/lib/plaid/models/transfer_recurring_cancel_response.rb +225 -0
  872. data/lib/plaid/models/transfer_recurring_create_request.rb +424 -0
  873. data/lib/plaid/models/transfer_recurring_create_response.rb +239 -0
  874. data/lib/plaid/models/transfer_recurring_get_request.rb +255 -0
  875. data/lib/plaid/models/transfer_recurring_get_response.rb +239 -0
  876. data/lib/plaid/models/transfer_recurring_list_request.rb +329 -0
  877. data/lib/plaid/models/transfer_recurring_list_response.rb +241 -0
  878. data/lib/plaid/models/transfer_recurring_schedule.rb +260 -0
  879. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  880. data/lib/plaid/models/transfer_refund.rb +284 -0
  881. data/lib/plaid/models/transfer_refund_cancel_request.rb +245 -0
  882. data/lib/plaid/models/transfer_refund_cancel_response.rb +225 -0
  883. data/lib/plaid/models/transfer_refund_create_request.rb +296 -0
  884. data/lib/plaid/models/transfer_refund_create_response.rb +239 -0
  885. data/lib/plaid/models/transfer_refund_get_request.rb +245 -0
  886. data/lib/plaid/models/transfer_refund_get_response.rb +239 -0
  887. data/lib/plaid/models/transfer_refund_status.rb +41 -0
  888. data/lib/plaid/models/transfer_repayment.rb +1 -1
  889. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  890. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  891. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  892. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  893. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  894. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  895. data/lib/plaid/models/transfer_status.rb +1 -1
  896. data/lib/plaid/models/transfer_sweep.rb +1 -1
  897. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  898. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  899. data/lib/plaid/models/transfer_sweep_list_request.rb +16 -5
  900. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  901. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  902. data/lib/plaid/models/transfer_test_clock.rb +236 -0
  903. data/lib/plaid/models/transfer_type.rb +1 -1
  904. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  905. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  906. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  907. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  908. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  909. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  910. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  911. data/lib/plaid/models/user_address.rb +1 -1
  912. data/lib/plaid/models/user_create_request.rb +1 -1
  913. data/lib/plaid/models/user_create_response.rb +1 -1
  914. data/lib/plaid/models/user_custom_password.rb +1 -1
  915. data/lib/plaid/models/user_id_number.rb +1 -1
  916. data/lib/plaid/models/user_name.rb +1 -1
  917. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  918. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  919. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  920. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  921. data/lib/plaid/models/validation_source.rb +1 -1
  922. data/lib/plaid/models/validation_sources.rb +1 -1
  923. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  924. data/lib/plaid/models/verification_of_asset.rb +1 -1
  925. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  926. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  927. data/lib/plaid/models/verification_status.rb +1 -1
  928. data/lib/plaid/models/w2.rb +1 -1
  929. data/lib/plaid/models/w2_box12.rb +1 -1
  930. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  931. data/lib/plaid/models/wallet.rb +1 -1
  932. data/lib/plaid/models/wallet_balance.rb +1 -1
  933. data/lib/plaid/models/wallet_create_request.rb +1 -1
  934. data/lib/plaid/models/wallet_create_response.rb +1 -1
  935. data/lib/plaid/models/wallet_get_request.rb +1 -1
  936. data/lib/plaid/models/wallet_get_response.rb +1 -1
  937. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  938. data/lib/plaid/models/wallet_list_request.rb +1 -1
  939. data/lib/plaid/models/wallet_list_response.rb +1 -1
  940. data/lib/plaid/models/wallet_numbers.rb +1 -1
  941. data/lib/plaid/models/wallet_transaction.rb +32 -6
  942. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  943. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  944. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  945. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  946. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  947. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  948. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  949. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  950. data/lib/plaid/models/wallet_transaction_get_response.rb +29 -3
  951. data/lib/plaid/models/wallet_transaction_list_request.rb +341 -0
  952. data/lib/plaid/models/wallet_transaction_list_request_options.rb +230 -0
  953. data/lib/plaid/models/{wallet_transactions_list_response.rb → wallet_transaction_list_response.rb} +5 -5
  954. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  955. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  956. data/lib/plaid/models/wallet_transactions_list_request.rb +17 -7
  957. data/lib/plaid/models/warning.rb +1 -1
  958. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  959. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  960. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  961. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  962. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  963. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  964. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  965. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  966. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  967. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  968. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  969. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  970. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  971. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  972. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  973. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  974. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  975. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  976. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  977. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  978. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  979. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  980. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  981. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  982. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  983. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  984. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  985. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  986. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  987. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  988. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  989. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  990. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  991. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  992. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  993. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  994. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  995. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  996. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  997. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  998. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  999. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1000. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1001. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1002. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1003. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1004. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1005. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1006. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1007. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1008. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1009. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1010. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1011. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1012. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1013. data/lib/plaid/models/webhook_type.rb +1 -1
  1014. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1015. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1016. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1017. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1018. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1019. data/lib/plaid/version.rb +2 -2
  1020. data/lib/plaid.rb +60 -4
  1021. data/plaid.gemspec +1 -1
  1022. metadata +61 -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.197.3
6
+ The version of the OpenAPI document: 2020-09-14_1.205.3
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -3854,71 +3854,6 @@ module Plaid
3854
3854
  return data, status_code, headers
3855
3855
  end
3856
3856
 
3857
- # (Deprecated) Refresh an income verification
3858
- # `/income/verification/refresh` refreshes a given income verification.
3859
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
3860
- # @param [Hash] opts the optional parameters
3861
- # @return [IncomeVerificationRefreshResponse]
3862
- def income_verification_refresh(income_verification_refresh_request, opts = {})
3863
- data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
3864
- data
3865
- end
3866
-
3867
- # (Deprecated) Refresh an income verification
3868
- # `/income/verification/refresh` refreshes a given income verification.
3869
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
3870
- # @param [Hash] opts the optional parameters
3871
- # @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
3872
- def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
3873
- if @api_client.config.debugging
3874
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
3875
- end
3876
- # verify the required parameter 'income_verification_refresh_request' is set
3877
- if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
3878
- fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
3879
- end
3880
- # resource path
3881
- local_var_path = '/income/verification/refresh'
3882
-
3883
- # query parameters
3884
- query_params = opts[:query_params] || {}
3885
-
3886
- # header parameters
3887
- header_params = opts[:header_params] || {}
3888
- # HTTP header 'Accept' (if needed)
3889
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3890
- # HTTP header 'Content-Type'
3891
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3892
-
3893
- # form parameters
3894
- form_params = opts[:form_params] || {}
3895
-
3896
- # http body (model)
3897
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
3898
-
3899
- # return_type
3900
- return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
3901
-
3902
- # auth_names
3903
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3904
-
3905
- new_options = opts.merge(
3906
- :operation => :"PlaidApi.income_verification_refresh",
3907
- :header_params => header_params,
3908
- :query_params => query_params,
3909
- :form_params => form_params,
3910
- :body => post_body,
3911
- :auth_names => auth_names,
3912
- :return_type => return_type
3913
- )
3914
-
3915
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3916
- if @api_client.config.debugging
3917
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3918
- end
3919
- return data, status_code, headers
3920
- end
3921
-
3922
3857
  # (Deprecated) Retrieve information from the tax documents used for income verification
3923
3858
  # `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
3924
3859
  # @param request_body [Hash<String, Object>]
@@ -5479,6 +5414,71 @@ module Plaid
5479
5414
  return data, status_code, headers
5480
5415
  end
5481
5416
 
5417
+ # Removes a Plaid reseller's end customer.
5418
+ # 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
+ # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
5420
+ # @param [Hash] opts the optional parameters
5421
+ # @return [PartnerCustomerRemoveResponse]
5422
+ def partner_customer_remove(partner_customer_remove_request, opts = {})
5423
+ data, _status_code, _headers = partner_customer_remove_with_http_info(partner_customer_remove_request, opts)
5424
+ data
5425
+ end
5426
+
5427
+ # Removes a Plaid reseller&#39;s end customer.
5428
+ # The &#x60;/partner/customer/remove&#x60; 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.
5429
+ # @param partner_customer_remove_request [PartnerCustomerRemoveRequest]
5430
+ # @param [Hash] opts the optional parameters
5431
+ # @return [Array<(PartnerCustomerRemoveResponse, Integer, Hash)>] PartnerCustomerRemoveResponse data, response status code and response headers
5432
+ def partner_customer_remove_with_http_info(partner_customer_remove_request, opts = {})
5433
+ if @api_client.config.debugging
5434
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_remove ...'
5435
+ end
5436
+ # verify the required parameter 'partner_customer_remove_request' is set
5437
+ if @api_client.config.client_side_validation && partner_customer_remove_request.nil?
5438
+ fail ArgumentError, "Missing the required parameter 'partner_customer_remove_request' when calling PlaidApi.partner_customer_remove"
5439
+ end
5440
+ # resource path
5441
+ local_var_path = '/partner/customer/remove'
5442
+
5443
+ # query parameters
5444
+ query_params = opts[:query_params] || {}
5445
+
5446
+ # header parameters
5447
+ header_params = opts[:header_params] || {}
5448
+ # HTTP header 'Accept' (if needed)
5449
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5450
+ # HTTP header 'Content-Type'
5451
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5452
+
5453
+ # form parameters
5454
+ form_params = opts[:form_params] || {}
5455
+
5456
+ # http body (model)
5457
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_remove_request)
5458
+
5459
+ # return_type
5460
+ return_type = opts[:debug_return_type] || 'PartnerCustomerRemoveResponse'
5461
+
5462
+ # auth_names
5463
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5464
+
5465
+ new_options = opts.merge(
5466
+ :operation => :"PlaidApi.partner_customer_remove",
5467
+ :header_params => header_params,
5468
+ :query_params => query_params,
5469
+ :form_params => form_params,
5470
+ :body => post_body,
5471
+ :auth_names => auth_names,
5472
+ :return_type => return_type
5473
+ )
5474
+
5475
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5476
+ if @api_client.config.debugging
5477
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5478
+ end
5479
+ return data, status_code, headers
5480
+ end
5481
+
5482
5482
  # Create payment consent
5483
5483
  # The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
5484
5484
  # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
@@ -7040,7 +7040,7 @@ module Plaid
7040
7040
  end
7041
7041
 
7042
7042
  # Fire a test webhook
7043
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7043
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. `RECURRING_TRANSACTIONS_UPDATE`: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `SYNC_UPDATES_AVAILABLE`: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7044
7044
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
7045
7045
  # @param [Hash] opts the optional parameters
7046
7046
  # @return [SandboxItemFireWebhookResponse]
@@ -7050,7 +7050,7 @@ module Plaid
7050
7050
  end
7051
7051
 
7052
7052
  # Fire a test webhook
7053
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7053
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. &#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;: Recurring Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Recurring Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;SYNC_UPDATES_AVAILABLE&#x60;: Transactions webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. Note that this endpoint is provided for developer ease-of-use and is not required for testing webhooks; webhooks will also fire in Sandbox under the same conditions that they would in Production or Development.
7054
7054
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
7055
7055
  # @param [Hash] opts the optional parameters
7056
7056
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -7300,7 +7300,7 @@ module Plaid
7300
7300
  end
7301
7301
 
7302
7302
  # Reset the login of a Payment Profile
7303
- # `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a decision_rationale `PAYMENT_PROFILE_LOGIN_REQUIRED``. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
7303
+ # `/sandbox/payment_profile/reset_login/` forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling `/sandbox/payment_profile/reset_login`, calls to the `/transfer/authorization/create` with the Payment Profile will result in a `decision_rationale` `PAYMENT_PROFILE_LOGIN_REQUIRED`. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
7304
7304
  # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
7305
7305
  # @param [Hash] opts the optional parameters
7306
7306
  # @return [SandboxPaymentProfileResetLoginResponse]
@@ -7310,7 +7310,7 @@ module Plaid
7310
7310
  end
7311
7311
 
7312
7312
  # Reset the login of a Payment Profile
7313
- # &#x60;/sandbox/payment_profile/reset_login/&#x60; forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling &#x60;/sandbox/payment_profile/reset_login&#x60;, calls to the &#x60;/transfer/authorization/create&#x60; with the Payment Profile will result in a decision_rationale &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;&#x60;. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
7313
+ # &#x60;/sandbox/payment_profile/reset_login/&#x60; forces a Payment Profile into a state where the login is no longer valid. This makes it easy to test update mode for Payment Profile in the Sandbox environment. After calling &#x60;/sandbox/payment_profile/reset_login&#x60;, calls to the &#x60;/transfer/authorization/create&#x60; with the Payment Profile will result in a &#x60;decision_rationale&#x60; &#x60;PAYMENT_PROFILE_LOGIN_REQUIRED&#x60;. You can then use update mode for Payment Profile to restore it into a good state. In order to invoke this endpoint, you must first [create a Payment Profile](https://plaid.com/docs/transfer/add-to-app/#create-a-payment-profile-optional) and [go through the Link flow](https://plaid.com/docs/transfer/add-to-app/#create-a-link-token).
7314
7314
  # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
7315
7315
  # @param [Hash] opts the optional parameters
7316
7316
  # @return [Array<(SandboxPaymentProfileResetLoginResponse, Integer, Hash)>] SandboxPaymentProfileResetLoginResponse data, response status code and response headers
@@ -7754,8 +7754,203 @@ module Plaid
7754
7754
  return data, status_code, headers
7755
7755
  end
7756
7756
 
7757
+ # 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.
7759
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7760
+ # @param [Hash] opts the optional parameters
7761
+ # @return [SandboxTransferTestClockAdvanceResponse]
7762
+ def sandbox_transfer_test_clock_advance(sandbox_transfer_test_clock_advance_request, opts = {})
7763
+ data, _status_code, _headers = sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts)
7764
+ data
7765
+ end
7766
+
7767
+ # 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.
7769
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7770
+ # @param [Hash] opts the optional parameters
7771
+ # @return [Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>] SandboxTransferTestClockAdvanceResponse data, response status code and response headers
7772
+ def sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts = {})
7773
+ if @api_client.config.debugging
7774
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_advance ...'
7775
+ end
7776
+ # verify the required parameter 'sandbox_transfer_test_clock_advance_request' is set
7777
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_advance_request.nil?
7778
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_advance_request' when calling PlaidApi.sandbox_transfer_test_clock_advance"
7779
+ end
7780
+ # resource path
7781
+ local_var_path = '/sandbox/transfer/test_clock/advance'
7782
+
7783
+ # query parameters
7784
+ query_params = opts[:query_params] || {}
7785
+
7786
+ # header parameters
7787
+ header_params = opts[:header_params] || {}
7788
+ # HTTP header 'Accept' (if needed)
7789
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7790
+ # HTTP header 'Content-Type'
7791
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7792
+
7793
+ # form parameters
7794
+ form_params = opts[:form_params] || {}
7795
+
7796
+ # http body (model)
7797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_advance_request)
7798
+
7799
+ # return_type
7800
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockAdvanceResponse'
7801
+
7802
+ # auth_names
7803
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7804
+
7805
+ new_options = opts.merge(
7806
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_advance",
7807
+ :header_params => header_params,
7808
+ :query_params => query_params,
7809
+ :form_params => form_params,
7810
+ :body => post_body,
7811
+ :auth_names => auth_names,
7812
+ :return_type => return_type
7813
+ )
7814
+
7815
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7816
+ if @api_client.config.debugging
7817
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_advance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7818
+ end
7819
+ return data, status_code, headers
7820
+ end
7821
+
7822
+ # 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.
7824
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7825
+ # @param [Hash] opts the optional parameters
7826
+ # @return [SandboxTransferTestClockCreateResponse]
7827
+ def sandbox_transfer_test_clock_create(sandbox_transfer_test_clock_create_request, opts = {})
7828
+ data, _status_code, _headers = sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts)
7829
+ data
7830
+ end
7831
+
7832
+ # 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.
7834
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7835
+ # @param [Hash] opts the optional parameters
7836
+ # @return [Array<(SandboxTransferTestClockCreateResponse, Integer, Hash)>] SandboxTransferTestClockCreateResponse data, response status code and response headers
7837
+ def sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts = {})
7838
+ if @api_client.config.debugging
7839
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_create ...'
7840
+ end
7841
+ # verify the required parameter 'sandbox_transfer_test_clock_create_request' is set
7842
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_create_request.nil?
7843
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_create_request' when calling PlaidApi.sandbox_transfer_test_clock_create"
7844
+ end
7845
+ # resource path
7846
+ local_var_path = '/sandbox/transfer/test_clock/create'
7847
+
7848
+ # query parameters
7849
+ query_params = opts[:query_params] || {}
7850
+
7851
+ # header parameters
7852
+ header_params = opts[:header_params] || {}
7853
+ # HTTP header 'Accept' (if needed)
7854
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7855
+ # HTTP header 'Content-Type'
7856
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7857
+
7858
+ # form parameters
7859
+ form_params = opts[:form_params] || {}
7860
+
7861
+ # http body (model)
7862
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_create_request)
7863
+
7864
+ # return_type
7865
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockCreateResponse'
7866
+
7867
+ # auth_names
7868
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7869
+
7870
+ new_options = opts.merge(
7871
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_create",
7872
+ :header_params => header_params,
7873
+ :query_params => query_params,
7874
+ :form_params => form_params,
7875
+ :body => post_body,
7876
+ :auth_names => auth_names,
7877
+ :return_type => return_type
7878
+ )
7879
+
7880
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7881
+ if @api_client.config.debugging
7882
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7883
+ end
7884
+ return data, status_code, headers
7885
+ end
7886
+
7887
+ # Get a test clock
7888
+ # Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.
7889
+ # @param sandbox_transfer_test_clock_get_request [SandboxTransferTestClockGetRequest]
7890
+ # @param [Hash] opts the optional parameters
7891
+ # @return [SandboxTransferTestClockGetResponse]
7892
+ def sandbox_transfer_test_clock_get(sandbox_transfer_test_clock_get_request, opts = {})
7893
+ data, _status_code, _headers = sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts)
7894
+ data
7895
+ end
7896
+
7897
+ # Get a test clock
7898
+ # Use the &#x60;/sandbox/transfer/test_clock/get&#x60; endpoint to get a &#x60;test_clock&#x60; in the Sandbox environment.
7899
+ # @param sandbox_transfer_test_clock_get_request [SandboxTransferTestClockGetRequest]
7900
+ # @param [Hash] opts the optional parameters
7901
+ # @return [Array<(SandboxTransferTestClockGetResponse, Integer, Hash)>] SandboxTransferTestClockGetResponse data, response status code and response headers
7902
+ def sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts = {})
7903
+ if @api_client.config.debugging
7904
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_get ...'
7905
+ end
7906
+ # verify the required parameter 'sandbox_transfer_test_clock_get_request' is set
7907
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_get_request.nil?
7908
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_get_request' when calling PlaidApi.sandbox_transfer_test_clock_get"
7909
+ end
7910
+ # resource path
7911
+ local_var_path = '/sandbox/transfer/test_clock/get'
7912
+
7913
+ # query parameters
7914
+ query_params = opts[:query_params] || {}
7915
+
7916
+ # header parameters
7917
+ header_params = opts[:header_params] || {}
7918
+ # HTTP header 'Accept' (if needed)
7919
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7920
+ # HTTP header 'Content-Type'
7921
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7922
+
7923
+ # form parameters
7924
+ form_params = opts[:form_params] || {}
7925
+
7926
+ # http body (model)
7927
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_get_request)
7928
+
7929
+ # return_type
7930
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockGetResponse'
7931
+
7932
+ # auth_names
7933
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7934
+
7935
+ new_options = opts.merge(
7936
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_get",
7937
+ :header_params => header_params,
7938
+ :query_params => query_params,
7939
+ :form_params => form_params,
7940
+ :body => post_body,
7941
+ :auth_names => auth_names,
7942
+ :return_type => return_type
7943
+ )
7944
+
7945
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7946
+ if @api_client.config.debugging
7947
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7948
+ end
7949
+ return data, status_code, headers
7950
+ end
7951
+
7757
7952
  # Report whether you initiated an ACH transaction
7758
- # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
7953
+ # 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`.
7759
7954
  # @param signal_decision_report_request [SignalDecisionReportRequest]
7760
7955
  # @param [Hash] opts the optional parameters
7761
7956
  # @return [SignalDecisionReportResponse]
@@ -7765,7 +7960,7 @@ module Plaid
7765
7960
  end
7766
7961
 
7767
7962
  # Report whether you initiated an ACH transaction
7768
- # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an &#x60;INVALID_REQUEST&#x60; error if called a second time with a different value for &#x60;initiated&#x60;.
7963
+ # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
7769
7964
  # @param signal_decision_report_request [SignalDecisionReportRequest]
7770
7965
  # @param [Hash] opts the optional parameters
7771
7966
  # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
@@ -7820,7 +8015,7 @@ module Plaid
7820
8015
  end
7821
8016
 
7822
8017
  # Evaluate a planned ACH transaction
7823
- # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
8018
+ # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7824
8019
  # @param signal_evaluate_request [SignalEvaluateRequest]
7825
8020
  # @param [Hash] opts the optional parameters
7826
8021
  # @return [SignalEvaluateResponse]
@@ -7830,7 +8025,7 @@ module Plaid
7830
8025
  end
7831
8026
 
7832
8027
  # Evaluate a planned ACH transaction
7833
- # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
8028
+ # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7834
8029
  # @param signal_evaluate_request [SignalEvaluateRequest]
7835
8030
  # @param [Hash] opts the optional parameters
7836
8031
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
@@ -7884,8 +8079,8 @@ module Plaid
7884
8079
  return data, status_code, headers
7885
8080
  end
7886
8081
 
7887
- # Prepare the Signal product before calling `/signal/evaluate`
7888
- # Call `/signal/prepare` with Plaid-linked bank account information at least 10 seconds before calling `/signal/evaluate` or as soon as an end-user enters the ACH deposit flow in your application.
8082
+ # Opt-in an Item to Signal
8083
+ # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account & routing number, call `/identity/get` to retrieve bank ownership details, call `/signal/prepare` to begin Signal data collection, then call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
7889
8084
  # @param signal_prepare_request [SignalPrepareRequest]
7890
8085
  # @param [Hash] opts the optional parameters
7891
8086
  # @return [SignalPrepareResponse]
@@ -7894,8 +8089,8 @@ module Plaid
7894
8089
  data
7895
8090
  end
7896
8091
 
7897
- # Prepare the Signal product before calling &#x60;/signal/evaluate&#x60;
7898
- # Call &#x60;/signal/prepare&#x60; with Plaid-linked bank account information at least 10 seconds before calling &#x60;/signal/evaluate&#x60; or as soon as an end-user enters the ACH deposit flow in your application.
8092
+ # Opt-in an Item to Signal
8093
+ # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account &amp; routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, call &#x60;/signal/prepare&#x60; to begin Signal data collection, then call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
7899
8094
  # @param signal_prepare_request [SignalPrepareRequest]
7900
8095
  # @param [Hash] opts the optional parameters
7901
8096
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -8079,31 +8274,31 @@ module Plaid
8079
8274
  return data, status_code, headers
8080
8275
  end
8081
8276
 
8082
- # Get transaction data
8083
- # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
8084
- # @param transactions_get_request [TransactionsGetRequest]
8277
+ # 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
8279
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8085
8280
  # @param [Hash] opts the optional parameters
8086
- # @return [TransactionsGetResponse]
8087
- def transactions_get(transactions_get_request, opts = {})
8088
- data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
8281
+ # @return [TransactionsEnrichGetResponse]
8282
+ def transactions_enrich(transactions_enrich_get_request, opts = {})
8283
+ data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_get_request, opts)
8089
8284
  data
8090
8285
  end
8091
8286
 
8092
- # Get transaction data
8093
- # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
8094
- # @param transactions_get_request [TransactionsGetRequest]
8287
+ # 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
8289
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8095
8290
  # @param [Hash] opts the optional parameters
8096
- # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
8097
- def transactions_get_with_http_info(transactions_get_request, opts = {})
8291
+ # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
8292
+ def transactions_enrich_with_http_info(transactions_enrich_get_request, opts = {})
8098
8293
  if @api_client.config.debugging
8099
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
8294
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
8100
8295
  end
8101
- # verify the required parameter 'transactions_get_request' is set
8102
- if @api_client.config.client_side_validation && transactions_get_request.nil?
8103
- fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
8296
+ # verify the required parameter 'transactions_enrich_get_request' is set
8297
+ if @api_client.config.client_side_validation && transactions_enrich_get_request.nil?
8298
+ fail ArgumentError, "Missing the required parameter 'transactions_enrich_get_request' when calling PlaidApi.transactions_enrich"
8104
8299
  end
8105
8300
  # resource path
8106
- local_var_path = '/transactions/get'
8301
+ local_var_path = '/transactions/enrich'
8107
8302
 
8108
8303
  # query parameters
8109
8304
  query_params = opts[:query_params] || {}
@@ -8119,16 +8314,16 @@ module Plaid
8119
8314
  form_params = opts[:form_params] || {}
8120
8315
 
8121
8316
  # http body (model)
8122
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
8317
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enrich_get_request)
8123
8318
 
8124
8319
  # return_type
8125
- return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
8320
+ return_type = opts[:debug_return_type] || 'TransactionsEnrichGetResponse'
8126
8321
 
8127
8322
  # auth_names
8128
8323
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8129
8324
 
8130
8325
  new_options = opts.merge(
8131
- :operation => :"PlaidApi.transactions_get",
8326
+ :operation => :"PlaidApi.transactions_enrich",
8132
8327
  :header_params => header_params,
8133
8328
  :query_params => query_params,
8134
8329
  :form_params => form_params,
@@ -8139,23 +8334,88 @@ module Plaid
8139
8334
 
8140
8335
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8141
8336
  if @api_client.config.debugging
8142
- @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8337
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_enrich\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8143
8338
  end
8144
8339
  return data, status_code, headers
8145
8340
  end
8146
8341
 
8147
- # Fetch recurring transaction streams
8148
- # 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 and learn more about pricing, 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.
8149
- # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8342
+ # Get transaction data
8343
+ # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
8344
+ # @param transactions_get_request [TransactionsGetRequest]
8150
8345
  # @param [Hash] opts the optional parameters
8151
- # @return [TransactionsRecurringGetResponse]
8152
- def transactions_recurring_get(transactions_recurring_get_request, opts = {})
8153
- data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
8346
+ # @return [TransactionsGetResponse]
8347
+ def transactions_get(transactions_get_request, opts = {})
8348
+ data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
8349
+ data
8350
+ end
8351
+
8352
+ # Get transaction data
8353
+ # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
8354
+ # @param transactions_get_request [TransactionsGetRequest]
8355
+ # @param [Hash] opts the optional parameters
8356
+ # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
8357
+ def transactions_get_with_http_info(transactions_get_request, opts = {})
8358
+ if @api_client.config.debugging
8359
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
8360
+ end
8361
+ # verify the required parameter 'transactions_get_request' is set
8362
+ if @api_client.config.client_side_validation && transactions_get_request.nil?
8363
+ fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
8364
+ end
8365
+ # resource path
8366
+ local_var_path = '/transactions/get'
8367
+
8368
+ # query parameters
8369
+ query_params = opts[:query_params] || {}
8370
+
8371
+ # header parameters
8372
+ header_params = opts[:header_params] || {}
8373
+ # HTTP header 'Accept' (if needed)
8374
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8375
+ # HTTP header 'Content-Type'
8376
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8377
+
8378
+ # form parameters
8379
+ form_params = opts[:form_params] || {}
8380
+
8381
+ # http body (model)
8382
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
8383
+
8384
+ # return_type
8385
+ return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
8386
+
8387
+ # auth_names
8388
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8389
+
8390
+ new_options = opts.merge(
8391
+ :operation => :"PlaidApi.transactions_get",
8392
+ :header_params => header_params,
8393
+ :query_params => query_params,
8394
+ :form_params => form_params,
8395
+ :body => post_body,
8396
+ :auth_names => auth_names,
8397
+ :return_type => return_type
8398
+ )
8399
+
8400
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8401
+ if @api_client.config.debugging
8402
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8403
+ end
8404
+ return data, status_code, headers
8405
+ end
8406
+
8407
+ # 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.
8409
+ # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8410
+ # @param [Hash] opts the optional parameters
8411
+ # @return [TransactionsRecurringGetResponse]
8412
+ def transactions_recurring_get(transactions_recurring_get_request, opts = {})
8413
+ data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
8154
8414
  data
8155
8415
  end
8156
8416
 
8157
8417
  # Fetch recurring transaction streams
8158
- # 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 and learn more about pricing, 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.
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.
8159
8419
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8160
8420
  # @param [Hash] opts the optional parameters
8161
8421
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -8470,7 +8730,7 @@ module Plaid
8470
8730
  end
8471
8731
 
8472
8732
  # Get incremental transaction updates on an Item
8473
- # 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. 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.
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.
8474
8734
  # @param transactions_sync_request [TransactionsSyncRequest]
8475
8735
  # @param [Hash] opts the optional parameters
8476
8736
  # @return [TransactionsSyncResponse]
@@ -8480,7 +8740,7 @@ module Plaid
8480
8740
  end
8481
8741
 
8482
8742
  # Get incremental transaction updates on an Item
8483
- # 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. 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.
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.
8484
8744
  # @param transactions_sync_request [TransactionsSyncRequest]
8485
8745
  # @param [Hash] opts the optional parameters
8486
8746
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -8860,7 +9120,7 @@ module Plaid
8860
9120
  end
8861
9121
 
8862
9122
  # Retrieve a transfer
8863
- # The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
9123
+ # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
8864
9124
  # @param transfer_get_request [TransferGetRequest]
8865
9125
  # @param [Hash] opts the optional parameters
8866
9126
  # @return [TransferGetResponse]
@@ -8870,7 +9130,7 @@ module Plaid
8870
9130
  end
8871
9131
 
8872
9132
  # Retrieve a transfer
8873
- # The &#x60;/transfer/get&#x60; fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
9133
+ # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
8874
9134
  # @param transfer_get_request [TransferGetRequest]
8875
9135
  # @param [Hash] opts the optional parameters
8876
9136
  # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
@@ -9184,31 +9444,31 @@ module Plaid
9184
9444
  return data, status_code, headers
9185
9445
  end
9186
9446
 
9187
- # Lists historical repayments
9188
- # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
9189
- # @param transfer_repayment_list_request [TransferRepaymentListRequest]
9447
+ # Create a new originator
9448
+ # Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.
9449
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
9190
9450
  # @param [Hash] opts the optional parameters
9191
- # @return [TransferRepaymentListResponse]
9192
- def transfer_repayment_list(transfer_repayment_list_request, opts = {})
9193
- data, _status_code, _headers = transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts)
9451
+ # @return [TransferOriginatorCreateResponse]
9452
+ def transfer_originator_create(transfer_originator_create_request, opts = {})
9453
+ data, _status_code, _headers = transfer_originator_create_with_http_info(transfer_originator_create_request, opts)
9194
9454
  data
9195
9455
  end
9196
9456
 
9197
- # Lists historical repayments
9198
- # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.
9199
- # @param transfer_repayment_list_request [TransferRepaymentListRequest]
9457
+ # Create a new originator
9458
+ # Use the &#x60;/transfer/originator/create&#x60; endpoint to create a new originator and return an &#x60;originator_client_id&#x60;.
9459
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
9200
9460
  # @param [Hash] opts the optional parameters
9201
- # @return [Array<(TransferRepaymentListResponse, Integer, Hash)>] TransferRepaymentListResponse data, response status code and response headers
9202
- def transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {})
9461
+ # @return [Array<(TransferOriginatorCreateResponse, Integer, Hash)>] TransferOriginatorCreateResponse data, response status code and response headers
9462
+ def transfer_originator_create_with_http_info(transfer_originator_create_request, opts = {})
9203
9463
  if @api_client.config.debugging
9204
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_list ...'
9464
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_create ...'
9205
9465
  end
9206
- # verify the required parameter 'transfer_repayment_list_request' is set
9207
- if @api_client.config.client_side_validation && transfer_repayment_list_request.nil?
9208
- fail ArgumentError, "Missing the required parameter 'transfer_repayment_list_request' when calling PlaidApi.transfer_repayment_list"
9466
+ # verify the required parameter 'transfer_originator_create_request' is set
9467
+ if @api_client.config.client_side_validation && transfer_originator_create_request.nil?
9468
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_create_request' when calling PlaidApi.transfer_originator_create"
9209
9469
  end
9210
9470
  # resource path
9211
- local_var_path = '/transfer/repayment/list'
9471
+ local_var_path = '/transfer/originator/create'
9212
9472
 
9213
9473
  # query parameters
9214
9474
  query_params = opts[:query_params] || {}
@@ -9224,16 +9484,16 @@ module Plaid
9224
9484
  form_params = opts[:form_params] || {}
9225
9485
 
9226
9486
  # http body (model)
9227
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_list_request)
9487
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_create_request)
9228
9488
 
9229
9489
  # return_type
9230
- return_type = opts[:debug_return_type] || 'TransferRepaymentListResponse'
9490
+ return_type = opts[:debug_return_type] || 'TransferOriginatorCreateResponse'
9231
9491
 
9232
9492
  # auth_names
9233
9493
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9234
9494
 
9235
9495
  new_options = opts.merge(
9236
- :operation => :"PlaidApi.transfer_repayment_list",
9496
+ :operation => :"PlaidApi.transfer_originator_create",
9237
9497
  :header_params => header_params,
9238
9498
  :query_params => query_params,
9239
9499
  :form_params => form_params,
@@ -9244,36 +9504,36 @@ module Plaid
9244
9504
 
9245
9505
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9246
9506
  if @api_client.config.debugging
9247
- @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9507
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9248
9508
  end
9249
9509
  return data, status_code, headers
9250
9510
  end
9251
9511
 
9252
- # List the returns included in a repayment
9253
- # The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
9254
- # @param transfer_repayment_return_list_request [TransferRepaymentReturnListRequest]
9512
+ # Get status of an originator's onboarding
9513
+ # The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
9514
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
9255
9515
  # @param [Hash] opts the optional parameters
9256
- # @return [TransferRepaymentReturnListResponse]
9257
- def transfer_repayment_return_list(transfer_repayment_return_list_request, opts = {})
9258
- data, _status_code, _headers = transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts)
9516
+ # @return [TransferOriginatorGetResponse]
9517
+ def transfer_originator_get(transfer_originator_get_request, opts = {})
9518
+ data, _status_code, _headers = transfer_originator_get_with_http_info(transfer_originator_get_request, opts)
9259
9519
  data
9260
9520
  end
9261
9521
 
9262
- # List the returns included in a repayment
9263
- # The &#x60;/transfer/repayment/return/list&#x60; endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
9264
- # @param transfer_repayment_return_list_request [TransferRepaymentReturnListRequest]
9522
+ # Get status of an originator&#39;s onboarding
9523
+ # The &#x60;/transfer/originator/get&#x60; endpoint gets status updates for an originator&#39;s onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
9524
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
9265
9525
  # @param [Hash] opts the optional parameters
9266
- # @return [Array<(TransferRepaymentReturnListResponse, Integer, Hash)>] TransferRepaymentReturnListResponse data, response status code and response headers
9267
- def transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts = {})
9526
+ # @return [Array<(TransferOriginatorGetResponse, Integer, Hash)>] TransferOriginatorGetResponse data, response status code and response headers
9527
+ def transfer_originator_get_with_http_info(transfer_originator_get_request, opts = {})
9268
9528
  if @api_client.config.debugging
9269
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_return_list ...'
9529
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_get ...'
9270
9530
  end
9271
- # verify the required parameter 'transfer_repayment_return_list_request' is set
9272
- if @api_client.config.client_side_validation && transfer_repayment_return_list_request.nil?
9273
- fail ArgumentError, "Missing the required parameter 'transfer_repayment_return_list_request' when calling PlaidApi.transfer_repayment_return_list"
9531
+ # verify the required parameter 'transfer_originator_get_request' is set
9532
+ if @api_client.config.client_side_validation && transfer_originator_get_request.nil?
9533
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_get_request' when calling PlaidApi.transfer_originator_get"
9274
9534
  end
9275
9535
  # resource path
9276
- local_var_path = '/transfer/repayment/return/list'
9536
+ local_var_path = '/transfer/originator/get'
9277
9537
 
9278
9538
  # query parameters
9279
9539
  query_params = opts[:query_params] || {}
@@ -9283,22 +9543,22 @@ module Plaid
9283
9543
  # HTTP header 'Accept' (if needed)
9284
9544
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9285
9545
  # HTTP header 'Content-Type'
9286
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9546
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'examples'])
9287
9547
 
9288
9548
  # form parameters
9289
9549
  form_params = opts[:form_params] || {}
9290
9550
 
9291
9551
  # http body (model)
9292
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_return_list_request)
9552
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_get_request)
9293
9553
 
9294
9554
  # return_type
9295
- return_type = opts[:debug_return_type] || 'TransferRepaymentReturnListResponse'
9555
+ return_type = opts[:debug_return_type] || 'TransferOriginatorGetResponse'
9296
9556
 
9297
9557
  # auth_names
9298
9558
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9299
9559
 
9300
9560
  new_options = opts.merge(
9301
- :operation => :"PlaidApi.transfer_repayment_return_list",
9561
+ :operation => :"PlaidApi.transfer_originator_get",
9302
9562
  :header_params => header_params,
9303
9563
  :query_params => query_params,
9304
9564
  :form_params => form_params,
@@ -9309,36 +9569,36 @@ module Plaid
9309
9569
 
9310
9570
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9311
9571
  if @api_client.config.debugging
9312
- @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_return_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9572
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9313
9573
  end
9314
9574
  return data, status_code, headers
9315
9575
  end
9316
9576
 
9317
- # Retrieve a sweep
9318
- # The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
9319
- # @param transfer_sweep_get_request [TransferSweepGetRequest]
9577
+ # Get status of all originators' onboarding
9578
+ # The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
9579
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
9320
9580
  # @param [Hash] opts the optional parameters
9321
- # @return [TransferSweepGetResponse]
9322
- def transfer_sweep_get(transfer_sweep_get_request, opts = {})
9323
- data, _status_code, _headers = transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts)
9581
+ # @return [TransferOriginatorListResponse]
9582
+ def transfer_originator_list(transfer_originator_list_request, opts = {})
9583
+ data, _status_code, _headers = transfer_originator_list_with_http_info(transfer_originator_list_request, opts)
9324
9584
  data
9325
9585
  end
9326
9586
 
9327
- # Retrieve a sweep
9328
- # The &#x60;/transfer/sweep/get&#x60; endpoint fetches a sweep corresponding to the given &#x60;sweep_id&#x60;.
9329
- # @param transfer_sweep_get_request [TransferSweepGetRequest]
9587
+ # Get status of all originators&#39; onboarding
9588
+ # The &#x60;/transfer/originator/list&#x60; endpoint gets status updates for all of your originators&#39; onboarding. This information is also available via the Plaid dashboard.
9589
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
9330
9590
  # @param [Hash] opts the optional parameters
9331
- # @return [Array<(TransferSweepGetResponse, Integer, Hash)>] TransferSweepGetResponse data, response status code and response headers
9332
- def transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts = {})
9591
+ # @return [Array<(TransferOriginatorListResponse, Integer, Hash)>] TransferOriginatorListResponse data, response status code and response headers
9592
+ def transfer_originator_list_with_http_info(transfer_originator_list_request, opts = {})
9333
9593
  if @api_client.config.debugging
9334
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_get ...'
9594
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_list ...'
9335
9595
  end
9336
- # verify the required parameter 'transfer_sweep_get_request' is set
9337
- if @api_client.config.client_side_validation && transfer_sweep_get_request.nil?
9338
- fail ArgumentError, "Missing the required parameter 'transfer_sweep_get_request' when calling PlaidApi.transfer_sweep_get"
9596
+ # verify the required parameter 'transfer_originator_list_request' is set
9597
+ if @api_client.config.client_side_validation && transfer_originator_list_request.nil?
9598
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_list_request' when calling PlaidApi.transfer_originator_list"
9339
9599
  end
9340
9600
  # resource path
9341
- local_var_path = '/transfer/sweep/get'
9601
+ local_var_path = '/transfer/originator/list'
9342
9602
 
9343
9603
  # query parameters
9344
9604
  query_params = opts[:query_params] || {}
@@ -9354,16 +9614,16 @@ module Plaid
9354
9614
  form_params = opts[:form_params] || {}
9355
9615
 
9356
9616
  # http body (model)
9357
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_get_request)
9617
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_list_request)
9358
9618
 
9359
9619
  # return_type
9360
- return_type = opts[:debug_return_type] || 'TransferSweepGetResponse'
9620
+ return_type = opts[:debug_return_type] || 'TransferOriginatorListResponse'
9361
9621
 
9362
9622
  # auth_names
9363
9623
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9364
9624
 
9365
9625
  new_options = opts.merge(
9366
- :operation => :"PlaidApi.transfer_sweep_get",
9626
+ :operation => :"PlaidApi.transfer_originator_list",
9367
9627
  :header_params => header_params,
9368
9628
  :query_params => query_params,
9369
9629
  :form_params => form_params,
@@ -9374,36 +9634,36 @@ module Plaid
9374
9634
 
9375
9635
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9376
9636
  if @api_client.config.debugging
9377
- @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9637
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9378
9638
  end
9379
9639
  return data, status_code, headers
9380
9640
  end
9381
9641
 
9382
- # List sweeps
9383
- # The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
9384
- # @param transfer_sweep_list_request [TransferSweepListRequest]
9642
+ # Generate a Plaid-hosted onboarding UI URL.
9643
+ # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
9644
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
9385
9645
  # @param [Hash] opts the optional parameters
9386
- # @return [TransferSweepListResponse]
9387
- def transfer_sweep_list(transfer_sweep_list_request, opts = {})
9388
- data, _status_code, _headers = transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts)
9646
+ # @return [TransferQuestionnaireCreateResponse]
9647
+ def transfer_questionnaire_create(transfer_questionnaire_create_request, opts = {})
9648
+ data, _status_code, _headers = transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts)
9389
9649
  data
9390
9650
  end
9391
9651
 
9392
- # List sweeps
9393
- # The &#x60;/transfer/sweep/list&#x60; endpoint fetches sweeps matching the given filters.
9394
- # @param transfer_sweep_list_request [TransferSweepListRequest]
9652
+ # Generate a Plaid-hosted onboarding UI URL.
9653
+ # The &#x60;/transfer/questionnaire/create&#x60; endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
9654
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
9395
9655
  # @param [Hash] opts the optional parameters
9396
- # @return [Array<(TransferSweepListResponse, Integer, Hash)>] TransferSweepListResponse data, response status code and response headers
9397
- def transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts = {})
9656
+ # @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
9657
+ def transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts = {})
9398
9658
  if @api_client.config.debugging
9399
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_list ...'
9659
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_questionnaire_create ...'
9400
9660
  end
9401
- # verify the required parameter 'transfer_sweep_list_request' is set
9402
- if @api_client.config.client_side_validation && transfer_sweep_list_request.nil?
9403
- fail ArgumentError, "Missing the required parameter 'transfer_sweep_list_request' when calling PlaidApi.transfer_sweep_list"
9661
+ # verify the required parameter 'transfer_questionnaire_create_request' is set
9662
+ if @api_client.config.client_side_validation && transfer_questionnaire_create_request.nil?
9663
+ fail ArgumentError, "Missing the required parameter 'transfer_questionnaire_create_request' when calling PlaidApi.transfer_questionnaire_create"
9404
9664
  end
9405
9665
  # resource path
9406
- local_var_path = '/transfer/sweep/list'
9666
+ local_var_path = '/transfer/questionnaire/create'
9407
9667
 
9408
9668
  # query parameters
9409
9669
  query_params = opts[:query_params] || {}
@@ -9419,16 +9679,16 @@ module Plaid
9419
9679
  form_params = opts[:form_params] || {}
9420
9680
 
9421
9681
  # http body (model)
9422
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_list_request)
9682
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_questionnaire_create_request)
9423
9683
 
9424
9684
  # return_type
9425
- return_type = opts[:debug_return_type] || 'TransferSweepListResponse'
9685
+ return_type = opts[:debug_return_type] || 'TransferQuestionnaireCreateResponse'
9426
9686
 
9427
9687
  # auth_names
9428
9688
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9429
9689
 
9430
9690
  new_options = opts.merge(
9431
- :operation => :"PlaidApi.transfer_sweep_list",
9691
+ :operation => :"PlaidApi.transfer_questionnaire_create",
9432
9692
  :header_params => header_params,
9433
9693
  :query_params => query_params,
9434
9694
  :form_params => form_params,
@@ -9439,36 +9699,36 @@ module Plaid
9439
9699
 
9440
9700
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9441
9701
  if @api_client.config.debugging
9442
- @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9702
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_questionnaire_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9443
9703
  end
9444
9704
  return data, status_code, headers
9445
9705
  end
9446
9706
 
9447
- # Create user
9448
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
9449
- # @param user_create_request [UserCreateRequest]
9707
+ # Cancel a recurring transfer.
9708
+ # Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
9709
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
9450
9710
  # @param [Hash] opts the optional parameters
9451
- # @return [UserCreateResponse]
9452
- def user_create(user_create_request, opts = {})
9453
- data, _status_code, _headers = user_create_with_http_info(user_create_request, opts)
9711
+ # @return [TransferRecurringCancelResponse]
9712
+ def transfer_recurring_cancel(transfer_recurring_cancel_request, opts = {})
9713
+ data, _status_code, _headers = transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts)
9454
9714
  data
9455
9715
  end
9456
9716
 
9457
- # Create user
9458
- # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
9459
- # @param user_create_request [UserCreateRequest]
9717
+ # Cancel a recurring transfer.
9718
+ # Use the &#x60;/transfer/recurring/cancel&#x60; endpoint to cancel a recurring transfer. Scheduled transfer that hasn&#39;t been submitted to bank will be cancelled.
9719
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
9460
9720
  # @param [Hash] opts the optional parameters
9461
- # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
9462
- def user_create_with_http_info(user_create_request, opts = {})
9721
+ # @return [Array<(TransferRecurringCancelResponse, Integer, Hash)>] TransferRecurringCancelResponse data, response status code and response headers
9722
+ def transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts = {})
9463
9723
  if @api_client.config.debugging
9464
- @api_client.config.logger.debug 'Calling API: PlaidApi.user_create ...'
9724
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_cancel ...'
9465
9725
  end
9466
- # verify the required parameter 'user_create_request' is set
9467
- if @api_client.config.client_side_validation && user_create_request.nil?
9468
- fail ArgumentError, "Missing the required parameter 'user_create_request' when calling PlaidApi.user_create"
9726
+ # verify the required parameter 'transfer_recurring_cancel_request' is set
9727
+ if @api_client.config.client_side_validation && transfer_recurring_cancel_request.nil?
9728
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_cancel_request' when calling PlaidApi.transfer_recurring_cancel"
9469
9729
  end
9470
9730
  # resource path
9471
- local_var_path = '/user/create'
9731
+ local_var_path = '/transfer/recurring/cancel'
9472
9732
 
9473
9733
  # query parameters
9474
9734
  query_params = opts[:query_params] || {}
@@ -9484,16 +9744,16 @@ module Plaid
9484
9744
  form_params = opts[:form_params] || {}
9485
9745
 
9486
9746
  # http body (model)
9487
- post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_request)
9747
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_cancel_request)
9488
9748
 
9489
9749
  # return_type
9490
- return_type = opts[:debug_return_type] || 'UserCreateResponse'
9750
+ return_type = opts[:debug_return_type] || 'TransferRecurringCancelResponse'
9491
9751
 
9492
9752
  # auth_names
9493
9753
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9494
9754
 
9495
9755
  new_options = opts.merge(
9496
- :operation => :"PlaidApi.user_create",
9756
+ :operation => :"PlaidApi.transfer_recurring_cancel",
9497
9757
  :header_params => header_params,
9498
9758
  :query_params => query_params,
9499
9759
  :form_params => form_params,
@@ -9504,36 +9764,36 @@ module Plaid
9504
9764
 
9505
9765
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9506
9766
  if @api_client.config.debugging
9507
- @api_client.config.logger.debug "API called: PlaidApi#user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9767
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9508
9768
  end
9509
9769
  return data, status_code, headers
9510
9770
  end
9511
9771
 
9512
- # Create an e-wallet
9513
- # Create an e-wallet. The response is the newly created e-wallet object.
9514
- # @param wallet_create_request [WalletCreateRequest]
9772
+ # Create a recurring transfer
9773
+ # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
9774
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
9515
9775
  # @param [Hash] opts the optional parameters
9516
- # @return [WalletCreateResponse]
9517
- def wallet_create(wallet_create_request, opts = {})
9518
- data, _status_code, _headers = wallet_create_with_http_info(wallet_create_request, opts)
9776
+ # @return [TransferRecurringCreateResponse]
9777
+ def transfer_recurring_create(transfer_recurring_create_request, opts = {})
9778
+ data, _status_code, _headers = transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts)
9519
9779
  data
9520
9780
  end
9521
9781
 
9522
- # Create an e-wallet
9523
- # Create an e-wallet. The response is the newly created e-wallet object.
9524
- # @param wallet_create_request [WalletCreateRequest]
9782
+ # Create a recurring transfer
9783
+ # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer.
9784
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
9525
9785
  # @param [Hash] opts the optional parameters
9526
- # @return [Array<(WalletCreateResponse, Integer, Hash)>] WalletCreateResponse data, response status code and response headers
9527
- def wallet_create_with_http_info(wallet_create_request, opts = {})
9786
+ # @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
9787
+ def transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts = {})
9528
9788
  if @api_client.config.debugging
9529
- @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_create ...'
9789
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_create ...'
9530
9790
  end
9531
- # verify the required parameter 'wallet_create_request' is set
9532
- if @api_client.config.client_side_validation && wallet_create_request.nil?
9533
- fail ArgumentError, "Missing the required parameter 'wallet_create_request' when calling PlaidApi.wallet_create"
9791
+ # verify the required parameter 'transfer_recurring_create_request' is set
9792
+ if @api_client.config.client_side_validation && transfer_recurring_create_request.nil?
9793
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_create_request' when calling PlaidApi.transfer_recurring_create"
9534
9794
  end
9535
9795
  # resource path
9536
- local_var_path = '/wallet/create'
9796
+ local_var_path = '/transfer/recurring/create'
9537
9797
 
9538
9798
  # query parameters
9539
9799
  query_params = opts[:query_params] || {}
@@ -9549,16 +9809,16 @@ module Plaid
9549
9809
  form_params = opts[:form_params] || {}
9550
9810
 
9551
9811
  # http body (model)
9552
- post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_create_request)
9812
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_create_request)
9553
9813
 
9554
9814
  # return_type
9555
- return_type = opts[:debug_return_type] || 'WalletCreateResponse'
9815
+ return_type = opts[:debug_return_type] || 'TransferRecurringCreateResponse'
9556
9816
 
9557
9817
  # auth_names
9558
9818
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9559
9819
 
9560
9820
  new_options = opts.merge(
9561
- :operation => :"PlaidApi.wallet_create",
9821
+ :operation => :"PlaidApi.transfer_recurring_create",
9562
9822
  :header_params => header_params,
9563
9823
  :query_params => query_params,
9564
9824
  :form_params => form_params,
@@ -9569,36 +9829,36 @@ module Plaid
9569
9829
 
9570
9830
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9571
9831
  if @api_client.config.debugging
9572
- @api_client.config.logger.debug "API called: PlaidApi#wallet_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9832
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9573
9833
  end
9574
9834
  return data, status_code, headers
9575
9835
  end
9576
9836
 
9577
- # Fetch an e-wallet
9578
- # Fetch an e-wallet. The response includes the current balance.
9579
- # @param wallet_get_request [WalletGetRequest]
9837
+ # Retrieve a recurring transfer
9838
+ # The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.
9839
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
9580
9840
  # @param [Hash] opts the optional parameters
9581
- # @return [WalletGetResponse]
9582
- def wallet_get(wallet_get_request, opts = {})
9583
- data, _status_code, _headers = wallet_get_with_http_info(wallet_get_request, opts)
9841
+ # @return [TransferRecurringGetResponse]
9842
+ def transfer_recurring_get(transfer_recurring_get_request, opts = {})
9843
+ data, _status_code, _headers = transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts)
9584
9844
  data
9585
9845
  end
9586
9846
 
9587
- # Fetch an e-wallet
9588
- # Fetch an e-wallet. The response includes the current balance.
9589
- # @param wallet_get_request [WalletGetRequest]
9847
+ # Retrieve a recurring transfer
9848
+ # The &#x60;/transfer/recurring/get&#x60; fetches information about the recurring transfer corresponding to the given &#x60;recurring_transfer_id&#x60;.
9849
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
9590
9850
  # @param [Hash] opts the optional parameters
9591
- # @return [Array<(WalletGetResponse, Integer, Hash)>] WalletGetResponse data, response status code and response headers
9592
- def wallet_get_with_http_info(wallet_get_request, opts = {})
9851
+ # @return [Array<(TransferRecurringGetResponse, Integer, Hash)>] TransferRecurringGetResponse data, response status code and response headers
9852
+ def transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts = {})
9593
9853
  if @api_client.config.debugging
9594
- @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_get ...'
9854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_get ...'
9595
9855
  end
9596
- # verify the required parameter 'wallet_get_request' is set
9597
- if @api_client.config.client_side_validation && wallet_get_request.nil?
9598
- fail ArgumentError, "Missing the required parameter 'wallet_get_request' when calling PlaidApi.wallet_get"
9856
+ # verify the required parameter 'transfer_recurring_get_request' is set
9857
+ if @api_client.config.client_side_validation && transfer_recurring_get_request.nil?
9858
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_get_request' when calling PlaidApi.transfer_recurring_get"
9599
9859
  end
9600
9860
  # resource path
9601
- local_var_path = '/wallet/get'
9861
+ local_var_path = '/transfer/recurring/get'
9602
9862
 
9603
9863
  # query parameters
9604
9864
  query_params = opts[:query_params] || {}
@@ -9614,16 +9874,16 @@ module Plaid
9614
9874
  form_params = opts[:form_params] || {}
9615
9875
 
9616
9876
  # http body (model)
9617
- post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_get_request)
9877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_get_request)
9618
9878
 
9619
9879
  # return_type
9620
- return_type = opts[:debug_return_type] || 'WalletGetResponse'
9880
+ return_type = opts[:debug_return_type] || 'TransferRecurringGetResponse'
9621
9881
 
9622
9882
  # auth_names
9623
9883
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9624
9884
 
9625
9885
  new_options = opts.merge(
9626
- :operation => :"PlaidApi.wallet_get",
9886
+ :operation => :"PlaidApi.transfer_recurring_get",
9627
9887
  :header_params => header_params,
9628
9888
  :query_params => query_params,
9629
9889
  :form_params => form_params,
@@ -9634,36 +9894,36 @@ module Plaid
9634
9894
 
9635
9895
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9636
9896
  if @api_client.config.debugging
9637
- @api_client.config.logger.debug "API called: PlaidApi#wallet_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9897
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9638
9898
  end
9639
9899
  return data, status_code, headers
9640
9900
  end
9641
9901
 
9642
- # Fetch a list of e-wallets
9643
- # This endpoint lists all e-wallets in descending order of creation.
9644
- # @param wallet_list_request [WalletListRequest]
9902
+ # List recurring transfers
9903
+ # Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired recurring transfers.
9904
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
9645
9905
  # @param [Hash] opts the optional parameters
9646
- # @return [WalletListResponse]
9647
- def wallet_list(wallet_list_request, opts = {})
9648
- data, _status_code, _headers = wallet_list_with_http_info(wallet_list_request, opts)
9906
+ # @return [TransferRecurringListResponse]
9907
+ def transfer_recurring_list(transfer_recurring_list_request, opts = {})
9908
+ data, _status_code, _headers = transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts)
9649
9909
  data
9650
9910
  end
9651
9911
 
9652
- # Fetch a list of e-wallets
9653
- # This endpoint lists all e-wallets in descending order of creation.
9654
- # @param wallet_list_request [WalletListRequest]
9912
+ # List recurring transfers
9913
+ # Use the &#x60;/transfer/recurring/list&#x60; endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired recurring transfers.
9914
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
9655
9915
  # @param [Hash] opts the optional parameters
9656
- # @return [Array<(WalletListResponse, Integer, Hash)>] WalletListResponse data, response status code and response headers
9657
- def wallet_list_with_http_info(wallet_list_request, opts = {})
9916
+ # @return [Array<(TransferRecurringListResponse, Integer, Hash)>] TransferRecurringListResponse data, response status code and response headers
9917
+ def transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts = {})
9658
9918
  if @api_client.config.debugging
9659
- @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_list ...'
9919
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_list ...'
9660
9920
  end
9661
- # verify the required parameter 'wallet_list_request' is set
9662
- if @api_client.config.client_side_validation && wallet_list_request.nil?
9663
- fail ArgumentError, "Missing the required parameter 'wallet_list_request' when calling PlaidApi.wallet_list"
9921
+ # verify the required parameter 'transfer_recurring_list_request' is set
9922
+ if @api_client.config.client_side_validation && transfer_recurring_list_request.nil?
9923
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_list_request' when calling PlaidApi.transfer_recurring_list"
9664
9924
  end
9665
9925
  # resource path
9666
- local_var_path = '/wallet/list'
9926
+ local_var_path = '/transfer/recurring/list'
9667
9927
 
9668
9928
  # query parameters
9669
9929
  query_params = opts[:query_params] || {}
@@ -9679,16 +9939,16 @@ module Plaid
9679
9939
  form_params = opts[:form_params] || {}
9680
9940
 
9681
9941
  # http body (model)
9682
- post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_list_request)
9942
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_list_request)
9683
9943
 
9684
9944
  # return_type
9685
- return_type = opts[:debug_return_type] || 'WalletListResponse'
9945
+ return_type = opts[:debug_return_type] || 'TransferRecurringListResponse'
9686
9946
 
9687
9947
  # auth_names
9688
9948
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9689
9949
 
9690
9950
  new_options = opts.merge(
9691
- :operation => :"PlaidApi.wallet_list",
9951
+ :operation => :"PlaidApi.transfer_recurring_list",
9692
9952
  :header_params => header_params,
9693
9953
  :query_params => query_params,
9694
9954
  :form_params => form_params,
@@ -9699,36 +9959,36 @@ module Plaid
9699
9959
 
9700
9960
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9701
9961
  if @api_client.config.debugging
9702
- @api_client.config.logger.debug "API called: PlaidApi#wallet_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9962
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9703
9963
  end
9704
9964
  return data, status_code, headers
9705
9965
  end
9706
9966
 
9707
- # Execute a transaction using an e-wallet
9708
- # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
9709
- # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
9967
+ # Cancel a refund
9968
+ # Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
9969
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
9710
9970
  # @param [Hash] opts the optional parameters
9711
- # @return [WalletTransactionExecuteResponse]
9712
- def wallet_transaction_execute(wallet_transaction_execute_request, opts = {})
9713
- data, _status_code, _headers = wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts)
9971
+ # @return [TransferRefundCancelResponse]
9972
+ def transfer_refund_cancel(transfer_refund_cancel_request, opts = {})
9973
+ data, _status_code, _headers = transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts)
9714
9974
  data
9715
9975
  end
9716
9976
 
9717
- # Execute a transaction using an e-wallet
9718
- # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
9719
- # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
9977
+ # Cancel a refund
9978
+ # Use the &#x60;/transfer/refund/cancel&#x60; endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
9979
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
9720
9980
  # @param [Hash] opts the optional parameters
9721
- # @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
9722
- def wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts = {})
9981
+ # @return [Array<(TransferRefundCancelResponse, Integer, Hash)>] TransferRefundCancelResponse data, response status code and response headers
9982
+ def transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts = {})
9723
9983
  if @api_client.config.debugging
9724
- @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_execute ...'
9984
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_cancel ...'
9725
9985
  end
9726
- # verify the required parameter 'wallet_transaction_execute_request' is set
9727
- if @api_client.config.client_side_validation && wallet_transaction_execute_request.nil?
9728
- fail ArgumentError, "Missing the required parameter 'wallet_transaction_execute_request' when calling PlaidApi.wallet_transaction_execute"
9986
+ # verify the required parameter 'transfer_refund_cancel_request' is set
9987
+ if @api_client.config.client_side_validation && transfer_refund_cancel_request.nil?
9988
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_cancel_request' when calling PlaidApi.transfer_refund_cancel"
9729
9989
  end
9730
9990
  # resource path
9731
- local_var_path = '/wallet/transaction/execute'
9991
+ local_var_path = '/transfer/refund/cancel'
9732
9992
 
9733
9993
  # query parameters
9734
9994
  query_params = opts[:query_params] || {}
@@ -9744,16 +10004,16 @@ module Plaid
9744
10004
  form_params = opts[:form_params] || {}
9745
10005
 
9746
10006
  # http body (model)
9747
- post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_execute_request)
10007
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_cancel_request)
9748
10008
 
9749
10009
  # return_type
9750
- return_type = opts[:debug_return_type] || 'WalletTransactionExecuteResponse'
10010
+ return_type = opts[:debug_return_type] || 'TransferRefundCancelResponse'
9751
10011
 
9752
10012
  # auth_names
9753
10013
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9754
10014
 
9755
10015
  new_options = opts.merge(
9756
- :operation => :"PlaidApi.wallet_transaction_execute",
10016
+ :operation => :"PlaidApi.transfer_refund_cancel",
9757
10017
  :header_params => header_params,
9758
10018
  :query_params => query_params,
9759
10019
  :form_params => form_params,
@@ -9764,27 +10024,742 @@ module Plaid
9764
10024
 
9765
10025
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9766
10026
  if @api_client.config.debugging
9767
- @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10027
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9768
10028
  end
9769
10029
  return data, status_code, headers
9770
10030
  end
9771
10031
 
9772
- # Fetch an e-wallet transaction
9773
- # Fetch a specific e-wallet transaction
9774
- # @param wallet_transaction_get_request [WalletTransactionGetRequest]
10032
+ # Create a refund
10033
+ # Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 3 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
10034
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
9775
10035
  # @param [Hash] opts the optional parameters
9776
- # @return [WalletTransactionGetResponse]
9777
- def wallet_transaction_get(wallet_transaction_get_request, opts = {})
9778
- data, _status_code, _headers = wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts)
10036
+ # @return [TransferRefundCreateResponse]
10037
+ def transfer_refund_create(transfer_refund_create_request, opts = {})
10038
+ data, _status_code, _headers = transfer_refund_create_with_http_info(transfer_refund_create_request, opts)
9779
10039
  data
9780
10040
  end
9781
10041
 
9782
- # Fetch an e-wallet transaction
9783
- # Fetch a specific e-wallet transaction
9784
- # @param wallet_transaction_get_request [WalletTransactionGetRequest]
10042
+ # Create a refund
10043
+ # Use the &#x60;/transfer/refund/create&#x60; endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 3 business days following the transfer&#39;s settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
10044
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
9785
10045
  # @param [Hash] opts the optional parameters
9786
- # @return [Array<(WalletTransactionGetResponse, Integer, Hash)>] WalletTransactionGetResponse data, response status code and response headers
9787
- def wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts = {})
10046
+ # @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
10047
+ def transfer_refund_create_with_http_info(transfer_refund_create_request, opts = {})
10048
+ if @api_client.config.debugging
10049
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_create ...'
10050
+ end
10051
+ # verify the required parameter 'transfer_refund_create_request' is set
10052
+ if @api_client.config.client_side_validation && transfer_refund_create_request.nil?
10053
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_create_request' when calling PlaidApi.transfer_refund_create"
10054
+ end
10055
+ # resource path
10056
+ local_var_path = '/transfer/refund/create'
10057
+
10058
+ # query parameters
10059
+ query_params = opts[:query_params] || {}
10060
+
10061
+ # header parameters
10062
+ header_params = opts[:header_params] || {}
10063
+ # HTTP header 'Accept' (if needed)
10064
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10065
+ # HTTP header 'Content-Type'
10066
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10067
+
10068
+ # form parameters
10069
+ form_params = opts[:form_params] || {}
10070
+
10071
+ # http body (model)
10072
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_create_request)
10073
+
10074
+ # return_type
10075
+ return_type = opts[:debug_return_type] || 'TransferRefundCreateResponse'
10076
+
10077
+ # auth_names
10078
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10079
+
10080
+ new_options = opts.merge(
10081
+ :operation => :"PlaidApi.transfer_refund_create",
10082
+ :header_params => header_params,
10083
+ :query_params => query_params,
10084
+ :form_params => form_params,
10085
+ :body => post_body,
10086
+ :auth_names => auth_names,
10087
+ :return_type => return_type
10088
+ )
10089
+
10090
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10091
+ if @api_client.config.debugging
10092
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10093
+ end
10094
+ return data, status_code, headers
10095
+ end
10096
+
10097
+ # Retrieve a refund
10098
+ # The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.
10099
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
10100
+ # @param [Hash] opts the optional parameters
10101
+ # @return [TransferRefundGetResponse]
10102
+ def transfer_refund_get(transfer_refund_get_request, opts = {})
10103
+ data, _status_code, _headers = transfer_refund_get_with_http_info(transfer_refund_get_request, opts)
10104
+ data
10105
+ end
10106
+
10107
+ # Retrieve a refund
10108
+ # The &#x60;/transfer/refund/get&#x60; endpoint fetches information about the refund corresponding to the given &#x60;refund_id&#x60;.
10109
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
10110
+ # @param [Hash] opts the optional parameters
10111
+ # @return [Array<(TransferRefundGetResponse, Integer, Hash)>] TransferRefundGetResponse data, response status code and response headers
10112
+ def transfer_refund_get_with_http_info(transfer_refund_get_request, opts = {})
10113
+ if @api_client.config.debugging
10114
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_get ...'
10115
+ end
10116
+ # verify the required parameter 'transfer_refund_get_request' is set
10117
+ if @api_client.config.client_side_validation && transfer_refund_get_request.nil?
10118
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_get_request' when calling PlaidApi.transfer_refund_get"
10119
+ end
10120
+ # resource path
10121
+ local_var_path = '/transfer/refund/get'
10122
+
10123
+ # query parameters
10124
+ query_params = opts[:query_params] || {}
10125
+
10126
+ # header parameters
10127
+ header_params = opts[:header_params] || {}
10128
+ # HTTP header 'Accept' (if needed)
10129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10130
+ # HTTP header 'Content-Type'
10131
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10132
+
10133
+ # form parameters
10134
+ form_params = opts[:form_params] || {}
10135
+
10136
+ # http body (model)
10137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_get_request)
10138
+
10139
+ # return_type
10140
+ return_type = opts[:debug_return_type] || 'TransferRefundGetResponse'
10141
+
10142
+ # auth_names
10143
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10144
+
10145
+ new_options = opts.merge(
10146
+ :operation => :"PlaidApi.transfer_refund_get",
10147
+ :header_params => header_params,
10148
+ :query_params => query_params,
10149
+ :form_params => form_params,
10150
+ :body => post_body,
10151
+ :auth_names => auth_names,
10152
+ :return_type => return_type
10153
+ )
10154
+
10155
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10156
+ if @api_client.config.debugging
10157
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10158
+ end
10159
+ return data, status_code, headers
10160
+ end
10161
+
10162
+ # Lists historical repayments
10163
+ # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
10164
+ # @param transfer_repayment_list_request [TransferRepaymentListRequest]
10165
+ # @param [Hash] opts the optional parameters
10166
+ # @return [TransferRepaymentListResponse]
10167
+ def transfer_repayment_list(transfer_repayment_list_request, opts = {})
10168
+ data, _status_code, _headers = transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts)
10169
+ data
10170
+ end
10171
+
10172
+ # Lists historical repayments
10173
+ # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.
10174
+ # @param transfer_repayment_list_request [TransferRepaymentListRequest]
10175
+ # @param [Hash] opts the optional parameters
10176
+ # @return [Array<(TransferRepaymentListResponse, Integer, Hash)>] TransferRepaymentListResponse data, response status code and response headers
10177
+ def transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {})
10178
+ if @api_client.config.debugging
10179
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_list ...'
10180
+ end
10181
+ # verify the required parameter 'transfer_repayment_list_request' is set
10182
+ if @api_client.config.client_side_validation && transfer_repayment_list_request.nil?
10183
+ fail ArgumentError, "Missing the required parameter 'transfer_repayment_list_request' when calling PlaidApi.transfer_repayment_list"
10184
+ end
10185
+ # resource path
10186
+ local_var_path = '/transfer/repayment/list'
10187
+
10188
+ # query parameters
10189
+ query_params = opts[:query_params] || {}
10190
+
10191
+ # header parameters
10192
+ header_params = opts[:header_params] || {}
10193
+ # HTTP header 'Accept' (if needed)
10194
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10195
+ # HTTP header 'Content-Type'
10196
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10197
+
10198
+ # form parameters
10199
+ form_params = opts[:form_params] || {}
10200
+
10201
+ # http body (model)
10202
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_list_request)
10203
+
10204
+ # return_type
10205
+ return_type = opts[:debug_return_type] || 'TransferRepaymentListResponse'
10206
+
10207
+ # auth_names
10208
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10209
+
10210
+ new_options = opts.merge(
10211
+ :operation => :"PlaidApi.transfer_repayment_list",
10212
+ :header_params => header_params,
10213
+ :query_params => query_params,
10214
+ :form_params => form_params,
10215
+ :body => post_body,
10216
+ :auth_names => auth_names,
10217
+ :return_type => return_type
10218
+ )
10219
+
10220
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10221
+ if @api_client.config.debugging
10222
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10223
+ end
10224
+ return data, status_code, headers
10225
+ end
10226
+
10227
+ # List the returns included in a repayment
10228
+ # The `/transfer/repayment/return/list` endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
10229
+ # @param transfer_repayment_return_list_request [TransferRepaymentReturnListRequest]
10230
+ # @param [Hash] opts the optional parameters
10231
+ # @return [TransferRepaymentReturnListResponse]
10232
+ def transfer_repayment_return_list(transfer_repayment_return_list_request, opts = {})
10233
+ data, _status_code, _headers = transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts)
10234
+ data
10235
+ end
10236
+
10237
+ # List the returns included in a repayment
10238
+ # The &#x60;/transfer/repayment/return/list&#x60; endpoint retrieves the set of returns that were batched together into the specified repayment. The sum of amounts of returns retrieved by this request equals the amount of the repayment.
10239
+ # @param transfer_repayment_return_list_request [TransferRepaymentReturnListRequest]
10240
+ # @param [Hash] opts the optional parameters
10241
+ # @return [Array<(TransferRepaymentReturnListResponse, Integer, Hash)>] TransferRepaymentReturnListResponse data, response status code and response headers
10242
+ def transfer_repayment_return_list_with_http_info(transfer_repayment_return_list_request, opts = {})
10243
+ if @api_client.config.debugging
10244
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_return_list ...'
10245
+ end
10246
+ # verify the required parameter 'transfer_repayment_return_list_request' is set
10247
+ if @api_client.config.client_side_validation && transfer_repayment_return_list_request.nil?
10248
+ fail ArgumentError, "Missing the required parameter 'transfer_repayment_return_list_request' when calling PlaidApi.transfer_repayment_return_list"
10249
+ end
10250
+ # resource path
10251
+ local_var_path = '/transfer/repayment/return/list'
10252
+
10253
+ # query parameters
10254
+ query_params = opts[:query_params] || {}
10255
+
10256
+ # header parameters
10257
+ header_params = opts[:header_params] || {}
10258
+ # HTTP header 'Accept' (if needed)
10259
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10260
+ # HTTP header 'Content-Type'
10261
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10262
+
10263
+ # form parameters
10264
+ form_params = opts[:form_params] || {}
10265
+
10266
+ # http body (model)
10267
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_repayment_return_list_request)
10268
+
10269
+ # return_type
10270
+ return_type = opts[:debug_return_type] || 'TransferRepaymentReturnListResponse'
10271
+
10272
+ # auth_names
10273
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10274
+
10275
+ new_options = opts.merge(
10276
+ :operation => :"PlaidApi.transfer_repayment_return_list",
10277
+ :header_params => header_params,
10278
+ :query_params => query_params,
10279
+ :form_params => form_params,
10280
+ :body => post_body,
10281
+ :auth_names => auth_names,
10282
+ :return_type => return_type
10283
+ )
10284
+
10285
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10286
+ if @api_client.config.debugging
10287
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_repayment_return_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10288
+ end
10289
+ return data, status_code, headers
10290
+ end
10291
+
10292
+ # Retrieve a sweep
10293
+ # The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
10294
+ # @param transfer_sweep_get_request [TransferSweepGetRequest]
10295
+ # @param [Hash] opts the optional parameters
10296
+ # @return [TransferSweepGetResponse]
10297
+ def transfer_sweep_get(transfer_sweep_get_request, opts = {})
10298
+ data, _status_code, _headers = transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts)
10299
+ data
10300
+ end
10301
+
10302
+ # Retrieve a sweep
10303
+ # The &#x60;/transfer/sweep/get&#x60; endpoint fetches a sweep corresponding to the given &#x60;sweep_id&#x60;.
10304
+ # @param transfer_sweep_get_request [TransferSweepGetRequest]
10305
+ # @param [Hash] opts the optional parameters
10306
+ # @return [Array<(TransferSweepGetResponse, Integer, Hash)>] TransferSweepGetResponse data, response status code and response headers
10307
+ def transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts = {})
10308
+ if @api_client.config.debugging
10309
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_get ...'
10310
+ end
10311
+ # verify the required parameter 'transfer_sweep_get_request' is set
10312
+ if @api_client.config.client_side_validation && transfer_sweep_get_request.nil?
10313
+ fail ArgumentError, "Missing the required parameter 'transfer_sweep_get_request' when calling PlaidApi.transfer_sweep_get"
10314
+ end
10315
+ # resource path
10316
+ local_var_path = '/transfer/sweep/get'
10317
+
10318
+ # query parameters
10319
+ query_params = opts[:query_params] || {}
10320
+
10321
+ # header parameters
10322
+ header_params = opts[:header_params] || {}
10323
+ # HTTP header 'Accept' (if needed)
10324
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10325
+ # HTTP header 'Content-Type'
10326
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10327
+
10328
+ # form parameters
10329
+ form_params = opts[:form_params] || {}
10330
+
10331
+ # http body (model)
10332
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_get_request)
10333
+
10334
+ # return_type
10335
+ return_type = opts[:debug_return_type] || 'TransferSweepGetResponse'
10336
+
10337
+ # auth_names
10338
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10339
+
10340
+ new_options = opts.merge(
10341
+ :operation => :"PlaidApi.transfer_sweep_get",
10342
+ :header_params => header_params,
10343
+ :query_params => query_params,
10344
+ :form_params => form_params,
10345
+ :body => post_body,
10346
+ :auth_names => auth_names,
10347
+ :return_type => return_type
10348
+ )
10349
+
10350
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10351
+ if @api_client.config.debugging
10352
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10353
+ end
10354
+ return data, status_code, headers
10355
+ end
10356
+
10357
+ # List sweeps
10358
+ # The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
10359
+ # @param transfer_sweep_list_request [TransferSweepListRequest]
10360
+ # @param [Hash] opts the optional parameters
10361
+ # @return [TransferSweepListResponse]
10362
+ def transfer_sweep_list(transfer_sweep_list_request, opts = {})
10363
+ data, _status_code, _headers = transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts)
10364
+ data
10365
+ end
10366
+
10367
+ # List sweeps
10368
+ # The &#x60;/transfer/sweep/list&#x60; endpoint fetches sweeps matching the given filters.
10369
+ # @param transfer_sweep_list_request [TransferSweepListRequest]
10370
+ # @param [Hash] opts the optional parameters
10371
+ # @return [Array<(TransferSweepListResponse, Integer, Hash)>] TransferSweepListResponse data, response status code and response headers
10372
+ def transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts = {})
10373
+ if @api_client.config.debugging
10374
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_list ...'
10375
+ end
10376
+ # verify the required parameter 'transfer_sweep_list_request' is set
10377
+ if @api_client.config.client_side_validation && transfer_sweep_list_request.nil?
10378
+ fail ArgumentError, "Missing the required parameter 'transfer_sweep_list_request' when calling PlaidApi.transfer_sweep_list"
10379
+ end
10380
+ # resource path
10381
+ local_var_path = '/transfer/sweep/list'
10382
+
10383
+ # query parameters
10384
+ query_params = opts[:query_params] || {}
10385
+
10386
+ # header parameters
10387
+ header_params = opts[:header_params] || {}
10388
+ # HTTP header 'Accept' (if needed)
10389
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10390
+ # HTTP header 'Content-Type'
10391
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10392
+
10393
+ # form parameters
10394
+ form_params = opts[:form_params] || {}
10395
+
10396
+ # http body (model)
10397
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_list_request)
10398
+
10399
+ # return_type
10400
+ return_type = opts[:debug_return_type] || 'TransferSweepListResponse'
10401
+
10402
+ # auth_names
10403
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10404
+
10405
+ new_options = opts.merge(
10406
+ :operation => :"PlaidApi.transfer_sweep_list",
10407
+ :header_params => header_params,
10408
+ :query_params => query_params,
10409
+ :form_params => form_params,
10410
+ :body => post_body,
10411
+ :auth_names => auth_names,
10412
+ :return_type => return_type
10413
+ )
10414
+
10415
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10416
+ if @api_client.config.debugging
10417
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10418
+ end
10419
+ return data, status_code, headers
10420
+ end
10421
+
10422
+ # Create user
10423
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same `client_user_id`, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given `client_user_id`. Ensure that you store the `user_token` along with your user's identifier in your database, as it is not possible to retrieve a previously created `user_token`.
10424
+ # @param user_create_request [UserCreateRequest]
10425
+ # @param [Hash] opts the optional parameters
10426
+ # @return [UserCreateResponse]
10427
+ def user_create(user_create_request, opts = {})
10428
+ data, _status_code, _headers = user_create_with_http_info(user_create_request, opts)
10429
+ data
10430
+ end
10431
+
10432
+ # Create user
10433
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user. If you call the endpoint multiple times with the same &#x60;client_user_id&#x60;, the first creation call will succeed and the rest will fail with an error message indicating that the user has been created for the given &#x60;client_user_id&#x60;. Ensure that you store the &#x60;user_token&#x60; along with your user&#39;s identifier in your database, as it is not possible to retrieve a previously created &#x60;user_token&#x60;.
10434
+ # @param user_create_request [UserCreateRequest]
10435
+ # @param [Hash] opts the optional parameters
10436
+ # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
10437
+ def user_create_with_http_info(user_create_request, opts = {})
10438
+ if @api_client.config.debugging
10439
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_create ...'
10440
+ end
10441
+ # verify the required parameter 'user_create_request' is set
10442
+ if @api_client.config.client_side_validation && user_create_request.nil?
10443
+ fail ArgumentError, "Missing the required parameter 'user_create_request' when calling PlaidApi.user_create"
10444
+ end
10445
+ # resource path
10446
+ local_var_path = '/user/create'
10447
+
10448
+ # query parameters
10449
+ query_params = opts[:query_params] || {}
10450
+
10451
+ # header parameters
10452
+ header_params = opts[:header_params] || {}
10453
+ # HTTP header 'Accept' (if needed)
10454
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10455
+ # HTTP header 'Content-Type'
10456
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10457
+
10458
+ # form parameters
10459
+ form_params = opts[:form_params] || {}
10460
+
10461
+ # http body (model)
10462
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_request)
10463
+
10464
+ # return_type
10465
+ return_type = opts[:debug_return_type] || 'UserCreateResponse'
10466
+
10467
+ # auth_names
10468
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10469
+
10470
+ new_options = opts.merge(
10471
+ :operation => :"PlaidApi.user_create",
10472
+ :header_params => header_params,
10473
+ :query_params => query_params,
10474
+ :form_params => form_params,
10475
+ :body => post_body,
10476
+ :auth_names => auth_names,
10477
+ :return_type => return_type
10478
+ )
10479
+
10480
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10481
+ if @api_client.config.debugging
10482
+ @api_client.config.logger.debug "API called: PlaidApi#user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10483
+ end
10484
+ return data, status_code, headers
10485
+ end
10486
+
10487
+ # Create an e-wallet
10488
+ # Create an e-wallet. The response is the newly created e-wallet object.
10489
+ # @param wallet_create_request [WalletCreateRequest]
10490
+ # @param [Hash] opts the optional parameters
10491
+ # @return [WalletCreateResponse]
10492
+ def wallet_create(wallet_create_request, opts = {})
10493
+ data, _status_code, _headers = wallet_create_with_http_info(wallet_create_request, opts)
10494
+ data
10495
+ end
10496
+
10497
+ # Create an e-wallet
10498
+ # Create an e-wallet. The response is the newly created e-wallet object.
10499
+ # @param wallet_create_request [WalletCreateRequest]
10500
+ # @param [Hash] opts the optional parameters
10501
+ # @return [Array<(WalletCreateResponse, Integer, Hash)>] WalletCreateResponse data, response status code and response headers
10502
+ def wallet_create_with_http_info(wallet_create_request, opts = {})
10503
+ if @api_client.config.debugging
10504
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_create ...'
10505
+ end
10506
+ # verify the required parameter 'wallet_create_request' is set
10507
+ if @api_client.config.client_side_validation && wallet_create_request.nil?
10508
+ fail ArgumentError, "Missing the required parameter 'wallet_create_request' when calling PlaidApi.wallet_create"
10509
+ end
10510
+ # resource path
10511
+ local_var_path = '/wallet/create'
10512
+
10513
+ # query parameters
10514
+ query_params = opts[:query_params] || {}
10515
+
10516
+ # header parameters
10517
+ header_params = opts[:header_params] || {}
10518
+ # HTTP header 'Accept' (if needed)
10519
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10520
+ # HTTP header 'Content-Type'
10521
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10522
+
10523
+ # form parameters
10524
+ form_params = opts[:form_params] || {}
10525
+
10526
+ # http body (model)
10527
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_create_request)
10528
+
10529
+ # return_type
10530
+ return_type = opts[:debug_return_type] || 'WalletCreateResponse'
10531
+
10532
+ # auth_names
10533
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10534
+
10535
+ new_options = opts.merge(
10536
+ :operation => :"PlaidApi.wallet_create",
10537
+ :header_params => header_params,
10538
+ :query_params => query_params,
10539
+ :form_params => form_params,
10540
+ :body => post_body,
10541
+ :auth_names => auth_names,
10542
+ :return_type => return_type
10543
+ )
10544
+
10545
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10546
+ if @api_client.config.debugging
10547
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10548
+ end
10549
+ return data, status_code, headers
10550
+ end
10551
+
10552
+ # Fetch an e-wallet
10553
+ # Fetch an e-wallet. The response includes the current balance.
10554
+ # @param wallet_get_request [WalletGetRequest]
10555
+ # @param [Hash] opts the optional parameters
10556
+ # @return [WalletGetResponse]
10557
+ def wallet_get(wallet_get_request, opts = {})
10558
+ data, _status_code, _headers = wallet_get_with_http_info(wallet_get_request, opts)
10559
+ data
10560
+ end
10561
+
10562
+ # Fetch an e-wallet
10563
+ # Fetch an e-wallet. The response includes the current balance.
10564
+ # @param wallet_get_request [WalletGetRequest]
10565
+ # @param [Hash] opts the optional parameters
10566
+ # @return [Array<(WalletGetResponse, Integer, Hash)>] WalletGetResponse data, response status code and response headers
10567
+ def wallet_get_with_http_info(wallet_get_request, opts = {})
10568
+ if @api_client.config.debugging
10569
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_get ...'
10570
+ end
10571
+ # verify the required parameter 'wallet_get_request' is set
10572
+ if @api_client.config.client_side_validation && wallet_get_request.nil?
10573
+ fail ArgumentError, "Missing the required parameter 'wallet_get_request' when calling PlaidApi.wallet_get"
10574
+ end
10575
+ # resource path
10576
+ local_var_path = '/wallet/get'
10577
+
10578
+ # query parameters
10579
+ query_params = opts[:query_params] || {}
10580
+
10581
+ # header parameters
10582
+ header_params = opts[:header_params] || {}
10583
+ # HTTP header 'Accept' (if needed)
10584
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10585
+ # HTTP header 'Content-Type'
10586
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10587
+
10588
+ # form parameters
10589
+ form_params = opts[:form_params] || {}
10590
+
10591
+ # http body (model)
10592
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_get_request)
10593
+
10594
+ # return_type
10595
+ return_type = opts[:debug_return_type] || 'WalletGetResponse'
10596
+
10597
+ # auth_names
10598
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10599
+
10600
+ new_options = opts.merge(
10601
+ :operation => :"PlaidApi.wallet_get",
10602
+ :header_params => header_params,
10603
+ :query_params => query_params,
10604
+ :form_params => form_params,
10605
+ :body => post_body,
10606
+ :auth_names => auth_names,
10607
+ :return_type => return_type
10608
+ )
10609
+
10610
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10611
+ if @api_client.config.debugging
10612
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10613
+ end
10614
+ return data, status_code, headers
10615
+ end
10616
+
10617
+ # Fetch a list of e-wallets
10618
+ # This endpoint lists all e-wallets in descending order of creation.
10619
+ # @param wallet_list_request [WalletListRequest]
10620
+ # @param [Hash] opts the optional parameters
10621
+ # @return [WalletListResponse]
10622
+ def wallet_list(wallet_list_request, opts = {})
10623
+ data, _status_code, _headers = wallet_list_with_http_info(wallet_list_request, opts)
10624
+ data
10625
+ end
10626
+
10627
+ # Fetch a list of e-wallets
10628
+ # This endpoint lists all e-wallets in descending order of creation.
10629
+ # @param wallet_list_request [WalletListRequest]
10630
+ # @param [Hash] opts the optional parameters
10631
+ # @return [Array<(WalletListResponse, Integer, Hash)>] WalletListResponse data, response status code and response headers
10632
+ def wallet_list_with_http_info(wallet_list_request, opts = {})
10633
+ if @api_client.config.debugging
10634
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_list ...'
10635
+ end
10636
+ # verify the required parameter 'wallet_list_request' is set
10637
+ if @api_client.config.client_side_validation && wallet_list_request.nil?
10638
+ fail ArgumentError, "Missing the required parameter 'wallet_list_request' when calling PlaidApi.wallet_list"
10639
+ end
10640
+ # resource path
10641
+ local_var_path = '/wallet/list'
10642
+
10643
+ # query parameters
10644
+ query_params = opts[:query_params] || {}
10645
+
10646
+ # header parameters
10647
+ header_params = opts[:header_params] || {}
10648
+ # HTTP header 'Accept' (if needed)
10649
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10650
+ # HTTP header 'Content-Type'
10651
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10652
+
10653
+ # form parameters
10654
+ form_params = opts[:form_params] || {}
10655
+
10656
+ # http body (model)
10657
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_list_request)
10658
+
10659
+ # return_type
10660
+ return_type = opts[:debug_return_type] || 'WalletListResponse'
10661
+
10662
+ # auth_names
10663
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10664
+
10665
+ new_options = opts.merge(
10666
+ :operation => :"PlaidApi.wallet_list",
10667
+ :header_params => header_params,
10668
+ :query_params => query_params,
10669
+ :form_params => form_params,
10670
+ :body => post_body,
10671
+ :auth_names => auth_names,
10672
+ :return_type => return_type
10673
+ )
10674
+
10675
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10676
+ if @api_client.config.debugging
10677
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10678
+ end
10679
+ return data, status_code, headers
10680
+ end
10681
+
10682
+ # Execute a transaction using an e-wallet
10683
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
10684
+ # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
10685
+ # @param [Hash] opts the optional parameters
10686
+ # @return [WalletTransactionExecuteResponse]
10687
+ def wallet_transaction_execute(wallet_transaction_execute_request, opts = {})
10688
+ data, _status_code, _headers = wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts)
10689
+ data
10690
+ end
10691
+
10692
+ # Execute a transaction using an e-wallet
10693
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate transactions, the amount and reference for the transaction. Transactions will settle in seconds to several days, depending on the underlying payment rail.
10694
+ # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
10695
+ # @param [Hash] opts the optional parameters
10696
+ # @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
10697
+ def wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts = {})
10698
+ if @api_client.config.debugging
10699
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_execute ...'
10700
+ end
10701
+ # verify the required parameter 'wallet_transaction_execute_request' is set
10702
+ if @api_client.config.client_side_validation && wallet_transaction_execute_request.nil?
10703
+ fail ArgumentError, "Missing the required parameter 'wallet_transaction_execute_request' when calling PlaidApi.wallet_transaction_execute"
10704
+ end
10705
+ # resource path
10706
+ local_var_path = '/wallet/transaction/execute'
10707
+
10708
+ # query parameters
10709
+ query_params = opts[:query_params] || {}
10710
+
10711
+ # header parameters
10712
+ header_params = opts[:header_params] || {}
10713
+ # HTTP header 'Accept' (if needed)
10714
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10715
+ # HTTP header 'Content-Type'
10716
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10717
+
10718
+ # form parameters
10719
+ form_params = opts[:form_params] || {}
10720
+
10721
+ # http body (model)
10722
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_execute_request)
10723
+
10724
+ # return_type
10725
+ return_type = opts[:debug_return_type] || 'WalletTransactionExecuteResponse'
10726
+
10727
+ # auth_names
10728
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10729
+
10730
+ new_options = opts.merge(
10731
+ :operation => :"PlaidApi.wallet_transaction_execute",
10732
+ :header_params => header_params,
10733
+ :query_params => query_params,
10734
+ :form_params => form_params,
10735
+ :body => post_body,
10736
+ :auth_names => auth_names,
10737
+ :return_type => return_type
10738
+ )
10739
+
10740
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10741
+ if @api_client.config.debugging
10742
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10743
+ end
10744
+ return data, status_code, headers
10745
+ end
10746
+
10747
+ # Fetch an e-wallet transaction
10748
+ # Fetch a specific e-wallet transaction
10749
+ # @param wallet_transaction_get_request [WalletTransactionGetRequest]
10750
+ # @param [Hash] opts the optional parameters
10751
+ # @return [WalletTransactionGetResponse]
10752
+ def wallet_transaction_get(wallet_transaction_get_request, opts = {})
10753
+ data, _status_code, _headers = wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts)
10754
+ data
10755
+ end
10756
+
10757
+ # Fetch an e-wallet transaction
10758
+ # Fetch a specific e-wallet transaction
10759
+ # @param wallet_transaction_get_request [WalletTransactionGetRequest]
10760
+ # @param [Hash] opts the optional parameters
10761
+ # @return [Array<(WalletTransactionGetResponse, Integer, Hash)>] WalletTransactionGetResponse data, response status code and response headers
10762
+ def wallet_transaction_get_with_http_info(wallet_transaction_get_request, opts = {})
9788
10763
  if @api_client.config.debugging
9789
10764
  @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_get ...'
9790
10765
  end
@@ -9834,11 +10809,76 @@ module Plaid
9834
10809
  return data, status_code, headers
9835
10810
  end
9836
10811
 
10812
+ # List e-wallet transactions
10813
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
10814
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10815
+ # @param [Hash] opts the optional parameters
10816
+ # @return [WalletTransactionListResponse]
10817
+ def wallet_transaction_list(wallet_transaction_list_request, opts = {})
10818
+ data, _status_code, _headers = wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts)
10819
+ data
10820
+ end
10821
+
10822
+ # List e-wallet transactions
10823
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
10824
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10825
+ # @param [Hash] opts the optional parameters
10826
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
10827
+ def wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts = {})
10828
+ if @api_client.config.debugging
10829
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_list ...'
10830
+ end
10831
+ # verify the required parameter 'wallet_transaction_list_request' is set
10832
+ if @api_client.config.client_side_validation && wallet_transaction_list_request.nil?
10833
+ fail ArgumentError, "Missing the required parameter 'wallet_transaction_list_request' when calling PlaidApi.wallet_transaction_list"
10834
+ end
10835
+ # resource path
10836
+ local_var_path = '/wallet/transaction/list'
10837
+
10838
+ # query parameters
10839
+ query_params = opts[:query_params] || {}
10840
+
10841
+ # header parameters
10842
+ header_params = opts[:header_params] || {}
10843
+ # HTTP header 'Accept' (if needed)
10844
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10845
+ # HTTP header 'Content-Type'
10846
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10847
+
10848
+ # form parameters
10849
+ form_params = opts[:form_params] || {}
10850
+
10851
+ # http body (model)
10852
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_list_request)
10853
+
10854
+ # return_type
10855
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
10856
+
10857
+ # auth_names
10858
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10859
+
10860
+ new_options = opts.merge(
10861
+ :operation => :"PlaidApi.wallet_transaction_list",
10862
+ :header_params => header_params,
10863
+ :query_params => query_params,
10864
+ :form_params => form_params,
10865
+ :body => post_body,
10866
+ :auth_names => auth_names,
10867
+ :return_type => return_type
10868
+ )
10869
+
10870
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10871
+ if @api_client.config.debugging
10872
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10873
+ end
10874
+ return data, status_code, headers
10875
+ end
10876
+
9837
10877
  # List e-wallet transactions
9838
10878
  # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
9839
10879
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9840
10880
  # @param [Hash] opts the optional parameters
9841
- # @return [WalletTransactionsListResponse]
10881
+ # @return [WalletTransactionListResponse]
9842
10882
  def wallet_transactions_list(wallet_transactions_list_request, opts = {})
9843
10883
  data, _status_code, _headers = wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts)
9844
10884
  data
@@ -9848,7 +10888,7 @@ module Plaid
9848
10888
  # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
9849
10889
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9850
10890
  # @param [Hash] opts the optional parameters
9851
- # @return [Array<(WalletTransactionsListResponse, Integer, Hash)>] WalletTransactionsListResponse data, response status code and response headers
10891
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
9852
10892
  def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
9853
10893
  if @api_client.config.debugging
9854
10894
  @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
@@ -9877,7 +10917,7 @@ module Plaid
9877
10917
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transactions_list_request)
9878
10918
 
9879
10919
  # return_type
9880
- return_type = opts[:debug_return_type] || 'WalletTransactionsListResponse'
10920
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
9881
10921
 
9882
10922
  # auth_names
9883
10923
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']