plaid 17.0.0 → 17.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1037) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +306 -0
  3. data/Gemfile.lock +3 -3
  4. data/Makefile +1 -1
  5. data/lib/plaid/api/plaid_api.rb +1715 -545
  6. data/lib/plaid/api_client.rb +11 -4
  7. data/lib/plaid/api_error.rb +1 -1
  8. data/lib/plaid/configuration.rb +1 -1
  9. data/lib/plaid/models/account_access.rb +1 -1
  10. data/lib/plaid/models/account_assets.rb +1 -1
  11. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  12. data/lib/plaid/models/account_balance.rb +1 -1
  13. data/lib/plaid/models/account_base.rb +1 -1
  14. data/lib/plaid/models/account_filter.rb +1 -1
  15. data/lib/plaid/models/account_filters_response.rb +1 -1
  16. data/lib/plaid/models/account_identity.rb +1 -1
  17. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  18. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  19. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  20. data/lib/plaid/models/account_product_access.rb +1 -1
  21. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  22. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  23. data/lib/plaid/models/account_subtype.rb +1 -1
  24. data/lib/plaid/models/account_type.rb +1 -1
  25. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  26. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  27. data/lib/plaid/models/accounts_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_response.rb +1 -1
  30. data/lib/plaid/models/ach_class.rb +1 -1
  31. data/lib/plaid/models/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 +24 -2
  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 +313 -0
  135. data/lib/plaid/models/client_provided_transaction_location.rb +260 -0
  136. data/lib/plaid/models/connected_application.rb +1 -1
  137. data/lib/plaid/models/counterparty.rb +27 -5
  138. data/lib/plaid/models/counterparty_type.rb +3 -2
  139. data/lib/plaid/models/country_code.rb +1 -1
  140. data/lib/plaid/models/credit1099.rb +1 -1
  141. data/lib/plaid/models/credit1099_filer.rb +1 -1
  142. data/lib/plaid/models/credit1099_payer.rb +1 -1
  143. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  144. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  145. data/lib/plaid/models/credit_amount_with_currency.rb +242 -0
  146. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +1 -1
  147. data/lib/plaid/models/credit_audit_copy_token_create_response.rb +1 -1
  148. data/lib/plaid/models/credit_audit_copy_token_remove_request.rb +1 -1
  149. data/lib/plaid/models/credit_audit_copy_token_remove_response.rb +1 -1
  150. data/lib/plaid/models/credit_bank_income.rb +1 -1
  151. data/lib/plaid/models/credit_bank_income_account.rb +1 -1
  152. data/lib/plaid/models/credit_bank_income_account_type.rb +1 -1
  153. data/lib/plaid/models/credit_bank_income_category.rb +1 -1
  154. data/lib/plaid/models/credit_bank_income_cause.rb +1 -1
  155. data/lib/plaid/models/credit_bank_income_error_type.rb +1 -1
  156. data/lib/plaid/models/credit_bank_income_get_request.rb +1 -1
  157. data/lib/plaid/models/credit_bank_income_get_request_options.rb +1 -1
  158. data/lib/plaid/models/credit_bank_income_get_response.rb +1 -1
  159. data/lib/plaid/models/credit_bank_income_historical_summary.rb +17 -5
  160. data/lib/plaid/models/credit_bank_income_item.rb +1 -1
  161. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +1 -1
  162. data/lib/plaid/models/credit_bank_income_pdf_get_request.rb +1 -1
  163. data/lib/plaid/models/credit_bank_income_refresh_request.rb +1 -1
  164. data/lib/plaid/models/credit_bank_income_refresh_request_options.rb +1 -1
  165. data/lib/plaid/models/credit_bank_income_refresh_response.rb +1 -1
  166. data/lib/plaid/models/credit_bank_income_source.rb +1 -1
  167. data/lib/plaid/models/credit_bank_income_summary.rb +17 -5
  168. data/lib/plaid/models/credit_bank_income_transaction.rb +1 -1
  169. data/lib/plaid/models/credit_bank_income_warning.rb +1 -1
  170. data/lib/plaid/models/credit_bank_income_warning_code.rb +1 -1
  171. data/lib/plaid/models/credit_bank_income_warning_type.rb +1 -1
  172. data/lib/plaid/models/credit_card_liability.rb +1 -1
  173. data/lib/plaid/models/credit_category.rb +1 -1
  174. data/lib/plaid/models/credit_document_metadata.rb +1 -1
  175. data/lib/plaid/models/credit_employer_verification.rb +1 -1
  176. data/lib/plaid/models/credit_employment_get_request.rb +1 -1
  177. data/lib/plaid/models/credit_employment_get_response.rb +1 -1
  178. data/lib/plaid/models/credit_employment_item.rb +1 -1
  179. data/lib/plaid/models/credit_employment_verification.rb +1 -1
  180. data/lib/plaid/models/credit_filter.rb +1 -1
  181. data/lib/plaid/models/credit_pay_stub.rb +1 -1
  182. data/lib/plaid/models/credit_pay_stub_address.rb +1 -1
  183. data/lib/plaid/models/credit_pay_stub_deductions.rb +1 -1
  184. data/lib/plaid/models/credit_pay_stub_earnings.rb +1 -1
  185. data/lib/plaid/models/credit_pay_stub_employee.rb +1 -1
  186. data/lib/plaid/models/credit_pay_stub_employer.rb +1 -1
  187. data/lib/plaid/models/credit_pay_stub_net_pay.rb +1 -1
  188. data/lib/plaid/models/credit_pay_stub_pay_basis_type.rb +40 -0
  189. data/lib/plaid/models/credit_payroll_income_get_request.rb +1 -1
  190. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  191. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  192. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  193. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  194. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  195. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  196. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  197. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  198. data/lib/plaid/models/credit_relay_create_request.rb +2 -2
  199. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  200. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  201. data/lib/plaid/models/credit_relay_refresh_request.rb +2 -2
  202. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  203. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  204. data/lib/plaid/models/credit_relay_remove_response.rb +2 -2
  205. data/lib/plaid/models/credit_session.rb +1 -1
  206. data/lib/plaid/models/credit_session_bank_income_result.rb +1 -1
  207. data/lib/plaid/models/credit_session_bank_income_status.rb +1 -1
  208. data/lib/plaid/models/credit_session_document_income_result.rb +1 -1
  209. data/lib/plaid/models/credit_session_error.rb +1 -1
  210. data/lib/plaid/models/credit_session_item_add_result.rb +1 -1
  211. data/lib/plaid/models/credit_session_payroll_income_result.rb +1 -1
  212. data/lib/plaid/models/credit_session_results.rb +1 -1
  213. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  214. data/lib/plaid/models/credit_sessions_get_response.rb +1 -1
  215. data/lib/plaid/models/credit_w2.rb +1 -1
  216. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  217. data/lib/plaid/models/dashboard_user.rb +1 -1
  218. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  219. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  220. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  221. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  222. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  223. data/lib/plaid/models/date_range.rb +1 -1
  224. data/lib/plaid/models/deductions.rb +1 -1
  225. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  226. data/lib/plaid/models/deductions_total.rb +1 -1
  227. data/lib/plaid/models/default_update_webhook.rb +1 -1
  228. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  229. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  230. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  231. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  232. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  233. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  234. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  235. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  236. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  237. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  238. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  239. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  240. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  241. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  242. data/lib/plaid/models/depository_filter.rb +1 -1
  243. data/lib/plaid/models/distribution_breakdown.rb +1 -1
  244. data/lib/plaid/models/doc_type.rb +1 -1
  245. data/lib/plaid/models/document_analysis.rb +1 -1
  246. data/lib/plaid/models/document_authenticity_match_code.rb +1 -1
  247. data/lib/plaid/models/document_date_of_birth_match_code.rb +1 -1
  248. data/lib/plaid/models/document_metadata.rb +1 -1
  249. data/lib/plaid/models/document_name_match_code.rb +1 -1
  250. data/lib/plaid/models/document_risk_signal.rb +17 -6
  251. data/lib/plaid/models/document_risk_signal_institution_metadata.rb +1 -1
  252. data/lib/plaid/models/document_risk_signals_object.rb +1 -1
  253. data/lib/plaid/models/document_risk_summary.rb +221 -0
  254. data/lib/plaid/models/document_status.rb +1 -1
  255. data/lib/plaid/models/documentary_verification.rb +1 -1
  256. data/lib/plaid/models/documentary_verification_document.rb +1 -1
  257. data/lib/plaid/models/earnings.rb +1 -1
  258. data/lib/plaid/models/earnings_breakdown.rb +1 -1
  259. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +1 -1
  260. data/lib/plaid/models/earnings_total.rb +1 -1
  261. data/lib/plaid/models/email.rb +1 -1
  262. data/lib/plaid/models/email_address_match_score.rb +9 -9
  263. data/lib/plaid/models/employee.rb +1 -1
  264. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  265. data/lib/plaid/models/employer.rb +1 -1
  266. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  267. data/lib/plaid/models/employer_verification.rb +1 -1
  268. data/lib/plaid/models/employers_search_request.rb +1 -1
  269. data/lib/plaid/models/employers_search_response.rb +1 -1
  270. data/lib/plaid/models/employment_details.rb +1 -1
  271. data/lib/plaid/models/employment_verification.rb +1 -1
  272. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  273. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  274. data/lib/plaid/models/employment_verification_status.rb +1 -1
  275. data/lib/plaid/models/enhancements.rb +4 -4
  276. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  277. data/lib/plaid/models/enrichments.rb +347 -0
  278. data/lib/plaid/models/entity_document.rb +1 -1
  279. data/lib/plaid/models/entity_document_type.rb +1 -1
  280. data/lib/plaid/models/entity_screening_hit_analysis.rb +1 -1
  281. data/lib/plaid/models/entity_screening_hit_data.rb +1 -1
  282. data/lib/plaid/models/entity_screening_hit_documents_items.rb +1 -1
  283. data/lib/plaid/models/entity_screening_hit_emails.rb +1 -1
  284. data/lib/plaid/models/entity_screening_hit_emails_items.rb +1 -1
  285. data/lib/plaid/models/entity_screening_hit_names.rb +1 -1
  286. data/lib/plaid/models/entity_screening_hit_names_items.rb +1 -1
  287. data/lib/plaid/models/entity_screening_hit_phone_numbers.rb +1 -1
  288. data/lib/plaid/models/entity_screening_hit_urls.rb +1 -1
  289. data/lib/plaid/models/entity_screening_hit_urls_items.rb +1 -1
  290. data/lib/plaid/models/entity_screening_hits_phone_number_items.rb +1 -1
  291. data/lib/plaid/models/entity_screening_status_updated_webhook.rb +1 -1
  292. data/lib/plaid/models/entity_watchlist_code.rb +1 -1
  293. data/lib/plaid/models/entity_watchlist_program.rb +1 -1
  294. data/lib/plaid/models/entity_watchlist_screening.rb +1 -1
  295. data/lib/plaid/models/entity_watchlist_screening_hit.rb +1 -1
  296. data/lib/plaid/models/entity_watchlist_screening_review.rb +1 -1
  297. data/lib/plaid/models/entity_watchlist_screening_search_terms.rb +1 -1
  298. data/lib/plaid/models/entity_watchlist_search_terms.rb +1 -1
  299. data/lib/plaid/models/expiration_date.rb +1 -1
  300. data/lib/plaid/models/external_payment_initiation_consent_options.rb +1 -1
  301. data/lib/plaid/models/external_payment_options.rb +1 -1
  302. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  303. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  304. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  305. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  306. data/lib/plaid/models/fdx_content_types.rb +1 -1
  307. data/lib/plaid/models/fdx_hateoas_link.rb +1 -1
  308. data/lib/plaid/models/fdx_hateoas_link_action.rb +1 -1
  309. data/lib/plaid/models/fdx_notification.rb +1 -1
  310. data/lib/plaid/models/fdx_notification_category.rb +1 -1
  311. data/lib/plaid/models/fdx_notification_payload.rb +1 -1
  312. data/lib/plaid/models/fdx_notification_payload_id_type.rb +1 -1
  313. data/lib/plaid/models/fdx_notification_priority.rb +1 -1
  314. data/lib/plaid/models/fdx_notification_severity.rb +1 -1
  315. data/lib/plaid/models/fdx_notification_type.rb +1 -1
  316. data/lib/plaid/models/fdx_party.rb +1 -1
  317. data/lib/plaid/models/fdx_party_registry.rb +1 -1
  318. data/lib/plaid/models/fdx_party_type.rb +1 -1
  319. data/lib/plaid/models/fdxfi_attribute.rb +1 -1
  320. data/lib/plaid/models/form1099_type.rb +1 -1
  321. data/lib/plaid/models/generic_screening_hit_location_items.rb +1 -1
  322. data/lib/plaid/models/health_incident.rb +1 -1
  323. data/lib/plaid/models/historical_balance.rb +1 -1
  324. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  325. data/lib/plaid/models/holding.rb +1 -1
  326. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  327. data/lib/plaid/models/holdings_override.rb +1 -1
  328. data/lib/plaid/models/id_number_type.rb +1 -1
  329. data/lib/plaid/models/identity_default_update_webhook.rb +1 -1
  330. data/lib/plaid/models/identity_get_request.rb +1 -1
  331. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  332. data/lib/plaid/models/identity_get_response.rb +1 -1
  333. data/lib/plaid/models/identity_match_request.rb +1 -1
  334. data/lib/plaid/models/identity_match_request_options.rb +1 -1
  335. data/lib/plaid/models/identity_match_response.rb +1 -1
  336. data/lib/plaid/models/identity_match_user.rb +1 -1
  337. data/lib/plaid/models/identity_update_types.rb +1 -1
  338. data/lib/plaid/models/identity_verification.rb +1 -1
  339. data/lib/plaid/models/identity_verification_create_request.rb +1 -1
  340. data/lib/plaid/models/identity_verification_create_response.rb +1 -1
  341. data/lib/plaid/models/identity_verification_get_request.rb +1 -1
  342. data/lib/plaid/models/identity_verification_get_response.rb +1 -1
  343. data/lib/plaid/models/identity_verification_list_request.rb +1 -1
  344. data/lib/plaid/models/identity_verification_list_response.rb +1 -1
  345. data/lib/plaid/models/identity_verification_request_user.rb +1 -1
  346. data/lib/plaid/models/identity_verification_retried_webhook.rb +1 -1
  347. data/lib/plaid/models/identity_verification_retry_request.rb +1 -1
  348. data/lib/plaid/models/identity_verification_retry_request_steps_object.rb +1 -1
  349. data/lib/plaid/models/identity_verification_retry_response.rb +1 -1
  350. data/lib/plaid/models/identity_verification_status.rb +1 -1
  351. data/lib/plaid/models/identity_verification_status_updated_webhook.rb +1 -1
  352. data/lib/plaid/models/identity_verification_step_status.rb +1 -1
  353. data/lib/plaid/models/identity_verification_step_summary.rb +1 -1
  354. data/lib/plaid/models/identity_verification_step_updated_webhook.rb +1 -1
  355. data/lib/plaid/models/identity_verification_template_reference.rb +1 -1
  356. data/lib/plaid/models/identity_verification_user_address.rb +1 -1
  357. data/lib/plaid/models/identity_verification_user_data.rb +1 -1
  358. data/lib/plaid/models/image_quality.rb +1 -1
  359. data/lib/plaid/models/incident_update.rb +1 -1
  360. data/lib/plaid/models/income_breakdown.rb +1 -1
  361. data/lib/plaid/models/income_breakdown_type.rb +1 -1
  362. data/lib/plaid/models/income_override.rb +1 -1
  363. data/lib/plaid/models/income_summary.rb +1 -1
  364. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  365. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  366. data/lib/plaid/models/income_verification_create_request.rb +1 -1
  367. data/lib/plaid/models/income_verification_create_request_options.rb +1 -1
  368. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  369. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  370. data/lib/plaid/models/income_verification_payroll_flow_type.rb +1 -1
  371. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  372. data/lib/plaid/models/income_verification_paystubs_get_response.rb +1 -1
  373. data/lib/plaid/models/income_verification_precheck_confidence.rb +1 -1
  374. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  375. data/lib/plaid/models/income_verification_precheck_employer_address.rb +1 -1
  376. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +1 -1
  377. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  378. data/lib/plaid/models/income_verification_precheck_payroll_institution.rb +1 -1
  379. data/lib/plaid/models/income_verification_precheck_request.rb +1 -1
  380. data/lib/plaid/models/income_verification_precheck_response.rb +1 -1
  381. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  382. data/lib/plaid/models/income_verification_source_type.rb +1 -1
  383. data/lib/plaid/models/income_verification_status_webhook.rb +1 -1
  384. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  385. data/lib/plaid/models/income_verification_taxforms_get_response.rb +1 -1
  386. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  387. data/lib/plaid/models/individual_name.rb +1 -1
  388. data/lib/plaid/models/individual_screening_hit_names.rb +1 -1
  389. data/lib/plaid/models/individual_watchlist_code.rb +1 -1
  390. data/lib/plaid/models/individual_watchlist_program.rb +1 -1
  391. data/lib/plaid/models/inflow_model.rb +1 -1
  392. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  393. data/lib/plaid/models/institution.rb +1 -1
  394. data/lib/plaid/models/institution_status.rb +9 -1
  395. data/lib/plaid/models/institution_supported_networks.rb +224 -0
  396. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  397. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  398. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  399. data/lib/plaid/models/institutions_get_request.rb +1 -1
  400. data/lib/plaid/models/institutions_get_request_options.rb +1 -1
  401. data/lib/plaid/models/institutions_get_response.rb +1 -1
  402. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  403. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  404. data/lib/plaid/models/institutions_search_request.rb +1 -1
  405. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  406. data/lib/plaid/models/institutions_search_response.rb +1 -1
  407. data/lib/plaid/models/investment_account_subtype.rb +1 -1
  408. data/lib/plaid/models/investment_filter.rb +1 -1
  409. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  410. data/lib/plaid/models/investment_transaction.rb +2 -2
  411. data/lib/plaid/models/investment_transaction_subtype.rb +1 -1
  412. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  413. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  414. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  415. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  416. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  417. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  418. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  419. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  420. data/lib/plaid/models/issuing_country.rb +1 -1
  421. data/lib/plaid/models/item.rb +1 -1
  422. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  423. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  424. data/lib/plaid/models/item_application_list_request.rb +1 -1
  425. data/lib/plaid/models/item_application_list_response.rb +1 -1
  426. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  427. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  428. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  429. data/lib/plaid/models/item_error_webhook.rb +1 -1
  430. data/lib/plaid/models/item_get_request.rb +1 -1
  431. data/lib/plaid/models/item_get_response.rb +1 -1
  432. data/lib/plaid/models/item_import_request.rb +1 -1
  433. data/lib/plaid/models/item_import_request_options.rb +1 -1
  434. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  435. data/lib/plaid/models/item_import_response.rb +1 -1
  436. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  437. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  438. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  439. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  440. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  441. data/lib/plaid/models/item_remove_request.rb +1 -1
  442. data/lib/plaid/models/item_remove_response.rb +1 -1
  443. data/lib/plaid/models/item_status.rb +1 -1
  444. data/lib/plaid/models/item_status_investments.rb +1 -1
  445. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  446. data/lib/plaid/models/item_status_nullable.rb +1 -1
  447. data/lib/plaid/models/item_status_transactions.rb +1 -1
  448. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  449. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  450. data/lib/plaid/models/jwk_public_key.rb +3 -3
  451. data/lib/plaid/models/jwt_header.rb +1 -1
  452. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  453. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  454. data/lib/plaid/models/kyc_check_details.rb +1 -1
  455. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  456. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  457. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  458. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  459. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  460. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  461. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  462. data/lib/plaid/models/liabilities_object.rb +1 -1
  463. data/lib/plaid/models/liability_override.rb +1 -1
  464. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  465. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  466. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  467. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  468. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  469. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  470. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +1 -1
  471. data/lib/plaid/models/link_o_auth_correlation_id_exchange_response.rb +1 -1
  472. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  473. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  474. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  475. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  476. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  477. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  478. data/lib/plaid/models/link_token_create_request.rb +2 -2
  479. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  480. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  481. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  482. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  483. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  484. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  485. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  486. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  487. data/lib/plaid/models/link_token_create_request_transfer.rb +1 -1
  488. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  489. data/lib/plaid/models/link_token_create_request_user.rb +4 -2
  490. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  491. data/lib/plaid/models/link_token_create_response.rb +1 -1
  492. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  493. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  494. data/lib/plaid/models/link_token_get_request.rb +1 -1
  495. data/lib/plaid/models/link_token_get_response.rb +1 -1
  496. data/lib/plaid/models/link_token_investments.rb +1 -1
  497. data/lib/plaid/models/loan.rb +1 -1
  498. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  499. data/lib/plaid/models/loan_filter.rb +1 -1
  500. data/lib/plaid/models/loan_identifier.rb +1 -1
  501. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  502. data/lib/plaid/models/loan_identifiers.rb +1 -1
  503. data/lib/plaid/models/loans.rb +1 -1
  504. data/lib/plaid/models/location.rb +1 -1
  505. data/lib/plaid/models/match_summary.rb +1 -1
  506. data/lib/plaid/models/match_summary_code.rb +1 -1
  507. data/lib/plaid/models/meta.rb +1 -1
  508. data/lib/plaid/models/mfa.rb +1 -1
  509. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  510. data/lib/plaid/models/mortgage_liability.rb +1 -1
  511. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  512. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  513. data/lib/plaid/models/name_match_score.rb +1 -1
  514. data/lib/plaid/models/net_pay.rb +1 -1
  515. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  516. data/lib/plaid/models/numbers.rb +1 -1
  517. data/lib/plaid/models/numbers_ach.rb +28 -6
  518. data/lib/plaid/models/numbers_ach_nullable.rb +28 -6
  519. data/lib/plaid/models/numbers_bacs.rb +1 -1
  520. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  521. data/lib/plaid/models/numbers_eft.rb +1 -1
  522. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  523. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  524. data/lib/plaid/models/numbers_international.rb +1 -1
  525. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  526. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  527. data/lib/plaid/models/originator.rb +239 -0
  528. data/lib/plaid/models/override_account_type.rb +1 -1
  529. data/lib/plaid/models/override_accounts.rb +1 -1
  530. data/lib/plaid/models/owner.rb +1 -1
  531. data/lib/plaid/models/owner_override.rb +1 -1
  532. data/lib/plaid/models/ownership_type.rb +1 -1
  533. data/lib/plaid/models/parties.rb +1 -1
  534. data/lib/plaid/models/partner_customer_create_request.rb +28 -10
  535. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  536. data/lib/plaid/models/partner_customer_enable_request.rb +1 -1
  537. data/lib/plaid/models/partner_customer_enable_response.rb +1 -1
  538. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  539. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  540. data/lib/plaid/models/{income_verification_refresh_request.rb → partner_customer_remove_request.rb} +17 -25
  541. data/lib/plaid/models/partner_customer_remove_response.rb +220 -0
  542. data/lib/plaid/models/partner_end_customer.rb +1 -1
  543. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  544. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +238 -0
  545. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  546. data/lib/plaid/models/partner_end_customer_customer_support_info.rb +246 -0
  547. data/lib/plaid/models/partner_end_customer_secrets.rb +1 -1
  548. data/lib/plaid/models/partner_end_customer_status.rb +1 -1
  549. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  550. data/lib/plaid/models/partner_end_customer_with_secrets.rb +1 -1
  551. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +1 -1
  552. data/lib/plaid/models/party.rb +1 -1
  553. data/lib/plaid/models/party_individual.rb +1 -1
  554. data/lib/plaid/models/party_role_type.rb +1 -1
  555. data/lib/plaid/models/pay.rb +1 -1
  556. data/lib/plaid/models/pay_frequency.rb +1 -1
  557. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  558. data/lib/plaid/models/pay_period_details.rb +1 -1
  559. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  560. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  561. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  562. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  563. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  564. data/lib/plaid/models/pay_stub_pay_period_details.rb +11 -2
  565. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  566. data/lib/plaid/models/payment_amount.rb +1 -1
  567. data/lib/plaid/models/payment_amount_currency.rb +1 -3
  568. data/lib/plaid/models/payment_amount_nullable.rb +239 -0
  569. data/lib/plaid/models/payment_amount_refunded.rb +246 -0
  570. data/lib/plaid/models/payment_amount_to_refund.rb +246 -0
  571. data/lib/plaid/models/payment_channel.rb +1 -1
  572. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  573. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  574. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  575. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  576. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  577. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  578. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  579. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  580. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  581. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  582. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  583. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  584. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  585. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  586. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  587. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  588. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  589. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  590. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  591. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  592. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  593. data/lib/plaid/models/payment_initiation_payment.rb +26 -6
  594. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  595. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  596. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  597. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  598. data/lib/plaid/models/payment_initiation_payment_get_response.rb +22 -2
  599. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  600. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  601. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +14 -5
  602. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  603. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  604. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  605. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  606. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  607. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  608. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  609. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  610. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  611. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  612. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  613. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  614. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  615. data/lib/plaid/models/payment_meta.rb +1 -1
  616. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  617. data/lib/plaid/models/payment_profile_create_response.rb +1 -1
  618. data/lib/plaid/models/payment_profile_get_request.rb +1 -1
  619. data/lib/plaid/models/payment_profile_get_response.rb +13 -2
  620. data/lib/plaid/models/payment_profile_remove_request.rb +1 -1
  621. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  622. data/lib/plaid/models/payment_profile_status.rb +1 -1
  623. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  624. data/lib/plaid/models/payment_scheme.rb +3 -2
  625. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  626. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  627. data/lib/plaid/models/payroll_income_object.rb +1 -1
  628. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  629. data/lib/plaid/models/payroll_item.rb +32 -2
  630. data/lib/plaid/models/payroll_item_status.rb +1 -1
  631. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  632. data/lib/plaid/models/paystub.rb +1 -1
  633. data/lib/plaid/models/paystub_address.rb +1 -1
  634. data/lib/plaid/models/paystub_deduction.rb +1 -1
  635. data/lib/plaid/models/paystub_details.rb +1 -1
  636. data/lib/plaid/models/paystub_employer.rb +1 -1
  637. data/lib/plaid/models/paystub_override.rb +1 -1
  638. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  639. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  640. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  641. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  642. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  643. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  644. data/lib/plaid/models/personal_finance_category.rb +1 -1
  645. data/lib/plaid/models/phone_number.rb +1 -1
  646. data/lib/plaid/models/phone_number_match_score.rb +9 -9
  647. data/lib/plaid/models/phone_type.rb +1 -1
  648. data/lib/plaid/models/physical_document_category.rb +1 -1
  649. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  650. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  651. data/lib/plaid/models/physical_document_images.rb +1 -1
  652. data/lib/plaid/models/plaid_error.rb +1 -1
  653. data/lib/plaid/models/plaid_error_type.rb +1 -1
  654. data/lib/plaid/models/platform_ids.rb +1 -1
  655. data/lib/plaid/models/po_box_status.rb +1 -1
  656. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  657. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  658. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  659. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  660. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  661. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  662. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  663. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  664. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  665. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  666. data/lib/plaid/models/processor_number.rb +1 -1
  667. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  668. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  669. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  670. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  671. data/lib/plaid/models/product_access.rb +1 -1
  672. data/lib/plaid/models/product_status.rb +1 -1
  673. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  674. data/lib/plaid/models/products.rb +1 -1
  675. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  676. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  677. data/lib/plaid/models/pslf_status.rb +1 -1
  678. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  679. data/lib/plaid/models/recipient_bacs.rb +1 -1
  680. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  681. data/lib/plaid/models/recurring_cancelled_webhook.rb +269 -0
  682. data/lib/plaid/models/recurring_new_transfer_webhook.rb +284 -0
  683. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  684. data/lib/plaid/models/recurring_transactions_update_webhook.rb +2 -2
  685. data/lib/plaid/models/recurring_transfer.rb +436 -0
  686. data/lib/plaid/models/recurring_transfer_nullable.rb +443 -0
  687. data/lib/plaid/models/recurring_transfer_skipped_webhook.rb +307 -0
  688. data/lib/plaid/models/removed_transaction.rb +1 -1
  689. data/lib/plaid/models/report_type.rb +1 -1
  690. data/lib/plaid/models/reporting_information.rb +1 -1
  691. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  692. data/lib/plaid/models/role.rb +1 -1
  693. data/lib/plaid/models/role_detail.rb +1 -1
  694. data/lib/plaid/models/roles.rb +1 -1
  695. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  696. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  697. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  698. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  699. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +1 -1
  700. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  701. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  702. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  703. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  704. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  705. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  706. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  707. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  708. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +1 -1
  709. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +1 -1
  710. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  711. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  712. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  713. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  714. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +1 -1
  715. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  716. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +1 -1
  717. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  718. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  719. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  720. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  721. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  722. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  723. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  724. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  725. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  726. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  727. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +260 -0
  728. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +225 -0
  729. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +245 -0
  730. data/lib/plaid/models/{income_verification_refresh_response.rb → sandbox_transfer_test_clock_create_response.rb} +23 -23
  731. data/lib/plaid/models/sandbox_transfer_test_clock_get_request.rb +245 -0
  732. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +239 -0
  733. data/lib/plaid/models/sandbox_transfer_test_clock_list_request.rb +320 -0
  734. data/lib/plaid/models/sandbox_transfer_test_clock_list_response.rb +241 -0
  735. data/lib/plaid/models/scopes.rb +1 -1
  736. data/lib/plaid/models/scopes_context.rb +1 -1
  737. data/lib/plaid/models/scopes_nullable.rb +1 -1
  738. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  739. data/lib/plaid/models/screening_hit_data.rb +1 -1
  740. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  741. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  742. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  743. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  744. data/lib/plaid/models/security.rb +5 -5
  745. data/lib/plaid/models/security_override.rb +3 -3
  746. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  747. data/lib/plaid/models/service.rb +1 -1
  748. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  749. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  750. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  751. data/lib/plaid/models/servicer_address_data.rb +1 -1
  752. data/lib/plaid/models/services.rb +1 -1
  753. data/lib/plaid/models/signal_address_data.rb +1 -1
  754. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  755. data/lib/plaid/models/signal_decision_report_request.rb +39 -8
  756. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  757. data/lib/plaid/models/signal_device.rb +1 -1
  758. data/lib/plaid/models/signal_evaluate_core_attributes.rb +17 -6
  759. data/lib/plaid/models/signal_evaluate_request.rb +26 -4
  760. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  761. data/lib/plaid/models/signal_payment_method.rb +43 -0
  762. data/lib/plaid/models/signal_person_name.rb +1 -1
  763. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  764. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  765. data/lib/plaid/models/signal_return_report_request.rb +17 -6
  766. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  767. data/lib/plaid/models/signal_scores.rb +1 -1
  768. data/lib/plaid/models/signal_user.rb +1 -1
  769. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  770. data/lib/plaid/models/single_document_risk_signal.rb +19 -5
  771. data/lib/plaid/models/source.rb +1 -1
  772. data/lib/plaid/models/standalone_account_type.rb +1 -1
  773. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  774. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  775. data/lib/plaid/models/status.rb +1 -1
  776. data/lib/plaid/models/statuses.rb +1 -1
  777. data/lib/plaid/models/strategy.rb +1 -1
  778. data/lib/plaid/models/student_loan.rb +2 -2
  779. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  780. data/lib/plaid/models/student_loan_status.rb +1 -1
  781. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  782. data/lib/plaid/models/sync_updates_available_webhook.rb +2 -2
  783. data/lib/plaid/models/taxform.rb +1 -1
  784. data/lib/plaid/models/taxpayer_id.rb +1 -1
  785. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  786. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  787. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  788. data/lib/plaid/models/total.rb +1 -1
  789. data/lib/plaid/models/total_canonical_description.rb +1 -1
  790. data/lib/plaid/models/transaction.rb +51 -7
  791. data/lib/plaid/models/transaction_all_of.rb +29 -7
  792. data/lib/plaid/models/transaction_base.rb +24 -2
  793. data/lib/plaid/models/transaction_code.rb +1 -1
  794. data/lib/plaid/models/transaction_counterparty.rb +261 -0
  795. data/lib/plaid/models/transaction_data.rb +1 -1
  796. data/lib/plaid/models/transaction_override.rb +1 -1
  797. data/lib/plaid/models/transaction_stream.rb +1 -1
  798. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  799. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  800. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  801. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  802. data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
  803. data/lib/plaid/models/transactions_enrich_get_request.rb +271 -0
  804. data/lib/plaid/models/transactions_enrich_get_response.rb +237 -0
  805. data/lib/plaid/models/transactions_enrich_request_options.rb +222 -0
  806. data/lib/plaid/models/transactions_get_request.rb +1 -1
  807. data/lib/plaid/models/transactions_get_request_options.rb +17 -5
  808. data/lib/plaid/models/transactions_get_response.rb +1 -1
  809. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  810. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  811. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  812. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  813. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  814. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  815. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  816. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  817. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  818. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  819. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  820. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  821. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  822. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  823. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  824. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  825. data/lib/plaid/models/transactions_sync_request_options.rb +17 -5
  826. data/lib/plaid/models/transactions_sync_response.rb +3 -3
  827. data/lib/plaid/models/transfer.rb +45 -11
  828. data/lib/plaid/models/transfer_authorization.rb +1 -1
  829. data/lib/plaid/models/transfer_authorization_create_request.rb +17 -6
  830. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  831. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  832. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  833. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +1 -1
  834. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  835. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  836. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  837. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  838. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +16 -10
  839. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  840. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  841. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  842. data/lib/plaid/models/transfer_capabilities_get_request.rb +260 -0
  843. data/lib/plaid/models/transfer_capabilities_get_response.rb +239 -0
  844. data/lib/plaid/models/transfer_capabilities_get_rtp.rb +222 -0
  845. data/lib/plaid/models/transfer_create_request.rb +1 -1
  846. data/lib/plaid/models/transfer_create_response.rb +1 -1
  847. data/lib/plaid/models/transfer_device.rb +240 -0
  848. data/lib/plaid/models/transfer_diligence_status.rb +40 -0
  849. data/lib/plaid/models/transfer_event.rb +28 -6
  850. data/lib/plaid/models/transfer_event_list_request.rb +17 -6
  851. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  852. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  853. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  854. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  855. data/lib/plaid/models/transfer_event_type.rb +1 -1
  856. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  857. data/lib/plaid/models/transfer_failure.rb +1 -1
  858. data/lib/plaid/models/transfer_get_request.rb +1 -1
  859. data/lib/plaid/models/transfer_get_response.rb +1 -1
  860. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  861. data/lib/plaid/models/transfer_intent_create.rb +1 -1
  862. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  863. data/lib/plaid/models/transfer_intent_create_request.rb +1 -1
  864. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  865. data/lib/plaid/models/transfer_intent_get.rb +1 -1
  866. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  867. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  868. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  869. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  870. data/lib/plaid/models/transfer_list_request.rb +17 -6
  871. data/lib/plaid/models/transfer_list_response.rb +1 -1
  872. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  873. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  874. data/lib/plaid/models/transfer_network.rb +1 -1
  875. data/lib/plaid/models/transfer_originator_create_request.rb +266 -0
  876. data/lib/plaid/models/transfer_originator_create_response.rb +255 -0
  877. data/lib/plaid/models/transfer_originator_get_request.rb +245 -0
  878. data/lib/plaid/models/transfer_originator_get_response.rb +239 -0
  879. data/lib/plaid/models/transfer_originator_list_request.rb +299 -0
  880. data/lib/plaid/models/transfer_originator_list_response.rb +241 -0
  881. data/lib/plaid/models/transfer_questionnaire_create_request.rb +281 -0
  882. data/lib/plaid/models/transfer_questionnaire_create_response.rb +240 -0
  883. data/lib/plaid/models/transfer_recurring_cancel_request.rb +245 -0
  884. data/lib/plaid/models/transfer_recurring_cancel_response.rb +225 -0
  885. data/lib/plaid/models/transfer_recurring_create_request.rb +437 -0
  886. data/lib/plaid/models/transfer_recurring_create_response.rb +258 -0
  887. data/lib/plaid/models/transfer_recurring_get_request.rb +245 -0
  888. data/lib/plaid/models/transfer_recurring_get_response.rb +239 -0
  889. data/lib/plaid/models/transfer_recurring_list_request.rb +319 -0
  890. data/lib/plaid/models/transfer_recurring_list_response.rb +241 -0
  891. data/lib/plaid/models/transfer_recurring_schedule.rb +280 -0
  892. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  893. data/lib/plaid/models/transfer_refund.rb +284 -0
  894. data/lib/plaid/models/transfer_refund_cancel_request.rb +245 -0
  895. data/lib/plaid/models/transfer_refund_cancel_response.rb +225 -0
  896. data/lib/plaid/models/transfer_refund_create_request.rb +296 -0
  897. data/lib/plaid/models/transfer_refund_create_response.rb +239 -0
  898. data/lib/plaid/models/transfer_refund_get_request.rb +245 -0
  899. data/lib/plaid/models/transfer_refund_get_response.rb +239 -0
  900. data/lib/plaid/models/transfer_refund_status.rb +41 -0
  901. data/lib/plaid/models/transfer_repayment.rb +1 -1
  902. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  903. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  904. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  905. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  906. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  907. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  908. data/lib/plaid/models/transfer_status.rb +1 -1
  909. data/lib/plaid/models/transfer_sweep.rb +1 -1
  910. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  911. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  912. data/lib/plaid/models/transfer_sweep_list_request.rb +16 -5
  913. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  914. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  915. data/lib/plaid/models/transfer_test_clock.rb +240 -0
  916. data/lib/plaid/models/transfer_type.rb +1 -1
  917. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  918. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  919. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  920. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -1
  921. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  922. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  923. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  924. data/lib/plaid/models/user_address.rb +1 -1
  925. data/lib/plaid/models/user_create_request.rb +1 -1
  926. data/lib/plaid/models/user_create_response.rb +1 -1
  927. data/lib/plaid/models/user_custom_password.rb +1 -1
  928. data/lib/plaid/models/user_id_number.rb +1 -1
  929. data/lib/plaid/models/user_name.rb +1 -1
  930. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  931. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  932. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  933. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  934. data/lib/plaid/models/validation_source.rb +1 -1
  935. data/lib/plaid/models/validation_sources.rb +1 -1
  936. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  937. data/lib/plaid/models/verification_of_asset.rb +1 -1
  938. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  939. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  940. data/lib/plaid/models/verification_status.rb +1 -1
  941. data/lib/plaid/models/w2.rb +1 -1
  942. data/lib/plaid/models/w2_box12.rb +1 -1
  943. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  944. data/lib/plaid/models/wallet.rb +1 -1
  945. data/lib/plaid/models/wallet_balance.rb +1 -1
  946. data/lib/plaid/models/wallet_create_request.rb +1 -1
  947. data/lib/plaid/models/wallet_create_response.rb +1 -1
  948. data/lib/plaid/models/wallet_get_request.rb +1 -1
  949. data/lib/plaid/models/wallet_get_response.rb +1 -1
  950. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  951. data/lib/plaid/models/wallet_list_request.rb +1 -1
  952. data/lib/plaid/models/wallet_list_response.rb +1 -1
  953. data/lib/plaid/models/wallet_numbers.rb +1 -1
  954. data/lib/plaid/models/wallet_transaction.rb +34 -8
  955. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  956. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  957. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  958. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  959. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  960. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  961. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  962. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  963. data/lib/plaid/models/wallet_transaction_get_response.rb +31 -5
  964. data/lib/plaid/models/wallet_transaction_list_request.rb +341 -0
  965. data/lib/plaid/models/wallet_transaction_list_request_options.rb +230 -0
  966. data/lib/plaid/models/{wallet_transactions_list_response.rb → wallet_transaction_list_response.rb} +5 -5
  967. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  968. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  969. data/lib/plaid/models/wallet_transactions_list_request.rb +17 -7
  970. data/lib/plaid/models/warning.rb +1 -1
  971. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  972. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  973. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  974. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  975. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  976. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  977. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  978. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  979. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  980. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  981. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  982. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  983. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  984. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  985. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  986. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  987. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  988. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  989. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  990. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  991. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  992. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  993. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  994. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  995. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  996. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  997. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  998. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  999. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  1000. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  1001. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  1002. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  1003. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  1004. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  1005. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  1006. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  1007. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  1008. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  1009. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  1010. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1011. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1012. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1013. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1014. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1015. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1016. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1017. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1018. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1019. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1020. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1021. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1022. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1023. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1024. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1025. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1026. data/lib/plaid/models/webhook_type.rb +1 -1
  1027. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1028. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1029. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1030. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1031. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1032. data/lib/plaid/version.rb +2 -2
  1033. data/lib/plaid.rb +73 -4
  1034. data/plaid.gemspec +1 -1
  1035. data/templates/ruby/api_client_faraday_partial.mustache +9 -2
  1036. data/test/test_enrich.rb +60 -0
  1037. metadata +75 -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.210.4
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -1906,26 +1906,26 @@ module Plaid
1906
1906
 
