plaid 16.0.0 → 17.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (1029) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +208 -0
  3. data/Dockerfile +1 -1
  4. data/Gemfile.lock +6 -22
  5. data/Makefile +1 -1
  6. data/README.md +1 -1
  7. data/lib/plaid/api/plaid_api.rb +1440 -140
  8. data/lib/plaid/api_client.rb +5 -3
  9. data/lib/plaid/api_error.rb +1 -1
  10. data/lib/plaid/configuration.rb +1 -1
  11. data/lib/plaid/models/account_access.rb +1 -1
  12. data/lib/plaid/models/account_assets.rb +1 -1
  13. data/lib/plaid/models/account_assets_all_of.rb +1 -1
  14. data/lib/plaid/models/account_balance.rb +1 -1
  15. data/lib/plaid/models/account_base.rb +1 -1
  16. data/lib/plaid/models/account_filter.rb +1 -1
  17. data/lib/plaid/models/account_filters_response.rb +1 -1
  18. data/lib/plaid/models/account_identity.rb +1 -1
  19. data/lib/plaid/models/account_identity_all_of.rb +1 -1
  20. data/lib/plaid/models/account_identity_match_score.rb +1 -1
  21. data/lib/plaid/models/account_identity_match_score_all_of.rb +1 -1
  22. data/lib/plaid/models/account_product_access.rb +1 -1
  23. data/lib/plaid/models/account_product_access_nullable.rb +1 -1
  24. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  25. data/lib/plaid/models/account_subtype.rb +2 -1
  26. data/lib/plaid/models/account_type.rb +1 -1
  27. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  28. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  29. data/lib/plaid/models/accounts_get_request.rb +1 -1
  30. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  31. data/lib/plaid/models/accounts_get_response.rb +1 -1
  32. data/lib/plaid/models/ach_class.rb +1 -1
  33. data/lib/plaid/models/address.rb +1 -1
  34. data/lib/plaid/models/address_data.rb +1 -1
  35. data/lib/plaid/models/address_data_nullable.rb +1 -1
  36. data/lib/plaid/models/address_match_score.rb +1 -1
  37. data/lib/plaid/models/address_nullable.rb +1 -1
  38. data/lib/plaid/models/address_purpose_label.rb +1 -1
  39. data/lib/plaid/models/application.rb +1 -1
  40. data/lib/plaid/models/application_get_request.rb +1 -1
  41. data/lib/plaid/models/application_get_response.rb +1 -1
  42. data/lib/plaid/models/apr.rb +1 -1
  43. data/lib/plaid/models/asset.rb +1 -1
  44. data/lib/plaid/models/asset_detail.rb +1 -1
  45. data/lib/plaid/models/asset_holder.rb +1 -1
  46. data/lib/plaid/models/asset_holder_name.rb +1 -1
  47. data/lib/plaid/models/asset_owner.rb +1 -1
  48. data/lib/plaid/models/asset_owners.rb +1 -1
  49. data/lib/plaid/models/asset_report.rb +1 -1
  50. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -6
  51. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  52. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  53. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  54. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  55. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  56. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  57. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  58. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  59. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  60. data/lib/plaid/models/asset_report_freddie.rb +2 -2
  61. data/lib/plaid/models/asset_report_freddie_get_request.rb +1 -1
  62. data/lib/plaid/models/asset_report_freddie_get_response.rb +20 -5
  63. data/lib/plaid/models/asset_report_get_request.rb +1 -1
  64. data/lib/plaid/models/asset_report_get_request_options.rb +1 -1
  65. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  66. data/lib/plaid/models/asset_report_item.rb +1 -1
  67. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  68. data/lib/plaid/models/asset_report_pdf_get_request_options.rb +1 -1
  69. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  70. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  71. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  72. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  73. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  74. data/lib/plaid/models/asset_report_transaction.rb +1 -1
  75. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  76. data/lib/plaid/models/asset_report_user.rb +1 -1
  77. data/lib/plaid/models/asset_transaction.rb +1 -1
  78. data/lib/plaid/models/asset_transaction_category_type.rb +1 -1
  79. data/lib/plaid/models/asset_transaction_description.rb +1 -1
  80. data/lib/plaid/models/asset_transaction_detail.rb +1 -1
  81. data/lib/plaid/models/asset_transaction_type.rb +1 -1
  82. data/lib/plaid/models/asset_transactions.rb +1 -1
  83. data/lib/plaid/models/asset_type.rb +1 -1
  84. data/lib/plaid/models/assets.rb +1 -1
  85. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  86. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  87. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  88. data/lib/plaid/models/auth_get_request.rb +1 -1
  89. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  90. data/lib/plaid/models/auth_get_response.rb +1 -1
  91. data/lib/plaid/models/auth_metadata.rb +1 -1
  92. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  93. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  94. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  95. data/lib/plaid/models/bank_transfer.rb +1 -1
  96. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  97. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  98. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  99. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  100. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  101. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  102. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  103. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  104. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  105. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +1 -1
  106. data/lib/plaid/models/bank_transfer_event_list_direction.rb +1 -1
  107. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  108. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  109. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  110. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_sweep.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  128. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  129. data/lib/plaid/models/categories_get_response.rb +1 -1
  130. data/lib/plaid/models/category.rb +1 -1
  131. data/lib/plaid/models/cause.rb +2 -37
  132. data/lib/plaid/models/cause_all_of.rb +1 -1
  133. data/lib/plaid/models/client_provided_enhanced_transaction.rb +1 -1
  134. data/lib/plaid/models/client_provided_enriched_transaction.rb +293 -0
  135. data/lib/plaid/models/client_provided_raw_transaction.rb +4 -4
  136. data/lib/plaid/models/client_provided_transaction.rb +279 -0
  137. data/lib/plaid/models/connected_application.rb +1 -1
  138. data/lib/plaid/models/counterparty.rb +1 -1
  139. data/lib/plaid/models/counterparty_type.rb +1 -1
  140. data/lib/plaid/models/country_code.rb +8 -1
  141. data/lib/plaid/models/credit1099.rb +1 -1
  142. data/lib/plaid/models/credit1099_filer.rb +1 -1
  143. data/lib/plaid/models/credit1099_payer.rb +1 -1
  144. data/lib/plaid/models/credit1099_recipient.rb +1 -1
  145. data/lib/plaid/models/credit_account_subtype.rb +1 -1
  146. data/lib/plaid/models/credit_audit_copy_token_create_request.rb +5 -20
  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 +1 -1
  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 +1 -1
  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 +2 -2
  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_payroll_income_get_request.rb +1 -1
  189. data/lib/plaid/models/credit_payroll_income_get_response.rb +1 -1
  190. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +1 -1
  191. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +1 -1
  192. data/lib/plaid/models/credit_payroll_income_refresh_request.rb +1 -1
  193. data/lib/plaid/models/credit_payroll_income_refresh_response.rb +1 -1
  194. data/lib/plaid/models/credit_payroll_income_risk_signals_get_request.rb +1 -1
  195. data/lib/plaid/models/credit_payroll_income_risk_signals_get_response.rb +1 -1
  196. data/lib/plaid/models/credit_platform_ids.rb +1 -1
  197. data/lib/plaid/models/credit_relay_create_request.rb +1 -1
  198. data/lib/plaid/models/credit_relay_create_response.rb +1 -1
  199. data/lib/plaid/models/credit_relay_get_request.rb +1 -1
  200. data/lib/plaid/models/credit_relay_refresh_request.rb +1 -1
  201. data/lib/plaid/models/credit_relay_refresh_response.rb +1 -1
  202. data/lib/plaid/models/credit_relay_remove_request.rb +1 -1
  203. data/lib/plaid/models/credit_relay_remove_response.rb +1 -1
  204. data/lib/plaid/models/credit_session.rb +20 -8
  205. data/lib/plaid/models/credit_session_bank_income_result.rb +4 -2
  206. data/lib/plaid/models/credit_session_bank_income_status.rb +2 -1
  207. data/lib/plaid/models/credit_session_document_income_result.rb +240 -0
  208. data/lib/plaid/models/{error.rb → credit_session_error.rb} +14 -117
  209. data/lib/plaid/models/credit_session_item_add_result.rb +15 -12
  210. data/lib/plaid/models/credit_session_payroll_income_result.rb +250 -0
  211. data/lib/plaid/models/credit_session_results.rb +30 -6
  212. data/lib/plaid/models/credit_sessions_get_request.rb +1 -1
  213. data/lib/plaid/models/credit_sessions_get_response.rb +2 -1
  214. data/lib/plaid/models/credit_w2.rb +1 -1
  215. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  216. data/lib/plaid/models/dashboard_user.rb +1 -1
  217. data/lib/plaid/models/dashboard_user_get_request.rb +1 -1
  218. data/lib/plaid/models/dashboard_user_get_response.rb +1 -1
  219. data/lib/plaid/models/dashboard_user_list_request.rb +1 -1
  220. data/lib/plaid/models/dashboard_user_list_response.rb +1 -1
  221. data/lib/plaid/models/dashboard_user_status.rb +1 -1
  222. data/lib/plaid/models/date_range.rb +1 -1
  223. data/lib/plaid/models/deductions.rb +1 -1
  224. data/lib/plaid/models/deductions_breakdown.rb +1 -1
  225. data/lib/plaid/models/deductions_total.rb +1 -1
  226. data/lib/plaid/models/default_update_webhook.rb +2 -2
  227. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  228. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  229. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  230. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  231. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  232. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  233. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  234. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  235. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  236. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  237. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  238. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  239. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  240. data/lib/plaid/models/depository_account_subtype.rb +1 -1
  241. data/lib/plaid/models/depository_filter.rb +1 -1
  242. data/lib/plaid/models/disbursement_limits.rb +255 -0
  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 +1 -1
  276. data/lib/plaid/models/enrich_transaction_direction.rb +39 -0
  277. data/lib/plaid/models/enrichments.rb +342 -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 +2 -1
  323. data/lib/plaid/models/historical_balance.rb +1 -1
  324. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  325. data/lib/plaid/models/holding.rb +3 -3
  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 +2 -3
  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 +2 -2
  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 +2 -2
  393. data/lib/plaid/models/institution.rb +2 -2
  394. data/lib/plaid/models/institution_status.rb +9 -1
  395. data/lib/plaid/models/institutions_get_by_id_request.rb +1 -1
  396. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  397. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  398. data/lib/plaid/models/institutions_get_request.rb +1 -1
  399. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  400. data/lib/plaid/models/institutions_get_response.rb +1 -1
  401. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  402. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  403. data/lib/plaid/models/institutions_search_request.rb +1 -1
  404. data/lib/plaid/models/institutions_search_request_options.rb +2 -2
  405. data/lib/plaid/models/institutions_search_response.rb +1 -1
  406. data/lib/plaid/models/investment_account_subtype.rb +2 -1
  407. data/lib/plaid/models/investment_filter.rb +1 -1
  408. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  409. data/lib/plaid/models/investment_transaction.rb +1 -1
  410. data/lib/plaid/models/investment_transaction_subtype.rb +2 -1
  411. data/lib/plaid/models/investment_transaction_type.rb +1 -1
  412. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  413. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  414. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  415. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  416. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  417. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  418. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  419. data/lib/plaid/models/issuing_country.rb +1 -1
  420. data/lib/plaid/models/item.rb +1 -1
  421. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  422. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  423. data/lib/plaid/models/item_application_list_request.rb +1 -1
  424. data/lib/plaid/models/item_application_list_response.rb +1 -1
  425. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  426. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  427. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  428. data/lib/plaid/models/item_error_webhook.rb +1 -1
  429. data/lib/plaid/models/item_get_request.rb +1 -1
  430. data/lib/plaid/models/item_get_response.rb +1 -1
  431. data/lib/plaid/models/item_import_request.rb +1 -1
  432. data/lib/plaid/models/item_import_request_options.rb +1 -1
  433. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  434. data/lib/plaid/models/item_import_response.rb +1 -1
  435. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  436. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  437. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  438. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  439. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  440. data/lib/plaid/models/item_remove_request.rb +1 -1
  441. data/lib/plaid/models/item_remove_response.rb +1 -1
  442. data/lib/plaid/models/item_status.rb +1 -1
  443. data/lib/plaid/models/item_status_investments.rb +1 -1
  444. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  445. data/lib/plaid/models/item_status_nullable.rb +1 -1
  446. data/lib/plaid/models/item_status_transactions.rb +1 -1
  447. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  448. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  449. data/lib/plaid/models/jwk_public_key.rb +1 -1
  450. data/lib/plaid/models/jwt_header.rb +1 -1
  451. data/lib/plaid/models/kyc_check_address_summary.rb +1 -1
  452. data/lib/plaid/models/kyc_check_date_of_birth_summary.rb +1 -1
  453. data/lib/plaid/models/kyc_check_details.rb +1 -1
  454. data/lib/plaid/models/kyc_check_id_number_summary.rb +1 -1
  455. data/lib/plaid/models/kyc_check_name_summary.rb +1 -1
  456. data/lib/plaid/models/kyc_check_phone_summary.rb +1 -1
  457. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  458. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  459. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  460. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  461. data/lib/plaid/models/liabilities_object.rb +1 -1
  462. data/lib/plaid/models/liability_override.rb +1 -1
  463. data/lib/plaid/models/link_delivery_create_request.rb +1 -1
  464. data/lib/plaid/models/link_delivery_create_response.rb +1 -1
  465. data/lib/plaid/models/link_delivery_delivery_method.rb +1 -1
  466. data/lib/plaid/models/link_delivery_get_request.rb +1 -1
  467. data/lib/plaid/models/link_delivery_get_response.rb +1 -1
  468. data/lib/plaid/models/link_delivery_session_status.rb +1 -1
  469. data/lib/plaid/models/link_o_auth_correlation_id_exchange_request.rb +245 -0
  470. data/lib/plaid/models/{income_verification_refresh_response.rb → link_o_auth_correlation_id_exchange_response.rb} +24 -23
  471. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  472. data/lib/plaid/models/link_token_create_credit_filter.rb +1 -1
  473. data/lib/plaid/models/link_token_create_depository_filter.rb +1 -1
  474. data/lib/plaid/models/link_token_create_institution_data.rb +1 -1
  475. data/lib/plaid/models/link_token_create_investment_filter.rb +1 -1
  476. data/lib/plaid/models/link_token_create_loan_filter.rb +1 -1
  477. data/lib/plaid/models/link_token_create_request.rb +4 -4
  478. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +1 -1
  479. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  480. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  481. data/lib/plaid/models/link_token_create_request_identity_verification.rb +1 -1
  482. data/lib/plaid/models/link_token_create_request_income_verification.rb +1 -1
  483. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +1 -1
  484. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +1 -1
  485. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +5 -14
  486. data/lib/plaid/models/link_token_create_request_transfer.rb +9 -9
  487. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  488. data/lib/plaid/models/link_token_create_request_user.rb +1 -2
  489. data/lib/plaid/models/link_token_create_request_user_stated_income_source.rb +1 -1
  490. data/lib/plaid/models/link_token_create_response.rb +1 -1
  491. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  492. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  493. data/lib/plaid/models/link_token_get_request.rb +1 -1
  494. data/lib/plaid/models/link_token_get_response.rb +1 -1
  495. data/lib/plaid/models/link_token_investments.rb +1 -1
  496. data/lib/plaid/models/loan.rb +1 -1
  497. data/lib/plaid/models/loan_account_subtype.rb +1 -1
  498. data/lib/plaid/models/loan_filter.rb +1 -1
  499. data/lib/plaid/models/loan_identifier.rb +1 -1
  500. data/lib/plaid/models/loan_identifier_type.rb +1 -1
  501. data/lib/plaid/models/loan_identifiers.rb +1 -1
  502. data/lib/plaid/models/loans.rb +1 -1
  503. data/lib/plaid/models/location.rb +1 -1
  504. data/lib/plaid/models/match_summary.rb +1 -1
  505. data/lib/plaid/models/match_summary_code.rb +1 -1
  506. data/lib/plaid/models/meta.rb +1 -1
  507. data/lib/plaid/models/mfa.rb +1 -1
  508. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  509. data/lib/plaid/models/mortgage_liability.rb +1 -1
  510. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  511. data/lib/plaid/models/multi_document_risk_signal.rb +1 -1
  512. data/lib/plaid/models/name_match_score.rb +1 -1
  513. data/lib/plaid/models/net_pay.rb +1 -1
  514. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  515. data/lib/plaid/models/numbers.rb +1 -1
  516. data/lib/plaid/models/numbers_ach.rb +28 -6
  517. data/lib/plaid/models/numbers_ach_nullable.rb +28 -6
  518. data/lib/plaid/models/numbers_bacs.rb +1 -1
  519. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  520. data/lib/plaid/models/numbers_eft.rb +1 -1
  521. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  522. data/lib/plaid/models/numbers_iban_nullable.rb +1 -1
  523. data/lib/plaid/models/numbers_international.rb +1 -1
  524. data/lib/plaid/models/numbers_international_iban.rb +1 -1
  525. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  526. data/lib/plaid/models/originator.rb +239 -0
  527. data/lib/plaid/models/override_account_type.rb +1 -1
  528. data/lib/plaid/models/override_accounts.rb +1 -1
  529. data/lib/plaid/models/owner.rb +1 -1
  530. data/lib/plaid/models/owner_override.rb +1 -1
  531. data/lib/plaid/models/ownership_type.rb +1 -1
  532. data/lib/plaid/models/parties.rb +1 -1
  533. data/lib/plaid/models/partner_customer_create_request.rb +15 -6
  534. data/lib/plaid/models/partner_customer_create_response.rb +1 -1
  535. data/lib/plaid/models/partner_customer_enable_request.rb +244 -0
  536. data/lib/plaid/models/partner_customer_enable_response.rb +230 -0
  537. data/lib/plaid/models/partner_customer_get_request.rb +1 -1
  538. data/lib/plaid/models/partner_customer_get_response.rb +1 -1
  539. data/lib/plaid/models/partner_customer_remove_request.rb +244 -0
  540. data/lib/plaid/models/partner_customer_remove_response.rb +220 -0
  541. data/lib/plaid/models/partner_end_customer.rb +1 -2
  542. data/lib/plaid/models/partner_end_customer_address.rb +1 -1
  543. data/lib/plaid/models/partner_end_customer_assets_under_management.rb +238 -0
  544. data/lib/plaid/models/partner_end_customer_billing_contact.rb +1 -1
  545. data/lib/plaid/models/partner_end_customer_secrets.rb +3 -13
  546. data/lib/plaid/models/partner_end_customer_status.rb +2 -1
  547. data/lib/plaid/models/partner_end_customer_technical_contact.rb +1 -1
  548. data/lib/plaid/models/partner_end_customer_with_secrets.rb +10 -3
  549. data/lib/plaid/models/partner_end_customer_with_secrets_all_of.rb +218 -0
  550. data/lib/plaid/models/party.rb +1 -1
  551. data/lib/plaid/models/party_individual.rb +1 -1
  552. data/lib/plaid/models/party_role_type.rb +1 -1
  553. data/lib/plaid/models/pay.rb +1 -1
  554. data/lib/plaid/models/pay_frequency.rb +1 -1
  555. data/lib/plaid/models/pay_frequency_value.rb +1 -1
  556. data/lib/plaid/models/pay_period_details.rb +1 -1
  557. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +1 -1
  558. data/lib/plaid/models/pay_stub_deductions_total.rb +1 -1
  559. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +1 -1
  560. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +1 -1
  561. data/lib/plaid/models/pay_stub_earnings_total.rb +1 -1
  562. data/lib/plaid/models/pay_stub_pay_period_details.rb +1 -1
  563. data/lib/plaid/models/pay_stub_taxpayer_id.rb +1 -1
  564. data/lib/plaid/models/payment_amount.rb +1 -1
  565. data/lib/plaid/models/payment_amount_currency.rb +1 -1
  566. data/lib/plaid/models/payment_amount_nullable.rb +239 -0
  567. data/lib/plaid/models/payment_amount_refunded.rb +246 -0
  568. data/lib/plaid/models/payment_amount_to_refund.rb +246 -0
  569. data/lib/plaid/models/payment_channel.rb +1 -1
  570. data/lib/plaid/models/payment_consent_max_payment_amount.rb +1 -1
  571. data/lib/plaid/models/payment_consent_periodic_alignment.rb +1 -1
  572. data/lib/plaid/models/payment_consent_periodic_amount.rb +1 -1
  573. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +1 -1
  574. data/lib/plaid/models/payment_consent_periodic_interval.rb +1 -1
  575. data/lib/plaid/models/payment_consent_valid_date_time.rb +1 -1
  576. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  577. data/lib/plaid/models/payment_initiation_consent.rb +1 -1
  578. data/lib/plaid/models/payment_initiation_consent_constraints.rb +1 -1
  579. data/lib/plaid/models/payment_initiation_consent_create_request.rb +1 -1
  580. data/lib/plaid/models/payment_initiation_consent_create_response.rb +1 -1
  581. data/lib/plaid/models/payment_initiation_consent_get_request.rb +1 -1
  582. data/lib/plaid/models/payment_initiation_consent_get_response.rb +1 -1
  583. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +1 -1
  584. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +1 -1
  585. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +1 -1
  586. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +1 -1
  587. data/lib/plaid/models/payment_initiation_consent_scope.rb +1 -1
  588. data/lib/plaid/models/payment_initiation_consent_status.rb +1 -1
  589. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  590. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  591. data/lib/plaid/models/payment_initiation_payment.rb +26 -6
  592. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  593. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  594. data/lib/plaid/models/payment_initiation_payment_create_status.rb +1 -1
  595. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  596. data/lib/plaid/models/payment_initiation_payment_get_response.rb +22 -2
  597. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  598. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  599. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +14 -5
  600. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  601. data/lib/plaid/models/payment_initiation_payment_status.rb +1 -1
  602. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  603. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  604. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  605. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  606. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  607. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  608. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  609. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  610. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  611. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  612. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  613. data/lib/plaid/models/payment_limits.rb +255 -0
  614. data/lib/plaid/models/payment_meta.rb +1 -1
  615. data/lib/plaid/models/payment_profile_create_request.rb +1 -1
  616. data/lib/plaid/models/payment_profile_create_response.rb +12 -12
  617. data/lib/plaid/models/payment_profile_get_request.rb +12 -12
  618. data/lib/plaid/models/payment_profile_get_response.rb +13 -2
  619. data/lib/plaid/models/payment_profile_remove_request.rb +12 -12
  620. data/lib/plaid/models/payment_profile_remove_response.rb +1 -1
  621. data/lib/plaid/models/payment_profile_status.rb +1 -1
  622. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  623. data/lib/plaid/models/payment_scheme.rb +1 -1
  624. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  625. data/lib/plaid/models/payroll_income_account_data.rb +1 -1
  626. data/lib/plaid/models/payroll_income_object.rb +1 -1
  627. data/lib/plaid/models/payroll_income_rate_of_pay.rb +1 -1
  628. data/lib/plaid/models/payroll_item.rb +32 -2
  629. data/lib/plaid/models/payroll_item_status.rb +1 -1
  630. data/lib/plaid/models/payroll_risk_signals_item.rb +1 -1
  631. data/lib/plaid/models/paystub.rb +1 -1
  632. data/lib/plaid/models/paystub_address.rb +1 -1
  633. data/lib/plaid/models/paystub_deduction.rb +1 -1
  634. data/lib/plaid/models/paystub_details.rb +1 -1
  635. data/lib/plaid/models/paystub_employer.rb +1 -1
  636. data/lib/plaid/models/paystub_override.rb +1 -1
  637. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  638. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  639. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  640. data/lib/plaid/models/paystub_pay_frequency.rb +1 -1
  641. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  642. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  643. data/lib/plaid/models/personal_finance_category.rb +1 -1
  644. data/lib/plaid/models/phone_number.rb +1 -1
  645. data/lib/plaid/models/phone_number_match_score.rb +9 -9
  646. data/lib/plaid/models/phone_type.rb +1 -1
  647. data/lib/plaid/models/physical_document_category.rb +1 -1
  648. data/lib/plaid/models/physical_document_extracted_data.rb +1 -1
  649. data/lib/plaid/models/physical_document_extracted_data_analysis.rb +1 -1
  650. data/lib/plaid/models/physical_document_images.rb +1 -1
  651. data/lib/plaid/models/plaid_error.rb +2 -44
  652. data/lib/plaid/models/plaid_error_type.rb +51 -0
  653. data/lib/plaid/models/platform_ids.rb +1 -1
  654. data/lib/plaid/models/po_box_status.rb +1 -1
  655. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  656. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  657. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  658. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  659. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  660. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  661. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  662. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  663. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  664. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  665. data/lib/plaid/models/processor_number.rb +1 -1
  666. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  667. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  668. data/lib/plaid/models/processor_token_create_request.rb +3 -3
  669. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  670. data/lib/plaid/models/product_access.rb +1 -1
  671. data/lib/plaid/models/product_status.rb +1 -1
  672. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  673. data/lib/plaid/models/products.rb +1 -1
  674. data/lib/plaid/models/program_name_sensitivity.rb +1 -1
  675. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  676. data/lib/plaid/models/pslf_status.rb +1 -1
  677. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  678. data/lib/plaid/models/recipient_bacs.rb +1 -1
  679. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  680. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  681. data/lib/plaid/models/recurring_transactions_update_webhook.rb +1 -1
  682. data/lib/plaid/models/recurring_transfer.rb +431 -0
  683. data/lib/plaid/models/removed_transaction.rb +1 -1
  684. data/lib/plaid/models/report_type.rb +1 -1
  685. data/lib/plaid/models/reporting_information.rb +1 -1
  686. data/lib/plaid/models/risk_signal_document_reference.rb +1 -1
  687. data/lib/plaid/models/role.rb +1 -1
  688. data/lib/plaid/models/role_detail.rb +1 -1
  689. data/lib/plaid/models/roles.rb +1 -1
  690. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  691. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  692. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  693. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  694. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +2 -2
  695. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  696. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +3 -3
  697. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  698. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  699. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  700. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  701. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  702. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  703. data/lib/plaid/models/sandbox_payment_profile_reset_login_request.rb +245 -0
  704. data/lib/plaid/models/sandbox_payment_profile_reset_login_response.rb +240 -0
  705. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  706. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  707. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  708. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  709. data/lib/plaid/models/sandbox_public_token_create_request_income_verification_bank_income.rb +220 -0
  710. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +14 -5
  711. data/lib/plaid/models/sandbox_public_token_create_request_options_income_verification.rb +231 -0
  712. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +1 -1
  713. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  714. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +1 -1
  715. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +1 -1
  716. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +1 -1
  717. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +1 -1
  718. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  719. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  720. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +1 -1
  721. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +1 -1
  722. data/lib/plaid/models/sandbox_transfer_test_clock_advance_request.rb +266 -0
  723. data/lib/plaid/models/sandbox_transfer_test_clock_advance_response.rb +225 -0
  724. data/lib/plaid/models/sandbox_transfer_test_clock_create_request.rb +255 -0
  725. data/lib/plaid/models/sandbox_transfer_test_clock_create_response.rb +239 -0
  726. data/lib/plaid/models/{income_verification_refresh_request.rb → sandbox_transfer_test_clock_get_request.rb} +24 -25
  727. data/lib/plaid/models/sandbox_transfer_test_clock_get_response.rb +239 -0
  728. data/lib/plaid/models/scopes.rb +1 -1
  729. data/lib/plaid/models/scopes_context.rb +1 -1
  730. data/lib/plaid/models/scopes_nullable.rb +1 -1
  731. data/lib/plaid/models/screening_hit_analysis.rb +1 -1
  732. data/lib/plaid/models/screening_hit_data.rb +1 -1
  733. data/lib/plaid/models/screening_hit_date_of_birth_item.rb +1 -1
  734. data/lib/plaid/models/screening_hit_documents_items.rb +1 -1
  735. data/lib/plaid/models/screening_hit_names_items.rb +1 -1
  736. data/lib/plaid/models/screening_status_updated_webhook.rb +1 -1
  737. data/lib/plaid/models/security.rb +4 -4
  738. data/lib/plaid/models/security_override.rb +3 -3
  739. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  740. data/lib/plaid/models/service.rb +1 -1
  741. data/lib/plaid/models/service_product_fulfillment.rb +1 -1
  742. data/lib/plaid/models/service_product_fulfillment_detail.rb +1 -1
  743. data/lib/plaid/models/service_product_fulfillment_identifier.rb +1 -1
  744. data/lib/plaid/models/servicer_address_data.rb +1 -1
  745. data/lib/plaid/models/services.rb +1 -1
  746. data/lib/plaid/models/signal_address_data.rb +1 -1
  747. data/lib/plaid/models/signal_decision_outcome.rb +42 -0
  748. data/lib/plaid/models/signal_decision_report_request.rb +39 -8
  749. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  750. data/lib/plaid/models/signal_device.rb +1 -1
  751. data/lib/plaid/models/signal_evaluate_core_attributes.rb +17 -6
  752. data/lib/plaid/models/signal_evaluate_request.rb +26 -4
  753. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  754. data/lib/plaid/models/signal_payment_method.rb +43 -0
  755. data/lib/plaid/models/signal_person_name.rb +1 -1
  756. data/lib/plaid/models/signal_prepare_request.rb +1 -1
  757. data/lib/plaid/models/signal_prepare_response.rb +1 -1
  758. data/lib/plaid/models/signal_return_report_request.rb +17 -6
  759. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  760. data/lib/plaid/models/signal_scores.rb +1 -1
  761. data/lib/plaid/models/signal_user.rb +1 -1
  762. data/lib/plaid/models/simulated_transfer_sweep.rb +1 -1
  763. data/lib/plaid/models/single_document_risk_signal.rb +19 -5
  764. data/lib/plaid/models/source.rb +1 -1
  765. data/lib/plaid/models/standalone_account_type.rb +1 -1
  766. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  767. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  768. data/lib/plaid/models/status.rb +1 -1
  769. data/lib/plaid/models/statuses.rb +1 -1
  770. data/lib/plaid/models/strategy.rb +1 -1
  771. data/lib/plaid/models/student_loan.rb +2 -2
  772. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  773. data/lib/plaid/models/student_loan_status.rb +1 -1
  774. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  775. data/lib/plaid/models/sync_updates_available_webhook.rb +2 -2
  776. data/lib/plaid/models/taxform.rb +1 -1
  777. data/lib/plaid/models/taxpayer_id.rb +1 -1
  778. data/lib/plaid/models/taxpayer_identifier.rb +1 -1
  779. data/lib/plaid/models/taxpayer_identifier_type.rb +1 -1
  780. data/lib/plaid/models/taxpayer_identifiers.rb +1 -1
  781. data/lib/plaid/models/total.rb +1 -1
  782. data/lib/plaid/models/total_canonical_description.rb +1 -1
  783. data/lib/plaid/models/transaction.rb +2 -2
  784. data/lib/plaid/models/transaction_all_of.rb +2 -2
  785. data/lib/plaid/models/transaction_base.rb +1 -1
  786. data/lib/plaid/models/transaction_code.rb +1 -1
  787. data/lib/plaid/models/transaction_data.rb +1 -1
  788. data/lib/plaid/models/transaction_frequency.rb +41 -0
  789. data/lib/plaid/models/transaction_override.rb +1 -1
  790. data/lib/plaid/models/transaction_stream.rb +1 -1
  791. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  792. data/lib/plaid/models/transaction_stream_status.rb +1 -1
  793. data/lib/plaid/models/transactions_category_rule.rb +1 -1
  794. data/lib/plaid/models/transactions_enhance_get_request.rb +1 -1
  795. data/lib/plaid/models/transactions_enhance_get_response.rb +2 -2
  796. data/lib/plaid/models/transactions_enrich_get_request.rb +274 -0
  797. data/lib/plaid/models/transactions_enrich_get_response.rb +237 -0
  798. data/lib/plaid/models/transactions_get_request.rb +1 -1
  799. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  800. data/lib/plaid/models/transactions_get_response.rb +1 -1
  801. data/lib/plaid/models/transactions_recurring_get_request.rb +1 -1
  802. data/lib/plaid/models/transactions_recurring_get_request_options.rb +1 -1
  803. data/lib/plaid/models/transactions_recurring_get_response.rb +1 -1
  804. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  805. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  806. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  807. data/lib/plaid/models/transactions_rule_details.rb +1 -1
  808. data/lib/plaid/models/transactions_rule_field.rb +1 -1
  809. data/lib/plaid/models/transactions_rule_type.rb +1 -1
  810. data/lib/plaid/models/transactions_rules_create_request.rb +1 -1
  811. data/lib/plaid/models/transactions_rules_create_response.rb +1 -1
  812. data/lib/plaid/models/transactions_rules_list_request.rb +1 -1
  813. data/lib/plaid/models/transactions_rules_list_response.rb +1 -1
  814. data/lib/plaid/models/transactions_rules_remove_request.rb +1 -1
  815. data/lib/plaid/models/transactions_rules_remove_response.rb +1 -1
  816. data/lib/plaid/models/transactions_sync_request.rb +1 -1
  817. data/lib/plaid/models/transactions_sync_request_options.rb +1 -1
  818. data/lib/plaid/models/transactions_sync_response.rb +3 -3
  819. data/lib/plaid/models/transfer.rb +34 -16
  820. data/lib/plaid/models/transfer_authorization.rb +1 -1
  821. data/lib/plaid/models/transfer_authorization_create_request.rb +49 -32
  822. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  823. data/lib/plaid/models/transfer_authorization_decision.rb +1 -1
  824. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  825. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +3 -2
  826. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  827. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +1 -1
  828. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +1 -1
  829. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +1 -1
  830. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +16 -15
  831. data/lib/plaid/models/transfer_authorization_user_in_request.rb +1 -1
  832. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  833. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  834. data/lib/plaid/models/transfer_create_request.rb +18 -17
  835. data/lib/plaid/models/transfer_create_response.rb +1 -1
  836. data/lib/plaid/models/transfer_device.rb +240 -0
  837. data/lib/plaid/models/transfer_diligence_status.rb +40 -0
  838. data/lib/plaid/models/transfer_event.rb +28 -6
  839. data/lib/plaid/models/transfer_event_list_request.rb +17 -6
  840. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  841. data/lib/plaid/models/transfer_event_list_transfer_type.rb +1 -1
  842. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  843. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  844. data/lib/plaid/models/transfer_event_type.rb +1 -1
  845. data/lib/plaid/models/transfer_events_update_webhook.rb +1 -1
  846. data/lib/plaid/models/transfer_failure.rb +1 -1
  847. data/lib/plaid/models/transfer_get_request.rb +1 -1
  848. data/lib/plaid/models/transfer_get_response.rb +1 -1
  849. data/lib/plaid/models/transfer_intent_authorization_decision.rb +1 -1
  850. data/lib/plaid/models/transfer_intent_create.rb +1 -6
  851. data/lib/plaid/models/transfer_intent_create_mode.rb +1 -1
  852. data/lib/plaid/models/transfer_intent_create_request.rb +1 -6
  853. data/lib/plaid/models/transfer_intent_create_response.rb +1 -1
  854. data/lib/plaid/models/transfer_intent_get.rb +1 -6
  855. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +1 -1
  856. data/lib/plaid/models/transfer_intent_get_request.rb +1 -1
  857. data/lib/plaid/models/transfer_intent_get_response.rb +1 -1
  858. data/lib/plaid/models/transfer_intent_status.rb +1 -1
  859. data/lib/plaid/models/transfer_list_request.rb +17 -6
  860. data/lib/plaid/models/transfer_list_response.rb +1 -1
  861. data/lib/plaid/models/transfer_migrate_account_request.rb +1 -1
  862. data/lib/plaid/models/transfer_migrate_account_response.rb +1 -1
  863. data/lib/plaid/models/transfer_network.rb +2 -1
  864. data/lib/plaid/models/transfer_originator_create_request.rb +245 -0
  865. data/lib/plaid/models/transfer_originator_create_response.rb +255 -0
  866. data/lib/plaid/models/transfer_originator_get_request.rb +245 -0
  867. data/lib/plaid/models/transfer_originator_get_response.rb +239 -0
  868. data/lib/plaid/models/transfer_originator_list_request.rb +297 -0
  869. data/lib/plaid/models/transfer_originator_list_response.rb +241 -0
  870. data/lib/plaid/models/transfer_questionnaire_create_request.rb +302 -0
  871. data/lib/plaid/models/transfer_questionnaire_create_response.rb +240 -0
  872. data/lib/plaid/models/transfer_recurring_cancel_request.rb +255 -0
  873. data/lib/plaid/models/transfer_recurring_cancel_response.rb +225 -0
  874. data/lib/plaid/models/transfer_recurring_create_request.rb +424 -0
  875. data/lib/plaid/models/transfer_recurring_create_response.rb +239 -0
  876. data/lib/plaid/models/transfer_recurring_get_request.rb +255 -0
  877. data/lib/plaid/models/transfer_recurring_get_response.rb +239 -0
  878. data/lib/plaid/models/transfer_recurring_list_request.rb +329 -0
  879. data/lib/plaid/models/transfer_recurring_list_response.rb +241 -0
  880. data/lib/plaid/models/transfer_recurring_schedule.rb +260 -0
  881. data/lib/plaid/models/transfer_recurring_status.rb +40 -0
  882. data/lib/plaid/models/transfer_refund.rb +284 -0
  883. data/lib/plaid/models/transfer_refund_cancel_request.rb +245 -0
  884. data/lib/plaid/models/transfer_refund_cancel_response.rb +225 -0
  885. data/lib/plaid/models/transfer_refund_create_request.rb +296 -0
  886. data/lib/plaid/models/transfer_refund_create_response.rb +239 -0
  887. data/lib/plaid/models/transfer_refund_get_request.rb +245 -0
  888. data/lib/plaid/models/transfer_refund_get_response.rb +239 -0
  889. data/lib/plaid/models/transfer_refund_status.rb +41 -0
  890. data/lib/plaid/models/transfer_repayment.rb +1 -1
  891. data/lib/plaid/models/transfer_repayment_list_request.rb +1 -1
  892. data/lib/plaid/models/transfer_repayment_list_response.rb +1 -1
  893. data/lib/plaid/models/transfer_repayment_return.rb +1 -1
  894. data/lib/plaid/models/transfer_repayment_return_list_request.rb +1 -1
  895. data/lib/plaid/models/transfer_repayment_return_list_response.rb +1 -1
  896. data/lib/plaid/models/transfer_schedule_interval_unit.rb +39 -0
  897. data/lib/plaid/models/transfer_status.rb +1 -1
  898. data/lib/plaid/models/transfer_sweep.rb +1 -1
  899. data/lib/plaid/models/transfer_sweep_get_request.rb +1 -1
  900. data/lib/plaid/models/transfer_sweep_get_response.rb +1 -1
  901. data/lib/plaid/models/transfer_sweep_list_request.rb +16 -5
  902. data/lib/plaid/models/transfer_sweep_list_response.rb +1 -1
  903. data/lib/plaid/models/transfer_sweep_status.rb +1 -1
  904. data/lib/plaid/models/transfer_test_clock.rb +236 -0
  905. data/lib/plaid/models/transfer_type.rb +1 -1
  906. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  907. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  908. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  909. data/lib/plaid/models/transfer_user_in_request_deprecated.rb +1 -13
  910. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  911. data/lib/plaid/models/update_entity_screening_request_search_terms.rb +1 -1
  912. data/lib/plaid/models/update_individual_screening_request_search_terms.rb +1 -1
  913. data/lib/plaid/models/user_address.rb +1 -1
  914. data/lib/plaid/models/user_create_request.rb +32 -2
  915. data/lib/plaid/models/user_create_response.rb +1 -1
  916. data/lib/plaid/models/user_custom_password.rb +2 -2
  917. data/lib/plaid/models/user_id_number.rb +1 -1
  918. data/lib/plaid/models/user_name.rb +1 -1
  919. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  920. data/lib/plaid/models/user_stated_income_source_category.rb +1 -1
  921. data/lib/plaid/models/user_stated_income_source_frequency.rb +1 -1
  922. data/lib/plaid/models/user_stated_income_source_pay_type.rb +1 -1
  923. data/lib/plaid/models/validation_source.rb +1 -1
  924. data/lib/plaid/models/validation_sources.rb +1 -1
  925. data/lib/plaid/models/verification_expired_webhook.rb +1 -1
  926. data/lib/plaid/models/verification_of_asset.rb +1 -1
  927. data/lib/plaid/models/verification_of_asset_response.rb +1 -1
  928. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  929. data/lib/plaid/models/verification_status.rb +1 -1
  930. data/lib/plaid/models/w2.rb +1 -1
  931. data/lib/plaid/models/w2_box12.rb +1 -1
  932. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  933. data/lib/plaid/models/wallet.rb +1 -1
  934. data/lib/plaid/models/wallet_balance.rb +1 -1
  935. data/lib/plaid/models/wallet_create_request.rb +1 -1
  936. data/lib/plaid/models/wallet_create_response.rb +1 -1
  937. data/lib/plaid/models/wallet_get_request.rb +1 -1
  938. data/lib/plaid/models/wallet_get_response.rb +1 -1
  939. data/lib/plaid/models/wallet_iso_currency_code.rb +1 -1
  940. data/lib/plaid/models/wallet_list_request.rb +1 -1
  941. data/lib/plaid/models/wallet_list_response.rb +1 -1
  942. data/lib/plaid/models/wallet_numbers.rb +1 -1
  943. data/lib/plaid/models/wallet_transaction.rb +32 -6
  944. data/lib/plaid/models/wallet_transaction_amount.rb +1 -1
  945. data/lib/plaid/models/wallet_transaction_counterparty.rb +1 -1
  946. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +1 -1
  947. data/lib/plaid/models/wallet_transaction_counterparty_international.rb +1 -1
  948. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +1 -1
  949. data/lib/plaid/models/wallet_transaction_execute_request.rb +1 -1
  950. data/lib/plaid/models/wallet_transaction_execute_response.rb +1 -1
  951. data/lib/plaid/models/wallet_transaction_get_request.rb +1 -1
  952. data/lib/plaid/models/wallet_transaction_get_response.rb +29 -3
  953. data/lib/plaid/models/wallet_transaction_list_request.rb +341 -0
  954. data/lib/plaid/models/wallet_transaction_list_request_options.rb +230 -0
  955. data/lib/plaid/models/{wallet_transactions_list_response.rb → wallet_transaction_list_response.rb} +5 -5
  956. data/lib/plaid/models/wallet_transaction_status.rb +1 -1
  957. data/lib/plaid/models/wallet_transaction_status_update_webhook.rb +1 -1
  958. data/lib/plaid/models/wallet_transactions_list_request.rb +17 -7
  959. data/lib/plaid/models/warning.rb +1 -1
  960. data/lib/plaid/models/watchlist_screening_audit_trail.rb +1 -1
  961. data/lib/plaid/models/watchlist_screening_document.rb +1 -1
  962. data/lib/plaid/models/watchlist_screening_document_type.rb +1 -1
  963. data/lib/plaid/models/watchlist_screening_entity_create_request.rb +1 -1
  964. data/lib/plaid/models/watchlist_screening_entity_create_response.rb +1 -1
  965. data/lib/plaid/models/watchlist_screening_entity_get_request.rb +1 -1
  966. data/lib/plaid/models/watchlist_screening_entity_get_response.rb +1 -1
  967. data/lib/plaid/models/watchlist_screening_entity_history_list_request.rb +1 -1
  968. data/lib/plaid/models/watchlist_screening_entity_history_list_response.rb +1 -1
  969. data/lib/plaid/models/watchlist_screening_entity_hit_list_request.rb +1 -1
  970. data/lib/plaid/models/watchlist_screening_entity_hit_list_response.rb +1 -1
  971. data/lib/plaid/models/watchlist_screening_entity_list_request.rb +1 -1
  972. data/lib/plaid/models/watchlist_screening_entity_list_response.rb +1 -1
  973. data/lib/plaid/models/watchlist_screening_entity_program_get_request.rb +1 -1
  974. data/lib/plaid/models/watchlist_screening_entity_program_get_response.rb +1 -1
  975. data/lib/plaid/models/watchlist_screening_entity_program_list_request.rb +1 -1
  976. data/lib/plaid/models/watchlist_screening_entity_program_list_response.rb +1 -1
  977. data/lib/plaid/models/watchlist_screening_entity_review_create_request.rb +1 -1
  978. data/lib/plaid/models/watchlist_screening_entity_review_create_response.rb +1 -1
  979. data/lib/plaid/models/watchlist_screening_entity_review_list_request.rb +1 -1
  980. data/lib/plaid/models/watchlist_screening_entity_review_list_response.rb +1 -1
  981. data/lib/plaid/models/watchlist_screening_entity_update_request.rb +1 -1
  982. data/lib/plaid/models/watchlist_screening_entity_update_request_resettable_field.rb +1 -1
  983. data/lib/plaid/models/watchlist_screening_entity_update_response.rb +1 -1
  984. data/lib/plaid/models/watchlist_screening_hit.rb +1 -1
  985. data/lib/plaid/models/watchlist_screening_hit_locations.rb +1 -1
  986. data/lib/plaid/models/watchlist_screening_hit_status.rb +1 -1
  987. data/lib/plaid/models/watchlist_screening_individual.rb +1 -1
  988. data/lib/plaid/models/watchlist_screening_individual_create_request.rb +1 -1
  989. data/lib/plaid/models/watchlist_screening_individual_create_response.rb +1 -1
  990. data/lib/plaid/models/watchlist_screening_individual_get_request.rb +1 -1
  991. data/lib/plaid/models/watchlist_screening_individual_get_response.rb +1 -1
  992. data/lib/plaid/models/watchlist_screening_individual_history_list_request.rb +1 -1
  993. data/lib/plaid/models/watchlist_screening_individual_history_list_response.rb +1 -1
  994. data/lib/plaid/models/watchlist_screening_individual_hit_list_request.rb +1 -1
  995. data/lib/plaid/models/watchlist_screening_individual_hit_list_response.rb +1 -1
  996. data/lib/plaid/models/watchlist_screening_individual_list_request.rb +1 -1
  997. data/lib/plaid/models/watchlist_screening_individual_list_response.rb +1 -1
  998. data/lib/plaid/models/watchlist_screening_individual_program_get_request.rb +1 -1
  999. data/lib/plaid/models/watchlist_screening_individual_program_get_response.rb +1 -1
  1000. data/lib/plaid/models/watchlist_screening_individual_program_list_request.rb +1 -1
  1001. data/lib/plaid/models/watchlist_screening_individual_program_list_response.rb +1 -1
  1002. data/lib/plaid/models/watchlist_screening_individual_review_create_request.rb +1 -1
  1003. data/lib/plaid/models/watchlist_screening_individual_review_create_response.rb +1 -1
  1004. data/lib/plaid/models/watchlist_screening_individual_review_list_request.rb +1 -1
  1005. data/lib/plaid/models/watchlist_screening_individual_review_list_response.rb +1 -1
  1006. data/lib/plaid/models/watchlist_screening_individual_update_request.rb +1 -1
  1007. data/lib/plaid/models/watchlist_screening_individual_update_request_resettable_field.rb +1 -1
  1008. data/lib/plaid/models/watchlist_screening_individual_update_response.rb +1 -1
  1009. data/lib/plaid/models/watchlist_screening_request_search_terms.rb +1 -1
  1010. data/lib/plaid/models/watchlist_screening_review.rb +1 -1
  1011. data/lib/plaid/models/watchlist_screening_search_terms.rb +1 -1
  1012. data/lib/plaid/models/watchlist_screening_status.rb +1 -1
  1013. data/lib/plaid/models/weak_alias_determination.rb +1 -1
  1014. data/lib/plaid/models/webhook_environment_values.rb +1 -1
  1015. data/lib/plaid/models/webhook_type.rb +1 -1
  1016. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  1017. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  1018. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  1019. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  1020. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  1021. data/lib/plaid/version.rb +2 -2
  1022. data/lib/plaid.rb +73 -5
  1023. data/plaid.gemspec +5 -4
  1024. data/templates/ruby/api_client.mustache +1 -0
  1025. data/templates/ruby/api_client_faraday_partial.mustache +2 -2
  1026. data/templates/ruby/gemspec.mustache +3 -2
  1027. data/test/test_api_client.rb +2 -0
  1028. data/test/test_sandbox.rb +31 -0
  1029. metadata +101 -12