1907
1907
  # Refresh a user's bank income information
1908
1908
  # `/credit/bank_income/refresh` refreshes the bank income report data for a specific user.
1909
- # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
1909
+ # @param request_body [Hash<String, Object>]
1910
1910
  # @param [Hash] opts the optional parameters
1911
1911
  # @return [CreditBankIncomeRefreshResponse]
1912
- def credit_bank_income_refresh(credit_bank_income_refresh_request, opts = {})
1913
- data, _status_code, _headers = credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts)
1912
+ def credit_bank_income_refresh(request_body, opts = {})
1913
+ data, _status_code, _headers = credit_bank_income_refresh_with_http_info(request_body, opts)
1914
1914
  data
1915
1915
  end
1916
1916
 
1917
1917
  # Refresh a user&#39;s bank income information
1918
1918
  # &#x60;/credit/bank_income/refresh&#x60; refreshes the bank income report data for a specific user.
1919
- # @param credit_bank_income_refresh_request [CreditBankIncomeRefreshRequest]
1919
+ # @param request_body [Hash<String, Object>]
1920
1920
  # @param [Hash] opts the optional parameters
1921
1921
  # @return [Array<(CreditBankIncomeRefreshResponse, Integer, Hash)>] CreditBankIncomeRefreshResponse data, response status code and response headers
1922
- def credit_bank_income_refresh_with_http_info(credit_bank_income_refresh_request, opts = {})
1922
+ def credit_bank_income_refresh_with_http_info(request_body, opts = {})
1923
1923
  if @api_client.config.debugging
1924
1924
  @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_refresh ...'
1925
1925
  end
1926
- # verify the required parameter 'credit_bank_income_refresh_request' is set
1927
- if @api_client.config.client_side_validation && credit_bank_income_refresh_request.nil?
1928
- fail ArgumentError, "Missing the required parameter 'credit_bank_income_refresh_request' when calling PlaidApi.credit_bank_income_refresh"
1926
+ # verify the required parameter 'request_body' is set
1927
+ if @api_client.config.client_side_validation && request_body.nil?
1928
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.credit_bank_income_refresh"
1929
1929
  end
1930
1930
  # resource path
1931
1931
  local_var_path = '/credit/bank_income/refresh'
@@ -1944,7 +1944,7 @@ module Plaid
1944
1944
  form_params = opts[:form_params] || {}
1945
1945
 
1946
1946
  # http body (model)
1947
- post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_refresh_request)
1947
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
1948
1948
 
1949
1949
  # return_type
1950
1950
  return_type = opts[:debug_return_type] || 'CreditBankIncomeRefreshResponse'
@@ -2229,8 +2229,8 @@ module Plaid
2229
2229
  return data, status_code, headers
2230
2230
  end
2231
2231
 
2232
- # Create a `relay_token` to share an Asset Report with a partner client
2233
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party to whom you want to grant access to the Report.
2232
+ # Create a relay token to share an Asset Report with a partner client (beta)
2233
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant a third party access to an Asset Report, use the `/credit/relay/create` endpoint to create a `relay_token` and then pass that token to your third party. Each third party has its own `secondary_client_id`; for example, `ce5bd328dcd34123456`. You'll need to create a separate `relay_token` for each third party that needs access to the report on your behalf.
2234
2234
  # @param credit_relay_create_request [CreditRelayCreateRequest]
2235
2235
  # @param [Hash] opts the optional parameters
2236
2236
  # @return [CreditRelayCreateResponse]
@@ -2239,8 +2239,8 @@ module Plaid
2239
2239
  data
2240
2240
  end
2241
2241
 
2242
- # Create a &#x60;relay_token&#x60; to share an Asset Report with a partner client
2243
- # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in &#x60;/asset_report/create&#x60;. To grant access to an Asset Report to a third party, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;secondary_client_id&#x60;, for example &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;relay_token&#x60; for each third party to whom you want to grant access to the Report.
2242
+ # Create a relay token to share an Asset Report with a partner client (beta)
2243
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in &#x60;/asset_report/create&#x60;. To grant a third party access to an Asset Report, use the &#x60;/credit/relay/create&#x60; endpoint to create a &#x60;relay_token&#x60; and then pass that token to your third party. Each third party has its own &#x60;secondary_client_id&#x60;; for example, &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;relay_token&#x60; for each third party that needs access to the report on your behalf.
2244
2244
  # @param credit_relay_create_request [CreditRelayCreateRequest]
2245
2245
  # @param [Hash] opts the optional parameters
2246
2246
  # @return [Array<(CreditRelayCreateResponse, Integer, Hash)>] CreditRelayCreateResponse data, response status code and response headers
@@ -2294,8 +2294,8 @@ module Plaid
2294
2294
  return data, status_code, headers
2295
2295
  end
2296
2296
 
2297
- # Retrieve the reports associated with a Relay token that was shared with you
2298
- # `/credit/relay/get` allows third parties to get a report that was shared with them, using an `relay_token` that was created by the report owner.
2297
+ # Retrieve the reports associated with a relay token that was shared with you (beta)
2298
+ # `/credit/relay/get` allows third parties to receive a report that was shared with them, using a `relay_token` that was created by the report owner.
2299
2299
  # @param credit_relay_get_request [CreditRelayGetRequest]
2300
2300
  # @param [Hash] opts the optional parameters
2301
2301
  # @return [AssetReportGetResponse]
@@ -2304,8 +2304,8 @@ module Plaid
2304
2304
  data
2305
2305
  end
2306
2306
 
2307
- # Retrieve the reports associated with a Relay token that was shared with you
2308
- # &#x60;/credit/relay/get&#x60; allows third parties to get a report that was shared with them, using an &#x60;relay_token&#x60; that was created by the report owner.
2307
+ # Retrieve the reports associated with a relay token that was shared with you (beta)
2308
+ # &#x60;/credit/relay/get&#x60; allows third parties to receive a report that was shared with them, using a &#x60;relay_token&#x60; that was created by the report owner.
2309
2309
  # @param credit_relay_get_request [CreditRelayGetRequest]
2310
2310
  # @param [Hash] opts the optional parameters
2311
2311
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -2359,8 +2359,8 @@ module Plaid
2359
2359
  return data, status_code, headers
2360
2360
  end
2361
2361
 
2362
- # Refresh a report of a Relay Token
2363
- # The `/credit/relay/refresh` endpoint allows third parties to refresh an report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
2362
+ # Refresh a report of a relay token (beta)
2363
+ # The `/credit/relay/refresh` endpoint allows third parties to refresh a report that was relayed to them, using a `relay_token` that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the `days_requested` value of the original report.
2364
2364
  # @param credit_relay_refresh_request [CreditRelayRefreshRequest]
2365
2365
  # @param [Hash] opts the optional parameters
2366
2366
  # @return [CreditRelayRefreshResponse]
@@ -2369,8 +2369,8 @@ module Plaid
2369
2369
  data
2370
2370
  end
2371
2371
 
2372
- # Refresh a report of a Relay Token
2373
- # The &#x60;/credit/relay/refresh&#x60; endpoint allows third parties to refresh an report that was relayed to them, using a &#x60;relay_token&#x60; that was created by the report owner. A new report will be created based on the old one, but with the most recent data available.
2372
+ # Refresh a report of a relay token (beta)
2373
+ # The &#x60;/credit/relay/refresh&#x60; endpoint allows third parties to refresh a report that was relayed to them, using a &#x60;relay_token&#x60; that was created by the report owner. A new report will be created with the original report parameters, but with the most recent data available based on the &#x60;days_requested&#x60; value of the original report.
2374
2374
  # @param credit_relay_refresh_request [CreditRelayRefreshRequest]
2375
2375
  # @param [Hash] opts the optional parameters
2376
2376
  # @return [Array<(CreditRelayRefreshResponse, Integer, Hash)>] CreditRelayRefreshResponse data, response status code and response headers
@@ -2424,8 +2424,8 @@ module Plaid
2424
2424
  return data, status_code, headers
2425
2425
  end
2426
2426
 
2427
- # Remove Credit Relay Token
2428
- # The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`, meaning the third party holding the token will no longer be able to use it to access the reports to which the `relay_token` gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token.
2427
+ # Remove relay token (beta)
2428
+ # The `/credit/relay/remove` endpoint allows you to invalidate a `relay_token`. The third party holding the token will no longer be able to access or refresh the reports which the `relay_token` gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given `relay_token`.
2429
2429
  # @param credit_relay_remove_request [CreditRelayRemoveRequest]
2430
2430
  # @param [Hash] opts the optional parameters
2431
2431
  # @return [CreditRelayRemoveResponse]
@@ -2434,8 +2434,8 @@ module Plaid
2434
2434
  data
2435
2435
  end
2436
2436
 
2437
- # Remove Credit Relay Token
2438
- # The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;, meaning the third party holding the token will no longer be able to use it to access the reports to which the &#x60;relay_token&#x60; gives access to. The report, items associated with it, and other Relay tokens that provide access to the same report are not affected and will remain accessible after removing the given &#x60;relay_token.
2437
+ # Remove relay token (beta)
2438
+ # The &#x60;/credit/relay/remove&#x60; endpoint allows you to invalidate a &#x60;relay_token&#x60;. The third party holding the token will no longer be able to access or refresh the reports which the &#x60;relay_token&#x60; gives access to. The original report, associated Items, and other relay tokens that provide access to the same report are not affected and will remain accessible after removing the given &#x60;relay_token&#x60;.
2439
2439
  # @param credit_relay_remove_request [CreditRelayRemoveRequest]
2440
2440
  # @param [Hash] opts the optional parameters
2441
2441
  # @return [Array<(CreditRelayRemoveResponse, Integer, Hash)>] CreditRelayRemoveResponse data, response status code and response headers
@@ -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
- # &#x60;/income/verification/refresh&#x60; 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]
@@ -5740,7 +5740,7 @@ module Plaid
5740
5740
  end
5741
5741
 
5742
5742
  # Create a payment
5743
- # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
5743
+ # After creating a payment recipient, you can use the `/payment_initiation/payment/create` endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
5744
5744
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
5745
5745
  # @param [Hash] opts the optional parameters
5746
5746
  # @return [PaymentInitiationPaymentCreateResponse]
@@ -5750,7 +5750,7 @@ module Plaid
5750
5750
  end
5751
5751
 
5752
5752
  # Create a payment
5753
- # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR or GBP. If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer and GBP-denominated payments will be sent via the Faster Payments network, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP / EUR. For details on any payment limits in Production, contact your Plaid Account Manager.
5753
+ # After creating a payment recipient, you can use the &#x60;/payment_initiation/payment/create&#x60; endpoint to create a payment to that recipient. Payments can be one-time or standing order (recurring) and can be denominated in either EUR, GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). If making domestic GBP-denominated payments, your recipient must have been created with BACS numbers. In general, EUR-denominated payments will be sent via SEPA Credit Transfer, GBP-denominated payments will be sent via the Faster Payments network and for non-Eurozone markets typically via the local payment scheme, but the payment network used will be determined by the institution. Payments sent via Faster Payments will typically arrive immediately, while payments sent via SEPA Credit Transfer or other local payment schemes will typically arrive in one business day. Standing orders (recurring payments) must be denominated in GBP and can only be sent to recipients in the UK. Once created, standing order payments cannot be modified or canceled via the API. An end user can cancel or modify a standing order directly on their banking application or website, or by contacting the bank. Standing orders will follow the payment rules of the underlying rails (Faster Payments in UK). Payments can be sent Monday to Friday, excluding bank holidays. If the pre-arranged date falls on a weekend or bank holiday, the payment is made on the next working day. It is not possible to guarantee the exact time the payment will reach the recipient’s account, although at least 90% of standing order payments are sent by 6am. In the Development environment, payments must be below 5 GBP or other chosen [currency](https://plaid.com/docs/api/products/payment-initiation/#payment_initiation-payment-create-request-amount-currency). For details on any payment limits in Production, contact your Plaid Account Manager.
5754
5754
  # @param payment_initiation_payment_create_request [PaymentInitiationPaymentCreateRequest]
5755
5755
  # @param [Hash] opts the optional parameters
5756
5756
  # @return [Array<(PaymentInitiationPaymentCreateResponse, Integer, Hash)>] PaymentInitiationPaymentCreateResponse data, response status code and response headers
@@ -5935,7 +5935,7 @@ module Plaid
5935
5935
  end
5936
5936
 
5937
5937
  # Reverse an existing payment
5938
- # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use `/wallet/transaction/execute`, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
5938
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
5939
5939
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5940
5940
  # @param [Hash] opts the optional parameters
5941
5941
  # @return [PaymentInitiationPaymentReverseResponse]
@@ -5945,7 +5945,7 @@ module Plaid
5945
5945
  end
5946
5946
 
5947
5947
  # Reverse an existing payment
5948
- # Reverse a previously settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded and only full payment refunds are currently supported. To power partial refunds, use &#x60;/wallet/transaction/execute&#x60;, where you can specify the exact amount for a payout to an end user. A payment can only be reversed once and will be refunded back to the same source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account. The refund will be initiated from the same virtual account that the payment was paid into.
5948
+ # Reverse a settled payment from a Plaid virtual account. The original payment must be in a settled state to be refunded. To refund partially, specify the amount as part of the request. If the amount is not specified, the refund amount will be equal to all of the remaining payment amount that has not been refunded yet. If the remaining amount is less than one unit of currency (e.g. 1 GBP or 1 EUR), the refund will fail. The refund will go back to the source account that initiated the payment. The original payment must have been initiated to a Plaid virtual account so that this account can be used to initiate the refund.
5949
5949
  # @param payment_initiation_payment_reverse_request [PaymentInitiationPaymentReverseRequest]
5950
5950
  # @param [Hash] opts the optional parameters
5951
5951
  # @return [Array<(PaymentInitiationPaymentReverseResponse, Integer, Hash)>] PaymentInitiationPaymentReverseResponse data, response status code and response headers
@@ -6000,7 +6000,7 @@ module Plaid
6000
6000
  end
6001
6001
 
6002
6002
  # Create payment recipient
6003
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
6003
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use `bacs` in the UK and `iban` in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same `recipient_id`.
6004
6004
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
6005
6005
  # @param [Hash] opts the optional parameters
6006
6006
  # @return [PaymentInitiationRecipientCreateResponse]
@@ -6010,7 +6010,7 @@ module Plaid
6010
6010
  end
6011
6011
 
6012
6012
  # Create payment recipient
6013
- # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA). For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
6013
+ # Create a payment recipient for payment initiation. The recipient must be in Europe, within a country that is a member of the Single Euro Payment Area (SEPA) or a non-Eurozone country [supported](https://plaid.com/global) by Plaid. For a standing order (recurring) payment, the recipient must be in the UK. It is recommended to use &#x60;bacs&#x60; in the UK and &#x60;iban&#x60; in EU. The endpoint is idempotent: if a developer has already made a request with the same payment details, Plaid will return the same &#x60;recipient_id&#x60;.
6014
6014
  # @param payment_initiation_recipient_create_request [PaymentInitiationRecipientCreateRequest]
6015
6015
  # @param [Hash] opts the optional parameters
6016
6016
  # @return [Array<(PaymentInitiationRecipientCreateResponse, Integer, Hash)>] PaymentInitiationRecipientCreateResponse data, response status code and response headers
@@ -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,31 +7754,31 @@ module Plaid
7754
7754
  return data, status_code, headers
7755
7755
  end
7756
7756
 
7757
- # 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`.
7759
- # @param signal_decision_report_request [SignalDecisionReportRequest]
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 `virtual_time` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `virtual_time`, but may never go back to a lower `virtual_time`. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `virtual_time` = t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current `virtual_time` should be limited such that there are no more than 20 originations resulting from the advance operation on each `recurring_transfer` associated with the `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `virtual_time` up to 80 weeks on each API call.
7759
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7760
7760
  # @param [Hash] opts the optional parameters
7761
- # @return [SignalDecisionReportResponse]
7762
- def signal_decision_report(signal_decision_report_request, opts = {})
7763
- data, _status_code, _headers = signal_decision_report_with_http_info(signal_decision_report_request, opts)
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
7764
  data
7765
7765
  end
7766
7766
 
7767
- # 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;.
7769
- # @param signal_decision_report_request [SignalDecisionReportRequest]
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;virtual_time&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;virtual_time&#x60;, but may never go back to a lower &#x60;virtual_time&#x60;. If a test clock is advanced, we will simulate the changes that ought to occur during the time that elapsed. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;virtual_time&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The advancement of the test clock from its current &#x60;virtual_time&#x60; should be limited such that there are no more than 20 originations resulting from the advance operation on each &#x60;recurring_transfer&#x60; associated with the &#x60;test_clock&#x60;. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;virtual_time&#x60; up to 80 weeks on each API call.
7769
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7770
7770
  # @param [Hash] opts the optional parameters
7771
- # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
7772
- def signal_decision_report_with_http_info(signal_decision_report_request, opts = {})
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
7773
  if @api_client.config.debugging
7774
- @api_client.config.logger.debug 'Calling API: PlaidApi.signal_decision_report ...'
7774
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_advance ...'
7775
7775
  end
7776
- # verify the required parameter 'signal_decision_report_request' is set
7777
- if @api_client.config.client_side_validation && signal_decision_report_request.nil?
7778
- fail ArgumentError, "Missing the required parameter 'signal_decision_report_request' when calling PlaidApi.signal_decision_report"
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
7779
  end
7780
7780
  # resource path
7781
- local_var_path = '/signal/decision/report'
7781
+ local_var_path = '/sandbox/transfer/test_clock/advance'
7782
7782
 
7783
7783
  # query parameters
7784
7784
  query_params = opts[:query_params] || {}
@@ -7794,16 +7794,16 @@ module Plaid
7794
7794
  form_params = opts[:form_params] || {}
7795
7795
 
7796
7796
  # http body (model)
7797
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_decision_report_request)
7797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_advance_request)
7798
7798
 
7799
7799
  # return_type
7800
- return_type = opts[:debug_return_type] || 'SignalDecisionReportResponse'
7800
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockAdvanceResponse'
7801
7801
 
7802
7802
  # auth_names
7803
7803
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7804
7804
 
7805
7805
  new_options = opts.merge(
7806
- :operation => :"PlaidApi.signal_decision_report",
7806
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_advance",
7807
7807
  :header_params => header_params,
7808
7808
  :query_params => query_params,
7809
7809
  :form_params => form_params,
@@ -7814,36 +7814,36 @@ module Plaid
7814
7814
 
7815
7815
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7816
7816
  if @api_client.config.debugging
7817
- @api_client.config.logger.debug "API called: PlaidApi#signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7817
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_advance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7818
7818
  end
7819
7819
  return data, status_code, headers
7820
7820
  end
7821
7821
 
7822
- # 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.
7824
- # @param signal_evaluate_request [SignalEvaluateRequest]
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 `virtual_time` field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
7824
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7825
7825
  # @param [Hash] opts the optional parameters
7826
- # @return [SignalEvaluateResponse]
7827
- def signal_evaluate(signal_evaluate_request, opts = {})
7828
- data, _status_code, _headers = signal_evaluate_with_http_info(signal_evaluate_request, opts)
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
7829
  data
7830
7830
  end
7831
7831
 
7832
- # 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.
7834
- # @param signal_evaluate_request [SignalEvaluateRequest]
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;virtual_time&#x60; field indicating the current timestamp of the timeline. Test clocks are used for testing recurring transfers in Sandbox. A test clock can be associated with up to 5 recurring transfers.
7834
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7835
7835
  # @param [Hash] opts the optional parameters
7836
- # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
7837
- def signal_evaluate_with_http_info(signal_evaluate_request, opts = {})
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
7838
  if @api_client.config.debugging
7839
- @api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
7839
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_create ...'
7840
7840
  end
7841
- # verify the required parameter 'signal_evaluate_request' is set
7842
- if @api_client.config.client_side_validation && signal_evaluate_request.nil?
7843
- fail ArgumentError, "Missing the required parameter 'signal_evaluate_request' when calling PlaidApi.signal_evaluate"
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
7844
  end
7845
7845
  # resource path
7846
- local_var_path = '/signal/evaluate'
7846
+ local_var_path = '/sandbox/transfer/test_clock/create'
7847
7847
 
7848
7848
  # query parameters
7849
7849
  query_params = opts[:query_params] || {}
@@ -7859,16 +7859,16 @@ module Plaid
7859
7859
  form_params = opts[:form_params] || {}
7860
7860
 
7861
7861
  # http body (model)
7862
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)
7862
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_create_request)
7863
7863
 
7864
7864
  # return_type
7865
- return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
7865
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockCreateResponse'
7866
7866
 
7867
7867
  # auth_names
7868
7868
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7869
7869
 
7870
7870
  new_options = opts.merge(
7871
- :operation => :"PlaidApi.signal_evaluate",
7871
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_create",
7872
7872
  :header_params => header_params,
7873
7873
  :query_params => query_params,
7874
7874
  :form_params => form_params,
@@ -7879,36 +7879,36 @@ module Plaid
7879
7879
 
7880
7880
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7881
7881
  if @api_client.config.debugging
7882
- @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7882
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7883
7883
  end
7884
7884
  return data, status_code, headers
7885
7885
  end
7886
7886
 
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.
7889
- # @param signal_prepare_request [SignalPrepareRequest]
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
7890
  # @param [Hash] opts the optional parameters
7891
- # @return [SignalPrepareResponse]
7892
- def signal_prepare(signal_prepare_request, opts = {})
7893
- data, _status_code, _headers = signal_prepare_with_http_info(signal_prepare_request, opts)
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
7894
  data
7895
7895
  end
7896
7896
 
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.
7899
- # @param signal_prepare_request [SignalPrepareRequest]
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
7900
  # @param [Hash] opts the optional parameters
7901
- # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
7902
- def signal_prepare_with_http_info(signal_prepare_request, opts = {})
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
7903
  if @api_client.config.debugging
7904
- @api_client.config.logger.debug 'Calling API: PlaidApi.signal_prepare ...'
7904
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_get ...'
7905
7905
  end
7906
- # verify the required parameter 'signal_prepare_request' is set
7907
- if @api_client.config.client_side_validation && signal_prepare_request.nil?
7908
- fail ArgumentError, "Missing the required parameter 'signal_prepare_request' when calling PlaidApi.signal_prepare"
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
7909
  end
7910
7910
  # resource path
7911
- local_var_path = '/signal/prepare'
7911
+ local_var_path = '/sandbox/transfer/test_clock/get'
7912
7912
 
7913
7913
  # query parameters
7914
7914
  query_params = opts[:query_params] || {}
@@ -7924,16 +7924,16 @@ module Plaid
7924
7924
  form_params = opts[:form_params] || {}
7925
7925
 
7926
7926
  # http body (model)
7927
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_prepare_request)
7927
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_get_request)
7928
7928
 
7929
7929
  # return_type
7930
- return_type = opts[:debug_return_type] || 'SignalPrepareResponse'
7930
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockGetResponse'
7931
7931
 
7932
7932
  # auth_names
7933
7933
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7934
7934
 
7935
7935
  new_options = opts.merge(
7936
- :operation => :"PlaidApi.signal_prepare",
7936
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_get",
7937
7937
  :header_params => header_params,
7938
7938
  :query_params => query_params,
7939
7939
  :form_params => form_params,
@@ -7944,36 +7944,36 @@ module Plaid
7944
7944
 
7945
7945
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7946
7946
  if @api_client.config.debugging
7947
- @api_client.config.logger.debug "API called: PlaidApi#signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7947
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7948
7948
  end
7949
7949
  return data, status_code, headers
7950
7950
  end
7951
7951
 
7952
- # Report a return for an ACH transaction
7953
- # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7954
- # @param signal_return_report_request [SignalReturnReportRequest]
7952
+ # List test clocks
7953
+ # Use the `/sandbox/transfer/test_clock/list` endpoint to see a list of all your test clocks in the Sandbox environment, by ascending `virtual_time`. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired test clocks.
7954
+ # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
7955
7955
  # @param [Hash] opts the optional parameters
7956
- # @return [SignalReturnReportResponse]
7957
- def signal_return_report(signal_return_report_request, opts = {})
7958
- data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
7956
+ # @return [SandboxTransferTestClockListResponse]
7957
+ def sandbox_transfer_test_clock_list(sandbox_transfer_test_clock_list_request, opts = {})
7958
+ data, _status_code, _headers = sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts)
7959
7959
  data
7960
7960
  end
7961
7961
 
7962
- # Report a return for an ACH transaction
7963
- # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
7964
- # @param signal_return_report_request [SignalReturnReportRequest]
7962
+ # List test clocks
7963
+ # Use the &#x60;/sandbox/transfer/test_clock/list&#x60; endpoint to see a list of all your test clocks in the Sandbox environment, by ascending &#x60;virtual_time&#x60;. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired test clocks.
7964
+ # @param sandbox_transfer_test_clock_list_request [SandboxTransferTestClockListRequest]
7965
7965
  # @param [Hash] opts the optional parameters
7966
- # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
7967
- def signal_return_report_with_http_info(signal_return_report_request, opts = {})
7966
+ # @return [Array<(SandboxTransferTestClockListResponse, Integer, Hash)>] SandboxTransferTestClockListResponse data, response status code and response headers
7967
+ def sandbox_transfer_test_clock_list_with_http_info(sandbox_transfer_test_clock_list_request, opts = {})
7968
7968
  if @api_client.config.debugging
7969
- @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
7969
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_list ...'
7970
7970
  end
7971
- # verify the required parameter 'signal_return_report_request' is set
7972
- if @api_client.config.client_side_validation && signal_return_report_request.nil?
7973
- fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
7971
+ # verify the required parameter 'sandbox_transfer_test_clock_list_request' is set
7972
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_list_request.nil?
7973
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_list_request' when calling PlaidApi.sandbox_transfer_test_clock_list"
7974
7974
  end
7975
7975
  # resource path
7976
- local_var_path = '/signal/return/report'
7976
+ local_var_path = '/sandbox/transfer/test_clock/list'
7977
7977
 
7978
7978
  # query parameters
7979
7979
  query_params = opts[:query_params] || {}
@@ -7989,16 +7989,16 @@ module Plaid
7989
7989
  form_params = opts[:form_params] || {}
7990
7990
 
7991
7991
  # http body (model)
7992
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
7992
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_list_request)
7993
7993
 
7994
7994
  # return_type
7995
- return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
7995
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockListResponse'
7996
7996
 
7997
7997
  # auth_names
7998
7998
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7999
7999
 
8000
8000
  new_options = opts.merge(
8001
- :operation => :"PlaidApi.signal_return_report",
8001
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_list",
8002
8002
  :header_params => header_params,
8003
8003
  :query_params => query_params,
8004
8004
  :form_params => form_params,
@@ -8009,36 +8009,36 @@ module Plaid
8009
8009
 
8010
8010
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8011
8011
  if @api_client.config.debugging
8012
- @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8012
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8013
8013
  end
8014
8014
  return data, status_code, headers
8015
8015
  end
8016
8016
 
8017
- # enhance locally-held transaction data
8018
- # The '/beta/transactions/v1/enhance' endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8019
- # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8017
+ # Report whether you initiated an ACH transaction
8018
+ # 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`.
8019
+ # @param signal_decision_report_request [SignalDecisionReportRequest]
8020
8020
  # @param [Hash] opts the optional parameters