@@ -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.181.1
6
+ The version of the OpenAPI document: 2020-09-14_1.205.3
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.1
@@ -20,7 +20,7 @@ module Plaid
20
20
  @api_client = api_client
21
21
  end
22
22
  # Retrieve real-time balance data
23
- # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
23
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
24
24
  # @param accounts_balance_get_request [AccountsBalanceGetRequest]
25
25
  # @param [Hash] opts the optional parameters
26
26
  # @return [AccountsGetResponse]
@@ -30,7 +30,7 @@ module Plaid
30
30
  end
31
31
 
32
32
  # Retrieve real-time balance data
33
- # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link.
33
+ # The `/accounts/balance/get` endpoint returns the real-time balance for each of an Item's accounts. While other endpoints may return a balance object, only `/accounts/balance/get` forces the available and current balance fields to be refreshed rather than cached. This endpoint can be used for existing Items that were added via any of Plaid’s other products. This endpoint can be used as long as Link has been initialized with any other product, `balance` itself is not a product that can be used to initialize Link. As this endpoint triggers a synchronous request for fresh data, latency may be higher than for other Plaid endpoints; if you encounter errors, you may find it necessary to adjust your timeout period when making requests.
34
34
  # @param accounts_balance_get_request [AccountsBalanceGetRequest]
35
35
  # @param [Hash] opts the optional parameters
36
36
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -1710,7 +1710,7 @@ module Plaid
1710
1710
  end
1711
1711
 
1712
1712
  # Create Asset or Income Report Audit Copy Token
1713
- # Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). To grant access to an Audit Copy token, use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the third party who needs access. Each third party has its own `auditor_id`, for example `fannie_mae`. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
1713
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the `/credit/audit_copy_token/create` endpoint to create an `audit_copy_token` and then pass that token to the GSE who needs access.
1714
1714
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
1715
1715
  # @param [Hash] opts the optional parameters
1716
1716
  # @return [CreditAuditCopyTokenCreateResponse]
@@ -1720,7 +1720,7 @@ module Plaid
1720
1720
  end
1721
1721
 
1722
1722
  # Create Asset or Income Report Audit Copy Token
1723
- # Plaid can provide an Audit Copy token of an Asset Report and/or Income Report directly to a participating third party on your behalf. For example, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf if you participate in the Day 1 Certainty™ program. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). To grant access to an Audit Copy token, use the &#x60;/credit/audit_copy_token/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;auditor_id&#x60;, for example &#x60;fannie_mae&#x60;. You’ll need to create a separate Audit Copy for each third party to whom you want to grant access to the Report.
1723
+ # Plaid can create an Audit Copy token of an Asset Report and/or Income Report to share with participating Government Sponsored Entity (GSE). If you participate in the Day 1 Certainty™ program, Plaid can supply an Audit Copy token directly to Fannie Mae on your behalf. An Audit Copy token contains the same underlying data as the Asset Report and/or Income Report (result of /credit/payroll_income/get). Use the &#x60;/credit/audit_copy_token/create&#x60; endpoint to create an &#x60;audit_copy_token&#x60; and then pass that token to the GSE who needs access.
1724
1724
  # @param credit_audit_copy_token_create_request [CreditAuditCopyTokenCreateRequest]
1725
1725
  # @param [Hash] opts the optional parameters
1726
1726
  # @return [Array<(CreditAuditCopyTokenCreateResponse, Integer, Hash)>] CreditAuditCopyTokenCreateResponse data, response status code and response headers
@@ -2554,8 +2554,8 @@ module Plaid
2554
2554
  return data, status_code, headers
2555
2555
  end
2556
2556
 
2557
- # Retrieve Link Sessions For Your User
2558
- # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata(for e.g. whether the user finished the bank income verification step).
2557
+ # Retrieve Link sessions for your user
2558
+ # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).
2559
2559
  # @param credit_sessions_get_request [CreditSessionsGetRequest]
2560
2560
  # @param [Hash] opts the optional parameters
2561
2561
  # @return [CreditSessionsGetResponse]
@@ -2564,8 +2564,8 @@ module Plaid
2564
2564
  data
2565
2565
  end
2566
2566
 
2567
- # Retrieve Link Sessions For Your User
2568
- # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata(for e.g. whether the user finished the bank income verification step).
2567
+ # Retrieve Link sessions for your user
2568
+ # This endpoint can be used for your end users after they complete the Link flow. This endpoint returns a list of Link sessions that your user completed, where each session includes the results from the Link flow. These results include details about the Item that was created and some product related metadata (showing, for example, whether the user finished the bank income verification step).
2569
2569
  # @param credit_sessions_get_request [CreditSessionsGetRequest]