8021
- # @return [TransactionsEnhanceGetResponse]
8022
- def transactions_enhance(transactions_enhance_get_request, opts = {})
8023
- data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
8021
+ # @return [SignalDecisionReportResponse]
8022
+ def signal_decision_report(signal_decision_report_request, opts = {})
8023
+ data, _status_code, _headers = signal_decision_report_with_http_info(signal_decision_report_request, opts)
8024
8024
  data
8025
8025
  end
8026
8026
 
8027
- # enhance locally-held transaction data
8028
- # The &#39;/beta/transactions/v1/enhance&#39; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8029
- # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8027
+ # Report whether you initiated an ACH transaction
8028
+ # 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;.
8029
+ # @param signal_decision_report_request [SignalDecisionReportRequest]
8030
8030
  # @param [Hash] opts the optional parameters
8031
- # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
8032
- def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
8031
+ # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
8032
+ def signal_decision_report_with_http_info(signal_decision_report_request, opts = {})
8033
8033
  if @api_client.config.debugging
8034
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
8034
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_decision_report ...'
8035
8035
  end
8036
- # verify the required parameter 'transactions_enhance_get_request' is set
8037
- if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
8038
- fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
8036
+ # verify the required parameter 'signal_decision_report_request' is set
8037
+ if @api_client.config.client_side_validation && signal_decision_report_request.nil?
8038
+ fail ArgumentError, "Missing the required parameter 'signal_decision_report_request' when calling PlaidApi.signal_decision_report"
8039
8039
  end
8040
8040
  # resource path
8041
- local_var_path = '/beta/transactions/v1/enhance'
8041
+ local_var_path = '/signal/decision/report'
8042
8042
 
8043
8043
  # query parameters
8044
8044
  query_params = opts[:query_params] || {}
@@ -8054,16 +8054,16 @@ module Plaid
8054
8054
  form_params = opts[:form_params] || {}
8055
8055
 
8056
8056
  # http body (model)
8057
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)
8057
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_decision_report_request)
8058
8058
 
8059
8059
  # return_type
8060
- return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'
8060
+ return_type = opts[:debug_return_type] || 'SignalDecisionReportResponse'
8061
8061
 
8062
8062
  # auth_names
8063
8063
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8064
8064
 
8065
8065
  new_options = opts.merge(
8066
- :operation => :"PlaidApi.transactions_enhance",
8066
+ :operation => :"PlaidApi.signal_decision_report",
8067
8067
  :header_params => header_params,
8068
8068
  :query_params => query_params,
8069
8069
  :form_params => form_params,
@@ -8074,36 +8074,36 @@ module Plaid
8074
8074
 
8075
8075
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8076
8076
  if @api_client.config.debugging
8077
- @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8077
+ @api_client.config.logger.debug "API called: PlaidApi#signal_decision_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8078
8078
  end
8079
8079
  return data, status_code, headers
8080
8080
  end
8081
8081
 
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]
8082
+ # Evaluate a planned ACH transaction
8083
+ # 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.
8084
+ # @param signal_evaluate_request [SignalEvaluateRequest]
8085
8085
  # @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)
8086
+ # @return [SignalEvaluateResponse]
8087
+ def signal_evaluate(signal_evaluate_request, opts = {})
8088
+ data, _status_code, _headers = signal_evaluate_with_http_info(signal_evaluate_request, opts)
8089
8089
  data
8090
8090
  end
8091
8091
 
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]
8092
+ # Evaluate a planned ACH transaction
8093
+ # 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.
8094
+ # @param signal_evaluate_request [SignalEvaluateRequest]
8095
8095
  # @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 = {})
8096
+ # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
8097
+ def signal_evaluate_with_http_info(signal_evaluate_request, opts = {})
8098
8098
  if @api_client.config.debugging
8099
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
8099
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_evaluate ...'
8100
8100
  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"
8101
+ # verify the required parameter 'signal_evaluate_request' is set
8102
+ if @api_client.config.client_side_validation && signal_evaluate_request.nil?
8103
+ fail ArgumentError, "Missing the required parameter 'signal_evaluate_request' when calling PlaidApi.signal_evaluate"
8104
8104
  end
8105
8105
  # resource path
8106
- local_var_path = '/transactions/get'
8106
+ local_var_path = '/signal/evaluate'
8107
8107
 
8108
8108
  # query parameters
8109
8109
  query_params = opts[:query_params] || {}
@@ -8119,16 +8119,16 @@ module Plaid
8119
8119
  form_params = opts[:form_params] || {}
8120
8120
 
8121
8121
  # http body (model)
8122
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
8122
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)
8123
8123
 
8124
8124
  # return_type
8125
- return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
8125
+ return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
8126
8126
 
8127
8127
  # auth_names
8128
8128
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8129
8129
 
8130
8130
  new_options = opts.merge(
8131
- :operation => :"PlaidApi.transactions_get",
8131
+ :operation => :"PlaidApi.signal_evaluate",
8132
8132
  :header_params => header_params,
8133
8133
  :query_params => query_params,
8134
8134
  :form_params => form_params,
@@ -8139,36 +8139,1076 @@ module Plaid
8139
8139
 
8140
8140
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8141
8141
  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}"
8142
+ @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8143
8143
  end
8144
8144
  return data, status_code, headers
8145
8145
  end
8146
8146
 
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]
8147
+ # Opt-in an Item to Signal
8148
+ # 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).
8149
+ # @param signal_prepare_request [SignalPrepareRequest]
8150
8150
  # @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)
8151
+ # @return [SignalPrepareResponse]
8152
+ def signal_prepare(signal_prepare_request, opts = {})
8153
+ data, _status_code, _headers = signal_prepare_with_http_info(signal_prepare_request, opts)
8154
8154
  data
8155
8155
  end
8156
8156
 
8157
- # 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.
8159
- # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8157
+ # Opt-in an Item to Signal
8158
+ # 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).
8159
+ # @param signal_prepare_request [SignalPrepareRequest]
8160
8160
  # @param [Hash] opts the optional parameters
8161
- # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
8162
- def transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {})
8163
- if @api_client.config.debugging
8161
+ # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
8162
+ def signal_prepare_with_http_info(signal_prepare_request, opts = {})
8163
+ if @api_client.config.debugging
8164
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_prepare ...'
8165
+ end
8166
+ # verify the required parameter 'signal_prepare_request' is set
8167
+ if @api_client.config.client_side_validation && signal_prepare_request.nil?
8168
+ fail ArgumentError, "Missing the required parameter 'signal_prepare_request' when calling PlaidApi.signal_prepare"
8169
+ end
8170
+ # resource path
8171
+ local_var_path = '/signal/prepare'
8172
+
8173
+ # query parameters
8174
+ query_params = opts[:query_params] || {}
8175
+
8176
+ # header parameters
8177
+ header_params = opts[:header_params] || {}
8178
+ # HTTP header 'Accept' (if needed)
8179
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8180
+ # HTTP header 'Content-Type'
8181
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8182
+
8183
+ # form parameters
8184
+ form_params = opts[:form_params] || {}
8185
+
8186
+ # http body (model)
8187
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_prepare_request)
8188
+
8189
+ # return_type
8190
+ return_type = opts[:debug_return_type] || 'SignalPrepareResponse'
8191
+
8192
+ # auth_names
8193
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8194
+
8195
+ new_options = opts.merge(
8196
+ :operation => :"PlaidApi.signal_prepare",
8197
+ :header_params => header_params,
8198
+ :query_params => query_params,
8199
+ :form_params => form_params,
8200
+ :body => post_body,
8201
+ :auth_names => auth_names,
8202
+ :return_type => return_type
8203
+ )
8204
+
8205
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8206
+ if @api_client.config.debugging
8207
+ @api_client.config.logger.debug "API called: PlaidApi#signal_prepare\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8208
+ end
8209
+ return data, status_code, headers
8210
+ end
8211
+
8212
+ # Report a return for an ACH transaction
8213
+ # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
8214
+ # @param signal_return_report_request [SignalReturnReportRequest]
8215
+ # @param [Hash] opts the optional parameters
8216
+ # @return [SignalReturnReportResponse]
8217
+ def signal_return_report(signal_return_report_request, opts = {})
8218
+ data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
8219
+ data
8220
+ end
8221
+
8222
+ # Report a return for an ACH transaction
8223
+ # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
8224
+ # @param signal_return_report_request [SignalReturnReportRequest]
8225
+ # @param [Hash] opts the optional parameters
8226
+ # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
8227
+ def signal_return_report_with_http_info(signal_return_report_request, opts = {})
8228
+ if @api_client.config.debugging
8229
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
8230
+ end
8231
+ # verify the required parameter 'signal_return_report_request' is set
8232
+ if @api_client.config.client_side_validation && signal_return_report_request.nil?
8233
+ fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
8234
+ end
8235
+ # resource path
8236
+ local_var_path = '/signal/return/report'
8237
+
8238
+ # query parameters
8239
+ query_params = opts[:query_params] || {}
8240
+
8241
+ # header parameters
8242
+ header_params = opts[:header_params] || {}
8243
+ # HTTP header 'Accept' (if needed)
8244
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8245
+ # HTTP header 'Content-Type'
8246
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8247
+
8248
+ # form parameters
8249
+ form_params = opts[:form_params] || {}
8250
+
8251
+ # http body (model)
8252
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
8253
+
8254
+ # return_type
8255
+ return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
8256
+
8257
+ # auth_names
8258
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8259
+
8260
+ new_options = opts.merge(
8261
+ :operation => :"PlaidApi.signal_return_report",
8262
+ :header_params => header_params,
8263
+ :query_params => query_params,
8264
+ :form_params => form_params,
8265
+ :body => post_body,
8266
+ :auth_names => auth_names,
8267
+ :return_type => return_type
8268
+ )
8269
+
8270
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8271
+ if @api_client.config.debugging
8272
+ @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8273
+ end
8274
+ return data, status_code, headers
8275
+ end
8276
+
8277
+ # enhance locally-held transaction data
8278
+ # The `/beta/transactions/v1/enhance` endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8279
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8280
+ # @param [Hash] opts the optional parameters
8281
+ # @return [TransactionsEnhanceGetResponse]
8282
+ def transactions_enhance(transactions_enhance_get_request, opts = {})
8283
+ data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
8284
+ data
8285
+ end
8286
+
8287
+ # enhance locally-held transaction data
8288
+ # The &#x60;/beta/transactions/v1/enhance&#x60; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
8289
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
8290
+ # @param [Hash] opts the optional parameters
8291
+ # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
8292
+ def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
8293
+ if @api_client.config.debugging
8294
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
8295
+ end
8296
+ # verify the required parameter 'transactions_enhance_get_request' is set
8297
+ if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
8298
+ fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
8299
+ end
8300
+ # resource path
8301
+ local_var_path = '/beta/transactions/v1/enhance'
8302
+
8303
+ # query parameters
8304
+ query_params = opts[:query_params] || {}
8305
+
8306
+ # header parameters
8307
+ header_params = opts[:header_params] || {}
8308
+ # HTTP header 'Accept' (if needed)
8309
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8310
+ # HTTP header 'Content-Type'
8311
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8312
+
8313
+ # form parameters
8314
+ form_params = opts[:form_params] || {}
8315
+
8316
+ # http body (model)
8317
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)
8318
+
8319
+ # return_type
8320
+ return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'
8321
+
8322
+ # auth_names
8323
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8324
+
8325
+ new_options = opts.merge(
8326
+ :operation => :"PlaidApi.transactions_enhance",
8327
+ :header_params => header_params,
8328
+ :query_params => query_params,
8329
+ :form_params => form_params,
8330
+ :body => post_body,
8331
+ :auth_names => auth_names,
8332
+ :return_type => return_type
8333
+ )
8334
+
8335
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8336
+ if @api_client.config.debugging
8337
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8338
+ end
8339
+ return data, status_code, headers
8340
+ end
8341
+
8342
+ # Enrich locally-held transaction data
8343
+ # The `/transactions/enrich` endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8344
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8345
+ # @param [Hash] opts the optional parameters
8346
+ # @return [TransactionsEnrichGetResponse]
8347
+ def transactions_enrich(transactions_enrich_get_request, opts = {})
8348
+ data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_get_request, opts)
8349
+ data
8350
+ end
8351
+
8352
+ # Enrich locally-held transaction data
8353
+ # The &#x60;/transactions/enrich&#x60; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact enrich-feedback@plaid.com
8354
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8355
+ # @param [Hash] opts the optional parameters
8356
+ # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
8357
+ def transactions_enrich_with_http_info(transactions_enrich_get_request, opts = {})
8358
+ if @api_client.config.debugging
8359
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
8360
+ end
8361
+ # verify the required parameter 'transactions_enrich_get_request' is set
8362
+ if @api_client.config.client_side_validation && transactions_enrich_get_request.nil?
8363
+ fail ArgumentError, "Missing the required parameter 'transactions_enrich_get_request' when calling PlaidApi.transactions_enrich"
8364
+ end
8365
+ # resource path
8366
+ local_var_path = '/transactions/enrich'
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_enrich_get_request)
8383
+
8384
+ # return_type
8385
+ return_type = opts[:debug_return_type] || 'TransactionsEnrichGetResponse'
8386
+
8387
+ # auth_names
8388
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8389
+
8390
+ new_options = opts.merge(
8391
+ :operation => :"PlaidApi.transactions_enrich",
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_enrich\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8403
+ end
8404
+ return data, status_code, headers
8405
+ end
8406
+
8407
+ # Get transaction data
8408
+ # 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.
8409
+ # @param transactions_get_request [TransactionsGetRequest]
8410
+ # @param [Hash] opts the optional parameters
8411
+ # @return [TransactionsGetResponse]
8412
+ def transactions_get(transactions_get_request, opts = {})
8413
+ data, _status_code, _headers = transactions_get_with_http_info(transactions_get_request, opts)
8414
+ data
8415
+ end
8416
+
8417
+ # Get transaction data
8418
+ # 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.
8419
+ # @param transactions_get_request [TransactionsGetRequest]
8420
+ # @param [Hash] opts the optional parameters
8421
+ # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
8422
+ def transactions_get_with_http_info(transactions_get_request, opts = {})
8423
+ if @api_client.config.debugging
8424
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_get ...'
8425
+ end
8426
+ # verify the required parameter 'transactions_get_request' is set
8427
+ if @api_client.config.client_side_validation && transactions_get_request.nil?
8428
+ fail ArgumentError, "Missing the required parameter 'transactions_get_request' when calling PlaidApi.transactions_get"
8429
+ end
8430
+ # resource path
8431
+ local_var_path = '/transactions/get'
8432
+
8433
+ # query parameters
8434
+ query_params = opts[:query_params] || {}
8435
+
8436
+ # header parameters
8437
+ header_params = opts[:header_params] || {}
8438
+ # HTTP header 'Accept' (if needed)
8439
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8440
+ # HTTP header 'Content-Type'
8441
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8442
+
8443
+ # form parameters
8444
+ form_params = opts[:form_params] || {}
8445
+
8446
+ # http body (model)
8447
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_get_request)
8448
+
8449
+ # return_type
8450
+ return_type = opts[:debug_return_type] || 'TransactionsGetResponse'
8451
+
8452
+ # auth_names
8453
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8454
+
8455
+ new_options = opts.merge(
8456
+ :operation => :"PlaidApi.transactions_get",
8457
+ :header_params => header_params,
8458
+ :query_params => query_params,
8459
+ :form_params => form_params,
8460
+ :body => post_body,
8461
+ :auth_names => auth_names,
8462
+ :return_type => return_type
8463
+ )
8464
+
8465
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8466
+ if @api_client.config.debugging
8467
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8468
+ end
8469
+ return data, status_code, headers
8470
+ end
8471
+
8472
+ # Fetch recurring transaction streams
8473
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in `/link/token/create`; or after Link, by calling `/transactions/get`). After the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call `/transactions/recurring/get` to receive the Recurring Transactions streams and subscribe to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [`RECURRING_TRANSACTIONS_UPDATE`](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8474
+ # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8475
+ # @param [Hash] opts the optional parameters
8476
+ # @return [TransactionsRecurringGetResponse]
8477
+ def transactions_recurring_get(transactions_recurring_get_request, opts = {})
8478
+ data, _status_code, _headers = transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts)
8479
+ data
8480
+ end
8481
+
8482
+ # Fetch recurring transaction streams
8483
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. This endpoint can only be called on an Item that has already been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;; or after Link, by calling &#x60;/transactions/get&#x60;). After the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired, call &#x60;/transactions/recurring/get&#x60; to receive the Recurring Transactions streams and subscribe to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook. After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Listen to the [&#x60;RECURRING_TRANSACTIONS_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#recurring_transactions_update) webhook to be notified when new updates are available.
8484
+ # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
8485
+ # @param [Hash] opts the optional parameters
8486
+ # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
8487
+ def transactions_recurring_get_with_http_info(transactions_recurring_get_request, opts = {})
8488
+ if @api_client.config.debugging
8164
8489
  @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_recurring_get ...'
8165
8490
  end