2570
2570
  # @param [Hash] opts the optional parameters
2571
2571
  # @return [Array<(CreditSessionsGetResponse, Integer, Hash)>] CreditSessionsGetResponse data, response status code and response headers
@@ -3139,6 +3139,71 @@ module Plaid
3139
3139
  return data, status_code, headers
3140
3140
  end
3141
3141
 
3142
+ # Webhook receiver for fdx notifications
3143
+ # A generic webhook receiver endpoint for FDX Event Notifications
3144
+ # @param fdx_notification [FDXNotification]
3145
+ # @param [Hash] opts the optional parameters
3146
+ # @return [nil]
3147
+ def fdx_notifications(fdx_notification, opts = {})
3148
+ fdx_notifications_with_http_info(fdx_notification, opts)
3149
+ nil
3150
+ end
3151
+
3152
+ # Webhook receiver for fdx notifications
3153
+ # A generic webhook receiver endpoint for FDX Event Notifications
3154
+ # @param fdx_notification [FDXNotification]
3155
+ # @param [Hash] opts the optional parameters
3156
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
3157
+ def fdx_notifications_with_http_info(fdx_notification, opts = {})
3158
+ if @api_client.config.debugging
3159
+ @api_client.config.logger.debug 'Calling API: PlaidApi.fdx_notifications ...'
3160
+ end
3161
+ # verify the required parameter 'fdx_notification' is set
3162
+ if @api_client.config.client_side_validation && fdx_notification.nil?
3163
+ fail ArgumentError, "Missing the required parameter 'fdx_notification' when calling PlaidApi.fdx_notifications"
3164
+ end
3165
+ # resource path
3166
+ local_var_path = '/fdx/notifications'
3167
+
3168
+ # query parameters
3169
+ query_params = opts[:query_params] || {}
3170
+
3171
+ # header parameters
3172
+ header_params = opts[:header_params] || {}
3173
+ # HTTP header 'Accept' (if needed)
3174
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3175
+ # HTTP header 'Content-Type'
3176
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3177
+
3178
+ # form parameters
3179
+ form_params = opts[:form_params] || {}
3180
+
3181
+ # http body (model)
3182
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(fdx_notification)
3183
+
3184
+ # return_type
3185
+ return_type = opts[:debug_return_type]
3186
+
3187
+ # auth_names
3188
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3189
+
3190
+ new_options = opts.merge(
3191
+ :operation => :"PlaidApi.fdx_notifications",
3192
+ :header_params => header_params,
3193
+ :query_params => query_params,
3194
+ :form_params => form_params,
3195
+ :body => post_body,
3196
+ :auth_names => auth_names,
3197
+ :return_type => return_type
3198
+ )
3199
+
3200
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3201
+ if @api_client.config.debugging
3202
+ @api_client.config.logger.debug "API called: PlaidApi#fdx_notifications\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3203
+ end
3204
+ return data, status_code, headers
3205
+ end
3206
+
3142
3207
  # Retrieve identity data
3143
3208
  # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
3144
3209
  # @param identity_get_request [IdentityGetRequest]
@@ -3335,7 +3400,7 @@ module Plaid
3335
3400
  end
3336
3401
 
3337
3402
  # Retrieve Identity Verification
3338
- # Retrieve a previously created identity verification
3403
+ # Retrieve a previously created identity verification.
3339
3404
  # @param identity_verification_get_request [IdentityVerificationGetRequest]
3340
3405
  # @param [Hash] opts the optional parameters
3341
3406
  # @return [IdentityVerificationGetResponse]
@@ -3345,7 +3410,7 @@ module Plaid
3345
3410
  end
3346
3411
 
3347
3412
  # Retrieve Identity Verification
3348
- # Retrieve a previously created identity verification
3413
+ # Retrieve a previously created identity verification.
3349
3414
  # @param identity_verification_get_request [IdentityVerificationGetRequest]
3350
3415
  # @param [Hash] opts the optional parameters
3351
3416
  # @return [Array<(IdentityVerificationGetResponse, Integer, Hash)>] IdentityVerificationGetResponse data, response status code and response headers
@@ -3789,71 +3854,6 @@ module Plaid
3789
3854
  return data, status_code, headers
3790
3855
  end
3791
3856
 
3792
- # (Deprecated) Refresh an income verification
3793
- # `/income/verification/refresh` refreshes a given income verification.
3794
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
3795
- # @param [Hash] opts the optional parameters
3796
- # @return [IncomeVerificationRefreshResponse]
3797
- def income_verification_refresh(income_verification_refresh_request, opts = {})
3798
- data, _status_code, _headers = income_verification_refresh_with_http_info(income_verification_refresh_request, opts)
3799
- data
3800
- end
3801
-
3802
- # (Deprecated) Refresh an income verification
3803
- # &#x60;/income/verification/refresh&#x60; refreshes a given income verification.
3804
- # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
3805
- # @param [Hash] opts the optional parameters
3806
- # @return [Array<(IncomeVerificationRefreshResponse, Integer, Hash)>] IncomeVerificationRefreshResponse data, response status code and response headers
3807
- def income_verification_refresh_with_http_info(income_verification_refresh_request, opts = {})
3808
- if @api_client.config.debugging
3809
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_refresh ...'
3810
- end
3811
- # verify the required parameter 'income_verification_refresh_request' is set
3812
- if @api_client.config.client_side_validation && income_verification_refresh_request.nil?
3813
- fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
3814
- end
3815
- # resource path
3816
- local_var_path = '/income/verification/refresh'
3817
-
3818
- # query parameters
3819
- query_params = opts[:query_params] || {}
3820
-
3821
- # header parameters
3822
- header_params = opts[:header_params] || {}
3823
- # HTTP header 'Accept' (if needed)
3824
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3825
- # HTTP header 'Content-Type'
3826
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3827
-
3828
- # form parameters
3829
- form_params = opts[:form_params] || {}
3830
-
3831
- # http body (model)
3832
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
3833
-
3834
- # return_type
3835
- return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
3836
-
3837
- # auth_names
3838
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3839
-
3840
- new_options = opts.merge(
3841
- :operation => :"PlaidApi.income_verification_refresh",
3842
- :header_params => header_params,
3843
- :query_params => query_params,
3844
- :form_params => form_params,
3845
- :body => post_body,
3846
- :auth_names => auth_names,
3847
- :return_type => return_type
3848
- )
3849
-
3850
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3851
- if @api_client.config.debugging
3852
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3853
- end
3854
- return data, status_code, headers
3855
- end
3856
-
3857
3857
  # (Deprecated) Retrieve information from the tax documents used for income verification
3858
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.
3859
3859
  # @param request_body [Hash<String, Object>]
@@ -5024,6 +5024,71 @@ module Plaid
5024
5024
  return data, status_code, headers
5025
5025
  end
5026
5026
 
5027
+ # Exchange the Link Correlation Id for a Link Token
5028
+ # Exchange an OAuth `link_correlation_id` for the corresponding `link_token`. The `link_correlation_id` is only available for 'payment_initiation' products and is provided to the client via the OAuth `redirect_uri` as a query parameter. The `link_correlation_id` is ephemeral and expires in a brief period, after which it can no longer be exchanged for the 'link_token'.
5029
+ # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
5030
+ # @param [Hash] opts the optional parameters
5031
+ # @return [LinkOAuthCorrelationIdExchangeResponse]
5032
+ def link_oauth_correlation_id_exchange(link_o_auth_correlation_id_exchange_request, opts = {})
5033
+ data, _status_code, _headers = link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts)
5034
+ data
5035
+ end
5036
+
5037
+ # Exchange the Link Correlation Id for a Link Token
5038
+ # Exchange an OAuth &#x60;link_correlation_id&#x60; for the corresponding &#x60;link_token&#x60;. The &#x60;link_correlation_id&#x60; is only available for &#39;payment_initiation&#39; products and is provided to the client via the OAuth &#x60;redirect_uri&#x60; as a query parameter. The &#x60;link_correlation_id&#x60; is ephemeral and expires in a brief period, after which it can no longer be exchanged for the &#39;link_token&#39;.
5039
+ # @param link_o_auth_correlation_id_exchange_request [LinkOAuthCorrelationIdExchangeRequest]
5040
+ # @param [Hash] opts the optional parameters
5041
+ # @return [Array<(LinkOAuthCorrelationIdExchangeResponse, Integer, Hash)>] LinkOAuthCorrelationIdExchangeResponse data, response status code and response headers
5042
+ def link_oauth_correlation_id_exchange_with_http_info(link_o_auth_correlation_id_exchange_request, opts = {})
5043
+ if @api_client.config.debugging
5044
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_oauth_correlation_id_exchange ...'
5045
+ end
5046
+ # verify the required parameter 'link_o_auth_correlation_id_exchange_request' is set
5047
+ if @api_client.config.client_side_validation && link_o_auth_correlation_id_exchange_request.nil?
5048
+ fail ArgumentError, "Missing the required parameter 'link_o_auth_correlation_id_exchange_request' when calling PlaidApi.link_oauth_correlation_id_exchange"
5049
+ end
5050
+ # resource path
5051
+ local_var_path = '/link/oauth/correlation_id/exchange'
5052
+
5053
+ # query parameters
5054
+ query_params = opts[:query_params] || {}
5055
+
5056
+ # header parameters
5057
+ header_params = opts[:header_params] || {}
5058
+ # HTTP header 'Accept' (if needed)
5059
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5060
+ # HTTP header 'Content-Type'
5061
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5062
+
5063
+ # form parameters
5064
+ form_params = opts[:form_params] || {}
5065
+
5066
+ # http body (model)
5067
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_o_auth_correlation_id_exchange_request)
5068
+
5069
+ # return_type
5070
+ return_type = opts[:debug_return_type] || 'LinkOAuthCorrelationIdExchangeResponse'
5071
+
5072
+ # auth_names
5073
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5074
+
5075
+ new_options = opts.merge(
5076
+ :operation => :"PlaidApi.link_oauth_correlation_id_exchange",
5077
+ :header_params => header_params,
5078
+ :query_params => query_params,
5079
+ :form_params => form_params,
5080
+ :body => post_body,
5081
+ :auth_names => auth_names,
5082
+ :return_type => return_type
5083
+ )
5084
+
5085
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5086
+ if @api_client.config.debugging
5087
+ @api_client.config.logger.debug "API called: PlaidApi#link_oauth_correlation_id_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5088
+ end
5089
+ return data, status_code, headers
5090
+ end
5091
+
5027
5092
  # Create Link Token
5028
5093
  # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
5029
5094
  # @param link_token_create_request [LinkTokenCreateRequest]
@@ -5219,6 +5284,71 @@ module Plaid
5219
5284
  return data, status_code, headers
5220
5285
  end
5221
5286
 
5287
+ # Enables a Plaid reseller's end customer in the Production environment.
5288
+ # The `/partner/customer/enable` endpoint is used by reseller partners to enable an end customer in the Production environment.
5289
+ # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
5290
+ # @param [Hash] opts the optional parameters
5291
+ # @return [PartnerCustomerEnableResponse]
5292
+ def partner_customer_enable(partner_customer_enable_request, opts = {})
5293
+ data, _status_code, _headers = partner_customer_enable_with_http_info(partner_customer_enable_request, opts)
5294
+ data
5295
+ end
5296
+
5297
+ # Enables a Plaid reseller&#39;s end customer in the Production environment.
5298
+ # The &#x60;/partner/customer/enable&#x60; endpoint is used by reseller partners to enable an end customer in the Production environment.
5299
+ # @param partner_customer_enable_request [PartnerCustomerEnableRequest]
5300
+ # @param [Hash] opts the optional parameters
5301
+ # @return [Array<(PartnerCustomerEnableResponse, Integer, Hash)>] PartnerCustomerEnableResponse data, response status code and response headers
5302
+ def partner_customer_enable_with_http_info(partner_customer_enable_request, opts = {})
5303
+ if @api_client.config.debugging
5304
+ @api_client.config.logger.debug 'Calling API: PlaidApi.partner_customer_enable ...'
5305
+ end
5306
+ # verify the required parameter 'partner_customer_enable_request' is set
5307
+ if @api_client.config.client_side_validation && partner_customer_enable_request.nil?
5308
+ fail ArgumentError, "Missing the required parameter 'partner_customer_enable_request' when calling PlaidApi.partner_customer_enable"
5309
+ end
5310
+ # resource path
5311
+ local_var_path = '/partner/customer/enable'
5312
+
5313
+ # query parameters
5314
+ query_params = opts[:query_params] || {}
5315
+
5316
+ # header parameters
5317
+ header_params = opts[:header_params] || {}
5318
+ # HTTP header 'Accept' (if needed)
5319
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5320
+ # HTTP header 'Content-Type'
5321
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5322
+
5323
+ # form parameters
5324
+ form_params = opts[:form_params] || {}
5325
+
5326
+ # http body (model)
5327
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(partner_customer_enable_request)
5328
+
5329
+ # return_type
5330
+ return_type = opts[:debug_return_type] || 'PartnerCustomerEnableResponse'
5331
+
5332
+ # auth_names
5333
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5334
+
5335
+ new_options = opts.merge(
5336
+ :operation => :"PlaidApi.partner_customer_enable",
5337
+ :header_params => header_params,
5338
+ :query_params => query_params,
5339
+ :form_params => form_params,
5340
+ :body => post_body,
5341
+ :auth_names => auth_names,
5342
+ :return_type => return_type
5343
+ )
5344
+
5345
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5346
+ if @api_client.config.debugging
5347
+ @api_client.config.logger.debug "API called: PlaidApi#partner_customer_enable\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5348
+ end
5349
+ return data, status_code, headers
5350
+ end
5351
+
5222
5352
  # Returns a Plaid reseller's end customer.
5223
5353
  # The `/partner/customer/get` endpoint is used by reseller partners to retrieve data about a single end customer.
5224
5354
  # @param partner_customer_get_request [PartnerCustomerGetRequest]
@@ -5284,6 +5414,71 @@ module Plaid
5284
5414
  return data, status_code, headers
5285
5415
  end
5286
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
+
5287
5482
  # Create payment consent
5288
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.
5289
5484
  # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
@@ -6000,7 +6195,7 @@ module Plaid
6000
6195
  end
6001
6196
 
6002
6197
  # Create payment profile
6003
- # Use `/payment_profile/create` endpoint to create a new payment profile, identified by a Payment Profile ID. To initiate the account linking experience, call `/link/token/create` and provide the Payment Profile ID in the `transfer.payment_profile_id` field. You can then use the Payment Profile ID when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
6198
+ # Use `/payment_profile/create` endpoint to create a new payment profile. To initiate the account linking experience, call `/link/token/create` and provide the `payment_profile_token` in the `transfer.payment_profile_token` field. You can then use the `payment_profile_token` when creating transfers using `/transfer/authorization/create` and `/transfer/create`.
6004
6199
  # @param payment_profile_create_request [PaymentProfileCreateRequest]
6005
6200
  # @param [Hash] opts the optional parameters
6006
6201
  # @return [PaymentProfileCreateResponse]
@@ -6010,7 +6205,7 @@ module Plaid
6010
6205
  end
6011
6206
 
6012
6207
  # Create payment profile
6013
- # Use &#x60;/payment_profile/create&#x60; endpoint to create a new payment profile, identified by a Payment Profile ID. To initiate the account linking experience, call &#x60;/link/token/create&#x60; and provide the Payment Profile ID in the &#x60;transfer.payment_profile_id&#x60; field. You can then use the Payment Profile ID when creating transfers using &#x60;/transfer/authorization/create&#x60; and &#x60;/transfer/create&#x60;.
6208
+ # Use &#x60;/payment_profile/create&#x60; endpoint to create a new payment profile. To initiate the account linking experience, call &#x60;/link/token/create&#x60; and provide the &#x60;payment_profile_token&#x60; in the &#x60;transfer.payment_profile_token&#x60; field. You can then use the &#x60;payment_profile_token&#x60; when creating transfers using &#x60;/transfer/authorization/create&#x60; and &#x60;/transfer/create&#x60;.
6014
6209
  # @param payment_profile_create_request [PaymentProfileCreateRequest]
6015
6210
  # @param [Hash] opts the optional parameters
6016
6211
  # @return [Array<(PaymentProfileCreateResponse, Integer, Hash)>] PaymentProfileCreateResponse data, response status code and response headers
@@ -6520,7 +6715,7 @@ module Plaid
6520
6715
  end
6521
6716
 
6522
6717
  # Create Stripe bank account token
6523
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
6718
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user's bank account information changes or they revoke Plaid's permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new `access_token`. Bank account tokens can also be revoked, using `/item/remove`.'
6524
6719
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
6525
6720
  # @param [Hash] opts the optional parameters
6526
6721
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -6530,7 +6725,7 @@ module Plaid
6530
6725
  end
6531
6726
 
6532
6727
  # Create Stripe bank account token
6533
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user&#39;s bank account information changes or they revoke Plaid&#39;s permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new &#x60;access_token&#x60;. Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.&#39;
6728
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Note that the Stripe bank account token is a one-time use token. To store bank account information for later use, you can use a Stripe customer object and create an associated bank account from the token, or you can use a Stripe Custom account and create an associated external bank account from the token. This bank account information should work indefinitely, unless the user&#39;s bank account information changes or they revoke Plaid&#39;s permissions to access their account. Stripe bank account information cannot be modified once the bank account token has been created. If you ever need to change the bank account details used by Stripe for a specific customer, have the user go through Link again and create a new bank account token from the new &#x60;access_token&#x60;. Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.&#39;
6534
6729
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
6535
6730
  # @param [Hash] opts the optional parameters
6536
6731
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -6845,7 +7040,7 @@ module Plaid
6845
7040
  end
6846
7041
 
6847
7042
  # Fire a test webhook
6848
- # 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.
6849
7044
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
6850
7045
  # @param [Hash] opts the optional parameters
6851
7046
  # @return [SandboxItemFireWebhookResponse]
@@ -6855,7 +7050,7 @@ module Plaid
6855
7050
  end
6856
7051
 
6857
7052
  # Fire a test webhook
6858
- # 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.
6859
7054
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
6860
7055
  # @param [Hash] opts the optional parameters
6861
7056
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -7104,31 +7299,31 @@ module Plaid
7104
7299
  return data, status_code, headers
7105
7300
  end
7106
7301
 
7107
- # Create a test Item and processor token
7108
- # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
7109
- # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
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).
7304
+ # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
7110
7305
  # @param [Hash] opts the optional parameters
7111
- # @return [SandboxProcessorTokenCreateResponse]
7112
- def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
7113
- data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
7306
+ # @return [SandboxPaymentProfileResetLoginResponse]
7307
+ def sandbox_payment_profile_reset_login(sandbox_payment_profile_reset_login_request, opts = {})
7308
+ data, _status_code, _headers = sandbox_payment_profile_reset_login_with_http_info(sandbox_payment_profile_reset_login_request, opts)
7114
7309
  data
7115
7310
  end
7116
7311
 
7117
- # Create a test Item and processor token
7118
- # Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
7119
- # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
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 &#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
+ # @param sandbox_payment_profile_reset_login_request [SandboxPaymentProfileResetLoginRequest]
7120
7315
  # @param [Hash] opts the optional parameters
7121
- # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
7122
- def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
7316
+ # @return [Array<(SandboxPaymentProfileResetLoginResponse, Integer, Hash)>] SandboxPaymentProfileResetLoginResponse data, response status code and response headers
7317
+ def sandbox_payment_profile_reset_login_with_http_info(sandbox_payment_profile_reset_login_request, opts = {})
7123
7318
  if @api_client.config.debugging
7124
- @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
7319
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_payment_profile_reset_login ...'
7125
7320
  end
7126
- # verify the required parameter 'sandbox_processor_token_create_request' is set
7127
- if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
7128
- fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
7321
+ # verify the required parameter 'sandbox_payment_profile_reset_login_request' is set
7322
+ if @api_client.config.client_side_validation && sandbox_payment_profile_reset_login_request.nil?
7323
+ fail ArgumentError, "Missing the required parameter 'sandbox_payment_profile_reset_login_request' when calling PlaidApi.sandbox_payment_profile_reset_login"
7129
7324
  end
7130
7325
  # resource path
7131
- local_var_path = '/sandbox/processor_token/create'
7326
+ local_var_path = '/sandbox/payment_profile/reset_login'
7132
7327
 
7133
7328
  # query parameters
7134
7329
  query_params = opts[:query_params] || {}
@@ -7144,16 +7339,16 @@ module Plaid
7144
7339
  form_params = opts[:form_params] || {}
7145
7340
 
7146
7341
  # http body (model)
7147
- post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)
7342
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_payment_profile_reset_login_request)
7148
7343
 
7149
7344
  # return_type
7150
- return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
7345
+ return_type = opts[:debug_return_type] || 'SandboxPaymentProfileResetLoginResponse'
7151
7346
 
7152
7347
  # auth_names
7153
7348
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7154
7349
 
7155
7350
  new_options = opts.merge(
7156
- :operation => :"PlaidApi.sandbox_processor_token_create",
7351
+ :operation => :"PlaidApi.sandbox_payment_profile_reset_login",
7157
7352
  :header_params => header_params,
7158
7353
  :query_params => query_params,
7159
7354
  :form_params => form_params,
@@ -7164,18 +7359,83 @@ module Plaid
7164
7359
 
7165
7360
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7166
7361
  if @api_client.config.debugging
7167
- @api_client.config.logger.debug "API called: PlaidApi#sandbox_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7362
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_payment_profile_reset_login\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7168
7363
  end
7169
7364
  return data, status_code, headers
7170
7365
  end
7171
7366
 
7172
- # Create a test Item
7173
- # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions.
7174
- # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
7367
+ # Create a test Item and processor token
7368
+ # Use the `/sandbox/processor_token/create` endpoint to create a valid `processor_token` for an arbitrary institution ID and test credentials. The created `processor_token` corresponds to a new Sandbox Item. You can then use this `processor_token` with the `/processor/` API endpoints in Sandbox. You can also use `/sandbox/processor_token/create` with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
7369
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
7175
7370
  # @param [Hash] opts the optional parameters
7176
- # @return [SandboxPublicTokenCreateResponse]
7177
- def sandbox_public_token_create(sandbox_public_token_create_request, opts = {})
7178
- data, _status_code, _headers = sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts)
7371
+ # @return [SandboxProcessorTokenCreateResponse]
7372
+ def sandbox_processor_token_create(sandbox_processor_token_create_request, opts = {})
7373
+ data, _status_code, _headers = sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts)
7374
+ data
7375
+ end
7376
+
7377
+ # Create a test Item and processor token
7378
+ # Use the &#x60;/sandbox/processor_token/create&#x60; endpoint to create a valid &#x60;processor_token&#x60; for an arbitrary institution ID and test credentials. The created &#x60;processor_token&#x60; corresponds to a new Sandbox Item. You can then use this &#x60;processor_token&#x60; with the &#x60;/processor/&#x60; API endpoints in Sandbox. You can also use &#x60;/sandbox/processor_token/create&#x60; with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
7379
+ # @param sandbox_processor_token_create_request [SandboxProcessorTokenCreateRequest]
7380
+ # @param [Hash] opts the optional parameters
7381
+ # @return [Array<(SandboxProcessorTokenCreateResponse, Integer, Hash)>] SandboxProcessorTokenCreateResponse data, response status code and response headers
7382
+ def sandbox_processor_token_create_with_http_info(sandbox_processor_token_create_request, opts = {})
7383
+ if @api_client.config.debugging
7384
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_processor_token_create ...'
7385
+ end
7386
+ # verify the required parameter 'sandbox_processor_token_create_request' is set
7387
+ if @api_client.config.client_side_validation && sandbox_processor_token_create_request.nil?
7388
+ fail ArgumentError, "Missing the required parameter 'sandbox_processor_token_create_request' when calling PlaidApi.sandbox_processor_token_create"
7389
+ end
7390
+ # resource path
7391
+ local_var_path = '/sandbox/processor_token/create'
7392
+
7393
+ # query parameters
7394
+ query_params = opts[:query_params] || {}
7395
+
7396
+ # header parameters
7397
+ header_params = opts[:header_params] || {}
7398
+ # HTTP header 'Accept' (if needed)
7399
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7400
+ # HTTP header 'Content-Type'
7401
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7402
+
7403
+ # form parameters
7404
+ form_params = opts[:form_params] || {}
7405
+
7406
+ # http body (model)
7407
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_processor_token_create_request)
7408
+
7409
+ # return_type
7410
+ return_type = opts[:debug_return_type] || 'SandboxProcessorTokenCreateResponse'
7411
+
7412
+ # auth_names
7413
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7414
+
7415
+ new_options = opts.merge(
7416
+ :operation => :"PlaidApi.sandbox_processor_token_create",
7417
+ :header_params => header_params,
7418
+ :query_params => query_params,
7419
+ :form_params => form_params,
7420
+ :body => post_body,
7421
+ :auth_names => auth_names,
7422
+ :return_type => return_type
7423
+ )
7424
+
7425
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7426
+ if @api_client.config.debugging
7427
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_processor_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7428
+ end
7429
+ return data, status_code, headers
7430
+ end
7431
+
7432
+ # Create a test Item
7433
+ # Use the `/sandbox/public_token/create` endpoint to create a valid `public_token` for an arbitrary institution ID, initial products, and test credentials. The created `public_token` maps to a new Sandbox Item. You can then call `/item/public_token/exchange` to exchange the `public_token` for an `access_token` and perform all API actions. `/sandbox/public_token/create` can also be used with the [`user_custom` test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. `/sandbox/public_token/create` cannot be used with OAuth institutions.
7434
+ # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
7435
+ # @param [Hash] opts the optional parameters
7436
+ # @return [SandboxPublicTokenCreateResponse]
7437
+ def sandbox_public_token_create(sandbox_public_token_create_request, opts = {})
7438
+ data, _status_code, _headers = sandbox_public_token_create_with_http_info(sandbox_public_token_create_request, opts)
7179
7439
  data
7180
7440
  end
7181
7441
 
@@ -7494,8 +7754,203 @@ module Plaid
7494
7754
  return data, status_code, headers
7495
7755
  end
7496
7756
 
7757
+ # Advance a test clock
7758
+ # Use the `/sandbox/transfer/test_clock/advance` endpoint to advance a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `frozen_timestamp` field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing `frozen_timestamp`, but may never go back to a lower `frozen_timestamp`. If a test clock is advanced from T1 to T2, we will simulate the changes that ought to occur during the period of (T1, T2]. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting `frozen_timestamp` = t + 15 days, 2 new originations should be created, along with the webhook events. The timestamps of the objects and webhook events created/updated in step 2 should also fall in (T1, T2] time range. The advancement of the test clock from its current `frozen_timestamp` should be limited such that there are no more than 20 originations resulted from the advance operation on each `recurring_transfer` associated with this `test_clock`. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the `frozen_timestamp` up to 80 weeks on each advance call.
7759
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7760
+ # @param [Hash] opts the optional parameters
7761
+ # @return [SandboxTransferTestClockAdvanceResponse]
7762
+ def sandbox_transfer_test_clock_advance(sandbox_transfer_test_clock_advance_request, opts = {})
7763
+ data, _status_code, _headers = sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts)
7764
+ data
7765
+ end
7766
+
7767
+ # Advance a test clock
7768
+ # Use the &#x60;/sandbox/transfer/test_clock/advance&#x60; endpoint to advance a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;frozen_timestamp&#x60; field indicating the current timestamp of the timeline. A test clock can be advanced by incrementing &#x60;frozen_timestamp&#x60;, but may never go back to a lower &#x60;frozen_timestamp&#x60;. If a test clock is advanced from T1 to T2, we will simulate the changes that ought to occur during the period of (T1, T2]. For instance, a client creates a weekly recurring transfer with a test clock set at t. When the client advances the test clock by setting &#x60;frozen_timestamp&#x60; &#x3D; t + 15 days, 2 new originations should be created, along with the webhook events. The timestamps of the objects and webhook events created/updated in step 2 should also fall in (T1, T2] time range. The advancement of the test clock from its current &#x60;frozen_timestamp&#x60; should be limited such that there are no more than 20 originations resulted from the advance operation on each &#x60;recurring_transfer&#x60; associated with this &#x60;test_clock&#x60;. For instance, if the recurring transfer associated with this test clock originates once every 4 weeks, you can advance the &#x60;frozen_timestamp&#x60; up to 80 weeks on each advance call.
7769
+ # @param sandbox_transfer_test_clock_advance_request [SandboxTransferTestClockAdvanceRequest]
7770
+ # @param [Hash] opts the optional parameters
7771
+ # @return [Array<(SandboxTransferTestClockAdvanceResponse, Integer, Hash)>] SandboxTransferTestClockAdvanceResponse data, response status code and response headers
7772
+ def sandbox_transfer_test_clock_advance_with_http_info(sandbox_transfer_test_clock_advance_request, opts = {})
7773
+ if @api_client.config.debugging
7774
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_advance ...'
7775
+ end
7776
+ # verify the required parameter 'sandbox_transfer_test_clock_advance_request' is set
7777
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_advance_request.nil?
7778
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_advance_request' when calling PlaidApi.sandbox_transfer_test_clock_advance"
7779
+ end
7780
+ # resource path
7781
+ local_var_path = '/sandbox/transfer/test_clock/advance'
7782
+
7783
+ # query parameters
7784
+ query_params = opts[:query_params] || {}
7785
+
7786
+ # header parameters
7787
+ header_params = opts[:header_params] || {}
7788
+ # HTTP header 'Accept' (if needed)
7789
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7790
+ # HTTP header 'Content-Type'
7791
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7792
+
7793
+ # form parameters
7794
+ form_params = opts[:form_params] || {}
7795
+
7796
+ # http body (model)
7797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_advance_request)
7798
+
7799
+ # return_type
7800
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockAdvanceResponse'
7801
+
7802
+ # auth_names
7803
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7804
+
7805
+ new_options = opts.merge(
7806
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_advance",
7807
+ :header_params => header_params,
7808
+ :query_params => query_params,
7809
+ :form_params => form_params,
7810
+ :body => post_body,
7811
+ :auth_names => auth_names,
7812
+ :return_type => return_type
7813
+ )
7814
+
7815
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7816
+ if @api_client.config.debugging
7817
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_advance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7818
+ end
7819
+ return data, status_code, headers
7820
+ end
7821
+
7822
+ # Create a test clock
7823
+ # Use the `/sandbox/transfer/test_clock/create` endpoint to create a `test_clock` in the Sandbox environment. A test clock object represents an independent timeline and has a `frozen_timestamp` field indicating the current timestamp of the timeline. Test clock allows clients to easily test and integrate with recurring transfer product in sandbox environment. A test clock can be associated with up to 5 recurring transfers.
7824
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7825
+ # @param [Hash] opts the optional parameters
7826
+ # @return [SandboxTransferTestClockCreateResponse]
7827
+ def sandbox_transfer_test_clock_create(sandbox_transfer_test_clock_create_request, opts = {})
7828
+ data, _status_code, _headers = sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts)
7829
+ data
7830
+ end
7831
+
7832
+ # Create a test clock
7833
+ # Use the &#x60;/sandbox/transfer/test_clock/create&#x60; endpoint to create a &#x60;test_clock&#x60; in the Sandbox environment. A test clock object represents an independent timeline and has a &#x60;frozen_timestamp&#x60; field indicating the current timestamp of the timeline. Test clock allows clients to easily test and integrate with recurring transfer product in sandbox environment. A test clock can be associated with up to 5 recurring transfers.
7834
+ # @param sandbox_transfer_test_clock_create_request [SandboxTransferTestClockCreateRequest]
7835
+ # @param [Hash] opts the optional parameters
7836
+ # @return [Array<(SandboxTransferTestClockCreateResponse, Integer, Hash)>] SandboxTransferTestClockCreateResponse data, response status code and response headers
7837
+ def sandbox_transfer_test_clock_create_with_http_info(sandbox_transfer_test_clock_create_request, opts = {})
7838
+ if @api_client.config.debugging
7839
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_create ...'
7840
+ end
7841
+ # verify the required parameter 'sandbox_transfer_test_clock_create_request' is set
7842
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_create_request.nil?
7843
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_create_request' when calling PlaidApi.sandbox_transfer_test_clock_create"
7844
+ end
7845
+ # resource path
7846
+ local_var_path = '/sandbox/transfer/test_clock/create'
7847
+
7848
+ # query parameters
7849
+ query_params = opts[:query_params] || {}
7850
+
7851
+ # header parameters
7852
+ header_params = opts[:header_params] || {}
7853
+ # HTTP header 'Accept' (if needed)
7854
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7855
+ # HTTP header 'Content-Type'
7856
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7857
+
7858
+ # form parameters
7859
+ form_params = opts[:form_params] || {}
7860
+
7861
+ # http body (model)
7862
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_create_request)
7863
+
7864
+ # return_type
7865
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockCreateResponse'
7866
+
7867
+ # auth_names
7868
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7869
+
7870
+ new_options = opts.merge(
7871
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_create",
7872
+ :header_params => header_params,
7873
+ :query_params => query_params,
7874
+ :form_params => form_params,
7875
+ :body => post_body,
7876
+ :auth_names => auth_names,
7877
+ :return_type => return_type
7878
+ )
7879
+
7880
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7881
+ if @api_client.config.debugging
7882
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7883
+ end
7884
+ return data, status_code, headers
7885
+ end
7886
+
7887
+ # Get a test clock
7888
+ # Use the `/sandbox/transfer/test_clock/get` endpoint to get a `test_clock` in the Sandbox environment.
7889
+ # @param sandbox_transfer_test_clock_get_request [SandboxTransferTestClockGetRequest]
7890
+ # @param [Hash] opts the optional parameters
7891
+ # @return [SandboxTransferTestClockGetResponse]
7892
+ def sandbox_transfer_test_clock_get(sandbox_transfer_test_clock_get_request, opts = {})
7893
+ data, _status_code, _headers = sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts)
7894
+ data
7895
+ end
7896
+
7897
+ # Get a test clock
7898
+ # Use the &#x60;/sandbox/transfer/test_clock/get&#x60; endpoint to get a &#x60;test_clock&#x60; in the Sandbox environment.
7899
+ # @param sandbox_transfer_test_clock_get_request [SandboxTransferTestClockGetRequest]
7900
+ # @param [Hash] opts the optional parameters
7901
+ # @return [Array<(SandboxTransferTestClockGetResponse, Integer, Hash)>] SandboxTransferTestClockGetResponse data, response status code and response headers
7902
+ def sandbox_transfer_test_clock_get_with_http_info(sandbox_transfer_test_clock_get_request, opts = {})
7903
+ if @api_client.config.debugging
7904
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_test_clock_get ...'
7905
+ end
7906
+ # verify the required parameter 'sandbox_transfer_test_clock_get_request' is set
7907
+ if @api_client.config.client_side_validation && sandbox_transfer_test_clock_get_request.nil?
7908
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_test_clock_get_request' when calling PlaidApi.sandbox_transfer_test_clock_get"
7909
+ end
7910
+ # resource path
7911
+ local_var_path = '/sandbox/transfer/test_clock/get'
7912
+
7913
+ # query parameters
7914
+ query_params = opts[:query_params] || {}
7915
+
7916
+ # header parameters
7917
+ header_params = opts[:header_params] || {}
7918
+ # HTTP header 'Accept' (if needed)
7919
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7920
+ # HTTP header 'Content-Type'
7921
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7922
+
7923
+ # form parameters
7924
+ form_params = opts[:form_params] || {}
7925
+
7926
+ # http body (model)
7927
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_test_clock_get_request)
7928
+
7929
+ # return_type
7930
+ return_type = opts[:debug_return_type] || 'SandboxTransferTestClockGetResponse'
7931
+
7932
+ # auth_names
7933
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7934
+
7935
+ new_options = opts.merge(
7936
+ :operation => :"PlaidApi.sandbox_transfer_test_clock_get",
7937
+ :header_params => header_params,
7938
+ :query_params => query_params,
7939
+ :form_params => form_params,
7940
+ :body => post_body,
7941
+ :auth_names => auth_names,
7942
+ :return_type => return_type
7943
+ )
7944
+
7945
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7946
+ if @api_client.config.debugging
7947
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_test_clock_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7948
+ end
7949
+ return data, status_code, headers
7950
+ end
7951
+
7497
7952
  # Report whether you initiated an ACH transaction