8166
- # verify the required parameter 'transactions_recurring_get_request' is set
8167
- if @api_client.config.client_side_validation && transactions_recurring_get_request.nil?
8168
- fail ArgumentError, "Missing the required parameter 'transactions_recurring_get_request' when calling PlaidApi.transactions_recurring_get"
8491
+ # verify the required parameter 'transactions_recurring_get_request' is set
8492
+ if @api_client.config.client_side_validation && transactions_recurring_get_request.nil?
8493
+ fail ArgumentError, "Missing the required parameter 'transactions_recurring_get_request' when calling PlaidApi.transactions_recurring_get"
8494
+ end
8495
+ # resource path
8496
+ local_var_path = '/transactions/recurring/get'
8497
+
8498
+ # query parameters
8499
+ query_params = opts[:query_params] || {}
8500
+
8501
+ # header parameters
8502
+ header_params = opts[:header_params] || {}
8503
+ # HTTP header 'Accept' (if needed)
8504
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8505
+ # HTTP header 'Content-Type'
8506
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8507
+
8508
+ # form parameters
8509
+ form_params = opts[:form_params] || {}
8510
+
8511
+ # http body (model)
8512
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_get_request)
8513
+
8514
+ # return_type
8515
+ return_type = opts[:debug_return_type] || 'TransactionsRecurringGetResponse'
8516
+
8517
+ # auth_names
8518
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8519
+
8520
+ new_options = opts.merge(
8521
+ :operation => :"PlaidApi.transactions_recurring_get",
8522
+ :header_params => header_params,
8523
+ :query_params => query_params,
8524
+ :form_params => form_params,
8525
+ :body => post_body,
8526
+ :auth_names => auth_names,
8527
+ :return_type => return_type
8528
+ )
8529
+
8530
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8531
+ if @api_client.config.debugging
8532
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8533
+ end
8534
+ return data, status_code, headers
8535
+ end
8536
+
8537
+ # Refresh transaction data
8538
+ # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
8539
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
8540
+ # @param [Hash] opts the optional parameters
8541
+ # @return [TransactionsRefreshResponse]
8542
+ def transactions_refresh(transactions_refresh_request, opts = {})
8543
+ data, _status_code, _headers = transactions_refresh_with_http_info(transactions_refresh_request, opts)
8544
+ data
8545
+ end
8546
+
8547
+ # Refresh transaction data
8548
+ # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UDPATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
8549
+ # @param transactions_refresh_request [TransactionsRefreshRequest]
8550
+ # @param [Hash] opts the optional parameters
8551
+ # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
8552
+ def transactions_refresh_with_http_info(transactions_refresh_request, opts = {})
8553
+ if @api_client.config.debugging
8554
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_refresh ...'
8555
+ end
8556
+ # verify the required parameter 'transactions_refresh_request' is set
8557
+ if @api_client.config.client_side_validation && transactions_refresh_request.nil?
8558
+ fail ArgumentError, "Missing the required parameter 'transactions_refresh_request' when calling PlaidApi.transactions_refresh"
8559
+ end
8560
+ # resource path
8561
+ local_var_path = '/transactions/refresh'
8562
+
8563
+ # query parameters
8564
+ query_params = opts[:query_params] || {}
8565
+
8566
+ # header parameters
8567
+ header_params = opts[:header_params] || {}
8568
+ # HTTP header 'Accept' (if needed)
8569
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8570
+ # HTTP header 'Content-Type'
8571
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8572
+
8573
+ # form parameters
8574
+ form_params = opts[:form_params] || {}
8575
+
8576
+ # http body (model)
8577
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_refresh_request)
8578
+
8579
+ # return_type
8580
+ return_type = opts[:debug_return_type] || 'TransactionsRefreshResponse'
8581
+
8582
+ # auth_names
8583
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8584
+
8585
+ new_options = opts.merge(
8586
+ :operation => :"PlaidApi.transactions_refresh",
8587
+ :header_params => header_params,
8588
+ :query_params => query_params,
8589
+ :form_params => form_params,
8590
+ :body => post_body,
8591
+ :auth_names => auth_names,
8592
+ :return_type => return_type
8593
+ )
8594
+
8595
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8596
+ if @api_client.config.debugging
8597
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8598
+ end
8599
+ return data, status_code, headers
8600
+ end
8601
+
8602
+ # Create transaction category rule
8603
+ # The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
8604
+ # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
8605
+ # @param [Hash] opts the optional parameters
8606
+ # @return [TransactionsRulesCreateResponse]
8607
+ def transactions_rules_create(transactions_rules_create_request, opts = {})
8608
+ data, _status_code, _headers = transactions_rules_create_with_http_info(transactions_rules_create_request, opts)
8609
+ data
8610
+ end
8611
+
8612
+ # Create transaction category rule
8613
+ # The &#x60;/transactions/rules/v1/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
8614
+ # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
8615
+ # @param [Hash] opts the optional parameters
8616
+ # @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
8617
+ def transactions_rules_create_with_http_info(transactions_rules_create_request, opts = {})
8618
+ if @api_client.config.debugging
8619
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_create ...'
8620
+ end
8621
+ # verify the required parameter 'transactions_rules_create_request' is set
8622
+ if @api_client.config.client_side_validation && transactions_rules_create_request.nil?
8623
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_create_request' when calling PlaidApi.transactions_rules_create"
8624
+ end
8625
+ # resource path
8626
+ local_var_path = '/beta/transactions/rules/v1/create'
8627
+
8628
+ # query parameters
8629
+ query_params = opts[:query_params] || {}
8630
+
8631
+ # header parameters
8632
+ header_params = opts[:header_params] || {}
8633
+ # HTTP header 'Accept' (if needed)
8634
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8635
+ # HTTP header 'Content-Type'
8636
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8637
+
8638
+ # form parameters
8639
+ form_params = opts[:form_params] || {}
8640
+
8641
+ # http body (model)
8642
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_create_request)
8643
+
8644
+ # return_type
8645
+ return_type = opts[:debug_return_type] || 'TransactionsRulesCreateResponse'
8646
+
8647
+ # auth_names
8648
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8649
+
8650
+ new_options = opts.merge(
8651
+ :operation => :"PlaidApi.transactions_rules_create",
8652
+ :header_params => header_params,
8653
+ :query_params => query_params,
8654
+ :form_params => form_params,
8655
+ :body => post_body,
8656
+ :auth_names => auth_names,
8657
+ :return_type => return_type
8658
+ )
8659
+
8660
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8661
+ if @api_client.config.debugging
8662
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8663
+ end
8664
+ return data, status_code, headers
8665
+ end
8666
+
8667
+ # Return a list of rules created for the Item associated with the access token.
8668
+ # The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
8669
+ # @param transactions_rules_list_request [TransactionsRulesListRequest]
8670
+ # @param [Hash] opts the optional parameters
8671
+ # @return [TransactionsRulesListResponse]
8672
+ def transactions_rules_list(transactions_rules_list_request, opts = {})
8673
+ data, _status_code, _headers = transactions_rules_list_with_http_info(transactions_rules_list_request, opts)
8674
+ data
8675
+ end
8676
+
8677
+ # Return a list of rules created for the Item associated with the access token.
8678
+ # The &#x60;/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
8679
+ # @param transactions_rules_list_request [TransactionsRulesListRequest]
8680
+ # @param [Hash] opts the optional parameters
8681
+ # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
8682
+ def transactions_rules_list_with_http_info(transactions_rules_list_request, opts = {})
8683
+ if @api_client.config.debugging
8684
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_list ...'
8685
+ end
8686
+ # verify the required parameter 'transactions_rules_list_request' is set
8687
+ if @api_client.config.client_side_validation && transactions_rules_list_request.nil?
8688
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_list_request' when calling PlaidApi.transactions_rules_list"
8689
+ end
8690
+ # resource path
8691
+ local_var_path = '/beta/transactions/rules/v1/list'
8692
+
8693
+ # query parameters
8694
+ query_params = opts[:query_params] || {}
8695
+
8696
+ # header parameters
8697
+ header_params = opts[:header_params] || {}
8698
+ # HTTP header 'Accept' (if needed)
8699
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8700
+ # HTTP header 'Content-Type'
8701
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8702
+
8703
+ # form parameters
8704
+ form_params = opts[:form_params] || {}
8705
+
8706
+ # http body (model)
8707
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_list_request)
8708
+
8709
+ # return_type
8710
+ return_type = opts[:debug_return_type] || 'TransactionsRulesListResponse'
8711
+
8712
+ # auth_names
8713
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8714
+
8715
+ new_options = opts.merge(
8716
+ :operation => :"PlaidApi.transactions_rules_list",
8717
+ :header_params => header_params,
8718
+ :query_params => query_params,
8719
+ :form_params => form_params,
8720
+ :body => post_body,
8721
+ :auth_names => auth_names,
8722
+ :return_type => return_type
8723
+ )
8724
+
8725
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8726
+ if @api_client.config.debugging
8727
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8728
+ end
8729
+ return data, status_code, headers
8730
+ end
8731
+
8732
+ # Remove transaction rule
8733
+ # The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
8734
+ # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
8735
+ # @param [Hash] opts the optional parameters
8736
+ # @return [TransactionsRulesRemoveResponse]
8737
+ def transactions_rules_remove(transactions_rules_remove_request, opts = {})
8738
+ data, _status_code, _headers = transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts)
8739
+ data
8740
+ end
8741
+
8742
+ # Remove transaction rule
8743
+ # The &#x60;/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
8744
+ # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
8745
+ # @param [Hash] opts the optional parameters
8746
+ # @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
8747
+ def transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts = {})
8748
+ if @api_client.config.debugging
8749
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_remove ...'
8750
+ end
8751
+ # verify the required parameter 'transactions_rules_remove_request' is set
8752
+ if @api_client.config.client_side_validation && transactions_rules_remove_request.nil?
8753
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_remove_request' when calling PlaidApi.transactions_rules_remove"
8754
+ end
8755
+ # resource path
8756
+ local_var_path = '/beta/transactions/rules/v1/remove'
8757
+
8758
+ # query parameters
8759
+ query_params = opts[:query_params] || {}
8760
+
8761
+ # header parameters
8762
+ header_params = opts[:header_params] || {}
8763
+ # HTTP header 'Accept' (if needed)
8764
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8765
+ # HTTP header 'Content-Type'
8766
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8767
+
8768
+ # form parameters
8769
+ form_params = opts[:form_params] || {}
8770
+
8771
+ # http body (model)
8772
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_remove_request)
8773
+
8774
+ # return_type
8775
+ return_type = opts[:debug_return_type] || 'TransactionsRulesRemoveResponse'
8776
+
8777
+ # auth_names
8778
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8779
+
8780
+ new_options = opts.merge(
8781
+ :operation => :"PlaidApi.transactions_rules_remove",
8782
+ :header_params => header_params,
8783
+ :query_params => query_params,
8784
+ :form_params => form_params,
8785
+ :body => post_body,
8786
+ :auth_names => auth_names,
8787
+ :return_type => return_type
8788
+ )
8789
+
8790
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8791
+ if @api_client.config.debugging
8792
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8793
+ end
8794
+ return data, status_code, headers
8795
+ end
8796
+
8797
+ # Get incremental transaction updates on an Item
8798
+ # 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.
8799
+ # @param transactions_sync_request [TransactionsSyncRequest]
8800
+ # @param [Hash] opts the optional parameters
8801
+ # @return [TransactionsSyncResponse]
8802
+ def transactions_sync(transactions_sync_request, opts = {})
8803
+ data, _status_code, _headers = transactions_sync_with_http_info(transactions_sync_request, opts)
8804
+ data
8805
+ end
8806
+
8807
+ # Get incremental transaction updates on an Item
8808
+ # 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.
8809
+ # @param transactions_sync_request [TransactionsSyncRequest]
8810
+ # @param [Hash] opts the optional parameters
8811
+ # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
8812
+ def transactions_sync_with_http_info(transactions_sync_request, opts = {})
8813
+ if @api_client.config.debugging
8814
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
8815
+ end
8816
+ # verify the required parameter 'transactions_sync_request' is set
8817
+ if @api_client.config.client_side_validation && transactions_sync_request.nil?
8818
+ fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
8819
+ end
8820
+ # resource path
8821
+ local_var_path = '/transactions/sync'
8822
+
8823
+ # query parameters
8824
+ query_params = opts[:query_params] || {}
8825
+
8826
+ # header parameters
8827
+ header_params = opts[:header_params] || {}
8828
+ # HTTP header 'Accept' (if needed)
8829
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8830
+ # HTTP header 'Content-Type'
8831
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8832
+
8833
+ # form parameters
8834
+ form_params = opts[:form_params] || {}
8835
+
8836
+ # http body (model)
8837
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
8838
+
8839
+ # return_type
8840
+ return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
8841
+
8842
+ # auth_names
8843
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8844
+
8845
+ new_options = opts.merge(
8846
+ :operation => :"PlaidApi.transactions_sync",
8847
+ :header_params => header_params,
8848
+ :query_params => query_params,
8849
+ :form_params => form_params,
8850
+ :body => post_body,
8851
+ :auth_names => auth_names,
8852
+ :return_type => return_type
8853
+ )
8854
+
8855
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8856
+ if @api_client.config.debugging
8857
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8858
+ end
8859
+ return data, status_code, headers
8860
+ end
8861
+
8862
+ # Create a transfer authorization
8863
+ # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
8864
+ # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8865
+ # @param [Hash] opts the optional parameters
8866
+ # @return [TransferAuthorizationCreateResponse]
8867
+ def transfer_authorization_create(transfer_authorization_create_request, opts = {})
8868
+ data, _status_code, _headers = transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts)
8869
+ data
8870
+ end
8871
+
8872
+ # Create a transfer authorization
8873
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60; are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : &#x60;idempotency_key&#x60;, &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.
8874
+ # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8875
+ # @param [Hash] opts the optional parameters
8876
+ # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
8877
+ def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
8878
+ if @api_client.config.debugging
8879
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
8880
+ end
8881
+ # verify the required parameter 'transfer_authorization_create_request' is set
8882
+ if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
8883
+ fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
8884
+ end
8885
+ # resource path
8886
+ local_var_path = '/transfer/authorization/create'
8887
+
8888
+ # query parameters
8889
+ query_params = opts[:query_params] || {}
8890
+
8891
+ # header parameters
8892
+ header_params = opts[:header_params] || {}
8893
+ # HTTP header 'Accept' (if needed)
8894
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8895
+ # HTTP header 'Content-Type'
8896
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8897
+
8898
+ # form parameters
8899
+ form_params = opts[:form_params] || {}
8900
+
8901
+ # http body (model)
8902
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)
8903
+
8904
+ # return_type
8905
+ return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'
8906
+
8907
+ # auth_names
8908
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8909
+
8910
+ new_options = opts.merge(
8911
+ :operation => :"PlaidApi.transfer_authorization_create",
8912
+ :header_params => header_params,
8913
+ :query_params => query_params,
8914
+ :form_params => form_params,
8915
+ :body => post_body,
8916
+ :auth_names => auth_names,
8917
+ :return_type => return_type
8918
+ )
8919
+
8920
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8921
+ if @api_client.config.debugging
8922
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8923
+ end
8924
+ return data, status_code, headers
8925
+ end
8926
+
8927
+ # Cancel a transfer
8928
+ # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
8929
+ # @param transfer_cancel_request [TransferCancelRequest]
8930
+ # @param [Hash] opts the optional parameters
8931
+ # @return [TransferCancelResponse]
8932
+ def transfer_cancel(transfer_cancel_request, opts = {})
8933
+ data, _status_code, _headers = transfer_cancel_with_http_info(transfer_cancel_request, opts)
8934
+ data
8935
+ end
8936
+
8937
+ # Cancel a transfer
8938
+ # Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancellation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
8939
+ # @param transfer_cancel_request [TransferCancelRequest]
8940
+ # @param [Hash] opts the optional parameters
8941
+ # @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
8942
+ def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
8943
+ if @api_client.config.debugging
8944
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
8945
+ end
8946
+ # verify the required parameter 'transfer_cancel_request' is set
8947
+ if @api_client.config.client_side_validation && transfer_cancel_request.nil?
8948
+ fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
8949
+ end
8950
+ # resource path
8951
+ local_var_path = '/transfer/cancel'
8952
+
8953
+ # query parameters
8954
+ query_params = opts[:query_params] || {}
8955
+
8956
+ # header parameters
8957
+ header_params = opts[:header_params] || {}
8958
+ # HTTP header 'Accept' (if needed)
8959
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8960
+ # HTTP header 'Content-Type'
8961
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
8962
+
8963
+ # form parameters
8964
+ form_params = opts[:form_params] || {}
8965
+
8966
+ # http body (model)
8967
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_cancel_request)
8968
+
8969
+ # return_type
8970
+ return_type = opts[:debug_return_type] || 'TransferCancelResponse'
8971
+
8972
+ # auth_names
8973
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8974
+
8975
+ new_options = opts.merge(
8976
+ :operation => :"PlaidApi.transfer_cancel",
8977
+ :header_params => header_params,
8978
+ :query_params => query_params,
8979
+ :form_params => form_params,
8980
+ :body => post_body,
8981
+ :auth_names => auth_names,
8982
+ :return_type => return_type
8983
+ )
8984
+
8985
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8986
+ if @api_client.config.debugging
8987
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8988
+ end
8989
+ return data, status_code, headers
8990
+ end
8991
+
8992
+ # Get RTP eligibility information of a transfer
8993
+ # Use the `/transfer/capabilities/get` endpoint to determine the RTP eligibility information of a transfer.
8994
+ # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
8995
+ # @param [Hash] opts the optional parameters
8996
+ # @return [TransferCapabilitiesGetResponse]
8997
+ def transfer_capabilities_get(transfer_capabilities_get_request, opts = {})
8998
+ data, _status_code, _headers = transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts)
8999
+ data
9000
+ end
9001
+
9002
+ # Get RTP eligibility information of a transfer
9003
+ # Use the &#x60;/transfer/capabilities/get&#x60; endpoint to determine the RTP eligibility information of a transfer.
9004
+ # @param transfer_capabilities_get_request [TransferCapabilitiesGetRequest]
9005
+ # @param [Hash] opts the optional parameters
9006
+ # @return [Array<(TransferCapabilitiesGetResponse, Integer, Hash)>] TransferCapabilitiesGetResponse data, response status code and response headers
9007
+ def transfer_capabilities_get_with_http_info(transfer_capabilities_get_request, opts = {})
9008
+ if @api_client.config.debugging
9009
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_capabilities_get ...'
9010
+ end
9011
+ # verify the required parameter 'transfer_capabilities_get_request' is set
9012
+ if @api_client.config.client_side_validation && transfer_capabilities_get_request.nil?
9013
+ fail ArgumentError, "Missing the required parameter 'transfer_capabilities_get_request' when calling PlaidApi.transfer_capabilities_get"
9014
+ end
9015
+ # resource path
9016
+ local_var_path = '/transfer/capabilities/get'
9017
+
9018
+ # query parameters
9019
+ query_params = opts[:query_params] || {}
9020
+
9021
+ # header parameters
9022
+ header_params = opts[:header_params] || {}
9023
+ # HTTP header 'Accept' (if needed)
9024
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9025
+ # HTTP header 'Content-Type'
9026
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9027
+
9028
+ # form parameters
9029
+ form_params = opts[:form_params] || {}
9030
+
9031
+ # http body (model)
9032
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_capabilities_get_request)
9033
+
9034
+ # return_type
9035
+ return_type = opts[:debug_return_type] || 'TransferCapabilitiesGetResponse'
9036
+
9037
+ # auth_names
9038
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9039
+
9040
+ new_options = opts.merge(
9041
+ :operation => :"PlaidApi.transfer_capabilities_get",
9042
+ :header_params => header_params,
9043
+ :query_params => query_params,
9044
+ :form_params => form_params,
9045
+ :body => post_body,
9046
+ :auth_names => auth_names,
9047
+ :return_type => return_type
9048
+ )
9049
+
9050
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9051
+ if @api_client.config.debugging
9052
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_capabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9053
+ end
9054
+ return data, status_code, headers
9055
+ end
9056
+
9057
+ # Create a transfer
9058
+ # Use the `/transfer/create` endpoint to initiate a new transfer.
9059
+ # @param transfer_create_request [TransferCreateRequest]
9060
+ # @param [Hash] opts the optional parameters
9061
+ # @return [TransferCreateResponse]
9062
+ def transfer_create(transfer_create_request, opts = {})
9063
+ data, _status_code, _headers = transfer_create_with_http_info(transfer_create_request, opts)
9064
+ data
9065
+ end
9066
+
9067
+ # Create a transfer
9068
+ # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer.
9069
+ # @param transfer_create_request [TransferCreateRequest]
9070
+ # @param [Hash] opts the optional parameters
9071
+ # @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
9072
+ def transfer_create_with_http_info(transfer_create_request, opts = {})
9073
+ if @api_client.config.debugging
9074
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_create ...'
9075
+ end
9076
+ # verify the required parameter 'transfer_create_request' is set
9077
+ if @api_client.config.client_side_validation && transfer_create_request.nil?
9078
+ fail ArgumentError, "Missing the required parameter 'transfer_create_request' when calling PlaidApi.transfer_create"
9079
+ end
9080
+ # resource path
9081
+ local_var_path = '/transfer/create'
9082
+
9083
+ # query parameters
9084
+ query_params = opts[:query_params] || {}
9085
+
9086
+ # header parameters
9087
+ header_params = opts[:header_params] || {}
9088
+ # HTTP header 'Accept' (if needed)
9089
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9090
+ # HTTP header 'Content-Type'
9091
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9092
+
9093
+ # form parameters
9094
+ form_params = opts[:form_params] || {}
9095
+
9096
+ # http body (model)
9097
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_create_request)
9098
+
9099
+ # return_type
9100
+ return_type = opts[:debug_return_type] || 'TransferCreateResponse'
9101
+
9102
+ # auth_names
9103
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9104
+
9105
+ new_options = opts.merge(
9106
+ :operation => :"PlaidApi.transfer_create",
9107
+ :header_params => header_params,
9108
+ :query_params => query_params,
9109
+ :form_params => form_params,
9110
+ :body => post_body,
9111
+ :auth_names => auth_names,
9112
+ :return_type => return_type
9113
+ )
9114
+
9115
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9116
+ if @api_client.config.debugging
9117
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9118
+ end
9119
+ return data, status_code, headers
9120
+ end
9121
+
9122
+ # List transfer events
9123
+ # Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
9124
+ # @param transfer_event_list_request [TransferEventListRequest]
9125
+ # @param [Hash] opts the optional parameters
9126
+ # @return [TransferEventListResponse]
9127
+ def transfer_event_list(transfer_event_list_request, opts = {})
9128
+ data, _status_code, _headers = transfer_event_list_with_http_info(transfer_event_list_request, opts)
9129
+ data
9130
+ end
9131
+
9132
+ # List transfer events
9133
+ # Use the &#x60;/transfer/event/list&#x60; endpoint to get a list of transfer events based on specified filter criteria.
9134
+ # @param transfer_event_list_request [TransferEventListRequest]
9135
+ # @param [Hash] opts the optional parameters
9136
+ # @return [Array<(TransferEventListResponse, Integer, Hash)>] TransferEventListResponse data, response status code and response headers
9137
+ def transfer_event_list_with_http_info(transfer_event_list_request, opts = {})
9138
+ if @api_client.config.debugging
9139
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_list ...'
9140
+ end
9141
+ # verify the required parameter 'transfer_event_list_request' is set
9142
+ if @api_client.config.client_side_validation && transfer_event_list_request.nil?
9143
+ fail ArgumentError, "Missing the required parameter 'transfer_event_list_request' when calling PlaidApi.transfer_event_list"
9144
+ end
9145
+ # resource path
9146
+ local_var_path = '/transfer/event/list'
9147
+
9148
+ # query parameters
9149
+ query_params = opts[:query_params] || {}
9150
+
9151
+ # header parameters
9152
+ header_params = opts[:header_params] || {}
9153
+ # HTTP header 'Accept' (if needed)
9154
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9155
+ # HTTP header 'Content-Type'
9156
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9157
+
9158
+ # form parameters
9159
+ form_params = opts[:form_params] || {}
9160
+
9161
+ # http body (model)
9162
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_list_request)
9163
+
9164
+ # return_type
9165
+ return_type = opts[:debug_return_type] || 'TransferEventListResponse'
9166
+
9167
+ # auth_names
9168
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9169
+
9170
+ new_options = opts.merge(
9171
+ :operation => :"PlaidApi.transfer_event_list",
9172
+ :header_params => header_params,
9173
+ :query_params => query_params,
9174
+ :form_params => form_params,
9175
+ :body => post_body,
9176
+ :auth_names => auth_names,
9177
+ :return_type => return_type
9178
+ )
9179
+
9180
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9181
+ if @api_client.config.debugging
9182
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9183
+ end
9184
+ return data, status_code, headers
9185
+ end
9186
+
9187
+ # Sync transfer events
9188
+ # `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
9189
+ # @param transfer_event_sync_request [TransferEventSyncRequest]
9190
+ # @param [Hash] opts the optional parameters
9191
+ # @return [TransferEventSyncResponse]
9192
+ def transfer_event_sync(transfer_event_sync_request, opts = {})
9193
+ data, _status_code, _headers = transfer_event_sync_with_http_info(transfer_event_sync_request, opts)
9194
+ data
9195
+ end
9196
+
9197
+ # Sync transfer events
9198
+ # &#x60;/transfer/event/sync&#x60; allows you to request up to the next 25 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events.
9199
+ # @param transfer_event_sync_request [TransferEventSyncRequest]
9200
+ # @param [Hash] opts the optional parameters
9201
+ # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers
9202
+ def transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {})
9203
+ if @api_client.config.debugging
9204
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_sync ...'
9205
+ end
9206
+ # verify the required parameter 'transfer_event_sync_request' is set
9207
+ if @api_client.config.client_side_validation && transfer_event_sync_request.nil?
9208
+ fail ArgumentError, "Missing the required parameter 'transfer_event_sync_request' when calling PlaidApi.transfer_event_sync"
8169
9209
  end