7498
- # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an `INVALID_REQUEST` error if called a second time with a different value for `initiated`.
7953
+ # After calling `/signal/evaluate`, call `/signal/decision/report` to report whether the transaction was initiated. This endpoint will return an [`INVALID_FIELD`](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for `initiated`.
7499
7954
  # @param signal_decision_report_request [SignalDecisionReportRequest]
7500
7955
  # @param [Hash] opts the optional parameters
7501
7956
  # @return [SignalDecisionReportResponse]
@@ -7505,7 +7960,7 @@ module Plaid
7505
7960
  end
7506
7961
 
7507
7962
  # Report whether you initiated an ACH transaction
7508
- # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an &#x60;INVALID_REQUEST&#x60; error if called a second time with a different value for &#x60;initiated&#x60;.
7963
+ # After calling &#x60;/signal/evaluate&#x60;, call &#x60;/signal/decision/report&#x60; to report whether the transaction was initiated. This endpoint will return an [&#x60;INVALID_FIELD&#x60;](/docs/errors/invalid-request/#invalid_field) error if called a second time with a different value for &#x60;initiated&#x60;.
7509
7964
  # @param signal_decision_report_request [SignalDecisionReportRequest]
7510
7965
  # @param [Hash] opts the optional parameters
7511
7966
  # @return [Array<(SignalDecisionReportResponse, Integer, Hash)>] SignalDecisionReportResponse data, response status code and response headers
@@ -7560,7 +8015,7 @@ module Plaid
7560
8015
  end
7561
8016
 
7562
8017
  # Evaluate a planned ACH transaction
7563
- # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
8018
+ # Use `/signal/evaluate` to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If `/signal/evaluate` is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7564
8019
  # @param signal_evaluate_request [SignalEvaluateRequest]
7565
8020
  # @param [Hash] opts the optional parameters
7566
8021
  # @return [SignalEvaluateResponse]
@@ -7570,7 +8025,7 @@ module Plaid
7570
8025
  end
7571
8026
 
7572
8027
  # Evaluate a planned ACH transaction
7573
- # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned.
8028
+ # Use &#x60;/signal/evaluate&#x60; to evaluate a planned ACH transaction to get a return risk assessment (such as a risk score and risk tier) and additional risk signals. In order to obtain a valid score for an ACH transaction, Plaid must have an access token for the account, and the Item must be healthy (receiving product updates) or have recently been in a healthy state. If the transaction does not meet eligibility requirements, an error will be returned corresponding to the underlying cause. If &#x60;/signal/evaluate&#x60; is called on the same transaction multiple times within a 24-hour period, cached results may be returned. For more information please refer to our error documentation on [item errors](/docs/errors/item/) and [Link in Update Mode](/docs/link/update-mode/). Note: This request may take some time to complete if Signal is being added to an existing Item. This is because Plaid must communicate directly with the institution when retrieving the data for the first time.
7574
8029
  # @param signal_evaluate_request [SignalEvaluateRequest]
7575
8030
  # @param [Hash] opts the optional parameters
7576
8031
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
@@ -7624,8 +8079,8 @@ module Plaid
7624
8079
  return data, status_code, headers
7625
8080
  end
7626
8081
 
7627
- # Prepare the Signal product before calling `/signal/evaluate`
7628
- # Call `/signal/prepare` with Plaid-linked bank account information at least 10 seconds before calling `/signal/evaluate` or as soon as an end-user enters the ACH deposit flow in your application.
8082
+ # Opt-in an Item to Signal
8083
+ # When Link is not initialized with Signal, call `/signal/prepare` to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call `/signal/prepare` after those product calls are complete. Example flow: Link is initialized with Auth, call `/auth/get` for the account & routing number, call `/identity/get` to retrieve bank ownership details, call `/signal/prepare` to begin Signal data collection, then call `/signal/evaluate` for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
7629
8084
  # @param signal_prepare_request [SignalPrepareRequest]
7630
8085
  # @param [Hash] opts the optional parameters
7631
8086
  # @return [SignalPrepareResponse]
@@ -7634,8 +8089,8 @@ module Plaid
7634
8089
  data
7635
8090
  end
7636
8091
 
7637
- # Prepare the Signal product before calling &#x60;/signal/evaluate&#x60;
7638
- # Call &#x60;/signal/prepare&#x60; with Plaid-linked bank account information at least 10 seconds before calling &#x60;/signal/evaluate&#x60; or as soon as an end-user enters the ACH deposit flow in your application.
8092
+ # Opt-in an Item to Signal
8093
+ # When Link is not initialized with Signal, call &#x60;/signal/prepare&#x60; to opt-in that Item to the Signal data collection process, developing a Signal score. If you are using other Plaid products after Link, e.g. Identity or Assets, call &#x60;/signal/prepare&#x60; after those product calls are complete. Example flow: Link is initialized with Auth, call &#x60;/auth/get&#x60; for the account &amp; routing number, call &#x60;/identity/get&#x60; to retrieve bank ownership details, call &#x60;/signal/prepare&#x60; to begin Signal data collection, then call &#x60;/signal/evaluate&#x60; for a Signal score. For more information please see [Recommendations for initializing Link with specific product combinations](/docs/link/best-practices/#recommendations-for-initializing-link-with-specific-product-combinations).
7639
8094
  # @param signal_prepare_request [SignalPrepareRequest]
7640
8095
  # @param [Hash] opts the optional parameters
7641
8096
  # @return [Array<(SignalPrepareResponse, Integer, Hash)>] SignalPrepareResponse data, response status code and response headers
@@ -7819,6 +8274,71 @@ module Plaid
7819
8274
  return data, status_code, headers
7820
8275
  end
7821
8276
 
8277
+ # Enrich locally-held transaction data
8278
+ # The '/transactions/enrich' endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact transactions-feedback@plaid.com
8279
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8280
+ # @param [Hash] opts the optional parameters
8281
+ # @return [TransactionsEnrichGetResponse]
8282
+ def transactions_enrich(transactions_enrich_get_request, opts = {})
8283
+ data, _status_code, _headers = transactions_enrich_with_http_info(transactions_enrich_get_request, opts)
8284
+ data
8285
+ end
8286
+
8287
+ # Enrich locally-held transaction data
8288
+ # The &#39;/transactions/enrich&#39; endpoint enriches raw transaction data generated by your own banking products or retrieved from other non-Plaid sources. The product is currently in beta. To request access, contact transactions-feedback@plaid.com
8289
+ # @param transactions_enrich_get_request [TransactionsEnrichGetRequest]
8290
+ # @param [Hash] opts the optional parameters
8291
+ # @return [Array<(TransactionsEnrichGetResponse, Integer, Hash)>] TransactionsEnrichGetResponse data, response status code and response headers
8292
+ def transactions_enrich_with_http_info(transactions_enrich_get_request, opts = {})
8293
+ if @api_client.config.debugging
8294
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enrich ...'
8295
+ end
8296
+ # verify the required parameter 'transactions_enrich_get_request' is set
8297
+ if @api_client.config.client_side_validation && transactions_enrich_get_request.nil?
8298
+ fail ArgumentError, "Missing the required parameter 'transactions_enrich_get_request' when calling PlaidApi.transactions_enrich"
8299
+ end
8300
+ # resource path
8301
+ local_var_path = '/transactions/enrich'
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_enrich_get_request)
8318
+
8319
+ # return_type
8320
+ return_type = opts[:debug_return_type] || 'TransactionsEnrichGetResponse'
8321
+
8322
+ # auth_names
8323
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
8324
+
8325
+ new_options = opts.merge(
8326
+ :operation => :"PlaidApi.transactions_enrich",
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_enrich\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
8338
+ end
8339
+ return data, status_code, headers
8340
+ end
8341
+
7822
8342
  # Get transaction data
7823
8343
  # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
7824
8344
  # @param transactions_get_request [TransactionsGetRequest]
@@ -7885,7 +8405,7 @@ module Plaid
7885
8405
  end
7886
8406
 
7887
8407
  # Fetch recurring transaction streams
7888
- # 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.
8408
+ # The `/transactions/recurring/get` endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. Note that unlike `/transactions/get`, `/transactions/recurring/get` will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in `/link/token/create`, or after Link, by calling `/transactions/get`) before calling this endpoint. Data is available to `/transactions/recurring/get` approximately 5 seconds after the [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call `/transactions/recurring/get` endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
7889
8409
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
7890
8410
  # @param [Hash] opts the optional parameters
7891
8411
  # @return [TransactionsRecurringGetResponse]
@@ -7895,7 +8415,7 @@ module Plaid
7895
8415
  end
7896
8416
 
7897
8417
  # Fetch recurring transaction streams
7898
- # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint and learn more about pricing, contact your Plaid account manager. Note that unlike &#x60;/transactions/get&#x60;, &#x60;/transactions/recurring/get&#x60; will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;, or after Link, by calling &#x60;/transactions/get&#x60;) before calling this endpoint. Data is available to &#x60;/transactions/recurring/get&#x60; approximately 5 seconds after the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
8418
+ # The &#x60;/transactions/recurring/get&#x60; endpoint allows developers to receive a summary of the recurring outflow and inflow streams (expenses and deposits) from a user’s checking, savings or credit card accounts. Additionally, Plaid provides key insights about each recurring stream including the category, merchant, last amount, and more. Developers can use these insights to build tools and experiences that help their users better manage cash flow, monitor subscriptions, reduce spend, and stay on track with bill payments. This endpoint is not included by default as part of Transactions. To request access to this endpoint, submit a [product access request](https://dashboard.plaid.com/team/products) or contact your Plaid account manager. Note that unlike &#x60;/transactions/get&#x60;, &#x60;/transactions/recurring/get&#x60; will not initialize an Item with Transactions. The Item must already have been initialized with Transactions (either during Link, by specifying it in &#x60;/link/token/create&#x60;, or after Link, by calling &#x60;/transactions/get&#x60;) before calling this endpoint. Data is available to &#x60;/transactions/recurring/get&#x60; approximately 5 seconds after the [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhook has fired (about 1-2 minutes after initialization). After the initial call, you can call &#x60;/transactions/recurring/get&#x60; endpoint at any point in the future to retrieve the latest summary of recurring streams. Since recurring streams do not change often, it will typically not be necessary to call this endpoint more than once per day.
7899
8419
  # @param transactions_recurring_get_request [TransactionsRecurringGetRequest]
7900
8420
  # @param [Hash] opts the optional parameters
7901
8421
  # @return [Array<(TransactionsRecurringGetResponse, Integer, Hash)>] TransactionsRecurringGetResponse data, response status code and response headers
@@ -7950,7 +8470,7 @@ module Plaid
7950
8470
  end
7951
8471
 
7952
8472
  # Refresh transaction data
7953
- # `/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: [`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`. 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.
8473
+ # `/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.
7954
8474
  # @param transactions_refresh_request [TransactionsRefreshRequest]
7955
8475
  # @param [Hash] opts the optional parameters
7956
8476
  # @return [TransactionsRefreshResponse]
@@ -7960,7 +8480,7 @@ module Plaid
7960
8480
  end
7961
8481
 
7962
8482
  # Refresh transaction data
7963
- # &#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: [&#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;. 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.
8483
+ # &#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.
7964
8484
  # @param transactions_refresh_request [TransactionsRefreshRequest]
7965
8485
  # @param [Hash] opts the optional parameters
7966
8486
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
@@ -8210,7 +8730,7 @@ module Plaid
8210
8730
  end
8211
8731
 
8212
8732
  # Get incremental transaction updates on an Item
8213
- # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8733
+ # This endpoint replaces `/transactions/get` and its associated webhooks for most common use-cases. The `/transactions/sync` endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. `/transactions/sync` provides the same functionality as `/transactions/get` and can be used instead of `/transactions/get` to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for `credit`, `depository`, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from `investments` accounts, use `/investments/transactions/get` instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to `/transactions/sync` for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \"adds\"), which then generates a `next_cursor` for that Item. In subsequent calls, send the `next_cursor` to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The `has_more` field specifies if additional calls are necessary to fetch all available transaction updates. Call `/transactions/sync` with the new cursor, pulling all updates, until `has_more` is `false`. When retrieving paginated updates, track both the `next_cursor` from the latest response and the original cursor from the first call in which `has_more` was `true`; if a call to `/transactions/sync` fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, `/transactions/sync` will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the `/transactions/refresh` endpoint. Note that for newly created Items, data may not be immediately available to `/transactions/sync`. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [`SYNC_UPDATES_AVAILABLE`](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8214
8734
  # @param transactions_sync_request [TransactionsSyncRequest]
8215
8735
  # @param [Hash] opts the optional parameters
8216
8736
  # @return [TransactionsSyncResponse]
@@ -8220,7 +8740,7 @@ module Plaid
8220
8740
  end
8221
8741
 
8222
8742
  # Get incremental transaction updates on an Item
8223
- # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8743
+ # This endpoint replaces &#x60;/transactions/get&#x60; and its associated webhooks for most common use-cases. The &#x60;/transactions/sync&#x60; endpoint allows developers to subscribe to all transactions associated with an Item and get updates synchronously in a stream-like manner, using a cursor to track which updates have already been seen. &#x60;/transactions/sync&#x60; provides the same functionality as &#x60;/transactions/get&#x60; and can be used instead of &#x60;/transactions/get&#x60; to simplify the process of tracking transactions updates. This endpoint provides user-authorized transaction data for &#x60;credit&#x60;, &#x60;depository&#x60;, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from &#x60;investments&#x60; accounts, use &#x60;/investments/transactions/get&#x60; instead. Returned transactions data is grouped into three types of update, indicating whether the transaction was added, removed, or modified since the last call to the API. In the first call to &#x60;/transactions/sync&#x60; for an Item, the endpoint will return all historical transactions data associated with that Item up until the time of the API call (as \&quot;adds\&quot;), which then generates a &#x60;next_cursor&#x60; for that Item. In subsequent calls, send the &#x60;next_cursor&#x60; to receive only the changes that have occurred since the previous call. Due to the potentially large number of transactions associated with an Item, results are paginated. The &#x60;has_more&#x60; field specifies if additional calls are necessary to fetch all available transaction updates. Call &#x60;/transactions/sync&#x60; with the new cursor, pulling all updates, until &#x60;has_more&#x60; is &#x60;false&#x60;. When retrieving paginated updates, track both the &#x60;next_cursor&#x60; from the latest response and the original cursor from the first call in which &#x60;has_more&#x60; was &#x60;true&#x60;; if a call to &#x60;/transactions/sync&#x60; fails when retrieving a paginated update, the entire pagination request loop must be restarted beginning with the cursor for the first page of the update, rather than retrying only the single request that failed. Whenever new or updated transaction data becomes available, &#x60;/transactions/sync&#x60; will provide these updates. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, use the &#x60;/transactions/refresh&#x60; endpoint. Note that for newly created Items, data may not be immediately available to &#x60;/transactions/sync&#x60;. Plaid begins preparing transactions data when the Item is created, but the process can take anywhere from a few seconds to several minutes to complete, depending on the number of transactions available. To be alerted when new data is available, listen for the [&#x60;SYNC_UPDATES_AVAILABLE&#x60;](https://plaid.com/docs/api/products/transactions/#sync_updates_available) webhook.
8224
8744
  # @param transactions_sync_request [TransactionsSyncRequest]
8225
8745
  # @param [Hash] opts the optional parameters
8226
8746
  # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
@@ -8275,7 +8795,7 @@ module Plaid
8275
8795
  end
8276
8796
 
8277
8797
  # Create a transfer authorization
8278
- # 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 `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. 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`.
8798
+ # 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`.
8279
8799
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8280
8800
  # @param [Hash] opts the optional parameters
8281
8801
  # @return [TransferAuthorizationCreateResponse]
@@ -8285,7 +8805,7 @@ module Plaid
8285
8805
  end
8286
8806
 
8287
8807
  # Create a transfer authorization
8288
- # 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;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. 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;.
8808
+ # 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;.
8289
8809
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
8290
8810
  # @param [Hash] opts the optional parameters
8291
8811
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -8600,7 +9120,7 @@ module Plaid
8600
9120
  end
8601
9121
 
8602
9122
  # Retrieve a transfer
8603
- # The `/transfer/get` fetches information about the transfer corresponding to the given `transfer_id`.
9123
+ # The `/transfer/get` endpoint fetches information about the transfer corresponding to the given `transfer_id`.
8604
9124
  # @param transfer_get_request [TransferGetRequest]
8605
9125
  # @param [Hash] opts the optional parameters
8606
9126
  # @return [TransferGetResponse]
@@ -8610,7 +9130,7 @@ module Plaid
8610
9130
  end
8611
9131
 
8612
9132
  # Retrieve a transfer
8613
- # The &#x60;/transfer/get&#x60; fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
9133
+ # The &#x60;/transfer/get&#x60; endpoint fetches information about the transfer corresponding to the given &#x60;transfer_id&#x60;.
8614
9134
  # @param transfer_get_request [TransferGetRequest]
8615
9135
  # @param [Hash] opts the optional parameters
8616
9136
  # @return [Array<(TransferGetResponse, Integer, Hash)>] TransferGetResponse data, response status code and response headers
@@ -8924,22 +9444,737 @@ module Plaid
8924
9444
  return data, status_code, headers
8925
9445
  end
8926
9446
 
8927
- # Lists historical repayments
8928
- # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
8929
- # @param transfer_repayment_list_request [TransferRepaymentListRequest]
9447
+ # Create a new originator
9448
+ # Use the `/transfer/originator/create` endpoint to create a new originator and return an `originator_client_id`.
9449
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
8930
9450
  # @param [Hash] opts the optional parameters
8931
- # @return [TransferRepaymentListResponse]
8932
- def transfer_repayment_list(transfer_repayment_list_request, opts = {})
8933
- data, _status_code, _headers = transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts)
9451
+ # @return [TransferOriginatorCreateResponse]
9452
+ def transfer_originator_create(transfer_originator_create_request, opts = {})
9453
+ data, _status_code, _headers = transfer_originator_create_with_http_info(transfer_originator_create_request, opts)
8934
9454
  data
8935
9455
  end
8936
9456
 
8937
- # Lists historical repayments
8938
- # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.
8939
- # @param transfer_repayment_list_request [TransferRepaymentListRequest]
9457
+ # Create a new originator
9458
+ # Use the &#x60;/transfer/originator/create&#x60; endpoint to create a new originator and return an &#x60;originator_client_id&#x60;.
9459
+ # @param transfer_originator_create_request [TransferOriginatorCreateRequest]
8940
9460
  # @param [Hash] opts the optional parameters
8941
- # @return [Array<(TransferRepaymentListResponse, Integer, Hash)>] TransferRepaymentListResponse data, response status code and response headers
8942
- def transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {})
9461
+ # @return [Array<(TransferOriginatorCreateResponse, Integer, Hash)>] TransferOriginatorCreateResponse data, response status code and response headers
9462
+ def transfer_originator_create_with_http_info(transfer_originator_create_request, opts = {})
9463
+ if @api_client.config.debugging
9464
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_create ...'
9465
+ end
9466
+ # verify the required parameter 'transfer_originator_create_request' is set
9467
+ if @api_client.config.client_side_validation && transfer_originator_create_request.nil?
9468
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_create_request' when calling PlaidApi.transfer_originator_create"
9469
+ end
9470
+ # resource path
9471
+ local_var_path = '/transfer/originator/create'
9472
+
9473
+ # query parameters
9474
+ query_params = opts[:query_params] || {}
9475
+
9476
+ # header parameters
9477
+ header_params = opts[:header_params] || {}
9478
+ # HTTP header 'Accept' (if needed)
9479
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9480
+ # HTTP header 'Content-Type'
9481
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9482
+
9483
+ # form parameters
9484
+ form_params = opts[:form_params] || {}
9485
+
9486
+ # http body (model)
9487
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_create_request)
9488
+
9489
+ # return_type
9490
+ return_type = opts[:debug_return_type] || 'TransferOriginatorCreateResponse'
9491
+
9492
+ # auth_names
9493
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9494
+
9495
+ new_options = opts.merge(
9496
+ :operation => :"PlaidApi.transfer_originator_create",
9497
+ :header_params => header_params,
9498
+ :query_params => query_params,
9499
+ :form_params => form_params,
9500
+ :body => post_body,
9501
+ :auth_names => auth_names,
9502
+ :return_type => return_type
9503
+ )
9504
+
9505
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9506
+ if @api_client.config.debugging
9507
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9508
+ end
9509
+ return data, status_code, headers
9510
+ end
9511
+
9512
+ # Get status of an originator's onboarding
9513
+ # The `/transfer/originator/get` endpoint gets status updates for an originator's onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
9514
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
9515
+ # @param [Hash] opts the optional parameters
9516
+ # @return [TransferOriginatorGetResponse]
9517
+ def transfer_originator_get(transfer_originator_get_request, opts = {})
9518
+ data, _status_code, _headers = transfer_originator_get_with_http_info(transfer_originator_get_request, opts)
9519
+ data
9520
+ end
9521
+
9522
+ # Get status of an originator&#39;s onboarding
9523
+ # The &#x60;/transfer/originator/get&#x60; endpoint gets status updates for an originator&#39;s onboarding process. This information is also available via the Transfer page on the Plaid dashboard.
9524
+ # @param transfer_originator_get_request [TransferOriginatorGetRequest]
9525
+ # @param [Hash] opts the optional parameters
9526
+ # @return [Array<(TransferOriginatorGetResponse, Integer, Hash)>] TransferOriginatorGetResponse data, response status code and response headers
9527
+ def transfer_originator_get_with_http_info(transfer_originator_get_request, opts = {})
9528
+ if @api_client.config.debugging
9529
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_get ...'
9530
+ end
9531
+ # verify the required parameter 'transfer_originator_get_request' is set
9532
+ if @api_client.config.client_side_validation && transfer_originator_get_request.nil?
9533
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_get_request' when calling PlaidApi.transfer_originator_get"
9534
+ end
9535
+ # resource path
9536
+ local_var_path = '/transfer/originator/get'
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', 'examples'])
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_originator_get_request)
9553
+
9554
+ # return_type
9555
+ return_type = opts[:debug_return_type] || 'TransferOriginatorGetResponse'
9556
+
9557
+ # auth_names
9558
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9559
+
9560
+ new_options = opts.merge(
9561
+ :operation => :"PlaidApi.transfer_originator_get",
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_originator_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9573
+ end
9574
+ return data, status_code, headers
9575
+ end
9576
+
9577
+ # Get status of all originators' onboarding
9578
+ # The `/transfer/originator/list` endpoint gets status updates for all of your originators' onboarding. This information is also available via the Plaid dashboard.
9579
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
9580
+ # @param [Hash] opts the optional parameters
9581
+ # @return [TransferOriginatorListResponse]
9582
+ def transfer_originator_list(transfer_originator_list_request, opts = {})
9583
+ data, _status_code, _headers = transfer_originator_list_with_http_info(transfer_originator_list_request, opts)
9584
+ data
9585
+ end
9586
+
9587
+ # Get status of all originators&#39; onboarding
9588
+ # The &#x60;/transfer/originator/list&#x60; endpoint gets status updates for all of your originators&#39; onboarding. This information is also available via the Plaid dashboard.
9589
+ # @param transfer_originator_list_request [TransferOriginatorListRequest]
9590
+ # @param [Hash] opts the optional parameters
9591
+ # @return [Array<(TransferOriginatorListResponse, Integer, Hash)>] TransferOriginatorListResponse data, response status code and response headers
9592
+ def transfer_originator_list_with_http_info(transfer_originator_list_request, opts = {})
9593
+ if @api_client.config.debugging
9594
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_originator_list ...'
9595
+ end
9596
+ # verify the required parameter 'transfer_originator_list_request' is set
9597
+ if @api_client.config.client_side_validation && transfer_originator_list_request.nil?
9598
+ fail ArgumentError, "Missing the required parameter 'transfer_originator_list_request' when calling PlaidApi.transfer_originator_list"
9599
+ end
9600
+ # resource path
9601
+ local_var_path = '/transfer/originator/list'
9602
+
9603
+ # query parameters
9604
+ query_params = opts[:query_params] || {}
9605
+
9606
+ # header parameters
9607
+ header_params = opts[:header_params] || {}
9608
+ # HTTP header 'Accept' (if needed)
9609
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9610
+ # HTTP header 'Content-Type'
9611
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9612
+
9613
+ # form parameters
9614
+ form_params = opts[:form_params] || {}
9615
+
9616
+ # http body (model)
9617
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_originator_list_request)
9618
+
9619
+ # return_type
9620
+ return_type = opts[:debug_return_type] || 'TransferOriginatorListResponse'
9621
+
9622
+ # auth_names
9623
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9624
+
9625
+ new_options = opts.merge(
9626
+ :operation => :"PlaidApi.transfer_originator_list",
9627
+ :header_params => header_params,
9628
+ :query_params => query_params,
9629
+ :form_params => form_params,
9630
+ :body => post_body,
9631
+ :auth_names => auth_names,
9632
+ :return_type => return_type
9633
+ )
9634
+
9635
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9636
+ if @api_client.config.debugging
9637
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_originator_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9638
+ end
9639
+ return data, status_code, headers
9640
+ end
9641
+
9642
+ # Generate a Plaid-hosted onboarding UI URL.
9643
+ # The `/transfer/questionnaire/create` endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
9644
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
9645
+ # @param [Hash] opts the optional parameters
9646
+ # @return [TransferQuestionnaireCreateResponse]
9647
+ def transfer_questionnaire_create(transfer_questionnaire_create_request, opts = {})
9648
+ data, _status_code, _headers = transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts)
9649
+ data
9650
+ end
9651
+
9652
+ # Generate a Plaid-hosted onboarding UI URL.
9653
+ # The &#x60;/transfer/questionnaire/create&#x60; endpoint generates a Plaid-hosted onboarding UI URL. Redirect the originator to this URL to provide their due diligence information and agree to Plaid’s terms for ACH money movement.
9654
+ # @param transfer_questionnaire_create_request [TransferQuestionnaireCreateRequest]
9655
+ # @param [Hash] opts the optional parameters
9656
+ # @return [Array<(TransferQuestionnaireCreateResponse, Integer, Hash)>] TransferQuestionnaireCreateResponse data, response status code and response headers
9657
+ def transfer_questionnaire_create_with_http_info(transfer_questionnaire_create_request, opts = {})
9658
+ if @api_client.config.debugging
9659
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_questionnaire_create ...'
9660
+ end
9661
+ # verify the required parameter 'transfer_questionnaire_create_request' is set
9662
+ if @api_client.config.client_side_validation && transfer_questionnaire_create_request.nil?
9663
+ fail ArgumentError, "Missing the required parameter 'transfer_questionnaire_create_request' when calling PlaidApi.transfer_questionnaire_create"
9664
+ end
9665
+ # resource path
9666
+ local_var_path = '/transfer/questionnaire/create'
9667
+
9668
+ # query parameters
9669
+ query_params = opts[:query_params] || {}
9670
+
9671
+ # header parameters
9672
+ header_params = opts[:header_params] || {}
9673
+ # HTTP header 'Accept' (if needed)
9674
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9675
+ # HTTP header 'Content-Type'
9676
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9677
+
9678
+ # form parameters
9679
+ form_params = opts[:form_params] || {}
9680
+
9681
+ # http body (model)
9682
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_questionnaire_create_request)
9683
+
9684
+ # return_type
9685
+ return_type = opts[:debug_return_type] || 'TransferQuestionnaireCreateResponse'
9686
+
9687
+ # auth_names
9688
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9689
+
9690
+ new_options = opts.merge(
9691
+ :operation => :"PlaidApi.transfer_questionnaire_create",
9692
+ :header_params => header_params,
9693
+ :query_params => query_params,
9694
+ :form_params => form_params,
9695
+ :body => post_body,
9696
+ :auth_names => auth_names,
9697
+ :return_type => return_type
9698
+ )
9699
+
9700
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9701
+ if @api_client.config.debugging
9702
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_questionnaire_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9703
+ end
9704
+ return data, status_code, headers
9705
+ end
9706
+
9707
+ # Cancel a recurring transfer.
9708
+ # Use the `/transfer/recurring/cancel` endpoint to cancel a recurring transfer. Scheduled transfer that hasn't been submitted to bank will be cancelled.
9709
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
9710
+ # @param [Hash] opts the optional parameters
9711
+ # @return [TransferRecurringCancelResponse]
9712
+ def transfer_recurring_cancel(transfer_recurring_cancel_request, opts = {})
9713
+ data, _status_code, _headers = transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts)
9714
+ data
9715
+ end
9716
+
9717
+ # Cancel a recurring transfer.
9718
+ # Use the &#x60;/transfer/recurring/cancel&#x60; endpoint to cancel a recurring transfer. Scheduled transfer that hasn&#39;t been submitted to bank will be cancelled.
9719
+ # @param transfer_recurring_cancel_request [TransferRecurringCancelRequest]
9720
+ # @param [Hash] opts the optional parameters
9721
+ # @return [Array<(TransferRecurringCancelResponse, Integer, Hash)>] TransferRecurringCancelResponse data, response status code and response headers
9722
+ def transfer_recurring_cancel_with_http_info(transfer_recurring_cancel_request, opts = {})
9723
+ if @api_client.config.debugging
9724
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_cancel ...'
9725
+ end
9726
+ # verify the required parameter 'transfer_recurring_cancel_request' is set
9727
+ if @api_client.config.client_side_validation && transfer_recurring_cancel_request.nil?
9728
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_cancel_request' when calling PlaidApi.transfer_recurring_cancel"
9729
+ end
9730
+ # resource path
9731
+ local_var_path = '/transfer/recurring/cancel'
9732
+
9733
+ # query parameters
9734
+ query_params = opts[:query_params] || {}
9735
+
9736
+ # header parameters
9737
+ header_params = opts[:header_params] || {}
9738
+ # HTTP header 'Accept' (if needed)
9739
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9740
+ # HTTP header 'Content-Type'
9741
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9742
+
9743
+ # form parameters
9744
+ form_params = opts[:form_params] || {}
9745
+
9746
+ # http body (model)
9747
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_cancel_request)
9748
+
9749
+ # return_type
9750
+ return_type = opts[:debug_return_type] || 'TransferRecurringCancelResponse'
9751
+
9752
+ # auth_names
9753
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9754
+
9755
+ new_options = opts.merge(
9756
+ :operation => :"PlaidApi.transfer_recurring_cancel",
9757
+ :header_params => header_params,
9758
+ :query_params => query_params,
9759
+ :form_params => form_params,
9760
+ :body => post_body,
9761
+ :auth_names => auth_names,
9762
+ :return_type => return_type
9763
+ )
9764
+
9765
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9766
+ if @api_client.config.debugging
9767
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9768
+ end
9769
+ return data, status_code, headers
9770
+ end
9771
+
9772
+ # Create a recurring transfer
9773
+ # Use the `/transfer/recurring/create` endpoint to initiate a new recurring transfer.
9774
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
9775
+ # @param [Hash] opts the optional parameters
9776
+ # @return [TransferRecurringCreateResponse]
9777
+ def transfer_recurring_create(transfer_recurring_create_request, opts = {})
9778
+ data, _status_code, _headers = transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts)
9779
+ data
9780
+ end
9781
+
9782
+ # Create a recurring transfer
9783
+ # Use the &#x60;/transfer/recurring/create&#x60; endpoint to initiate a new recurring transfer.
9784
+ # @param transfer_recurring_create_request [TransferRecurringCreateRequest]
9785
+ # @param [Hash] opts the optional parameters
9786
+ # @return [Array<(TransferRecurringCreateResponse, Integer, Hash)>] TransferRecurringCreateResponse data, response status code and response headers
9787
+ def transfer_recurring_create_with_http_info(transfer_recurring_create_request, opts = {})
9788
+ if @api_client.config.debugging
9789
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_create ...'
9790
+ end
9791
+ # verify the required parameter 'transfer_recurring_create_request' is set
9792
+ if @api_client.config.client_side_validation && transfer_recurring_create_request.nil?
9793
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_create_request' when calling PlaidApi.transfer_recurring_create"
9794
+ end
9795
+ # resource path
9796
+ local_var_path = '/transfer/recurring/create'
9797
+
9798
+ # query parameters
9799
+ query_params = opts[:query_params] || {}
9800
+
9801
+ # header parameters
9802
+ header_params = opts[:header_params] || {}
9803
+ # HTTP header 'Accept' (if needed)
9804
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9805
+ # HTTP header 'Content-Type'
9806
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9807
+
9808
+ # form parameters
9809
+ form_params = opts[:form_params] || {}
9810
+
9811
+ # http body (model)
9812
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_create_request)
9813
+
9814
+ # return_type
9815
+ return_type = opts[:debug_return_type] || 'TransferRecurringCreateResponse'
9816
+
9817
+ # auth_names
9818
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9819
+
9820
+ new_options = opts.merge(
9821
+ :operation => :"PlaidApi.transfer_recurring_create",
9822
+ :header_params => header_params,
9823
+ :query_params => query_params,
9824
+ :form_params => form_params,
9825
+ :body => post_body,
9826
+ :auth_names => auth_names,
9827
+ :return_type => return_type
9828
+ )
9829
+
9830
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9831
+ if @api_client.config.debugging
9832
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9833
+ end
9834
+ return data, status_code, headers
9835
+ end
9836
+
9837
+ # Retrieve a recurring transfer
9838
+ # The `/transfer/recurring/get` fetches information about the recurring transfer corresponding to the given `recurring_transfer_id`.
9839
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
9840
+ # @param [Hash] opts the optional parameters
9841
+ # @return [TransferRecurringGetResponse]
9842
+ def transfer_recurring_get(transfer_recurring_get_request, opts = {})
9843
+ data, _status_code, _headers = transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts)
9844
+ data
9845
+ end
9846
+
9847
+ # Retrieve a recurring transfer
9848
+ # The &#x60;/transfer/recurring/get&#x60; fetches information about the recurring transfer corresponding to the given &#x60;recurring_transfer_id&#x60;.
9849
+ # @param transfer_recurring_get_request [TransferRecurringGetRequest]
9850
+ # @param [Hash] opts the optional parameters
9851
+ # @return [Array<(TransferRecurringGetResponse, Integer, Hash)>] TransferRecurringGetResponse data, response status code and response headers
9852
+ def transfer_recurring_get_with_http_info(transfer_recurring_get_request, opts = {})
9853
+ if @api_client.config.debugging
9854
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_get ...'
9855
+ end
9856
+ # verify the required parameter 'transfer_recurring_get_request' is set
9857
+ if @api_client.config.client_side_validation && transfer_recurring_get_request.nil?
9858
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_get_request' when calling PlaidApi.transfer_recurring_get"
9859
+ end
9860
+ # resource path
9861
+ local_var_path = '/transfer/recurring/get'
9862
+
9863
+ # query parameters
9864
+ query_params = opts[:query_params] || {}
9865
+
9866
+ # header parameters
9867
+ header_params = opts[:header_params] || {}
9868
+ # HTTP header 'Accept' (if needed)
9869
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9870
+ # HTTP header 'Content-Type'
9871
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9872
+
9873
+ # form parameters
9874
+ form_params = opts[:form_params] || {}
9875
+
9876
+ # http body (model)
9877
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_get_request)
9878
+
9879
+ # return_type
9880
+ return_type = opts[:debug_return_type] || 'TransferRecurringGetResponse'
9881
+
9882
+ # auth_names
9883
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9884
+
9885
+ new_options = opts.merge(
9886
+ :operation => :"PlaidApi.transfer_recurring_get",
9887
+ :header_params => header_params,
9888
+ :query_params => query_params,
9889
+ :form_params => form_params,
9890
+ :body => post_body,
9891
+ :auth_names => auth_names,
9892
+ :return_type => return_type
9893
+ )
9894
+
9895
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9896
+ if @api_client.config.debugging
9897
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9898
+ end
9899
+ return data, status_code, headers
9900
+ end
9901
+
9902
+ # List recurring transfers
9903
+ # Use the `/transfer/recurring/list` endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired recurring transfers.
9904
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
9905
+ # @param [Hash] opts the optional parameters
9906
+ # @return [TransferRecurringListResponse]
9907
+ def transfer_recurring_list(transfer_recurring_list_request, opts = {})
9908
+ data, _status_code, _headers = transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts)
9909
+ data
9910
+ end
9911
+
9912
+ # List recurring transfers
9913
+ # Use the &#x60;/transfer/recurring/list&#x60; endpoint to see a list of all your recurring transfers and their statuses. Results are paginated; use the &#x60;count&#x60; and &#x60;offset&#x60; query parameters to retrieve the desired recurring transfers.
9914
+ # @param transfer_recurring_list_request [TransferRecurringListRequest]
9915
+ # @param [Hash] opts the optional parameters
9916
+ # @return [Array<(TransferRecurringListResponse, Integer, Hash)>] TransferRecurringListResponse data, response status code and response headers
9917
+ def transfer_recurring_list_with_http_info(transfer_recurring_list_request, opts = {})
9918
+ if @api_client.config.debugging
9919
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_recurring_list ...'
9920
+ end
9921
+ # verify the required parameter 'transfer_recurring_list_request' is set
9922
+ if @api_client.config.client_side_validation && transfer_recurring_list_request.nil?
9923
+ fail ArgumentError, "Missing the required parameter 'transfer_recurring_list_request' when calling PlaidApi.transfer_recurring_list"
9924
+ end
9925
+ # resource path
9926
+ local_var_path = '/transfer/recurring/list'
9927
+
9928
+ # query parameters
9929
+ query_params = opts[:query_params] || {}
9930
+
9931
+ # header parameters
9932
+ header_params = opts[:header_params] || {}
9933
+ # HTTP header 'Accept' (if needed)
9934
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
9935
+ # HTTP header 'Content-Type'
9936
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
9937
+
9938
+ # form parameters
9939
+ form_params = opts[:form_params] || {}
9940
+
9941
+ # http body (model)
9942
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_recurring_list_request)
9943
+
9944
+ # return_type
9945
+ return_type = opts[:debug_return_type] || 'TransferRecurringListResponse'
9946
+
9947
+ # auth_names
9948
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
9949
+
9950
+ new_options = opts.merge(
9951
+ :operation => :"PlaidApi.transfer_recurring_list",
9952
+ :header_params => header_params,
9953
+ :query_params => query_params,
9954
+ :form_params => form_params,
9955
+ :body => post_body,
9956
+ :auth_names => auth_names,
9957
+ :return_type => return_type
9958
+ )
9959
+
9960
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
9961
+ if @api_client.config.debugging
9962
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_recurring_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
9963
+ end
9964
+ return data, status_code, headers
9965
+ end
9966
+
9967
+ # Cancel a refund
9968
+ # Use the `/transfer/refund/cancel` endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
9969
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
9970
+ # @param [Hash] opts the optional parameters
9971
+ # @return [TransferRefundCancelResponse]
9972
+ def transfer_refund_cancel(transfer_refund_cancel_request, opts = {})
9973
+ data, _status_code, _headers = transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts)
9974
+ data
9975
+ end
9976
+
9977
+ # Cancel a refund
9978
+ # Use the &#x60;/transfer/refund/cancel&#x60; endpoint to cancel a refund. A refund is eligible for cancellation if it has not yet been submitted to the payment network.
9979
+ # @param transfer_refund_cancel_request [TransferRefundCancelRequest]
9980
+ # @param [Hash] opts the optional parameters
9981
+ # @return [Array<(TransferRefundCancelResponse, Integer, Hash)>] TransferRefundCancelResponse data, response status code and response headers
9982
+ def transfer_refund_cancel_with_http_info(transfer_refund_cancel_request, opts = {})
9983
+ if @api_client.config.debugging
9984
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_cancel ...'
9985
+ end
9986
+ # verify the required parameter 'transfer_refund_cancel_request' is set
9987
+ if @api_client.config.client_side_validation && transfer_refund_cancel_request.nil?
9988
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_cancel_request' when calling PlaidApi.transfer_refund_cancel"
9989
+ end
9990
+ # resource path
9991
+ local_var_path = '/transfer/refund/cancel'
9992
+
9993
+ # query parameters
9994
+ query_params = opts[:query_params] || {}
9995
+
9996
+ # header parameters
9997
+ header_params = opts[:header_params] || {}
9998
+ # HTTP header 'Accept' (if needed)
9999
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10000
+ # HTTP header 'Content-Type'
10001
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10002
+
10003
+ # form parameters
10004
+ form_params = opts[:form_params] || {}
10005
+
10006
+ # http body (model)
10007
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_cancel_request)
10008
+
10009
+ # return_type
10010
+ return_type = opts[:debug_return_type] || 'TransferRefundCancelResponse'
10011
+
10012
+ # auth_names
10013
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10014
+
10015
+ new_options = opts.merge(
10016
+ :operation => :"PlaidApi.transfer_refund_cancel",
10017
+ :header_params => header_params,
10018
+ :query_params => query_params,
10019
+ :form_params => form_params,
10020
+ :body => post_body,
10021
+ :auth_names => auth_names,
10022
+ :return_type => return_type
10023
+ )
10024
+
10025
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10026
+ if @api_client.config.debugging
10027
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_cancel\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10028
+ end
10029
+ return data, status_code, headers
10030
+ end
10031
+
10032
+ # Create a refund
10033
+ # Use the `/transfer/refund/create` endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 3 business days following the transfer's settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
10034
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
10035
+ # @param [Hash] opts the optional parameters
10036
+ # @return [TransferRefundCreateResponse]
10037
+ def transfer_refund_create(transfer_refund_create_request, opts = {})
10038
+ data, _status_code, _headers = transfer_refund_create_with_http_info(transfer_refund_create_request, opts)
10039
+ data
10040
+ end
10041
+
10042
+ # Create a refund
10043
+ # Use the &#x60;/transfer/refund/create&#x60; endpoint to create a refund for a transfer. A transfer can be refunded if the transfer was initiated in the past 180 days. Processing of the refund will not occur until at least 3 business days following the transfer&#39;s settlement date, plus any hold/settlement delays. This 3-day window helps better protect your business from regular ACH returns. Consumer initiated returns (unauthorized returns) could still happen for about 60 days from the settlement date. If the original transfer is canceled, returned or failed, all pending refunds will automatically be canceled. Processed refunds cannot be revoked.
10044
+ # @param transfer_refund_create_request [TransferRefundCreateRequest]
10045
+ # @param [Hash] opts the optional parameters
10046
+ # @return [Array<(TransferRefundCreateResponse, Integer, Hash)>] TransferRefundCreateResponse data, response status code and response headers
10047
+ def transfer_refund_create_with_http_info(transfer_refund_create_request, opts = {})
10048
+ if @api_client.config.debugging
10049
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_create ...'
10050
+ end
10051
+ # verify the required parameter 'transfer_refund_create_request' is set
10052
+ if @api_client.config.client_side_validation && transfer_refund_create_request.nil?
10053
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_create_request' when calling PlaidApi.transfer_refund_create"
10054
+ end
10055
+ # resource path
10056
+ local_var_path = '/transfer/refund/create'
10057
+
10058
+ # query parameters
10059
+ query_params = opts[:query_params] || {}
10060
+
10061
+ # header parameters
10062
+ header_params = opts[:header_params] || {}
10063
+ # HTTP header 'Accept' (if needed)
10064
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10065
+ # HTTP header 'Content-Type'
10066
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10067
+
10068
+ # form parameters
10069
+ form_params = opts[:form_params] || {}
10070
+
10071
+ # http body (model)
10072
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_create_request)
10073
+
10074
+ # return_type
10075
+ return_type = opts[:debug_return_type] || 'TransferRefundCreateResponse'
10076
+
10077
+ # auth_names
10078
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10079
+
10080
+ new_options = opts.merge(
10081
+ :operation => :"PlaidApi.transfer_refund_create",
10082
+ :header_params => header_params,
10083
+ :query_params => query_params,
10084
+ :form_params => form_params,
10085
+ :body => post_body,
10086
+ :auth_names => auth_names,
10087
+ :return_type => return_type
10088
+ )
10089
+
10090
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10091
+ if @api_client.config.debugging
10092
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10093
+ end
10094
+ return data, status_code, headers
10095
+ end
10096
+
10097
+ # Retrieve a refund
10098
+ # The `/transfer/refund/get` endpoint fetches information about the refund corresponding to the given `refund_id`.
10099
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
10100
+ # @param [Hash] opts the optional parameters
10101
+ # @return [TransferRefundGetResponse]
10102
+ def transfer_refund_get(transfer_refund_get_request, opts = {})
10103
+ data, _status_code, _headers = transfer_refund_get_with_http_info(transfer_refund_get_request, opts)
10104
+ data
10105
+ end
10106
+
10107
+ # Retrieve a refund
10108
+ # The &#x60;/transfer/refund/get&#x60; endpoint fetches information about the refund corresponding to the given &#x60;refund_id&#x60;.
10109
+ # @param transfer_refund_get_request [TransferRefundGetRequest]
10110
+ # @param [Hash] opts the optional parameters
10111
+ # @return [Array<(TransferRefundGetResponse, Integer, Hash)>] TransferRefundGetResponse data, response status code and response headers
10112
+ def transfer_refund_get_with_http_info(transfer_refund_get_request, opts = {})
10113
+ if @api_client.config.debugging
10114
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_refund_get ...'
10115
+ end
10116
+ # verify the required parameter 'transfer_refund_get_request' is set
10117
+ if @api_client.config.client_side_validation && transfer_refund_get_request.nil?
10118
+ fail ArgumentError, "Missing the required parameter 'transfer_refund_get_request' when calling PlaidApi.transfer_refund_get"
10119
+ end
10120
+ # resource path
10121
+ local_var_path = '/transfer/refund/get'
10122
+
10123
+ # query parameters
10124
+ query_params = opts[:query_params] || {}
10125
+
10126
+ # header parameters
10127
+ header_params = opts[:header_params] || {}
10128
+ # HTTP header 'Accept' (if needed)
10129
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10130
+ # HTTP header 'Content-Type'
10131
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10132
+
10133
+ # form parameters
10134
+ form_params = opts[:form_params] || {}
10135
+
10136
+ # http body (model)
10137
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_refund_get_request)
10138
+
10139
+ # return_type
10140
+ return_type = opts[:debug_return_type] || 'TransferRefundGetResponse'
10141
+
10142
+ # auth_names
10143
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10144
+
10145
+ new_options = opts.merge(
10146
+ :operation => :"PlaidApi.transfer_refund_get",
10147
+ :header_params => header_params,
10148
+ :query_params => query_params,
10149
+ :form_params => form_params,
10150
+ :body => post_body,
10151
+ :auth_names => auth_names,
10152
+ :return_type => return_type
10153
+ )
10154
+
10155
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10156
+ if @api_client.config.debugging
10157
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_refund_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10158
+ end
10159
+ return data, status_code, headers
10160
+ end
10161
+
10162
+ # Lists historical repayments
10163
+ # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
10164
+ # @param transfer_repayment_list_request [TransferRepaymentListRequest]
10165
+ # @param [Hash] opts the optional parameters
10166
+ # @return [TransferRepaymentListResponse]
10167
+ def transfer_repayment_list(transfer_repayment_list_request, opts = {})
10168
+ data, _status_code, _headers = transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts)
10169
+ data
10170
+ end
10171
+
10172
+ # Lists historical repayments
10173
+ # The &#x60;/transfer/repayment/list&#x60; endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given &#x60;start_time&#x60;.
10174
+ # @param transfer_repayment_list_request [TransferRepaymentListRequest]
10175
+ # @param [Hash] opts the optional parameters
10176
+ # @return [Array<(TransferRepaymentListResponse, Integer, Hash)>] TransferRepaymentListResponse data, response status code and response headers
10177
+ def transfer_repayment_list_with_http_info(transfer_repayment_list_request, opts = {})
8943
10178
  if @api_client.config.debugging