8170
9210
  # resource path
8171
- local_var_path = '/transactions/recurring/get'
9211
+ local_var_path = '/transfer/event/sync'
8172
9212
 
8173
9213
  # query parameters
8174
9214
  query_params = opts[:query_params] || {}
@@ -8184,16 +9224,16 @@ module Plaid
8184
9224
  form_params = opts[:form_params] || {}
8185
9225
 
8186
9226
  # http body (model)
8187
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_recurring_get_request)
9227
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_sync_request)
8188
9228
 
8189
9229
  # return_type
8190
- return_type = opts[:debug_return_type] || 'TransactionsRecurringGetResponse'
9230
+ return_type = opts[:debug_return_type] || 'TransferEventSyncResponse'
8191
9231
 
8192
9232
  # auth_names
8193
9233
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8194
9234
 
8195
9235
  new_options = opts.merge(
8196
- :operation => :"PlaidApi.transactions_recurring_get",
9236
+ :operation => :"PlaidApi.transfer_event_sync",
8197
9237
  :header_params => header_params,
8198
9238
  :query_params => query_params,
8199
9239
  :form_params => form_params,
@@ -8204,36 +9244,36 @@ module Plaid
8204
9244
 
8205
9245
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8206
9246
  if @api_client.config.debugging
8207
- @api_client.config.logger.debug "API called: PlaidApi#transactions_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9247
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8208
9248
  end
8209
9249
  return data, status_code, headers
8210
9250
  end
8211
9251
 
8212
- # Refresh transaction data
8213
- # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: for `/transactions/sync` users, [`SYNC_UDPATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both `/transactions/sync` and `/transactions/get`, [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get` or `/transactions/sync`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
8214
- # @param transactions_refresh_request [TransactionsRefreshRequest]
9252
+ # Retrieve a transfer
9253
+ # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
9254
+ # @param transfer_get_request [TransferGetRequest]
8215
9255
  # @param [Hash] opts the optional parameters
8216
- # @return [TransactionsRefreshResponse]
8217
- def transactions_refresh(transactions_refresh_request, opts = {})
8218
- data, _status_code, _headers = transactions_refresh_with_http_info(transactions_refresh_request, opts)
9256
+ # @return [TransferGetResponse]
9257
+ def transfer_get(transfer_get_request, opts = {})
9258
+ data, _status_code, _headers = transfer_get_with_http_info(transfer_get_request, opts)
8219
9259
  data
8220
9260
  end
8221
9261
 
8222
- # Refresh transaction data
8223
- # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: for &#x60;/transactions/sync&#x60; users, [&#x60;SYNC_UDPATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) will be fired if there are any transactions updated, added, or removed. For users of both &#x60;/transactions/sync&#x60; and &#x60;/transactions/get&#x60;, [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60; or &#x60;/transactions/sync&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
8224
- # @param transactions_refresh_request [TransactionsRefreshRequest]
9262
+ # Retrieve a transfer
9263
+ # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
9264
+ # @param transfer_get_request [TransferGetRequest]
8225
9265
  # @param [Hash] opts the optional parameters
8226
- # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
8227
- def transactions_refresh_with_http_info(transactions_refresh_request, opts = {})
9266
+ # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
9267
+ def transfer_get_with_http_info(transfer_get_request, opts = {})
8228
9268
  if @api_client.config.debugging
8229
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_refresh ...'
9269
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_get ...'
8230
9270
  end
8231
- # verify the required parameter 'transactions_refresh_request' is set
8232
- if @api_client.config.client_side_validation && transactions_refresh_request.nil?
8233
- fail ArgumentError, "Missing the required parameter 'transactions_refresh_request' when calling PlaidApi.transactions_refresh"
9271
+ # verify the required parameter 'transfer_get_request' is set
9272
+ if @api_client.config.client_side_validation && transfer_get_request.nil?
9273
+ fail ArgumentError, "Missing the required parameter 'transfer_get_request' when calling PlaidApi.transfer_get"
8234
9274
  end
8235
9275
  # resource path
8236
- local_var_path = '/transactions/refresh'
9276
+ local_var_path = '/transfer/get'
8237
9277
 
8238
9278
  # query parameters
8239
9279
  query_params = opts[:query_params] || {}
@@ -8249,16 +9289,16 @@ module Plaid
8249
9289
  form_params = opts[:form_params] || {}
8250
9290
 
8251
9291
  # http body (model)
8252
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_refresh_request)
9292
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_get_request)
8253
9293
 
8254
9294
  # return_type
8255
- return_type = opts[:debug_return_type] || 'TransactionsRefreshResponse'
9295
+ return_type = opts[:debug_return_type] || 'TransferGetResponse'
8256
9296
 
8257
9297
  # auth_names
8258
9298
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8259
9299
 
8260
9300
  new_options = opts.merge(
8261
- :operation => :"PlaidApi.transactions_refresh",
9301
+ :operation => :"PlaidApi.transfer_get",
8262
9302
  :header_params => header_params,
8263
9303
  :query_params => query_params,
8264
9304
  :form_params => form_params,
@@ -8269,36 +9309,36 @@ module Plaid
8269
9309
 
8270
9310
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8271
9311
  if @api_client.config.debugging
8272
- @api_client.config.logger.debug "API called: PlaidApi#transactions_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9312
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8273
9313
  end
8274
9314
  return data, status_code, headers
8275
9315
  end
8276
9316
 
8277
- # Create transaction category rule
8278
- # The `/transactions/rules/v1/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
8279
- # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
9317
+ # Create a transfer intent object to invoke the Transfer UI
9318
+ # Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
9319
+ # @param transfer_intent_create_request [TransferIntentCreateRequest]
8280
9320
  # @param [Hash] opts the optional parameters
8281
- # @return [TransactionsRulesCreateResponse]
8282
- def transactions_rules_create(transactions_rules_create_request, opts = {})
8283
- data, _status_code, _headers = transactions_rules_create_with_http_info(transactions_rules_create_request, opts)
9321
+ # @return [TransferIntentCreateResponse]
9322
+ def transfer_intent_create(transfer_intent_create_request, opts = {})
9323
+ data, _status_code, _headers = transfer_intent_create_with_http_info(transfer_intent_create_request, opts)
8284
9324
  data
8285
9325
  end
8286
9326
 
8287
- # Create transaction category rule
8288
- # The &#x60;/transactions/rules/v1/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
8289
- # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
9327
+ # Create a transfer intent object to invoke the Transfer UI
9328
+ # Use the &#x60;/transfer/intent/create&#x60; endpoint to generate a transfer intent object and invoke the Transfer UI.
9329
+ # @param transfer_intent_create_request [TransferIntentCreateRequest]
8290
9330
  # @param [Hash] opts the optional parameters
8291
- # @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
8292
- def transactions_rules_create_with_http_info(transactions_rules_create_request, opts = {})
9331
+ # @return [Array<(TransferIntentCreateResponse, Integer, Hash)>] TransferIntentCreateResponse data, response status code and response headers
9332
+ def transfer_intent_create_with_http_info(transfer_intent_create_request, opts = {})
8293
9333
  if @api_client.config.debugging
8294
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_create ...'
9334
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_create ...'
8295
9335
  end
8296
- # verify the required parameter 'transactions_rules_create_request' is set
8297
- if @api_client.config.client_side_validation && transactions_rules_create_request.nil?
8298
- fail ArgumentError, "Missing the required parameter 'transactions_rules_create_request' when calling PlaidApi.transactions_rules_create"
9336
+ # verify the required parameter 'transfer_intent_create_request' is set
9337
+ if @api_client.config.client_side_validation && transfer_intent_create_request.nil?
9338
+ fail ArgumentError, "Missing the required parameter 'transfer_intent_create_request' when calling PlaidApi.transfer_intent_create"
8299
9339
  end
8300
9340
  # resource path
8301
- local_var_path = '/beta/transactions/rules/v1/create'
9341
+ local_var_path = '/transfer/intent/create'
8302
9342
 
8303
9343
  # query parameters
8304
9344
  query_params = opts[:query_params] || {}
@@ -8314,16 +9354,16 @@ module Plaid
8314
9354
  form_params = opts[:form_params] || {}
8315
9355
 
8316
9356
  # http body (model)
8317
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_create_request)
9357
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_intent_create_request)
8318
9358
 
8319
9359
  # return_type
8320
- return_type = opts[:debug_return_type] || 'TransactionsRulesCreateResponse'
9360
+ return_type = opts[:debug_return_type] || 'TransferIntentCreateResponse'
8321
9361
 
8322
9362
  # auth_names
8323
9363
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8324
9364
 
8325
9365
  new_options = opts.merge(
8326
- :operation => :"PlaidApi.transactions_rules_create",
9366
+ :operation => :"PlaidApi.transfer_intent_create",
8327
9367
  :header_params => header_params,
8328
9368
  :query_params => query_params,
8329
9369
  :form_params => form_params,
@@ -8334,36 +9374,36 @@ module Plaid
8334
9374
 
8335
9375
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8336
9376
  if @api_client.config.debugging
8337
- @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9377
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8338
9378
  end
8339
9379
  return data, status_code, headers
8340
9380
  end
8341
9381
 
8342
- # Return a list of rules created for the Item associated with the access token.
8343
- # The `/transactions/rules/v1/list` returns a list of transaction rules created for the Item associated with the access token.
8344
- # @param transactions_rules_list_request [TransactionsRulesListRequest]
9382
+ # Retrieve more information about a transfer intent
9383
+ # Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
9384
+ # @param request_body [Hash<String, Object>]
8345
9385
  # @param [Hash] opts the optional parameters
8346
- # @return [TransactionsRulesListResponse]
8347
- def transactions_rules_list(transactions_rules_list_request, opts = {})
8348
- data, _status_code, _headers = transactions_rules_list_with_http_info(transactions_rules_list_request, opts)
9386
+ # @return [TransferIntentGetResponse]
9387
+ def transfer_intent_get(request_body, opts = {})
9388
+ data, _status_code, _headers = transfer_intent_get_with_http_info(request_body, opts)
8349
9389
  data
8350
9390
  end
8351
9391
 
8352
- # Return a list of rules created for the Item associated with the access token.
8353
- # The &#x60;/transactions/rules/v1/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
8354
- # @param transactions_rules_list_request [TransactionsRulesListRequest]
9392
+ # Retrieve more information about a transfer intent
9393
+ # Use the &#x60;/transfer/intent/get&#x60; endpoint to retrieve more information about a transfer intent.
9394
+ # @param request_body [Hash<String, Object>]
8355
9395
  # @param [Hash] opts the optional parameters
8356
- # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
8357
- def transactions_rules_list_with_http_info(transactions_rules_list_request, opts = {})
9396
+ # @return [Array<(TransferIntentGetResponse, Integer, Hash)>] TransferIntentGetResponse data, response status code and response headers
9397
+ def transfer_intent_get_with_http_info(request_body, opts = {})
8358
9398
  if @api_client.config.debugging
8359
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_list ...'
9399
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_get ...'
8360
9400
  end
8361
- # verify the required parameter 'transactions_rules_list_request' is set
8362
- if @api_client.config.client_side_validation && transactions_rules_list_request.nil?
8363
- fail ArgumentError, "Missing the required parameter 'transactions_rules_list_request' when calling PlaidApi.transactions_rules_list"
9401
+ # verify the required parameter 'request_body' is set
9402
+ if @api_client.config.client_side_validation && request_body.nil?
9403
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.transfer_intent_get"
8364
9404
  end
8365
9405
  # resource path
8366
- local_var_path = '/beta/transactions/rules/v1/list'
9406
+ local_var_path = '/transfer/intent/get'
8367
9407
 
8368
9408
  # query parameters
8369
9409
  query_params = opts[:query_params] || {}
@@ -8379,16 +9419,16 @@ module Plaid
8379
9419
  form_params = opts[:form_params] || {}
8380
9420
 
8381
9421
  # http body (model)
8382
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_list_request)
9422
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
8383
9423
 
8384
9424
  # return_type
8385
- return_type = opts[:debug_return_type] || 'TransactionsRulesListResponse'
9425
+ return_type = opts[:debug_return_type] || 'TransferIntentGetResponse'
8386
9426
 
8387
9427
  # auth_names
8388
9428
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8389
9429
 
8390
9430
  new_options = opts.merge(
8391
- :operation => :"PlaidApi.transactions_rules_list",
9431
+ :operation => :"PlaidApi.transfer_intent_get",
8392
9432
  :header_params => header_params,
8393
9433
  :query_params => query_params,
8394
9434
  :form_params => form_params,
@@ -8399,36 +9439,36 @@ module Plaid
8399
9439
 
8400
9440
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8401
9441
  if @api_client.config.debugging
8402
- @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9442
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8403
9443
  end
8404
9444
  return data, status_code, headers
8405
9445
  end
8406
9446
 
8407
- # Remove transaction rule
8408
- # The `/transactions/rules/v1/remove` endpoint is used to remove a transaction rule.
8409
- # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
9447
+ # List transfers
9448
+ # Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
9449
+ # @param transfer_list_request [TransferListRequest]
8410
9450
  # @param [Hash] opts the optional parameters
8411
- # @return [TransactionsRulesRemoveResponse]
8412
- def transactions_rules_remove(transactions_rules_remove_request, opts = {})
8413
- data, _status_code, _headers = transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts)
9451
+ # @return [TransferListResponse]
9452
+ def transfer_list(transfer_list_request, opts = {})
9453
+ data, _status_code, _headers = transfer_list_with_http_info(transfer_list_request, opts)
8414
9454
  data
8415
9455
  end
8416
9456
 
8417
- # Remove transaction rule
8418
- # The &#x60;/transactions/rules/v1/remove&#x60; endpoint is used to remove a transaction rule.
8419
- # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
9457
+ # List transfers
9458
+ # Use the &#x60;/transfer/list&#x60; endpoint to see a list of all your transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired transfers.
9459
+ # @param transfer_list_request [TransferListRequest]
8420
9460
  # @param [Hash] opts the optional parameters
8421
- # @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
8422
- def transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts = {})
9461
+ # @return [Array<(TransferListResponse, Integer, Hash)>] TransferListResponse data, response status code and response headers
9462
+ def transfer_list_with_http_info(transfer_list_request, opts = {})
8423
9463
  if @api_client.config.debugging
8424
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_remove ...'
9464
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_list ...'
8425
9465
  end
8426
- # verify the required parameter 'transactions_rules_remove_request' is set
8427
- if @api_client.config.client_side_validation && transactions_rules_remove_request.nil?
8428
- fail ArgumentError, "Missing the required parameter 'transactions_rules_remove_request' when calling PlaidApi.transactions_rules_remove"
9466
+ # verify the required parameter 'transfer_list_request' is set
9467
+ if @api_client.config.client_side_validation && transfer_list_request.nil?
9468
+ fail ArgumentError, "Missing the required parameter 'transfer_list_request' when calling PlaidApi.transfer_list"
8429
9469
  end
8430
9470
  # resource path
8431
- local_var_path = '/beta/transactions/rules/v1/remove'
9471
+ local_var_path = '/transfer/list'
8432
9472
 
8433
9473
  # query parameters
8434
9474
  query_params = opts[:query_params] || {}
@@ -8444,16 +9484,16 @@ module Plaid
8444
9484
  form_params = opts[:form_params] || {}
8445
9485
 
8446
9486
  # http body (model)
8447
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_remove_request)
9487
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_list_request)
8448
9488
 
8449
9489
  # return_type
8450
- return_type = opts[:debug_return_type] || 'TransactionsRulesRemoveResponse'
9490
+ return_type = opts[:debug_return_type] || 'TransferListResponse'
8451
9491
 
8452
9492
  # auth_names
8453
9493
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8454
9494
 
8455
9495
  new_options = opts.merge(
8456
- :operation => :"PlaidApi.transactions_rules_remove",
9496
+ :operation => :"PlaidApi.transfer_list",
8457
9497
  :header_params => header_params,
8458
9498
  :query_params => query_params,
8459
9499
  :form_params => form_params,
@@ -8464,36 +9504,101 @@ module Plaid
8464
9504
 
8465
9505
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8466
9506
  if @api_client.config.debugging
8467
- @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9507
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8468
9508
  end
8469
9509
  return data, status_code, headers
8470
9510
  end
8471
9511
 
8472
- # 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.
8474
- # @param transactions_sync_request [TransactionsSyncRequest]
9512
+ # Migrate account into Transfers
9513
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
9514
+ # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
8475
9515
  # @param [Hash] opts the optional parameters
8476
- # @return [TransactionsSyncResponse]
8477
- def transactions_sync(transactions_sync_request, opts = {})
8478
- data, _status_code, _headers = transactions_sync_with_http_info(transactions_sync_request, opts)
9516
+ # @return [TransferMigrateAccountResponse]
9517
+ def transfer_migrate_account(transfer_migrate_account_request, opts = {})
9518
+ data, _status_code, _headers = transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts)
8479
9519
  data
8480
9520
  end
8481
9521
 
8482
- # 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.
8484
- # @param transactions_sync_request [TransactionsSyncRequest]
9522
+ # Migrate account into Transfers
9523
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
9524
+ # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
8485
9525
  # @param [Hash] opts the optional parameters
8486
- # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
8487
- def transactions_sync_with_http_info(transactions_sync_request, opts = {})
9526
+ # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
9527
+ def transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts = {})
8488
9528
  if @api_client.config.debugging