8944
10179
  @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_repayment_list ...'
8945
10180
  end
@@ -9574,11 +10809,76 @@ module Plaid
9574
10809
  return data, status_code, headers
9575
10810
  end
9576
10811
 
10812
+ # List e-wallet transactions
10813
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
10814
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10815
+ # @param [Hash] opts the optional parameters
10816
+ # @return [WalletTransactionListResponse]
10817
+ def wallet_transaction_list(wallet_transaction_list_request, opts = {})
10818
+ data, _status_code, _headers = wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts)
10819
+ data
10820
+ end
10821
+
10822
+ # List e-wallet transactions
10823
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
10824
+ # @param wallet_transaction_list_request [WalletTransactionListRequest]
10825
+ # @param [Hash] opts the optional parameters
10826
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
10827
+ def wallet_transaction_list_with_http_info(wallet_transaction_list_request, opts = {})
10828
+ if @api_client.config.debugging
10829
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_list ...'
10830
+ end
10831
+ # verify the required parameter 'wallet_transaction_list_request' is set
10832
+ if @api_client.config.client_side_validation && wallet_transaction_list_request.nil?
10833
+ fail ArgumentError, "Missing the required parameter 'wallet_transaction_list_request' when calling PlaidApi.wallet_transaction_list"
10834
+ end
10835
+ # resource path
10836
+ local_var_path = '/wallet/transaction/list'
10837
+
10838
+ # query parameters
10839
+ query_params = opts[:query_params] || {}
10840
+
10841
+ # header parameters
10842
+ header_params = opts[:header_params] || {}
10843
+ # HTTP header 'Accept' (if needed)
10844
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
10845
+ # HTTP header 'Content-Type'
10846
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
10847
+
10848
+ # form parameters
10849
+ form_params = opts[:form_params] || {}
10850
+
10851
+ # http body (model)
10852
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_list_request)
10853
+
10854
+ # return_type
10855
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
10856
+
10857
+ # auth_names
10858
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
10859
+
10860
+ new_options = opts.merge(
10861
+ :operation => :"PlaidApi.wallet_transaction_list",
10862
+ :header_params => header_params,
10863
+ :query_params => query_params,
10864
+ :form_params => form_params,
10865
+ :body => post_body,
10866
+ :auth_names => auth_names,
10867
+ :return_type => return_type
10868
+ )
10869
+
10870
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
10871
+ if @api_client.config.debugging
10872
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
10873
+ end
10874
+ return data, status_code, headers
10875
+ end
10876
+
9577
10877
  # List e-wallet transactions
9578
10878
  # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
9579
10879
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9580
10880
  # @param [Hash] opts the optional parameters
9581
- # @return [WalletTransactionsListResponse]
10881
+ # @return [WalletTransactionListResponse]
9582
10882
  def wallet_transactions_list(wallet_transactions_list_request, opts = {})
9583
10883
  data, _status_code, _headers = wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts)
9584
10884
  data
@@ -9588,7 +10888,7 @@ module Plaid
9588
10888
  # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
9589
10889
  # @param wallet_transactions_list_request [WalletTransactionsListRequest]
9590
10890
  # @param [Hash] opts the optional parameters
9591
- # @return [Array<(WalletTransactionsListResponse, Integer, Hash)>] WalletTransactionsListResponse data, response status code and response headers
10891
+ # @return [Array<(WalletTransactionListResponse, Integer, Hash)>] WalletTransactionListResponse data, response status code and response headers
9592
10892
  def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
9593
10893
  if @api_client.config.debugging
9594
10894
  @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
@@ -9617,7 +10917,7 @@ module Plaid
9617
10917
  post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transactions_list_request)
9618
10918
 
9619
10919
  # return_type
9620
- return_type = opts[:debug_return_type] || 'WalletTransactionsListResponse'
10920
+ return_type = opts[:debug_return_type] || 'WalletTransactionListResponse'
9621
10921
 
9622
10922
  # auth_names
9623
10923
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']