8489
- @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
9529
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_migrate_account ...'
9530
+ end
9531
+ # verify the required parameter 'transfer_migrate_account_request' is set
9532
+ if @api_client.config.client_side_validation && transfer_migrate_account_request.nil?
9533
+ fail ArgumentError, "Missing the required parameter 'transfer_migrate_account_request' when calling PlaidApi.transfer_migrate_account"
9534
+ end
9535
+ # resource path
9536
+ local_var_path = '/transfer/migrate_account'
9537
+
9538
+ # query parameters
9539
+ query_params = opts[:query_params] || {}
9540
+
9541
+ # header parameters
9542
+ header_params = opts[:header_params] || {}
9543
+ # HTTP header 'Accept' (if needed)
9544
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9545
+ # HTTP header 'Content-Type'
9546
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9547
+
9548
+ # form parameters
9549
+ form_params = opts[:form_params] || {}
9550
+
9551
+ # http body (model)
9552
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_migrate_account_request)
9553
+
9554
+ # return_type
9555
+ return_type = opts[:debug_return_type] || 'TransferMigrateAccountResponse'
9556
+
9557
+ # auth_names
9558
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9559
+
9560
+ new_options = opts.merge(
9561
+ :operation => :"PlaidApi.transfer_migrate_account",
9562
+ :header_params => header_params,
9563
+ :query_params => query_params,
9564
+ :form_params => form_params,
9565
+ :body => post_body,
9566
+ :auth_names => auth_names,
9567
+ :return_type => return_type
9568
+ )
9569
+
9570
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9571
+ if @api_client.config.debugging
9572
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9573
+ end
9574
+ return data, status_code, headers
9575
+ end
9576
+
9577
+ # Create a new originator
9578
+ # Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.
9579
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
9580
+ # @param [Hash] opts the optional parameters
9581
+ # @return [TransferOriginatorCreateResponse]
9582
+ def transfer_originator_create(transfer_originator_create_request, opts = {})
9583
+ data, _status_code, _headers = transfer_originator_create_with_http_info(transfer_originator_create_request, opts)
9584
+ data
9585
+ end
9586
+
9587
+ # Create a new originator
9588
+ # Use the &#x60;/transfer/originator/create&#x60; endpoint to create a new originator and return an &#x60;originator_client_id&#x60;.
9589
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
9590
+ # @param [Hash] opts the optional parameters
9591
+ # @return [Array<(TransferOriginatorCreateResponse, Integer, Hash)>] TransferOriginatorCreateResponse data, response status code and response headers
9592
+ def transfer_originator_create_with_http_info(transfer_originator_create_request, opts = {})
9593
+ if @api_client.config.debugging
9594
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_create ...'
8490
9595
  end
8491
- # verify the required parameter 'transactions_sync_request' is set
8492
- if @api_client.config.client_side_validation && transactions_sync_request.nil?
8493
- fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
9596
+ # verify the required parameter 'transfer_originator_create_request' is set
9597
+ if @api_client.config.client_side_validation && transfer_originator_create_request.nil?
9598
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_create_request' when calling PlaidApi.transfer_originator_create"
8494
9599
  end
8495
9600
  # resource path
8496
- local_var_path = '/transactions/sync'
9601
+ local_var_path = '/transfer/originator/create'
8497
9602
 
8498
9603
  # query parameters
8499
9604
  query_params = opts[:query_params] || {}
@@ -8509,16 +9614,16 @@ module Plaid
8509
9614
  form_params = opts[:form_params] || {}
8510
9615
 
8511
9616
  # http body (model)
8512
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
9617
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_create_request)
8513
9618
 
8514
9619
  # return_type
8515
- return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
9620
+ return_type = opts[:debug_return_type] || 'TransferOriginatorCreateResponse'
8516
9621
 
8517
9622
  # auth_names
8518
9623
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8519
9624
 
8520
9625
  new_options = opts.merge(
8521
- :operation => :"PlaidApi.transactions_sync",
9626
+ :operation => :"PlaidApi.transfer_originator_create",
8522
9627
  :header_params => header_params,
8523
9628
  :query_params => query_params,
8524
9629
  :form_params => form_params,
@@ -8529,36 +9634,36 @@ module Plaid
8529
9634
 
8530
9635
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8531
9636
  if @api_client.config.debugging
8532
- @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9637
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8533
9638
  end
8534
9639
  return data, status_code, headers
8535
9640
  end
8536
9641
 
8537
- # Create a transfer authorization
8538
- # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `ITEM_LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. `device.ip_address`, `device.user_agent` are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : `idempotency_key`, `user.phone_number` (optional if `email_address` provided), `user.email_address` (optional if `phone_number` provided), `device.ip_address`, `device.user_agent`, and `user_present`.
8539
- # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9642
+ # Get status of an originator's onboarding
9643
+ # 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.
9644
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
8540
9645
  # @param [Hash] opts the optional parameters
8541
- # @return [TransferAuthorizationCreateResponse]
8542
- def transfer_authorization_create(transfer_authorization_create_request, opts = {})
8543
- data, _status_code, _headers = transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts)
9646
+ # @return [TransferOriginatorGetResponse]
9647
+ def transfer_originator_get(transfer_originator_get_request, opts = {})
9648
+ data, _status_code, _headers = transfer_originator_get_with_http_info(transfer_originator_get_request, opts)
8544
9649
  data
8545
9650
  end
8546
9651
 
8547
- # Create a transfer authorization
8548
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s Sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;ITEM_LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60; are required fields. For [Guarantee](https://www.plaid.com/docs//transfer/guarantee/), the following fields are required : &#x60;idempotency_key&#x60;, &#x60;user.phone_number&#x60; (optional if &#x60;email_address&#x60; provided), &#x60;user.email_address&#x60; (optional if &#x60;phone_number&#x60; provided), &#x60;device.ip_address&#x60;, &#x60;device.user_agent&#x60;, and &#x60;user_present&#x60;.
8549
- # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
9652
+ # Get status of an originator&#39;s onboarding
9653
+ # 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.
9654
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
8550
9655
  # @param [Hash] opts the optional parameters
8551
- # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
8552
- def transfer_authorization_create_with_http_info(transfer_authorization_create_request, opts = {})
9656
+ # @return [Array<(TransferOriginatorGetResponse, Integer, Hash)>] TransferOriginatorGetResponse data, response status code and response headers
9657
+ def transfer_originator_get_with_http_info(transfer_originator_get_request, opts = {})
8553
9658
  if @api_client.config.debugging
8554
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_authorization_create ...'
9659
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_get ...'
8555
9660
  end
8556
- # verify the required parameter 'transfer_authorization_create_request' is set
8557
- if @api_client.config.client_side_validation && transfer_authorization_create_request.nil?
8558
- fail ArgumentError, "Missing the required parameter 'transfer_authorization_create_request' when calling PlaidApi.transfer_authorization_create"
9661
+ # verify the required parameter 'transfer_originator_get_request' is set
9662
+ if @api_client.config.client_side_validation && transfer_originator_get_request.nil?
9663
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_get_request' when calling PlaidApi.transfer_originator_get"
8559
9664
  end
8560
9665
  # resource path
8561
- local_var_path = '/transfer/authorization/create'
9666
+ local_var_path = '/transfer/originator/get'
8562
9667
 
8563
9668
  # query parameters
8564
9669
  query_params = opts[:query_params] || {}
@@ -8568,22 +9673,22 @@ module Plaid
8568
9673
  # HTTP header 'Accept' (if needed)
8569
9674
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
8570
9675
  # HTTP header 'Content-Type'
8571
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9676
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'examples'])
8572
9677
 
8573
9678
  # form parameters
8574
9679
  form_params = opts[:form_params] || {}
8575
9680
 
8576
9681
  # http body (model)
8577
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_authorization_create_request)
9682
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_get_request)
8578
9683
 
8579
9684
  # return_type
8580
- return_type = opts[:debug_return_type] || 'TransferAuthorizationCreateResponse'
9685
+ return_type = opts[:debug_return_type] || 'TransferOriginatorGetResponse'
8581
9686
 
8582
9687
  # auth_names
8583
9688
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8584
9689
 
8585
9690
  new_options = opts.merge(
8586
- :operation => :"PlaidApi.transfer_authorization_create",
9691
+ :operation => :"PlaidApi.transfer_originator_get",
8587
9692
  :header_params => header_params,
8588
9693
  :query_params => query_params,
8589
9694
  :form_params => form_params,
@@ -8594,36 +9699,36 @@ module Plaid
8594
9699
 
8595
9700
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8596
9701
  if @api_client.config.debugging
8597
- @api_client.config.logger.debug "API called: PlaidApi#transfer_authorization_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9702
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8598
9703
  end
8599
9704
  return data, status_code, headers
8600
9705
  end
8601
9706
 
8602
- # Cancel a transfer
8603
- # Use the `/transfer/cancel` endpoint to cancel a transfer. A transfer is eligible for cancellation if the `cancellable` property returned by `/transfer/get` is `true`.
8604
- # @param transfer_cancel_request [TransferCancelRequest]
9707
+ # Get status of all originators' onboarding
9708
+ # The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
9709
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
8605
9710
  # @param [Hash] opts the optional parameters
8606
- # @return [TransferCancelResponse]
8607
- def transfer_cancel(transfer_cancel_request, opts = {})
8608
- data, _status_code, _headers = transfer_cancel_with_http_info(transfer_cancel_request, opts)
9711
+ # @return [TransferOriginatorListResponse]
9712
+ def transfer_originator_list(transfer_originator_list_request, opts = {})
9713
+ data, _status_code, _headers = transfer_originator_list_with_http_info(transfer_originator_list_request, opts)
8609
9714
  data
8610
9715
  end
8611
9716
 
8612
- # Cancel a transfer
8613
- # Use the &#x60;/transfer/cancel&#x60; endpoint to cancel a transfer. A transfer is eligible for cancellation if the &#x60;cancellable&#x60; property returned by &#x60;/transfer/get&#x60; is &#x60;true&#x60;.
8614
- # @param transfer_cancel_request [TransferCancelRequest]
9717
+ # Get status of all originators&#39; onboarding
9718
+ # 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.
9719
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
8615
9720
  # @param [Hash] opts the optional parameters
8616
- # @return [Array<(TransferCancelResponse, Integer, Hash)>] TransferCancelResponse data, response status code and response headers
8617
- def transfer_cancel_with_http_info(transfer_cancel_request, opts = {})
9721
+ # @return [Array<(TransferOriginatorListResponse, Integer, Hash)>] TransferOriginatorListResponse data, response status code and response headers
9722
+ def transfer_originator_list_with_http_info(transfer_originator_list_request, opts = {})
8618
9723
  if @api_client.config.debugging
8619
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_cancel ...'
9724
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_list ...'
8620
9725
  end
8621
- # verify the required parameter 'transfer_cancel_request' is set
8622
- if @api_client.config.client_side_validation && transfer_cancel_request.nil?
8623
- fail ArgumentError, "Missing the required parameter 'transfer_cancel_request' when calling PlaidApi.transfer_cancel"
9726
+ # verify the required parameter 'transfer_originator_list_request' is set
9727
+ if @api_client.config.client_side_validation && transfer_originator_list_request.nil?
9728
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_list_request' when calling PlaidApi.transfer_originator_list"
8624
9729
  end
8625
9730
  # resource path
8626
- local_var_path = '/transfer/cancel'
9731
+ local_var_path = '/transfer/originator/list'
8627
9732
 
8628
9733
  # query parameters
8629
9734
  query_params = opts[:query_params] || {}
@@ -8639,16 +9744,16 @@ module Plaid
8639
9744
  form_params = opts[:form_params] || {}
8640
9745
 
8641
9746
  # http body (model)
8642
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_cancel_request)
9747
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_list_request)
8643
9748
 
8644
9749
  # return_type
8645
- return_type = opts[:debug_return_type] || 'TransferCancelResponse'
9750
+ return_type = opts[:debug_return_type] || 'TransferOriginatorListResponse'
8646
9751
 
8647
9752
  # auth_names
8648
9753
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8649
9754
 
8650
9755
  new_options = opts.merge(
8651
- :operation => :"PlaidApi.transfer_cancel",
9756
+ :operation => :"PlaidApi.transfer_originator_list",
8652
9757
  :header_params => header_params,
8653
9758
  :query_params => query_params,
8654
9759
  :form_params => form_params,
@@ -8659,36 +9764,36 @@ module Plaid
8659
9764
 
8660
9765
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8661
9766
  if @api_client.config.debugging
8662
- @api_client.config.logger.debug "API called: PlaidApi#transfer_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9767
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8663
9768
  end
8664
9769
  return data, status_code, headers
8665
9770
  end
8666
9771
 
8667
- # Create a transfer
8668
- # Use the `/transfer/create` endpoint to initiate a new transfer.
8669
- # @param transfer_create_request [TransferCreateRequest]
9772
+ # Generate a Plaid-hosted onboarding UI URL.
9773
+ # 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.
9774
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
8670
9775
  # @param [Hash] opts the optional parameters
8671
- # @return [TransferCreateResponse]
8672
- def transfer_create(transfer_create_request, opts = {})
8673
- data, _status_code, _headers = transfer_create_with_http_info(transfer_create_request, opts)
9776
+ # @return [TransferQuestionnaireCreateResponse]
9777
+ def transfer_questionnaire_create(transfer_questionnaire_create_request, opts = {})
9778
+ data, _status_code, _headers = transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts)
8674
9779
  data
8675
9780
  end
8676
9781
 
8677
- # Create a transfer
8678
- # Use the &#x60;/transfer/create&#x60; endpoint to initiate a new transfer.
8679
- # @param transfer_create_request [TransferCreateRequest]
9782
+ # Generate a Plaid-hosted onboarding UI URL.
9783
+ # 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.
9784
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
8680
9785
  # @param [Hash] opts the optional parameters
8681
- # @return [Array<(TransferCreateResponse, Integer, Hash)>] TransferCreateResponse data, response status code and response headers
8682
- def transfer_create_with_http_info(transfer_create_request, opts = {})
9786
+ # @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
9787
+ def transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts = {})
8683
9788
  if @api_client.config.debugging
8684
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_create ...'
9789
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_questionnaire_create ...'
8685
9790
  end
8686
- # verify the required parameter 'transfer_create_request' is set
8687
- if @api_client.config.client_side_validation && transfer_create_request.nil?
8688
- fail ArgumentError, "Missing the required parameter 'transfer_create_request' when calling PlaidApi.transfer_create"
9791
+ # verify the required parameter 'transfer_questionnaire_create_request' is set
9792
+ if @api_client.config.client_side_validation && transfer_questionnaire_create_request.nil?
9793
+ fail ArgumentError, "Missing the required parameter 'transfer_questionnaire_create_request' when calling PlaidApi.transfer_questionnaire_create"
8689
9794
  end
8690
9795
  # resource path
8691
- local_var_path = '/transfer/create'
9796
+ local_var_path = '/transfer/questionnaire/create'
8692
9797
 
8693
9798
  # query parameters
8694
9799
  query_params = opts[:query_params] || {}
@@ -8704,16 +9809,16 @@ module Plaid
8704
9809
  form_params = opts[:form_params] || {}
8705
9810
 
8706
9811
  # http body (model)
8707
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_create_request)
9812
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_questionnaire_create_request)
8708
9813
 
8709
9814
  # return_type
8710
- return_type = opts[:debug_return_type] || 'TransferCreateResponse'
9815
+ return_type = opts[:debug_return_type] || 'TransferQuestionnaireCreateResponse'
8711
9816
 
8712
9817
  # auth_names
8713
9818
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8714
9819
 
8715
9820
  new_options = opts.merge(
8716
- :operation => :"PlaidApi.transfer_create",
9821
+ :operation => :"PlaidApi.transfer_questionnaire_create",
8717
9822
  :header_params => header_params,
8718
9823
  :query_params => query_params,
8719
9824
  :form_params => form_params,
@@ -8724,36 +9829,36 @@ module Plaid
8724
9829
 
8725
9830
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8726
9831
  if @api_client.config.debugging
8727
- @api_client.config.logger.debug "API called: PlaidApi#transfer_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9832
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_questionnaire_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8728
9833
  end
8729
9834
  return data, status_code, headers
8730
9835
  end
8731
9836
 
8732
- # List transfer events
8733
- # Use the `/transfer/event/list` endpoint to get a list of transfer events based on specified filter criteria.
8734
- # @param transfer_event_list_request [TransferEventListRequest]
9837
+ # Cancel a recurring transfer.
9838
+ # Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
9839
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
8735
9840
  # @param [Hash] opts the optional parameters
8736
- # @return [TransferEventListResponse]
8737
- def transfer_event_list(transfer_event_list_request, opts = {})
8738
- data, _status_code, _headers = transfer_event_list_with_http_info(transfer_event_list_request, opts)
9841
+ # @return [TransferRecurringCancelResponse]
9842
+ def transfer_recurring_cancel(transfer_recurring_cancel_request, opts = {})
9843
+ data, _status_code, _headers = transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts)
8739
9844
  data
8740
9845
  end
8741
9846
 
8742
- # List transfer events
8743
- # Use the &#x60;/transfer/event/list&#x60; endpoint to get a list of transfer events based on specified filter criteria.
8744
- # @param transfer_event_list_request [TransferEventListRequest]
9847
+ # Cancel a recurring transfer.
9848
+ # 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.
9849
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
8745
9850
  # @param [Hash] opts the optional parameters
8746
- # @return [Array<(TransferEventListResponse, Integer, Hash)>] TransferEventListResponse data, response status code and response headers
8747
- def transfer_event_list_with_http_info(transfer_event_list_request, opts = {})
9851
+ # @return [Array<(TransferRecurringCancelResponse, Integer, Hash)>] TransferRecurringCancelResponse data, response status code and response headers
9852
+ def transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts = {})
8748
9853
  if @api_client.config.debugging
8749
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_list ...'
9854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_cancel ...'
8750
9855
  end
8751
- # verify the required parameter 'transfer_event_list_request' is set
8752
- if @api_client.config.client_side_validation && transfer_event_list_request.nil?
8753
- fail ArgumentError, "Missing the required parameter 'transfer_event_list_request' when calling PlaidApi.transfer_event_list"
9856
+ # verify the required parameter 'transfer_recurring_cancel_request' is set
9857
+ if @api_client.config.client_side_validation && transfer_recurring_cancel_request.nil?
9858
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_cancel_request' when calling PlaidApi.transfer_recurring_cancel"
8754
9859
  end
8755
9860
  # resource path
8756
- local_var_path = '/transfer/event/list'
9861
+ local_var_path = '/transfer/recurring/cancel'
8757
9862
 
8758
9863
  # query parameters
8759
9864
  query_params = opts[:query_params] || {}
@@ -8769,16 +9874,16 @@ module Plaid
8769
9874
  form_params = opts[:form_params] || {}
8770
9875
 
8771
9876
  # http body (model)
8772
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_list_request)
9877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_cancel_request)
8773
9878
 
8774
9879
  # return_type
8775
- return_type = opts[:debug_return_type] || 'TransferEventListResponse'
9880
+ return_type = opts[:debug_return_type] || 'TransferRecurringCancelResponse'
8776
9881
 
8777
9882
  # auth_names
8778
9883
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8779
9884
 
8780
9885
  new_options = opts.merge(
8781
- :operation => :"PlaidApi.transfer_event_list",
9886
+ :operation => :"PlaidApi.transfer_recurring_cancel",
8782
9887
  :header_params => header_params,
8783
9888
  :query_params => query_params,
8784
9889
  :form_params => form_params,
@@ -8789,36 +9894,36 @@ module Plaid
8789
9894
 
8790
9895
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8791
9896
  if @api_client.config.debugging
8792
- @api_client.config.logger.debug "API called: PlaidApi#transfer_event_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9897
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8793
9898
  end
8794
9899
  return data, status_code, headers
8795
9900
  end
8796
9901
 
8797
- # Sync transfer events
8798
- # `/transfer/event/sync` allows you to request up to the next 25 transfer events that happened after a specific `event_id`. Use the `/transfer/event/sync` endpoint to guarantee you have seen all transfer events.
8799
- # @param transfer_event_sync_request [TransferEventSyncRequest]
9902
+ # Create a recurring transfer
9903
+ # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
9904
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
8800
9905
  # @param [Hash] opts the optional parameters
8801
- # @return [TransferEventSyncResponse]
8802
- def transfer_event_sync(transfer_event_sync_request, opts = {})
8803
- data, _status_code, _headers = transfer_event_sync_with_http_info(transfer_event_sync_request, opts)
9906
+ # @return [TransferRecurringCreateResponse]
9907
+ def transfer_recurring_create(transfer_recurring_create_request, opts = {})
9908
+ data, _status_code, _headers = transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts)
8804
9909
  data
8805
9910
  end
8806
9911
 
8807
- # Sync transfer events
8808
- # &#x60;/transfer/event/sync&#x60; allows you to request up to the next 25 transfer events that happened after a specific &#x60;event_id&#x60;. Use the &#x60;/transfer/event/sync&#x60; endpoint to guarantee you have seen all transfer events.
8809
- # @param transfer_event_sync_request [TransferEventSyncRequest]
9912
+ # Create a recurring transfer
9913
+ # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer.
9914
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
8810
9915
  # @param [Hash] opts the optional parameters
8811
- # @return [Array<(TransferEventSyncResponse, Integer, Hash)>] TransferEventSyncResponse data, response status code and response headers
8812
- def transfer_event_sync_with_http_info(transfer_event_sync_request, opts = {})
9916
+ # @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
9917
+ def transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts = {})
8813
9918
  if @api_client.config.debugging
8814
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_event_sync ...'
9919
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_create ...'
8815
9920
  end
8816
- # verify the required parameter 'transfer_event_sync_request' is set
8817
- if @api_client.config.client_side_validation && transfer_event_sync_request.nil?
8818
- fail ArgumentError, "Missing the required parameter 'transfer_event_sync_request' when calling PlaidApi.transfer_event_sync"
9921
+ # verify the required parameter 'transfer_recurring_create_request' is set
9922
+ if @api_client.config.client_side_validation && transfer_recurring_create_request.nil?
9923
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_create_request' when calling PlaidApi.transfer_recurring_create"
8819
9924
  end
8820
9925
  # resource path
8821
- local_var_path = '/transfer/event/sync'
9926
+ local_var_path = '/transfer/recurring/create'
8822
9927
 
8823
9928
  # query parameters
8824
9929
  query_params = opts[:query_params] || {}
@@ -8834,16 +9939,16 @@ module Plaid
8834
9939
  form_params = opts[:form_params] || {}
8835
9940
 
8836
9941
  # http body (model)
8837
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_event_sync_request)
9942
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_create_request)
8838
9943
 
8839
9944
  # return_type
8840
- return_type = opts[:debug_return_type] || 'TransferEventSyncResponse'
9945
+ return_type = opts[:debug_return_type] || 'TransferRecurringCreateResponse'
8841
9946
 
8842
9947
  # auth_names
8843
9948
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8844
9949
 
8845
9950
  new_options = opts.merge(
8846
- :operation => :"PlaidApi.transfer_event_sync",
9951
+ :operation => :"PlaidApi.transfer_recurring_create",
8847
9952
  :header_params => header_params,
8848
9953
  :query_params => query_params,
8849
9954
  :form_params => form_params,
@@ -8854,36 +9959,36 @@ module Plaid
8854
9959
 
8855
9960
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8856
9961
  if @api_client.config.debugging
8857
- @api_client.config.logger.debug "API called: PlaidApi#transfer_event_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9962
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8858
9963
  end
8859
9964
  return data, status_code, headers
8860
9965
  end
8861
9966
 
8862
- # Retrieve a transfer
8863
- # The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
8864
- # @param transfer_get_request [TransferGetRequest]
9967
+ # Retrieve a recurring transfer
9968
+ # The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.
9969
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
8865
9970
  # @param [Hash] opts the optional parameters
8866
- # @return [TransferGetResponse]
8867
- def transfer_get(transfer_get_request, opts = {})
8868
- data, _status_code, _headers = transfer_get_with_http_info(transfer_get_request, opts)
9971
+ # @return [TransferRecurringGetResponse]
9972
+ def transfer_recurring_get(transfer_recurring_get_request, opts = {})
9973
+ data, _status_code, _headers = transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts)
8869
9974
  data
8870
9975
  end
8871
9976
 
8872
- # Retrieve a transfer
8873
- # The &#x60;/transfer/get&#x60; fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
8874
- # @param transfer_get_request [TransferGetRequest]
9977
+ # Retrieve a recurring transfer
9978
+ # The &#x60;/transfer/recurring/get&#x60; fetches information about the recurring transfer corresponding to the given &#x60;recurring_transfer_id&#x60;.
9979
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
8875
9980
  # @param [Hash] opts the optional parameters
8876
- # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
8877
- def transfer_get_with_http_info(transfer_get_request, opts = {})
9981
+ # @return [Array<(TransferRecurringGetResponse, Integer, Hash)>] TransferRecurringGetResponse data, response status code and response headers
9982
+ def transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts = {})
8878
9983
  if @api_client.config.debugging
8879
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_get ...'
9984
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_get ...'
8880
9985
  end
8881
- # verify the required parameter 'transfer_get_request' is set
8882
- if @api_client.config.client_side_validation && transfer_get_request.nil?
8883
- fail ArgumentError, "Missing the required parameter 'transfer_get_request' when calling PlaidApi.transfer_get"
9986
+ # verify the required parameter 'transfer_recurring_get_request' is set
9987
+ if @api_client.config.client_side_validation && transfer_recurring_get_request.nil?
9988
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_get_request' when calling PlaidApi.transfer_recurring_get"
8884
9989
  end
8885
9990
  # resource path
8886
- local_var_path = '/transfer/get'
9991
+ local_var_path = '/transfer/recurring/get'
8887
9992
 
8888
9993
  # query parameters
8889
9994
  query_params = opts[:query_params] || {}
@@ -8899,16 +10004,16 @@ module Plaid
8899
10004
  form_params = opts[:form_params] || {}
8900
10005
 
8901
10006
  # http body (model)
8902
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_get_request)
10007
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_get_request)
8903
10008
 
8904
10009
  # return_type
8905
- return_type = opts[:debug_return_type] || 'TransferGetResponse'
10010
+ return_type = opts[:debug_return_type] || 'TransferRecurringGetResponse'
8906
10011
 
8907
10012
  # auth_names
8908
10013
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8909
10014
 
8910
10015
  new_options = opts.merge(
8911
- :operation => :"PlaidApi.transfer_get",
10016
+ :operation => :"PlaidApi.transfer_recurring_get",
8912
10017
  :header_params => header_params,
8913
10018
  :query_params => query_params,
8914
10019
  :form_params => form_params,
@@ -8919,36 +10024,36 @@ module Plaid
8919
10024
 
8920
10025
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8921
10026
  if @api_client.config.debugging
8922
- @api_client.config.logger.debug "API called: PlaidApi#transfer_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10027
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8923
10028
  end
8924
10029
  return data, status_code, headers
8925
10030
  end
8926
10031
 
8927
- # Create a transfer intent object to invoke the Transfer UI
8928
- # Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
8929
- # @param transfer_intent_create_request [TransferIntentCreateRequest]
10032
+ # List recurring transfers
10033
+ # 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.
10034
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
8930
10035
  # @param [Hash] opts the optional parameters
8931
- # @return [TransferIntentCreateResponse]
8932
- def transfer_intent_create(transfer_intent_create_request, opts = {})
8933
- data, _status_code, _headers = transfer_intent_create_with_http_info(transfer_intent_create_request, opts)
10036
+ # @return [TransferRecurringListResponse]
10037
+ def transfer_recurring_list(transfer_recurring_list_request, opts = {})
10038
+ data, _status_code, _headers = transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts)
8934
10039
  data
8935
10040
  end
8936
10041
 
8937
- # Create a transfer intent object to invoke the Transfer UI
8938
- # Use the &#x60;/transfer/intent/create&#x60; endpoint to generate a transfer intent object and invoke the Transfer UI.
8939
- # @param transfer_intent_create_request [TransferIntentCreateRequest]
10042
+ # List recurring transfers
10043
+ # 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.
10044
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
8940
10045
  # @param [Hash] opts the optional parameters
8941
- # @return [Array<(TransferIntentCreateResponse, Integer, Hash)>] TransferIntentCreateResponse data, response status code and response headers
8942
- def transfer_intent_create_with_http_info(transfer_intent_create_request, opts = {})
10046
+ # @return [Array<(TransferRecurringListResponse, Integer, Hash)>] TransferRecurringListResponse data, response status code and response headers
10047
+ def transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts = {})
8943
10048
  if @api_client.config.debugging
8944
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_create ...'
10049
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_list ...'
8945
10050
  end
8946
- # verify the required parameter 'transfer_intent_create_request' is set
8947
- if @api_client.config.client_side_validation && transfer_intent_create_request.nil?
8948
- fail ArgumentError, "Missing the required parameter 'transfer_intent_create_request' when calling PlaidApi.transfer_intent_create"
10051
+ # verify the required parameter 'transfer_recurring_list_request' is set
10052
+ if @api_client.config.client_side_validation && transfer_recurring_list_request.nil?
10053
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_list_request' when calling PlaidApi.transfer_recurring_list"
8949
10054
  end
8950
10055
  # resource path
8951
- local_var_path = '/transfer/intent/create'
10056
+ local_var_path = '/transfer/recurring/list'
8952
10057
 
8953
10058
  # query parameters
8954
10059
  query_params = opts[:query_params] || {}
@@ -8964,16 +10069,16 @@ module Plaid
8964
10069
  form_params = opts[:form_params] || {}
8965
10070
 
8966
10071
  # http body (model)
8967
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_intent_create_request)
10072
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_list_request)
8968
10073
 
8969
10074
  # return_type
8970
- return_type = opts[:debug_return_type] || 'TransferIntentCreateResponse'
10075
+ return_type = opts[:debug_return_type] || 'TransferRecurringListResponse'
8971
10076
 
8972
10077
  # auth_names
8973
10078
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8974
10079
 
8975
10080
  new_options = opts.merge(
8976
- :operation => :"PlaidApi.transfer_intent_create",
10081
+ :operation => :"PlaidApi.transfer_recurring_list",
8977
10082
  :header_params => header_params,
8978
10083
  :query_params => query_params,
8979
10084
  :form_params => form_params,
@@ -8984,36 +10089,36 @@ module Plaid
8984
10089
 
8985
10090
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
8986
10091
  if @api_client.config.debugging
8987
- @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10092
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8988
10093
  end
8989
10094
  return data, status_code, headers
8990
10095
  end
8991
10096
 
8992
- # Retrieve more information about a transfer intent
8993
- # Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
8994
- # @param request_body [Hash<String, Object>]
10097
+ # Cancel a refund
10098
+ # 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.
10099
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
8995
10100
  # @param [Hash] opts the optional parameters
8996
- # @return [TransferIntentGetResponse]
8997
- def transfer_intent_get(request_body, opts = {})
8998
- data, _status_code, _headers = transfer_intent_get_with_http_info(request_body, opts)
10101
+ # @return [TransferRefundCancelResponse]
10102
+ def transfer_refund_cancel(transfer_refund_cancel_request, opts = {})
10103
+ data, _status_code, _headers = transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts)
8999
10104
  data
9000
10105
  end
9001
10106
 
9002
- # Retrieve more information about a transfer intent
9003
- # Use the &#x60;/transfer/intent/get&#x60; endpoint to retrieve more information about a transfer intent.
9004
- # @param request_body [Hash<String, Object>]
10107
+ # Cancel a refund
10108
+ # 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.
10109
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
9005
10110
  # @param [Hash] opts the optional parameters
9006
- # @return [Array<(TransferIntentGetResponse, Integer, Hash)>] TransferIntentGetResponse data, response status code and response headers
9007
- def transfer_intent_get_with_http_info(request_body, opts = {})
10111
+ # @return [Array<(TransferRefundCancelResponse, Integer, Hash)>] TransferRefundCancelResponse data, response status code and response headers
10112
+ def transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts = {})
9008
10113
  if @api_client.config.debugging
9009
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_get ...'
10114
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_cancel ...'
9010
10115
  end
9011
- # verify the required parameter 'request_body' is set
9012
- if @api_client.config.client_side_validation && request_body.nil?
9013
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.transfer_intent_get"
10116
+ # verify the required parameter 'transfer_refund_cancel_request' is set
10117
+ if @api_client.config.client_side_validation && transfer_refund_cancel_request.nil?
10118
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_cancel_request' when calling PlaidApi.transfer_refund_cancel"
9014
10119
  end
9015
10120
  # resource path
9016
- local_var_path = '/transfer/intent/get'
10121
+ local_var_path = '/transfer/refund/cancel'
9017
10122
 
9018
10123
  # query parameters
9019
10124
  query_params = opts[:query_params] || {}
@@ -9029,16 +10134,16 @@ module Plaid
9029
10134
  form_params = opts[:form_params] || {}
9030
10135
 
9031
10136
  # http body (model)
9032
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
10137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_cancel_request)
9033
10138
 
9034
10139
  # return_type
9035
- return_type = opts[:debug_return_type] || 'TransferIntentGetResponse'
10140
+ return_type = opts[:debug_return_type] || 'TransferRefundCancelResponse'
9036
10141
 
9037
10142
  # auth_names
9038
10143
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9039
10144
 
9040
10145
  new_options = opts.merge(
9041
- :operation => :"PlaidApi.transfer_intent_get",
10146
+ :operation => :"PlaidApi.transfer_refund_cancel",
9042
10147
  :header_params => header_params,
9043
10148
  :query_params => query_params,
9044
10149
  :form_params => form_params,
@@ -9049,36 +10154,36 @@ module Plaid
9049
10154
 
9050
10155
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9051
10156
  if @api_client.config.debugging
9052
- @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10157
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9053
10158
  end
9054
10159
  return data, status_code, headers
9055
10160
  end
9056
10161
 
9057
- # List transfers
9058
- # Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
9059
- # @param transfer_list_request [TransferListRequest]
10162
+ # Create a refund
10163
+ # 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.
10164
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
9060
10165
  # @param [Hash] opts the optional parameters
9061
- # @return [TransferListResponse]
9062
- def transfer_list(transfer_list_request, opts = {})
9063
- data, _status_code, _headers = transfer_list_with_http_info(transfer_list_request, opts)
10166
+ # @return [TransferRefundCreateResponse]
10167
+ def transfer_refund_create(transfer_refund_create_request, opts = {})
10168
+ data, _status_code, _headers = transfer_refund_create_with_http_info(transfer_refund_create_request, opts)
9064
10169
  data
9065
10170
  end
9066
10171
 
9067
- # List transfers
9068
- # Use the &#x60;/transfer/list&#x60; endpoint to see a list of all your transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired transfers.
9069
- # @param transfer_list_request [TransferListRequest]
10172
+ # Create a refund
10173
+ # 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.
10174
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
9070
10175
  # @param [Hash] opts the optional parameters
9071
- # @return [Array<(TransferListResponse, Integer, Hash)>] TransferListResponse data, response status code and response headers
9072
- def transfer_list_with_http_info(transfer_list_request, opts = {})
10176
+ # @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
10177
+ def transfer_refund_create_with_http_info(transfer_refund_create_request, opts = {})
9073
10178
  if @api_client.config.debugging
9074
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_list ...'
10179
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_create ...'
9075
10180
  end
9076
- # verify the required parameter 'transfer_list_request' is set
9077
- if @api_client.config.client_side_validation && transfer_list_request.nil?
9078
- fail ArgumentError, "Missing the required parameter 'transfer_list_request' when calling PlaidApi.transfer_list"
10181
+ # verify the required parameter 'transfer_refund_create_request' is set
10182
+ if @api_client.config.client_side_validation && transfer_refund_create_request.nil?
10183
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_create_request' when calling PlaidApi.transfer_refund_create"
9079
10184
  end
9080
10185
  # resource path
9081
- local_var_path = '/transfer/list'
10186
+ local_var_path = '/transfer/refund/create'
9082
10187
 
9083
10188
  # query parameters
9084
10189
  query_params = opts[:query_params] || {}
@@ -9094,16 +10199,16 @@ module Plaid
9094
10199
  form_params = opts[:form_params] || {}
9095
10200
 
9096
10201
  # http body (model)
9097
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_list_request)
10202
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_create_request)
9098
10203
 
9099
10204
  # return_type
9100
- return_type = opts[:debug_return_type] || 'TransferListResponse'
10205
+ return_type = opts[:debug_return_type] || 'TransferRefundCreateResponse'
9101
10206
 
9102
10207
  # auth_names
9103
10208
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9104
10209
 
9105
10210
  new_options = opts.merge(
9106
- :operation => :"PlaidApi.transfer_list",
10211
+ :operation => :"PlaidApi.transfer_refund_create",
9107
10212
  :header_params => header_params,
9108
10213
  :query_params => query_params,
9109
10214
  :form_params => form_params,
@@ -9114,36 +10219,36 @@ module Plaid
9114
10219
 
9115
10220
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9116
10221
  if @api_client.config.debugging
9117
- @api_client.config.logger.debug "API called: PlaidApi#transfer_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10222
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9118
10223
  end
9119
10224
  return data, status_code, headers
9120
10225
  end
9121
10226
 
9122
- # Migrate account into Transfers
9123
- # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
9124
- # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
10227
+ # Retrieve a refund
10228
+ # The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.
10229
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
9125
10230
  # @param [Hash] opts the optional parameters
9126
- # @return [TransferMigrateAccountResponse]
9127
- def transfer_migrate_account(transfer_migrate_account_request, opts = {})
9128
- data, _status_code, _headers = transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts)
10231
+ # @return [TransferRefundGetResponse]
10232
+ def transfer_refund_get(transfer_refund_get_request, opts = {})
10233
+ data, _status_code, _headers = transfer_refund_get_with_http_info(transfer_refund_get_request, opts)
9129
10234
  data
9130
10235
  end
9131
10236
 
9132
- # Migrate account into Transfers
9133
- # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
9134
- # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
10237
+ # Retrieve a refund
10238
+ # The &#x60;/transfer/refund/get&#x60; endpoint fetches information about the refund corresponding to the given &#x60;refund_id&#x60;.
10239
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
9135
10240
  # @param [Hash] opts the optional parameters
9136
- # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
9137
- def transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts = {})
10241
+ # @return [Array<(TransferRefundGetResponse, Integer, Hash)>] TransferRefundGetResponse data, response status code and response headers
10242
+ def transfer_refund_get_with_http_info(transfer_refund_get_request, opts = {})
9138
10243
  if @api_client.config.debugging
9139
- @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_migrate_account ...'
10244
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_get ...'
9140
10245
  end
9141
- # verify the required parameter 'transfer_migrate_account_request' is set
9142
- if @api_client.config.client_side_validation && transfer_migrate_account_request.nil?
9143
- fail ArgumentError, "Missing the required parameter 'transfer_migrate_account_request' when calling PlaidApi.transfer_migrate_account"
10246
+ # verify the required parameter 'transfer_refund_get_request' is set
10247
+ if @api_client.config.client_side_validation && transfer_refund_get_request.nil?
10248
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_get_request' when calling PlaidApi.transfer_refund_get"
9144
10249
  end
9145
10250
  # resource path
9146
- local_var_path = '/transfer/migrate_account'
10251
+ local_var_path = '/transfer/refund/get'
9147
10252
 
9148
10253
  # query parameters
9149
10254
  query_params = opts[:query_params] || {}
@@ -9159,16 +10264,16 @@ module Plaid
9159
10264
  form_params = opts[:form_params] || {}
9160
10265
 
9161
10266
  # http body (model)
9162
- post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_migrate_account_request)
10267
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_get_request)
9163
10268
 
9164
10269
  # return_type
9165
- return_type = opts[:debug_return_type] || 'TransferMigrateAccountResponse'
10270
+ return_type = opts[:debug_return_type] || 'TransferRefundGetResponse'
9166
10271
 
9167
10272
  # auth_names
9168
10273
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9169
10274
 
9170
10275
  new_options = opts.merge(
9171
- :operation => :"PlaidApi.transfer_migrate_account",
10276
+ :operation => :"PlaidApi.transfer_refund_get",
9172
10277
  :header_params => header_params,
9173
10278
  :query_params => query_params,
9174
10279
  :form_params => form_params,
@@ -9179,7 +10284,7 @@ module Plaid
9179
10284
 
9180
10285
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9181
10286
  if @api_client.config.debugging
9182
- @api_client.config.logger.debug "API called: PlaidApi#transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10287
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9183
10288
  end
9184
10289
  return data, status_code, headers
9185
10290
  end
@@ -9834,11 +10939,76 @@ module Plaid
9834
10939
  return data, status_code, headers
9835
10940
  end
9836
10941
 
10942
+ # List e-wallet transactions
10943
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
10944
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10945
+ # @param [Hash] opts the optional parameters
10946
+ # @return [WalletTransactionListResponse]
10947
+ def wallet_transaction_list(wallet_transaction_list_request, opts = {})
10948
+ data, _status_code, _headers = wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts)
10949
+ data
10950
+ end
10951
+
10952
+ # List e-wallet transactions
10953
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
10954
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10955
+ # @param [Hash] opts the optional parameters
10956
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
10957
+ def wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts = {})
10958
+ if @api_client.config.debugging
10959
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_list ...'
10960
+ end
10961
+ # verify the required parameter 'wallet_transaction_list_request' is set
10962
+ if @api_client.config.client_side_validation && wallet_transaction_list_request.nil?
10963
+ fail ArgumentError, "Missing the required parameter 'wallet_transaction_list_request' when calling PlaidApi.wallet_transaction_list"
10964
+ end
10965
+ # resource path
10966
+ local_var_path = '/wallet/transaction/list'
10967
+
10968
+ # query parameters
10969
+ query_params = opts[:query_params] || {}
10970
+
10971
+ # header parameters
10972
+ header_params = opts[:header_params] || {}
10973
+ # HTTP header 'Accept' (if needed)
10974
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10975
+ # HTTP header 'Content-Type'
10976
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10977
+
10978
+ # form parameters
10979
+ form_params = opts[:form_params] || {}
10980
+
10981
+ # http body (model)
10982
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_list_request)
10983
+
10984
+ # return_type
10985
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
10986
+
10987
+ # auth_names
10988
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10989
+
10990
+ new_options = opts.merge(
10991
+ :operation => :"PlaidApi.wallet_transaction_list",
10992
+ :header_params => header_params,
10993
+ :query_params => query_params,
10994
+ :form_params => form_params,
10995
+ :body => post_body,
10996
+ :auth_names => auth_names,
10997
+ :return_type => return_type
10998
+ )
10999
+
11000
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
11001
+ if @api_client.config.debugging
11002
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
11003
+ end
11004
+ return data, status_code, headers
11005
+ end
11006
+
9837
11007
  # List e-wallet transactions
9838
11008
  # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
9839
11009
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9840
11010
  # @param [Hash] opts the optional parameters
9841
- # @return [WalletTransactionsListResponse]
11011
+ # @return [WalletTransactionListResponse]
9842
11012
  def wallet_transactions_list(wallet_transactions_list_request, opts = {})
9843
11013
  data, _status_code, _headers = wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts)
9844
11014
  data
@@ -9848,7 +11018,7 @@ module Plaid
9848
11018
  # 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
11019
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9850
11020
  # @param [Hash] opts the optional parameters
9851
- # @return [Array<(WalletTransactionsListResponse, Integer, Hash)>] WalletTransactionsListResponse data, response status code and response headers
11021
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
9852
11022
  def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
9853
11023
  if @api_client.config.debugging
9854
11024
  @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
@@ -9877,7 +11047,7 @@ module Plaid
9877
11047
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transactions_list_request)
9878
11048
 
9879
11049
  # return_type
9880
- return_type = opts[:debug_return_type] || 'WalletTransactionsListResponse'
11050
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
9881
11051
 
9882
11052
  # auth_names
9883
11053
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']