plaid 14.5.0 → 14.9.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (577) hide show
  1. checksums.yaml +5 -5
  2. data/CHANGELOG.md +12 -0
  3. data/Dockerfile +4 -2
  4. data/Gemfile.lock +1 -1
  5. data/Makefile +1 -1
  6. data/README.md +4 -4
  7. data/doc/rdoc/.DS_Store +0 -0
  8. data/doc/rdoc/classes/Plaid/Models/Payment.html +17 -0
  9. data/doc/rdoc/classes/Plaid/PaymentGetResponse.html +17 -0
  10. data/doc/rdoc/classes/Plaid/PaymentInitiation.html +23 -20
  11. data/doc/rdoc/classes/Plaid.html +1 -1
  12. data/doc/rdoc/created.rid +28 -28
  13. data/doc/rdoc/files/LICENSE_txt.html +1 -1
  14. data/doc/rdoc/files/README_md.html +1 -1
  15. data/doc/rdoc/files/lib/plaid/client_rb.html +1 -1
  16. data/doc/rdoc/files/lib/plaid/errors_rb.html +1 -1
  17. data/doc/rdoc/files/lib/plaid/middleware_rb.html +1 -1
  18. data/doc/rdoc/files/lib/plaid/models_rb.html +1 -1
  19. data/doc/rdoc/files/lib/plaid/products/accounts_rb.html +1 -1
  20. data/doc/rdoc/files/lib/plaid/products/asset_report_rb.html +1 -1
  21. data/doc/rdoc/files/lib/plaid/products/auth_rb.html +1 -1
  22. data/doc/rdoc/files/lib/plaid/products/base_product_rb.html +1 -1
  23. data/doc/rdoc/files/lib/plaid/products/categories_rb.html +1 -1
  24. data/doc/rdoc/files/lib/plaid/products/credit_details_rb.html +1 -1
  25. data/doc/rdoc/files/lib/plaid/products/deposit_switch_rb.html +1 -1
  26. data/doc/rdoc/files/lib/plaid/products/identity_rb.html +1 -1
  27. data/doc/rdoc/files/lib/plaid/products/income_rb.html +1 -1
  28. data/doc/rdoc/files/lib/plaid/products/institutions_rb.html +1 -1
  29. data/doc/rdoc/files/lib/plaid/products/investments_rb.html +1 -1
  30. data/doc/rdoc/files/lib/plaid/products/item_rb.html +1 -1
  31. data/doc/rdoc/files/lib/plaid/products/liabilities_rb.html +1 -1
  32. data/doc/rdoc/files/lib/plaid/products/link_token_rb.html +1 -1
  33. data/doc/rdoc/files/lib/plaid/products/payment_initiation_rb.html +1 -1
  34. data/doc/rdoc/files/lib/plaid/products/processor_rb.html +1 -1
  35. data/doc/rdoc/files/lib/plaid/products/sandbox_rb.html +1 -1
  36. data/doc/rdoc/files/lib/plaid/products/transactions_rb.html +1 -1
  37. data/doc/rdoc/files/lib/plaid/products/webhooks_rb.html +1 -1
  38. data/doc/rdoc/files/lib/plaid/version_rb.html +1 -1
  39. data/doc/rdoc/files/lib/plaid_rb.html +1 -1
  40. data/doc/rdoc/js/navigation.js.gz +0 -0
  41. data/doc/rdoc/js/search_index.js +1 -1
  42. data/doc/rdoc/js/search_index.js.gz +0 -0
  43. data/doc/rdoc/js/searcher.js.gz +0 -0
  44. data/lib/plaid/.DS_Store +0 -0
  45. data/lib/plaid/api/plaid_api.rb +619 -34
  46. data/lib/plaid/api_client.rb +2 -2
  47. data/lib/plaid/api_error.rb +1 -1
  48. data/lib/plaid/configuration.rb +1 -1
  49. data/lib/plaid/models/account_access.rb +17 -7
  50. data/lib/plaid/models/account_assets.rb +2 -2
  51. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  52. data/lib/plaid/models/account_balance.rb +3 -3
  53. data/lib/plaid/models/account_base.rb +1 -1
  54. data/lib/plaid/models/account_filter.rb +1 -1
  55. data/lib/plaid/models/account_filters_response.rb +1 -1
  56. data/lib/plaid/models/account_identity.rb +2 -2
  57. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  58. data/lib/plaid/models/account_product_access.rb +249 -0
  59. data/lib/plaid/models/account_product_access_nullable.rb +255 -0
  60. data/lib/plaid/models/account_selection_cardinality.rb +1 -1
  61. data/lib/plaid/models/account_subtype.rb +1 -2
  62. data/lib/plaid/models/account_type.rb +1 -1
  63. data/lib/plaid/models/accounts_balance_get_request.rb +1 -1
  64. data/lib/plaid/models/accounts_balance_get_request_options.rb +1 -1
  65. data/lib/plaid/models/accounts_get_request.rb +1 -1
  66. data/lib/plaid/models/accounts_get_request_options.rb +1 -1
  67. data/lib/plaid/models/accounts_get_response.rb +1 -1
  68. data/lib/plaid/models/ach_class.rb +1 -1
  69. data/lib/plaid/models/address.rb +1 -1
  70. data/lib/plaid/models/address_data.rb +3 -3
  71. data/lib/plaid/models/address_data_nullable.rb +3 -3
  72. data/lib/plaid/models/address_nullable.rb +1 -1
  73. data/lib/plaid/models/application.rb +1 -1
  74. data/lib/plaid/models/application_get_request.rb +1 -1
  75. data/lib/plaid/models/application_get_response.rb +1 -1
  76. data/lib/plaid/models/apr.rb +1 -1
  77. data/lib/plaid/models/asset_report.rb +1 -1
  78. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +1 -1
  79. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +1 -1
  80. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +1 -1
  81. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +1 -1
  82. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +1 -1
  83. data/lib/plaid/models/asset_report_create_request.rb +1 -1
  84. data/lib/plaid/models/asset_report_create_request_options.rb +1 -1
  85. data/lib/plaid/models/asset_report_create_response.rb +1 -1
  86. data/lib/plaid/models/asset_report_filter_request.rb +1 -1
  87. data/lib/plaid/models/asset_report_filter_response.rb +1 -1
  88. data/lib/plaid/models/asset_report_get_request.rb +3 -1
  89. data/lib/plaid/models/asset_report_get_response.rb +1 -1
  90. data/lib/plaid/models/asset_report_item.rb +1 -1
  91. data/lib/plaid/models/asset_report_pdf_get_request.rb +1 -1
  92. data/lib/plaid/models/asset_report_refresh_request.rb +1 -1
  93. data/lib/plaid/models/asset_report_refresh_request_options.rb +1 -1
  94. data/lib/plaid/models/asset_report_refresh_response.rb +1 -1
  95. data/lib/plaid/models/asset_report_remove_request.rb +1 -1
  96. data/lib/plaid/models/asset_report_remove_response.rb +1 -1
  97. data/lib/plaid/models/asset_report_transaction.rb +24 -2
  98. data/lib/plaid/models/asset_report_transaction_all_of.rb +1 -1
  99. data/lib/plaid/models/asset_report_user.rb +1 -1
  100. data/lib/plaid/models/assets_error_webhook.rb +1 -1
  101. data/lib/plaid/models/assets_product_ready_webhook.rb +1 -1
  102. data/lib/plaid/models/auth_get_numbers.rb +1 -1
  103. data/lib/plaid/models/auth_get_request.rb +1 -1
  104. data/lib/plaid/models/auth_get_request_options.rb +1 -1
  105. data/lib/plaid/models/auth_get_response.rb +1 -1
  106. data/lib/plaid/models/auth_metadata.rb +1 -1
  107. data/lib/plaid/models/auth_supported_methods.rb +1 -1
  108. data/lib/plaid/models/automatically_verified_webhook.rb +1 -1
  109. data/lib/plaid/models/bank_initiated_return_risk.rb +1 -1
  110. data/lib/plaid/models/bank_transfer.rb +1 -1
  111. data/lib/plaid/models/bank_transfer_balance.rb +1 -1
  112. data/lib/plaid/models/bank_transfer_balance_get_request.rb +1 -1
  113. data/lib/plaid/models/bank_transfer_balance_get_response.rb +1 -1
  114. data/lib/plaid/models/bank_transfer_cancel_request.rb +1 -1
  115. data/lib/plaid/models/bank_transfer_cancel_response.rb +1 -1
  116. data/lib/plaid/models/bank_transfer_create_request.rb +1 -1
  117. data/lib/plaid/models/bank_transfer_create_response.rb +1 -1
  118. data/lib/plaid/models/bank_transfer_direction.rb +1 -1
  119. data/lib/plaid/models/bank_transfer_event.rb +1 -1
  120. data/lib/plaid/models/bank_transfer_event_list_request.rb +1 -1
  121. data/lib/plaid/models/bank_transfer_event_list_response.rb +1 -1
  122. data/lib/plaid/models/bank_transfer_event_sync_request.rb +1 -1
  123. data/lib/plaid/models/bank_transfer_event_sync_response.rb +1 -1
  124. data/lib/plaid/models/bank_transfer_event_type.rb +1 -1
  125. data/lib/plaid/models/bank_transfer_failure.rb +1 -1
  126. data/lib/plaid/models/bank_transfer_get_request.rb +1 -1
  127. data/lib/plaid/models/bank_transfer_get_response.rb +1 -1
  128. data/lib/plaid/models/bank_transfer_list_request.rb +1 -1
  129. data/lib/plaid/models/bank_transfer_list_response.rb +1 -1
  130. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +1 -1
  131. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +1 -1
  132. data/lib/plaid/models/bank_transfer_network.rb +1 -1
  133. data/lib/plaid/models/bank_transfer_receiver_details.rb +1 -1
  134. data/lib/plaid/models/bank_transfer_status.rb +1 -1
  135. data/lib/plaid/models/bank_transfer_sweep.rb +2 -23
  136. data/lib/plaid/models/bank_transfer_sweep_account.rb +1 -1
  137. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -23
  138. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +1 -1
  139. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -30
  140. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +1 -1
  141. data/lib/plaid/models/bank_transfer_type.rb +1 -1
  142. data/lib/plaid/models/bank_transfer_user.rb +1 -1
  143. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +1 -1
  144. data/lib/plaid/models/categories_get_response.rb +1 -1
  145. data/lib/plaid/models/category.rb +1 -1
  146. data/lib/plaid/models/cause.rb +1 -1
  147. data/lib/plaid/models/connected_application.rb +1 -1
  148. data/lib/plaid/models/country_code.rb +2 -1
  149. data/lib/plaid/models/credit_card_liability.rb +1 -1
  150. data/lib/plaid/models/credit_filter.rb +1 -1
  151. data/lib/plaid/models/customer_initiated_return_risk.rb +1 -1
  152. data/lib/plaid/models/deductions.rb +35 -5
  153. data/lib/plaid/models/deductions_breakdown.rb +265 -0
  154. data/lib/plaid/models/deductions_total.rb +254 -0
  155. data/lib/plaid/models/default_update_webhook.rb +1 -1
  156. data/lib/plaid/models/deposit_switch_address_data.rb +1 -1
  157. data/lib/plaid/models/deposit_switch_alt_create_request.rb +1 -1
  158. data/lib/plaid/models/deposit_switch_alt_create_response.rb +1 -1
  159. data/lib/plaid/models/deposit_switch_create_request.rb +1 -1
  160. data/lib/plaid/models/deposit_switch_create_request_options.rb +1 -1
  161. data/lib/plaid/models/deposit_switch_create_response.rb +1 -1
  162. data/lib/plaid/models/deposit_switch_get_request.rb +1 -1
  163. data/lib/plaid/models/deposit_switch_get_response.rb +1 -1
  164. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +1 -1
  165. data/lib/plaid/models/deposit_switch_target_account.rb +1 -1
  166. data/lib/plaid/models/deposit_switch_target_user.rb +1 -1
  167. data/lib/plaid/models/deposit_switch_token_create_request.rb +1 -1
  168. data/lib/plaid/models/deposit_switch_token_create_response.rb +1 -1
  169. data/lib/plaid/models/depository_filter.rb +1 -1
  170. data/lib/plaid/models/distribution_breakdown.rb +296 -0
  171. data/lib/plaid/models/doc_type.rb +45 -0
  172. data/lib/plaid/models/document_metadata.rb +2 -37
  173. data/lib/plaid/models/earnings.rb +25 -5
  174. data/lib/plaid/models/earnings_breakdown.rb +297 -0
  175. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +45 -0
  176. data/lib/plaid/models/earnings_total.rb +46 -67
  177. data/lib/plaid/models/email.rb +1 -1
  178. data/lib/plaid/models/employee.rb +11 -11
  179. data/lib/plaid/models/employee_income_summary_field_string.rb +1 -1
  180. data/lib/plaid/models/employer.rb +1 -1
  181. data/lib/plaid/models/employer_income_summary_field_string.rb +1 -1
  182. data/lib/plaid/models/employer_verification.rb +1 -1
  183. data/lib/plaid/models/employers_search_request.rb +1 -1
  184. data/lib/plaid/models/employers_search_response.rb +1 -1
  185. data/lib/plaid/models/employment_details.rb +1 -1
  186. data/lib/plaid/models/employment_verification.rb +2 -37
  187. data/lib/plaid/models/employment_verification_get_request.rb +1 -1
  188. data/lib/plaid/models/employment_verification_get_response.rb +1 -1
  189. data/lib/plaid/models/employment_verification_status.rb +40 -0
  190. data/lib/plaid/models/error.rb +4 -4
  191. data/lib/plaid/models/external_payment_options.rb +18 -18
  192. data/lib/plaid/models/external_payment_refund_details.rb +1 -1
  193. data/lib/plaid/models/external_payment_schedule_base.rb +1 -1
  194. data/lib/plaid/models/external_payment_schedule_get.rb +1 -1
  195. data/lib/plaid/models/external_payment_schedule_request.rb +1 -1
  196. data/lib/plaid/models/health_incident.rb +1 -1
  197. data/lib/plaid/models/historical_balance.rb +1 -1
  198. data/lib/plaid/models/historical_update_webhook.rb +1 -1
  199. data/lib/plaid/models/holding.rb +1 -1
  200. data/lib/plaid/models/holdings_default_update_webhook.rb +1 -1
  201. data/lib/plaid/models/holdings_override.rb +1 -1
  202. data/lib/plaid/models/identity_get_request.rb +1 -1
  203. data/lib/plaid/models/identity_get_request_options.rb +1 -1
  204. data/lib/plaid/models/identity_get_response.rb +1 -1
  205. data/lib/plaid/models/incident_update.rb +1 -1
  206. data/lib/plaid/models/income_breakdown.rb +2 -37
  207. data/lib/plaid/models/income_breakdown_type.rb +41 -0
  208. data/lib/plaid/models/income_override.rb +1 -1
  209. data/lib/plaid/models/income_summary.rb +1 -1
  210. data/lib/plaid/models/income_summary_field_number.rb +1 -1
  211. data/lib/plaid/models/income_summary_field_string.rb +1 -1
  212. data/lib/plaid/models/income_verification_create_request.rb +14 -5
  213. data/lib/plaid/models/income_verification_create_request_options.rb +222 -0
  214. data/lib/plaid/models/income_verification_create_response.rb +1 -1
  215. data/lib/plaid/models/income_verification_documents_download_request.rb +1 -1
  216. data/lib/plaid/models/income_verification_paystub_get_request.rb +1 -1
  217. data/lib/plaid/models/income_verification_paystub_get_response.rb +1 -1
  218. data/lib/plaid/models/income_verification_paystubs_get_request.rb +1 -1
  219. data/lib/plaid/models/income_verification_paystubs_get_response.rb +13 -13
  220. data/lib/plaid/models/income_verification_precheck_confidence.rb +40 -0
  221. data/lib/plaid/models/income_verification_precheck_employer.rb +1 -1
  222. data/lib/plaid/models/income_verification_precheck_employer_address.rb +3 -3
  223. data/lib/plaid/models/income_verification_precheck_military_info.rb +1 -1
  224. data/lib/plaid/models/income_verification_precheck_request.rb +14 -2
  225. data/lib/plaid/models/income_verification_precheck_response.rb +2 -37
  226. data/lib/plaid/models/income_verification_precheck_user.rb +1 -1
  227. data/lib/plaid/models/income_verification_refresh_request.rb +1 -1
  228. data/lib/plaid/models/income_verification_refresh_response.rb +1 -1
  229. data/lib/plaid/models/income_verification_status_webhook.rb +18 -3
  230. data/lib/plaid/models/income_verification_summary_get_request.rb +1 -1
  231. data/lib/plaid/models/income_verification_summary_get_response.rb +1 -1
  232. data/lib/plaid/models/income_verification_taxforms_get_request.rb +1 -1
  233. data/lib/plaid/models/income_verification_taxforms_get_response.rb +18 -18
  234. data/lib/plaid/models/income_verification_webhook_status.rb +1 -1
  235. data/lib/plaid/models/inflow_model.rb +2 -2
  236. data/lib/plaid/models/initial_update_webhook.rb +1 -1
  237. data/lib/plaid/models/institution.rb +1 -1
  238. data/lib/plaid/models/institution_status.rb +1 -1
  239. data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
  240. data/lib/plaid/models/institutions_get_by_id_request_options.rb +1 -1
  241. data/lib/plaid/models/institutions_get_by_id_response.rb +1 -1
  242. data/lib/plaid/models/institutions_get_request.rb +2 -2
  243. data/lib/plaid/models/institutions_get_request_options.rb +2 -2
  244. data/lib/plaid/models/institutions_get_response.rb +1 -1
  245. data/lib/plaid/models/institutions_search_account_filter.rb +1 -1
  246. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +1 -1
  247. data/lib/plaid/models/institutions_search_request.rb +2 -2
  248. data/lib/plaid/models/institutions_search_request_options.rb +1 -1
  249. data/lib/plaid/models/institutions_search_response.rb +1 -1
  250. data/lib/plaid/models/investment_filter.rb +2 -2
  251. data/lib/plaid/models/investment_holdings_get_request_options.rb +1 -1
  252. data/lib/plaid/models/investment_transaction.rb +2 -2
  253. data/lib/plaid/models/investments_default_update_webhook.rb +1 -1
  254. data/lib/plaid/models/investments_holdings_get_request.rb +1 -1
  255. data/lib/plaid/models/investments_holdings_get_response.rb +1 -1
  256. data/lib/plaid/models/investments_transactions_get_request.rb +1 -1
  257. data/lib/plaid/models/investments_transactions_get_request_options.rb +1 -1
  258. data/lib/plaid/models/investments_transactions_get_response.rb +1 -1
  259. data/lib/plaid/models/investments_transactions_override.rb +1 -1
  260. data/lib/plaid/models/item.rb +14 -2
  261. data/lib/plaid/models/item_access_token_invalidate_request.rb +1 -1
  262. data/lib/plaid/models/item_access_token_invalidate_response.rb +1 -1
  263. data/lib/plaid/models/item_application_list_request.rb +1 -1
  264. data/lib/plaid/models/item_application_list_response.rb +1 -1
  265. data/lib/plaid/models/item_application_list_user_auth.rb +1 -1
  266. data/lib/plaid/models/item_application_scopes_update_request.rb +1 -1
  267. data/lib/plaid/models/item_application_scopes_update_response.rb +1 -1
  268. data/lib/plaid/models/item_error_webhook.rb +1 -1
  269. data/lib/plaid/models/item_get_request.rb +1 -1
  270. data/lib/plaid/models/item_get_response.rb +1 -1
  271. data/lib/plaid/models/item_import_request.rb +1 -1
  272. data/lib/plaid/models/item_import_request_options.rb +1 -1
  273. data/lib/plaid/models/item_import_request_user_auth.rb +1 -1
  274. data/lib/plaid/models/item_import_response.rb +1 -1
  275. data/lib/plaid/models/item_product_ready_webhook.rb +1 -1
  276. data/lib/plaid/models/item_public_token_create_request.rb +1 -1
  277. data/lib/plaid/models/item_public_token_create_response.rb +1 -1
  278. data/lib/plaid/models/item_public_token_exchange_request.rb +1 -1
  279. data/lib/plaid/models/item_public_token_exchange_response.rb +1 -1
  280. data/lib/plaid/models/item_remove_request.rb +1 -1
  281. data/lib/plaid/models/item_remove_response.rb +1 -1
  282. data/lib/plaid/models/item_status.rb +1 -1
  283. data/lib/plaid/models/item_status_investments.rb +1 -1
  284. data/lib/plaid/models/item_status_last_webhook.rb +1 -1
  285. data/lib/plaid/models/item_status_nullable.rb +1 -1
  286. data/lib/plaid/models/item_status_transactions.rb +1 -1
  287. data/lib/plaid/models/item_webhook_update_request.rb +1 -1
  288. data/lib/plaid/models/item_webhook_update_response.rb +1 -1
  289. data/lib/plaid/models/jwk_public_key.rb +1 -1
  290. data/lib/plaid/models/jwt_header.rb +1 -1
  291. data/lib/plaid/models/liabilities_default_update_webhook.rb +1 -1
  292. data/lib/plaid/models/liabilities_get_request.rb +1 -1
  293. data/lib/plaid/models/liabilities_get_request_options.rb +1 -1
  294. data/lib/plaid/models/liabilities_get_response.rb +1 -1
  295. data/lib/plaid/models/liabilities_object.rb +1 -1
  296. data/lib/plaid/models/liability_override.rb +1 -1
  297. data/lib/plaid/models/link_token_account_filters.rb +1 -1
  298. data/lib/plaid/models/link_token_create_request.rb +14 -5
  299. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  300. data/lib/plaid/models/link_token_create_request_auth.rb +1 -1
  301. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +1 -1
  302. data/lib/plaid/models/link_token_create_request_income_verification.rb +17 -5
  303. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +1 -1
  304. data/lib/plaid/models/link_token_create_request_transfer.rb +220 -0
  305. data/lib/plaid/models/link_token_create_request_update.rb +1 -1
  306. data/lib/plaid/models/link_token_create_request_user.rb +1 -1
  307. data/lib/plaid/models/link_token_create_response.rb +1 -1
  308. data/lib/plaid/models/link_token_eu_config.rb +1 -1
  309. data/lib/plaid/models/link_token_get_metadata_response.rb +1 -1
  310. data/lib/plaid/models/link_token_get_request.rb +1 -1
  311. data/lib/plaid/models/link_token_get_response.rb +1 -1
  312. data/lib/plaid/models/loan_filter.rb +1 -1
  313. data/lib/plaid/models/location.rb +3 -3
  314. data/lib/plaid/models/meta.rb +1 -1
  315. data/lib/plaid/models/mfa.rb +1 -1
  316. data/lib/plaid/models/mortgage_interest_rate.rb +1 -1
  317. data/lib/plaid/models/mortgage_liability.rb +1 -1
  318. data/lib/plaid/models/mortgage_property_address.rb +1 -1
  319. data/lib/plaid/models/net_pay.rb +54 -10
  320. data/lib/plaid/models/new_accounts_available_webhook.rb +1 -1
  321. data/lib/plaid/models/numbers.rb +1 -1
  322. data/lib/plaid/models/numbers_ach.rb +2 -2
  323. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  324. data/lib/plaid/models/numbers_bacs.rb +1 -1
  325. data/lib/plaid/models/numbers_bacs_nullable.rb +1 -1
  326. data/lib/plaid/models/numbers_eft.rb +1 -1
  327. data/lib/plaid/models/numbers_eft_nullable.rb +1 -1
  328. data/lib/plaid/models/numbers_international.rb +1 -1
  329. data/lib/plaid/models/numbers_international_nullable.rb +1 -1
  330. data/lib/plaid/models/override_account_type.rb +1 -1
  331. data/lib/plaid/models/override_accounts.rb +1 -1
  332. data/lib/plaid/models/owner.rb +1 -1
  333. data/lib/plaid/models/owner_override.rb +1 -1
  334. data/lib/plaid/models/pay.rb +1 -1
  335. data/lib/plaid/models/pay_frequency.rb +2 -37
  336. data/lib/plaid/models/pay_frequency_value.rb +43 -0
  337. data/lib/plaid/models/pay_period_details.rb +95 -28
  338. data/lib/plaid/models/payment_amount.rb +1 -1
  339. data/lib/plaid/models/payment_initiation_address.rb +1 -1
  340. data/lib/plaid/models/payment_initiation_metadata.rb +1 -1
  341. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +1 -1
  342. data/lib/plaid/models/payment_initiation_payment.rb +11 -63
  343. data/lib/plaid/models/payment_initiation_payment_create_request.rb +1 -1
  344. data/lib/plaid/models/payment_initiation_payment_create_response.rb +1 -1
  345. data/lib/plaid/models/payment_initiation_payment_get_request.rb +1 -1
  346. data/lib/plaid/models/payment_initiation_payment_get_response.rb +11 -63
  347. data/lib/plaid/models/payment_initiation_payment_list_request.rb +1 -1
  348. data/lib/plaid/models/payment_initiation_payment_list_response.rb +1 -1
  349. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +1 -1
  350. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +1 -1
  351. data/lib/plaid/models/payment_initiation_payment_status.rb +46 -0
  352. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +1 -1
  353. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +1 -1
  354. data/lib/plaid/models/payment_initiation_recipient.rb +1 -1
  355. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +1 -1
  356. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +1 -1
  357. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +1 -1
  358. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +1 -1
  359. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +1 -1
  360. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +1 -1
  361. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +1 -1
  362. data/lib/plaid/models/payment_initiation_refund.rb +1 -1
  363. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +1 -1
  364. data/lib/plaid/models/payment_meta.rb +1 -1
  365. data/lib/plaid/models/payment_schedule_interval.rb +1 -1
  366. data/lib/plaid/models/payment_status_update_webhook.rb +1 -1
  367. data/lib/plaid/models/paystub.rb +45 -25
  368. data/lib/plaid/models/paystub_address.rb +40 -40
  369. data/lib/plaid/models/paystub_deduction.rb +1 -1
  370. data/lib/plaid/models/paystub_details.rb +2 -37
  371. data/lib/plaid/models/paystub_employer.rb +15 -15
  372. data/lib/plaid/models/paystub_override.rb +1 -1
  373. data/lib/plaid/models/paystub_override_employee.rb +1 -1
  374. data/lib/plaid/models/paystub_override_employee_address.rb +1 -1
  375. data/lib/plaid/models/paystub_override_employer.rb +1 -1
  376. data/lib/plaid/models/paystub_pay_frequency.rb +42 -0
  377. data/lib/plaid/models/{distribution_details.rb → paystub_verification.rb} +26 -53
  378. data/lib/plaid/models/paystub_verification_status.rb +41 -0
  379. data/lib/plaid/models/paystub_ytd_details.rb +1 -1
  380. data/lib/plaid/models/pending_expiration_webhook.rb +1 -1
  381. data/lib/plaid/models/personal_finance_category.rb +1 -1
  382. data/lib/plaid/models/phone_number.rb +1 -1
  383. data/lib/plaid/models/platform_ids.rb +1 -1
  384. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +1 -1
  385. data/lib/plaid/models/processor_auth_get_request.rb +1 -1
  386. data/lib/plaid/models/processor_auth_get_response.rb +1 -1
  387. data/lib/plaid/models/processor_balance_get_request.rb +1 -1
  388. data/lib/plaid/models/processor_balance_get_request_options.rb +1 -1
  389. data/lib/plaid/models/processor_balance_get_response.rb +1 -1
  390. data/lib/plaid/models/processor_bank_transfer_create_request.rb +1 -1
  391. data/lib/plaid/models/processor_bank_transfer_create_response.rb +1 -1
  392. data/lib/plaid/models/processor_identity_get_request.rb +1 -1
  393. data/lib/plaid/models/processor_identity_get_response.rb +1 -1
  394. data/lib/plaid/models/processor_number.rb +1 -1
  395. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +1 -1
  396. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +1 -1
  397. data/lib/plaid/models/processor_token_create_request.rb +1 -1
  398. data/lib/plaid/models/processor_token_create_response.rb +1 -1
  399. data/lib/plaid/models/product_access.rb +5 -5
  400. data/lib/plaid/models/product_status.rb +2 -2
  401. data/lib/plaid/models/product_status_breakdown.rb +1 -1
  402. data/lib/plaid/models/products.rb +1 -1
  403. data/lib/plaid/models/projected_income_summary_field_number.rb +1 -1
  404. data/lib/plaid/models/pslf_status.rb +1 -1
  405. data/lib/plaid/models/recaptcha_required_error.rb +1 -1
  406. data/lib/plaid/models/recipient_bacs.rb +1 -1
  407. data/lib/plaid/models/recipient_bacs_nullable.rb +1 -1
  408. data/lib/plaid/models/recurring_transaction_frequency.rb +1 -1
  409. data/lib/plaid/models/removed_transaction.rb +220 -0
  410. data/lib/plaid/models/requested_scopes.rb +1 -1
  411. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +1 -1
  412. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +1 -1
  413. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +1 -1
  414. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +1 -1
  415. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +17 -2
  416. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +1 -1
  417. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +1 -1
  418. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +1 -1
  419. data/lib/plaid/models/sandbox_item_reset_login_request.rb +1 -1
  420. data/lib/plaid/models/sandbox_item_reset_login_response.rb +1 -1
  421. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +1 -1
  422. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +1 -1
  423. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +1 -1
  424. data/lib/plaid/models/sandbox_processor_token_create_request.rb +1 -1
  425. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +1 -1
  426. data/lib/plaid/models/sandbox_processor_token_create_response.rb +1 -1
  427. data/lib/plaid/models/sandbox_public_token_create_request.rb +1 -1
  428. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +1 -1
  429. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  430. data/lib/plaid/models/sandbox_public_token_create_response.rb +1 -1
  431. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +1 -1
  432. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +1 -1
  433. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +254 -0
  434. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +239 -0
  435. data/lib/plaid/models/scopes.rb +1 -1
  436. data/lib/plaid/models/scopes_context.rb +1 -1
  437. data/lib/plaid/models/scopes_nullable.rb +1 -1
  438. data/lib/plaid/models/security.rb +1 -1
  439. data/lib/plaid/models/security_override.rb +1 -1
  440. data/lib/plaid/models/sender_bacs_nullable.rb +1 -1
  441. data/lib/plaid/models/servicer_address_data.rb +1 -1
  442. data/lib/plaid/models/signal_address_data.rb +1 -1
  443. data/lib/plaid/models/signal_decision_report_request.rb +63 -5
  444. data/lib/plaid/models/signal_decision_report_response.rb +1 -1
  445. data/lib/plaid/models/signal_device.rb +1 -1
  446. data/lib/plaid/models/signal_evaluate_core_attributes.rb +2 -2
  447. data/lib/plaid/models/signal_evaluate_request.rb +22 -2
  448. data/lib/plaid/models/signal_evaluate_response.rb +1 -1
  449. data/lib/plaid/models/signal_person_name.rb +1 -1
  450. data/lib/plaid/models/signal_return_report_request.rb +31 -1
  451. data/lib/plaid/models/signal_return_report_response.rb +1 -1
  452. data/lib/plaid/models/signal_scores.rb +1 -1
  453. data/lib/plaid/models/signal_user.rb +1 -1
  454. data/lib/plaid/models/standalone_account_type.rb +2 -2
  455. data/lib/plaid/models/standalone_currency_code_list.rb +1 -1
  456. data/lib/plaid/models/standalone_investment_transaction_type.rb +1 -1
  457. data/lib/plaid/models/student_loan.rb +1 -1
  458. data/lib/plaid/models/student_loan_repayment_model.rb +1 -1
  459. data/lib/plaid/models/student_loan_status.rb +1 -1
  460. data/lib/plaid/models/student_repayment_plan.rb +1 -1
  461. data/lib/plaid/models/taxform.rb +12 -2
  462. data/lib/plaid/models/taxpayer_id.rb +14 -2
  463. data/lib/plaid/models/total.rb +2 -37
  464. data/lib/plaid/models/total_canonical_description.rb +54 -0
  465. data/lib/plaid/models/transaction.rb +23 -23
  466. data/lib/plaid/models/transaction_all_of.rb +2 -24
  467. data/lib/plaid/models/transaction_base.rb +27 -5
  468. data/lib/plaid/models/transaction_code.rb +1 -1
  469. data/lib/plaid/models/transaction_data.rb +1 -1
  470. data/lib/plaid/models/transaction_override.rb +3 -3
  471. data/lib/plaid/models/transaction_stream.rb +1 -1
  472. data/lib/plaid/models/transaction_stream_amount.rb +1 -1
  473. data/lib/plaid/models/transactions_get_request.rb +1 -1
  474. data/lib/plaid/models/transactions_get_request_options.rb +1 -1
  475. data/lib/plaid/models/transactions_get_response.rb +1 -1
  476. data/lib/plaid/models/transactions_recurring_get_request.rb +11 -1
  477. data/lib/plaid/models/transactions_recurring_get_response.rb +6 -1
  478. data/lib/plaid/models/transactions_refresh_request.rb +1 -1
  479. data/lib/plaid/models/transactions_refresh_response.rb +1 -1
  480. data/lib/plaid/models/transactions_removed_webhook.rb +1 -1
  481. data/lib/plaid/models/transactions_sync_request.rb +293 -0
  482. data/lib/plaid/models/transactions_sync_response.rb +306 -0
  483. data/lib/plaid/models/transfer.rb +12 -2
  484. data/lib/plaid/models/transfer_authorization.rb +1 -1
  485. data/lib/plaid/models/transfer_authorization_create_request.rb +1 -1
  486. data/lib/plaid/models/transfer_authorization_create_response.rb +1 -1
  487. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +1 -1
  488. data/lib/plaid/models/transfer_authorization_device.rb +1 -1
  489. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +1 -1
  490. data/lib/plaid/models/transfer_cancel_request.rb +1 -1
  491. data/lib/plaid/models/transfer_cancel_response.rb +1 -1
  492. data/lib/plaid/models/transfer_create_request.rb +1 -1
  493. data/lib/plaid/models/transfer_create_response.rb +1 -1
  494. data/lib/plaid/models/transfer_event.rb +26 -6
  495. data/lib/plaid/models/transfer_event_list_request.rb +12 -2
  496. data/lib/plaid/models/transfer_event_list_response.rb +1 -1
  497. data/lib/plaid/models/transfer_event_sync_request.rb +1 -1
  498. data/lib/plaid/models/transfer_event_sync_response.rb +1 -1
  499. data/lib/plaid/models/transfer_event_type.rb +3 -1
  500. data/lib/plaid/models/transfer_failure.rb +1 -1
  501. data/lib/plaid/models/transfer_get_request.rb +1 -1
  502. data/lib/plaid/models/transfer_get_response.rb +1 -1
  503. data/lib/plaid/models/transfer_intent_create_mode.rb +39 -0
  504. data/lib/plaid/models/transfer_intent_create_request.rb +376 -0
  505. data/lib/plaid/models/transfer_intent_create_response.rb +408 -0
  506. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +240 -0
  507. data/lib/plaid/models/transfer_intent_get_request.rb +255 -0
  508. data/lib/plaid/models/transfer_intent_get_response.rb +467 -0
  509. data/lib/plaid/models/transfer_list_request.rb +1 -1
  510. data/lib/plaid/models/transfer_list_response.rb +1 -1
  511. data/lib/plaid/models/transfer_network.rb +1 -1
  512. data/lib/plaid/models/transfer_status.rb +1 -1
  513. data/lib/plaid/models/transfer_sweep.rb +250 -0
  514. data/lib/plaid/models/transfer_sweep_get_request.rb +245 -0
  515. data/lib/plaid/models/transfer_sweep_get_response.rb +239 -0
  516. data/lib/plaid/models/transfer_sweep_list_request.rb +330 -0
  517. data/lib/plaid/models/transfer_sweep_list_response.rb +241 -0
  518. data/lib/plaid/models/transfer_sweep_status.rb +41 -0
  519. data/lib/plaid/models/transfer_type.rb +1 -1
  520. data/lib/plaid/models/transfer_user_address_in_request.rb +1 -1
  521. data/lib/plaid/models/transfer_user_address_in_response.rb +1 -1
  522. data/lib/plaid/models/transfer_user_in_request.rb +1 -1
  523. data/lib/plaid/models/transfer_user_in_response.rb +1 -1
  524. data/lib/plaid/models/user_custom_password.rb +1 -1
  525. data/lib/plaid/models/user_permission_revoked_webhook.rb +1 -1
  526. data/lib/plaid/models/verification_attribute.rb +255 -0
  527. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  528. data/lib/plaid/models/verification_refresh_status.rb +1 -1
  529. data/lib/plaid/models/verification_status.rb +1 -1
  530. data/lib/plaid/models/w2.rb +1 -1
  531. data/lib/plaid/models/w2_box12.rb +1 -1
  532. data/lib/plaid/models/w2_state_and_local_wages.rb +1 -1
  533. data/lib/plaid/models/wallet_balance.rb +240 -0
  534. data/lib/plaid/models/wallet_get_request.rb +266 -0
  535. data/lib/plaid/models/wallet_get_response.rb +250 -0
  536. data/lib/plaid/models/wallet_transaction.rb +346 -0
  537. data/lib/plaid/models/wallet_transaction_amount.rb +306 -0
  538. data/lib/plaid/models/wallet_transaction_counterparty.rb +260 -0
  539. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +288 -0
  540. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +224 -0
  541. data/lib/plaid/models/wallet_transaction_execute_request.rb +384 -0
  542. data/lib/plaid/models/wallet_transaction_execute_response.rb +254 -0
  543. data/lib/plaid/models/wallet_transaction_status.rb +41 -0
  544. data/lib/plaid/models/wallet_transactions_list_request.rb +331 -0
  545. data/lib/plaid/models/wallet_transactions_list_response.rb +252 -0
  546. data/lib/plaid/models/warning.rb +1 -1
  547. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +1 -1
  548. data/lib/plaid/models/webhook_verification_key_get_request.rb +1 -1
  549. data/lib/plaid/models/webhook_verification_key_get_response.rb +1 -1
  550. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +1 -1
  551. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +1 -1
  552. data/lib/plaid/version.rb +2 -2
  553. data/lib/plaid.rb +51 -2
  554. data/pkg/plaid-13.2.0.gem +0 -0
  555. data/pkg/plaid-14.0.0.beta.3.gem +0 -0
  556. data/pkg/plaid-14.0.0.beta.5.gem +0 -0
  557. data/pkg/plaid-14.0.0.gem +0 -0
  558. data/pkg/plaid-14.1.0.gem +0 -0
  559. data/pkg/plaid-14.3.0.gem +0 -0
  560. data/pkg/plaid-14.6.0.gem +0 -0
  561. data/plaid.gemspec +1 -1
  562. data/templates/ruby/api_client.mustache +1 -1
  563. data/test/test_income_verifications.rb +81 -0
  564. metadata +71 -27
  565. data/doc/rdoc/classes/Plaid/AccessToken/UpdateVersionResponse.html +0 -118
  566. data/doc/rdoc/classes/Plaid/AddToken/CreateResponse.html +0 -118
  567. data/doc/rdoc/classes/Plaid/AddToken.html +0 -197
  568. data/pkg/plaid-10.0.0.gem +0 -0
  569. data/pkg/plaid-11.0.0.gem +0 -0
  570. data/pkg/plaid-12.0.0.gem +0 -0
  571. data/pkg/plaid-13.1.0.gem +0 -0
  572. data/pkg/plaid-14.4.0.gem +0 -0
  573. data/pkg/plaid-8.5.0.gem +0 -0
  574. data/pkg/plaid-8.6.0.gem +0 -0
  575. data/pkg/plaid-8.7.0.gem +0 -0
  576. data/pkg/plaid-8.8.0.gem +0 -0
  577. data/pkg/plaid-9.0.0.gem +0 -0
@@ -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.37.4
6
+ The version of the OpenAPI document: 2020-09-14_1.54.2
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 5.1.0
@@ -800,7 +800,7 @@ module Plaid
800
800
  end
801
801
 
802
802
  # Retrieve auth data
803
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
803
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
804
804
  # @param auth_get_request [AuthGetRequest]
805
805
  # @param [Hash] opts the optional parameters
806
806
  # @return [AuthGetResponse]
@@ -810,7 +810,7 @@ module Plaid
810
810
  end
811
811
 
812
812
  # Retrieve auth data
813
- # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item.
813
+ # The `/auth/get` endpoint returns the bank account and bank identification numbers (such as routing numbers, for US accounts) associated with an Item's checking and savings accounts, along with high-level account data and balances when available. Note: This request may take some time to complete if `auth` 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. Also note that `/auth/get` will not return data for any new accounts opened after the Item was created. To obtain data for new accounts, create a new Item. Versioning note: In API version 2017-03-08, the schema of the `numbers` object returned by this endpoint is substantially different. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2018-05-22).
814
814
  # @param auth_get_request [AuthGetRequest]
815
815
  # @param [Hash] opts the optional parameters
816
816
  # @return [Array<(AuthGetResponse, Integer, Hash)>] AuthGetResponse data, response status code and response headers
@@ -1515,7 +1515,7 @@ module Plaid
1515
1515
  end
1516
1516
 
1517
1517
  # Get Categories
1518
- # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1518
+ # Send a request to the `/categories/get` endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1519
1519
  # @param body [Object]
1520
1520
  # @param [Hash] opts the optional parameters
1521
1521
  # @return [CategoriesGetResponse]
@@ -1525,7 +1525,7 @@ module Plaid
1525
1525
  end
1526
1526
 
1527
1527
  # Get Categories
1528
- # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1528
+ # Send a request to the &#x60;/categories/get&#x60; endpoint to get detailed information on categories returned by Plaid. This endpoint does not require authentication.
1529
1529
  # @param body [Object]
1530
1530
  # @param [Hash] opts the optional parameters
1531
1531
  # @return [Array<(CategoriesGetResponse, Integer, Hash)>] CategoriesGetResponse data, response status code and response headers
@@ -2099,7 +2099,7 @@ module Plaid
2099
2099
  return data, status_code, headers
2100
2100
  end
2101
2101
 
2102
- # Create an income verification instance
2102
+ # (Deprecated) Create an income verification instance
2103
2103
  # `/income/verification/create` begins the income verification process by returning an `income_verification_id`. You can then provide the `income_verification_id` to `/link/token/create` under the `income_verification` parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an `INCOME` webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
2104
2104
  # @param income_verification_create_request [IncomeVerificationCreateRequest]
2105
2105
  # @param [Hash] opts the optional parameters
@@ -2109,7 +2109,7 @@ module Plaid
2109
2109
  data
2110
2110
  end
2111
2111
 
2112
- # Create an income verification instance
2112
+ # (Deprecated) Create an income verification instance
2113
2113
  # &#x60;/income/verification/create&#x60; begins the income verification process by returning an &#x60;income_verification_id&#x60;. You can then provide the &#x60;income_verification_id&#x60; to &#x60;/link/token/create&#x60; under the &#x60;income_verification&#x60; parameter in order to create a Link instance that will prompt the user to go through the income verification flow. Plaid will fire an &#x60;INCOME&#x60; webhook once the user completes the Payroll Income flow, or when the uploaded documents in the Document Income flow have finished processing.
2114
2114
  # @param income_verification_create_request [IncomeVerificationCreateRequest]
2115
2115
  # @param [Hash] opts the optional parameters
@@ -2487,7 +2487,7 @@ module Plaid
2487
2487
  return data, status_code, headers
2488
2488
  end
2489
2489
 
2490
- # Retrieve a summary of information derived from income verification
2490
+ # (Deprecated) Retrieve a summary of information derived from income verification
2491
2491
  # `/income/verification/summary/get` returns a verification summary for the income that was verified for an end user. 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.
2492
2492
  # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2493
2493
  # @param [Hash] opts the optional parameters
@@ -2497,7 +2497,7 @@ module Plaid
2497
2497
  data
2498
2498
  end
2499
2499
 
2500
- # Retrieve a summary of information derived from income verification
2500
+ # (Deprecated) Retrieve a summary of information derived from income verification
2501
2501
  # &#x60;/income/verification/summary/get&#x60; returns a verification summary for the income that was verified for an end user. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2502
2502
  # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2503
2503
  # @param [Hash] opts the optional parameters
@@ -2553,7 +2553,7 @@ module Plaid
2553
2553
  end
2554
2554
 
2555
2555
  # Retrieve information from the tax documents used for income verification
2556
- # `/income/verification/taxforms/get` returns the information collected from taxforms that were used to verify an end user's. 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.
2556
+ # `/income/verification/taxforms/get` returns the information collected from taxforms 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.
2557
2557
  # @param request_body [Hash<String, Object>]
2558
2558
  # @param [Hash] opts the optional parameters
2559
2559
  # @return [IncomeVerificationTaxformsGetResponse]
@@ -2563,7 +2563,7 @@ module Plaid
2563
2563
  end
2564
2564
 
2565
2565
  # Retrieve information from the tax documents used for income verification
2566
- # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from taxforms that were used to verify an end user&#39;s. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2566
+ # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from taxforms that were used to verify an end user&#39;s income. It can be called once the status of the verification has been set to &#x60;VERIFICATION_STATUS_PROCESSING_COMPLETE&#x60;, as reported by the &#x60;INCOME: verification_status&#x60; webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2567
2567
  # @param request_body [Hash<String, Object>]
2568
2568
  # @param [Hash] opts the optional parameters
2569
2569
  # @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
@@ -2683,7 +2683,7 @@ module Plaid
2683
2683
  end
2684
2684
 
2685
2685
  # Get details of an institution
2686
- # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2686
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` to authenticate to this endpoint. The `public_key` has been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
2687
2687
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2688
2688
  # @param [Hash] opts the optional parameters
2689
2689
  # @return [InstitutionsGetByIdResponse]
@@ -2693,7 +2693,7 @@ module Plaid
2693
2693
  end
2694
2694
 
2695
2695
  # Get details of an institution
2696
- # Returns a JSON response containing details on a specified financial institution currently supported by Plaid.
2696
+ # Returns a JSON response containing details on a specified financial institution currently supported by Plaid. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; to authenticate to this endpoint. The &#x60;public_key&#x60; has been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
2697
2697
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2698
2698
  # @param [Hash] opts the optional parameters
2699
2699
  # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
@@ -2748,7 +2748,7 @@ module Plaid
2748
2748
  end
2749
2749
 
2750
2750
  # Search institutions
2751
- # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2751
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the `public_key` parameter instead of the `client_id` and `secret` parameters to authenticate to this endpoint. The `public_key` parameter has since been deprecated; all customers are encouraged to use `client_id` and `secret` instead.
2752
2752
  # @param institutions_search_request [InstitutionsSearchRequest]
2753
2753
  # @param [Hash] opts the optional parameters
2754
2754
  # @return [InstitutionsSearchResponse]
@@ -2758,7 +2758,7 @@ module Plaid
2758
2758
  end
2759
2759
 
2760
2760
  # Search institutions
2761
- # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query.
2761
+ # Returns a JSON response containing details for institutions that match the query parameters, up to a maximum of ten institutions per query. Versioning note: API versions 2019-05-29 and earlier allow use of the &#x60;public_key&#x60; parameter instead of the &#x60;client_id&#x60; and &#x60;secret&#x60; parameters to authenticate to this endpoint. The &#x60;public_key&#x60; parameter has since been deprecated; all customers are encouraged to use &#x60;client_id&#x60; and &#x60;secret&#x60; instead.
2762
2762
  # @param institutions_search_request [InstitutionsSearchRequest]
2763
2763
  # @param [Hash] opts the optional parameters
2764
2764
  # @return [Array<(InstitutionsSearchResponse, Integer, Hash)>] InstitutionsSearchResponse data, response status code and response headers
@@ -3398,7 +3398,7 @@ module Plaid
3398
3398
  end
3399
3399
 
3400
3400
  # Remove an Item
3401
- # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager.
3401
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token` associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an `/item/remove` request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via `/item/remove` may still show as an active connection in the institution's OAuth permission manager. API versions 2019-05-29 and earlier return a `removed` boolean as part of the response.
3402
3402
  # @param item_remove_request [ItemRemoveRequest]
3403
3403
  # @param [Hash] opts the optional parameters
3404
3404
  # @return [ItemRemoveResponse]
@@ -3408,7 +3408,7 @@ module Plaid
3408
3408
  end
3409
3409
 
3410
3410
  # Remove an Item
3411
- # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60; associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager.
3411
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60; associated with the Item is no longer valid and cannot be used to access any data that was associated with the Item. Note that in the Development environment, issuing an &#x60;/item/remove&#x60; request will not decrement your live credential count. To increase your credential account in Development, contact Support. Also note that for certain OAuth-based institutions, an Item removed via &#x60;/item/remove&#x60; may still show as an active connection in the institution&#39;s OAuth permission manager. API versions 2019-05-29 and earlier return a &#x60;removed&#x60; boolean as part of the response.
3412
3412
  # @param item_remove_request [ItemRemoveRequest]
3413
3413
  # @param [Hash] opts the optional parameters
3414
3414
  # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
@@ -4243,7 +4243,7 @@ module Plaid
4243
4243
  end
4244
4244
 
4245
4245
  # Retrieve Auth data
4246
- # The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that's associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available.
4246
+ # The `/processor/auth/get` endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that''s associated with a given `processor_token`. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the `numbers` object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
4247
4247
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4248
4248
  # @param [Hash] opts the optional parameters
4249
4249
  # @return [ProcessorAuthGetResponse]
@@ -4253,7 +4253,7 @@ module Plaid
4253
4253
  end
4254
4254
 
4255
4255
  # Retrieve Auth data
4256
- # The &#x60;/processor/auth/get&#x60; endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that&#39;s associated with a given &#x60;processor_token&#x60;. The endpoint also returns high-level account data and balances when available.
4256
+ # The &#x60;/processor/auth/get&#x60; endpoint returns the bank account and bank identification number (such as the routing number, for US accounts), for a checking or savings account that&#39;&#39;s associated with a given &#x60;processor_token&#x60;. The endpoint also returns high-level account data and balances when available. Versioning note: API versions 2019-05-29 and earlier use a different schema for the &#x60;numbers&#x60; object returned by this endpoint. For details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2020-09-14).
4257
4257
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4258
4258
  # @param [Hash] opts the optional parameters
4259
4259
  # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
@@ -4828,7 +4828,7 @@ module Plaid
4828
4828
  end
4829
4829
 
4830
4830
  # Fire a test webhook
4831
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_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.
4831
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions `DEFAULT_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. 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.
4832
4832
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4833
4833
  # @param [Hash] opts the optional parameters
4834
4834
  # @return [SandboxItemFireWebhookResponse]
@@ -4838,7 +4838,7 @@ module Plaid
4838
4838
  end
4839
4839
 
4840
4840
  # Fire a test webhook
4841
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions &#x60;DEFAULT_UPDATE&#x60; 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.
4841
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. Calling this endpoint triggers a Transactions &#x60;DEFAULT_UPDATE&#x60; 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.
4842
4842
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4843
4843
  # @param [Hash] opts the optional parameters
4844
4844
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -5151,7 +5151,7 @@ module Plaid
5151
5151
  end
5152
5152
 
5153
5153
  # Create a test Item
5154
- # 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.
5154
+ # 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.
5155
5155
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
5156
5156
  # @param [Hash] opts the optional parameters
5157
5157
  # @return [SandboxPublicTokenCreateResponse]
@@ -5161,7 +5161,7 @@ module Plaid
5161
5161
  end
5162
5162
 
5163
5163
  # Create a test Item
5164
- # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data.
5164
+ # Use the &#x60;/sandbox/public_token/create&#x60; endpoint to create a valid &#x60;public_token&#x60; for an arbitrary institution ID, initial products, and test credentials. The created &#x60;public_token&#x60; maps to a new Sandbox Item. You can then call &#x60;/item/public_token/exchange&#x60; to exchange the &#x60;public_token&#x60; for an &#x60;access_token&#x60; and perform all API actions. &#x60;/sandbox/public_token/create&#x60; can also be used with the [&#x60;user_custom&#x60; test username](https://plaid.com/docs/sandbox/user-custom) to generate a test account with custom data. &#x60;/sandbox/public_token/create&#x60; cannot be used with OAuth institutions.
5165
5165
  # @param sandbox_public_token_create_request [SandboxPublicTokenCreateRequest]
5166
5166
  # @param [Hash] opts the optional parameters
5167
5167
  # @return [Array<(SandboxPublicTokenCreateResponse, Integer, Hash)>] SandboxPublicTokenCreateResponse data, response status code and response headers
@@ -5280,6 +5280,71 @@ module Plaid
5280
5280
  return data, status_code, headers
5281
5281
  end
5282
5282
 
5283
+ # Simulate creating a sweep for a set of transfers
5284
+ # Use the `/sandbox/transfer/sweep/simulate` endpoint to create a sweep and associated events in the Sandbox environment.
5285
+ # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
5286
+ # @param [Hash] opts the optional parameters
5287
+ # @return [SandboxTransferSweepSimulateResponse]
5288
+ def sandbox_transfer_sweep_simulate(sandbox_transfer_sweep_simulate_request, opts = {})
5289
+ data, _status_code, _headers = sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts)
5290
+ data
5291
+ end
5292
+
5293
+ # Simulate creating a sweep for a set of transfers
5294
+ # Use the &#x60;/sandbox/transfer/sweep/simulate&#x60; endpoint to create a sweep and associated events in the Sandbox environment.
5295
+ # @param sandbox_transfer_sweep_simulate_request [SandboxTransferSweepSimulateRequest]
5296
+ # @param [Hash] opts the optional parameters
5297
+ # @return [Array<(SandboxTransferSweepSimulateResponse, Integer, Hash)>] SandboxTransferSweepSimulateResponse data, response status code and response headers
5298
+ def sandbox_transfer_sweep_simulate_with_http_info(sandbox_transfer_sweep_simulate_request, opts = {})
5299
+ if @api_client.config.debugging
5300
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_sweep_simulate ...'
5301
+ end
5302
+ # verify the required parameter 'sandbox_transfer_sweep_simulate_request' is set
5303
+ if @api_client.config.client_side_validation && sandbox_transfer_sweep_simulate_request.nil?
5304
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_sweep_simulate_request' when calling PlaidApi.sandbox_transfer_sweep_simulate"
5305
+ end
5306
+ # resource path
5307
+ local_var_path = '/sandbox/transfer/sweep/simulate'
5308
+
5309
+ # query parameters
5310
+ query_params = opts[:query_params] || {}
5311
+
5312
+ # header parameters
5313
+ header_params = opts[:header_params] || {}
5314
+ # HTTP header 'Accept' (if needed)
5315
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5316
+ # HTTP header 'Content-Type'
5317
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5318
+
5319
+ # form parameters
5320
+ form_params = opts[:form_params] || {}
5321
+
5322
+ # http body (model)
5323
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_sweep_simulate_request)
5324
+
5325
+ # return_type
5326
+ return_type = opts[:debug_return_type] || 'SandboxTransferSweepSimulateResponse'
5327
+
5328
+ # auth_names
5329
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5330
+
5331
+ new_options = opts.merge(
5332
+ :operation => :"PlaidApi.sandbox_transfer_sweep_simulate",
5333
+ :header_params => header_params,
5334
+ :query_params => query_params,
5335
+ :form_params => form_params,
5336
+ :body => post_body,
5337
+ :auth_names => auth_names,
5338
+ :return_type => return_type
5339
+ )
5340
+
5341
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5342
+ if @api_client.config.debugging
5343
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_sweep_simulate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5344
+ end
5345
+ return data, status_code, headers
5346
+ end
5347
+
5283
5348
  # Report whether you initiated an ACH transaction
5284
5349
  # 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`.
5285
5350
  # @param signal_decision_report_request [SignalDecisionReportRequest]
@@ -5346,7 +5411,7 @@ module Plaid
5346
5411
  end
5347
5412
 
5348
5413
  # Evaluate a planned ACH transaction
5349
- # 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.
5414
+ # 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.
5350
5415
  # @param signal_evaluate_request [SignalEvaluateRequest]
5351
5416
  # @param [Hash] opts the optional parameters
5352
5417
  # @return [SignalEvaluateResponse]
@@ -5356,7 +5421,7 @@ module Plaid
5356
5421
  end
5357
5422
 
5358
5423
  # Evaluate a planned ACH transaction
5359
- # 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.
5424
+ # 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.
5360
5425
  # @param signal_evaluate_request [SignalEvaluateRequest]
5361
5426
  # @param [Hash] opts the optional parameters
5362
5427
  # @return [Array<(SignalEvaluateResponse, Integer, Hash)>] SignalEvaluateResponse data, response status code and response headers
@@ -5412,26 +5477,26 @@ module Plaid
5412
5477
 
5413
5478
  # Report a return for an ACH transaction
5414
5479
  # Call the `/signal/return/report` endpoint to report a returned transaction that was previously sent to the `/signal/evaluate` endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
5415
- # @param request_body [Hash<String, Object>]
5480
+ # @param signal_return_report_request [SignalReturnReportRequest]
5416
5481
  # @param [Hash] opts the optional parameters
5417
5482
  # @return [SignalReturnReportResponse]
5418
- def signal_return_report(request_body, opts = {})
5419
- data, _status_code, _headers = signal_return_report_with_http_info(request_body, opts)
5483
+ def signal_return_report(signal_return_report_request, opts = {})
5484
+ data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
5420
5485
  data
5421
5486
  end
5422
5487
 
5423
5488
  # Report a return for an ACH transaction
5424
5489
  # Call the &#x60;/signal/return/report&#x60; endpoint to report a returned transaction that was previously sent to the &#x60;/signal/evaluate&#x60; endpoint. Your feedback will be used by the model to incorporate the latest risk trend in your portfolio.
5425
- # @param request_body [Hash<String, Object>]
5490
+ # @param signal_return_report_request [SignalReturnReportRequest]
5426
5491
  # @param [Hash] opts the optional parameters
5427
5492
  # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
5428
- def signal_return_report_with_http_info(request_body, opts = {})
5493
+ def signal_return_report_with_http_info(signal_return_report_request, opts = {})
5429
5494
  if @api_client.config.debugging
5430
5495
  @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
5431
5496
  end
5432
- # verify the required parameter 'request_body' is set
5433
- if @api_client.config.client_side_validation && request_body.nil?
5434
- fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.signal_return_report"
5497
+ # verify the required parameter 'signal_return_report_request' is set
5498
+ if @api_client.config.client_side_validation && signal_return_report_request.nil?
5499
+ fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
5435
5500
  end
5436
5501
  # resource path
5437
5502
  local_var_path = '/signal/return/report'
@@ -5450,7 +5515,7 @@ module Plaid
5450
5515
  form_params = opts[:form_params] || {}
5451
5516
 
5452
5517
  # http body (model)
5453
- post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
5518
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
5454
5519
 
5455
5520
  # return_type
5456
5521
  return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
@@ -5670,6 +5735,71 @@ module Plaid
5670
5735
  return data, status_code, headers
5671
5736
  end
5672
5737
 
5738
+ # Get incremental transaction updates on an item
5739
+ # The `/transactions/sync` endpoint returns item transactions as a set of delta updates. Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
5740
+ # @param transactions_sync_request [TransactionsSyncRequest]
5741
+ # @param [Hash] opts the optional parameters
5742
+ # @return [TransactionsSyncResponse]
5743
+ def transactions_sync(transactions_sync_request, opts = {})
5744
+ data, _status_code, _headers = transactions_sync_with_http_info(transactions_sync_request, opts)
5745
+ data
5746
+ end
5747
+
5748
+ # Get incremental transaction updates on an item
5749
+ # The &#x60;/transactions/sync&#x60; endpoint returns item transactions as a set of delta updates. Subsequent calls to the endpoint using the cursor returned in the response will return new added, modified, and removed transactions since the last call to the endpoint The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
5750
+ # @param transactions_sync_request [TransactionsSyncRequest]
5751
+ # @param [Hash] opts the optional parameters
5752
+ # @return [Array<(TransactionsSyncResponse, Integer, Hash)>] TransactionsSyncResponse data, response status code and response headers
5753
+ def transactions_sync_with_http_info(transactions_sync_request, opts = {})
5754
+ if @api_client.config.debugging
5755
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_sync ...'
5756
+ end
5757
+ # verify the required parameter 'transactions_sync_request' is set
5758
+ if @api_client.config.client_side_validation && transactions_sync_request.nil?
5759
+ fail ArgumentError, "Missing the required parameter 'transactions_sync_request' when calling PlaidApi.transactions_sync"
5760
+ end
5761
+ # resource path
5762
+ local_var_path = '/transactions/sync'
5763
+
5764
+ # query parameters
5765
+ query_params = opts[:query_params] || {}
5766
+
5767
+ # header parameters
5768
+ header_params = opts[:header_params] || {}
5769
+ # HTTP header 'Accept' (if needed)
5770
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5771
+ # HTTP header 'Content-Type'
5772
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5773
+
5774
+ # form parameters
5775
+ form_params = opts[:form_params] || {}
5776
+
5777
+ # http body (model)
5778
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_sync_request)
5779
+
5780
+ # return_type
5781
+ return_type = opts[:debug_return_type] || 'TransactionsSyncResponse'
5782
+
5783
+ # auth_names
5784
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5785
+
5786
+ new_options = opts.merge(
5787
+ :operation => :"PlaidApi.transactions_sync",
5788
+ :header_params => header_params,
5789
+ :query_params => query_params,
5790
+ :form_params => form_params,
5791
+ :body => post_body,
5792
+ :auth_names => auth_names,
5793
+ :return_type => return_type
5794
+ )
5795
+
5796
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5797
+ if @api_client.config.debugging
5798
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_sync\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5799
+ end
5800
+ return data, status_code, headers
5801
+ end
5802
+
5673
5803
  # Create a transfer authorization
5674
5804
  # 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, make an authorization request with an `amount` less than the available balance in the account. - 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. - To permit 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 permit a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). All username/password combinations other than the ones listed above will result in a decision of permitted and rationale code `ERROR`.
5675
5805
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
@@ -6060,6 +6190,136 @@ module Plaid
6060
6190
  return data, status_code, headers
6061
6191
  end
6062
6192
 
6193
+ # Create a transfer intent object to invoke the Transfer UI
6194
+ # Use the `/transfer/intent/create` endpoint to generate a transfer intent object and invoke the Transfer UI.
6195
+ # @param transfer_intent_create_request [TransferIntentCreateRequest]
6196
+ # @param [Hash] opts the optional parameters
6197
+ # @return [TransferIntentCreateResponse]
6198
+ def transfer_intent_create(transfer_intent_create_request, opts = {})
6199
+ data, _status_code, _headers = transfer_intent_create_with_http_info(transfer_intent_create_request, opts)
6200
+ data
6201
+ end
6202
+
6203
+ # Create a transfer intent object to invoke the Transfer UI
6204
+ # Use the &#x60;/transfer/intent/create&#x60; endpoint to generate a transfer intent object and invoke the Transfer UI.
6205
+ # @param transfer_intent_create_request [TransferIntentCreateRequest]
6206
+ # @param [Hash] opts the optional parameters
6207
+ # @return [Array<(TransferIntentCreateResponse, Integer, Hash)>] TransferIntentCreateResponse data, response status code and response headers
6208
+ def transfer_intent_create_with_http_info(transfer_intent_create_request, opts = {})
6209
+ if @api_client.config.debugging
6210
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_create ...'
6211
+ end
6212
+ # verify the required parameter 'transfer_intent_create_request' is set
6213
+ if @api_client.config.client_side_validation && transfer_intent_create_request.nil?
6214
+ fail ArgumentError, "Missing the required parameter 'transfer_intent_create_request' when calling PlaidApi.transfer_intent_create"
6215
+ end
6216
+ # resource path
6217
+ local_var_path = '/transfer/intent/create'
6218
+
6219
+ # query parameters
6220
+ query_params = opts[:query_params] || {}
6221
+
6222
+ # header parameters
6223
+ header_params = opts[:header_params] || {}
6224
+ # HTTP header 'Accept' (if needed)
6225
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6226
+ # HTTP header 'Content-Type'
6227
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6228
+
6229
+ # form parameters
6230
+ form_params = opts[:form_params] || {}
6231
+
6232
+ # http body (model)
6233
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_intent_create_request)
6234
+
6235
+ # return_type
6236
+ return_type = opts[:debug_return_type] || 'TransferIntentCreateResponse'
6237
+
6238
+ # auth_names
6239
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6240
+
6241
+ new_options = opts.merge(
6242
+ :operation => :"PlaidApi.transfer_intent_create",
6243
+ :header_params => header_params,
6244
+ :query_params => query_params,
6245
+ :form_params => form_params,
6246
+ :body => post_body,
6247
+ :auth_names => auth_names,
6248
+ :return_type => return_type
6249
+ )
6250
+
6251
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6252
+ if @api_client.config.debugging
6253
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6254
+ end
6255
+ return data, status_code, headers
6256
+ end
6257
+
6258
+ # Retrieve more information about a transfer intent
6259
+ # Use the `/transfer/intent/get` endpoint to retrieve more information about a transfer intent.
6260
+ # @param request_body [Hash<String, Object>]
6261
+ # @param [Hash] opts the optional parameters
6262
+ # @return [TransferIntentGetResponse]
6263
+ def transfer_intent_get(request_body, opts = {})
6264
+ data, _status_code, _headers = transfer_intent_get_with_http_info(request_body, opts)
6265
+ data
6266
+ end
6267
+
6268
+ # Retrieve more information about a transfer intent
6269
+ # Use the &#x60;/transfer/intent/get&#x60; endpoint to retrieve more information about a transfer intent.
6270
+ # @param request_body [Hash<String, Object>]
6271
+ # @param [Hash] opts the optional parameters
6272
+ # @return [Array<(TransferIntentGetResponse, Integer, Hash)>] TransferIntentGetResponse data, response status code and response headers
6273
+ def transfer_intent_get_with_http_info(request_body, opts = {})
6274
+ if @api_client.config.debugging
6275
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_intent_get ...'
6276
+ end
6277
+ # verify the required parameter 'request_body' is set
6278
+ if @api_client.config.client_side_validation && request_body.nil?
6279
+ fail ArgumentError, "Missing the required parameter 'request_body' when calling PlaidApi.transfer_intent_get"
6280
+ end
6281
+ # resource path
6282
+ local_var_path = '/transfer/intent/get'
6283
+
6284
+ # query parameters
6285
+ query_params = opts[:query_params] || {}
6286
+
6287
+ # header parameters
6288
+ header_params = opts[:header_params] || {}
6289
+ # HTTP header 'Accept' (if needed)
6290
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6291
+ # HTTP header 'Content-Type'
6292
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6293
+
6294
+ # form parameters
6295
+ form_params = opts[:form_params] || {}
6296
+
6297
+ # http body (model)
6298
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(request_body)
6299
+
6300
+ # return_type
6301
+ return_type = opts[:debug_return_type] || 'TransferIntentGetResponse'
6302
+
6303
+ # auth_names
6304
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6305
+
6306
+ new_options = opts.merge(
6307
+ :operation => :"PlaidApi.transfer_intent_get",
6308
+ :header_params => header_params,
6309
+ :query_params => query_params,
6310
+ :form_params => form_params,
6311
+ :body => post_body,
6312
+ :auth_names => auth_names,
6313
+ :return_type => return_type
6314
+ )
6315
+
6316
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6317
+ if @api_client.config.debugging
6318
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_intent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6319
+ end
6320
+ return data, status_code, headers
6321
+ end
6322
+
6063
6323
  # List transfers
6064
6324
  # Use the `/transfer/list` endpoint to see a list of all your transfers and their statuses. Results are paginated; use the `count` and `offset` query parameters to retrieve the desired transfers.
6065
6325
  # @param transfer_list_request [TransferListRequest]
@@ -6125,6 +6385,331 @@ module Plaid
6125
6385
  return data, status_code, headers
6126
6386
  end
6127
6387
 
6388
+ # Retrieve a sweep
6389
+ # The `/transfer/sweep/get` endpoint fetches a sweep corresponding to the given `sweep_id`.
6390
+ # @param transfer_sweep_get_request [TransferSweepGetRequest]
6391
+ # @param [Hash] opts the optional parameters
6392
+ # @return [TransferSweepGetResponse]
6393
+ def transfer_sweep_get(transfer_sweep_get_request, opts = {})
6394
+ data, _status_code, _headers = transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts)
6395
+ data
6396
+ end
6397
+
6398
+ # Retrieve a sweep
6399
+ # The &#x60;/transfer/sweep/get&#x60; endpoint fetches a sweep corresponding to the given &#x60;sweep_id&#x60;.
6400
+ # @param transfer_sweep_get_request [TransferSweepGetRequest]
6401
+ # @param [Hash] opts the optional parameters
6402
+ # @return [Array<(TransferSweepGetResponse, Integer, Hash)>] TransferSweepGetResponse data, response status code and response headers
6403
+ def transfer_sweep_get_with_http_info(transfer_sweep_get_request, opts = {})
6404
+ if @api_client.config.debugging
6405
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_get ...'
6406
+ end
6407
+ # verify the required parameter 'transfer_sweep_get_request' is set
6408
+ if @api_client.config.client_side_validation && transfer_sweep_get_request.nil?
6409
+ fail ArgumentError, "Missing the required parameter 'transfer_sweep_get_request' when calling PlaidApi.transfer_sweep_get"
6410
+ end
6411
+ # resource path
6412
+ local_var_path = '/transfer/sweep/get'
6413
+
6414
+ # query parameters
6415
+ query_params = opts[:query_params] || {}
6416
+
6417
+ # header parameters
6418
+ header_params = opts[:header_params] || {}
6419
+ # HTTP header 'Accept' (if needed)
6420
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6421
+ # HTTP header 'Content-Type'
6422
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6423
+
6424
+ # form parameters
6425
+ form_params = opts[:form_params] || {}
6426
+
6427
+ # http body (model)
6428
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_get_request)
6429
+
6430
+ # return_type
6431
+ return_type = opts[:debug_return_type] || 'TransferSweepGetResponse'
6432
+
6433
+ # auth_names
6434
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6435
+
6436
+ new_options = opts.merge(
6437
+ :operation => :"PlaidApi.transfer_sweep_get",
6438
+ :header_params => header_params,
6439
+ :query_params => query_params,
6440
+ :form_params => form_params,
6441
+ :body => post_body,
6442
+ :auth_names => auth_names,
6443
+ :return_type => return_type
6444
+ )
6445
+
6446
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6447
+ if @api_client.config.debugging
6448
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6449
+ end
6450
+ return data, status_code, headers
6451
+ end
6452
+
6453
+ # List sweeps
6454
+ # The `/transfer/sweep/list` endpoint fetches sweeps matching the given filters.
6455
+ # @param transfer_sweep_list_request [TransferSweepListRequest]
6456
+ # @param [Hash] opts the optional parameters
6457
+ # @return [TransferSweepListResponse]
6458
+ def transfer_sweep_list(transfer_sweep_list_request, opts = {})
6459
+ data, _status_code, _headers = transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts)
6460
+ data
6461
+ end
6462
+
6463
+ # List sweeps
6464
+ # The &#x60;/transfer/sweep/list&#x60; endpoint fetches sweeps matching the given filters.
6465
+ # @param transfer_sweep_list_request [TransferSweepListRequest]
6466
+ # @param [Hash] opts the optional parameters
6467
+ # @return [Array<(TransferSweepListResponse, Integer, Hash)>] TransferSweepListResponse data, response status code and response headers
6468
+ def transfer_sweep_list_with_http_info(transfer_sweep_list_request, opts = {})
6469
+ if @api_client.config.debugging
6470
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_sweep_list ...'
6471
+ end
6472
+ # verify the required parameter 'transfer_sweep_list_request' is set
6473
+ if @api_client.config.client_side_validation && transfer_sweep_list_request.nil?
6474
+ fail ArgumentError, "Missing the required parameter 'transfer_sweep_list_request' when calling PlaidApi.transfer_sweep_list"
6475
+ end
6476
+ # resource path
6477
+ local_var_path = '/transfer/sweep/list'
6478
+
6479
+ # query parameters
6480
+ query_params = opts[:query_params] || {}
6481
+
6482
+ # header parameters
6483
+ header_params = opts[:header_params] || {}
6484
+ # HTTP header 'Accept' (if needed)
6485
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6486
+ # HTTP header 'Content-Type'
6487
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6488
+
6489
+ # form parameters
6490
+ form_params = opts[:form_params] || {}
6491
+
6492
+ # http body (model)
6493
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_sweep_list_request)
6494
+
6495
+ # return_type
6496
+ return_type = opts[:debug_return_type] || 'TransferSweepListResponse'
6497
+
6498
+ # auth_names
6499
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6500
+
6501
+ new_options = opts.merge(
6502
+ :operation => :"PlaidApi.transfer_sweep_list",
6503
+ :header_params => header_params,
6504
+ :query_params => query_params,
6505
+ :form_params => form_params,
6506
+ :body => post_body,
6507
+ :auth_names => auth_names,
6508
+ :return_type => return_type
6509
+ )
6510
+
6511
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6512
+ if @api_client.config.debugging
6513
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_sweep_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6514
+ end
6515
+ return data, status_code, headers
6516
+ end
6517
+
6518
+ # Fetch an e-wallet
6519
+ # Fetch an e-wallet. The response includes the current balance.
6520
+ # @param wallet_get_request [WalletGetRequest]
6521
+ # @param [Hash] opts the optional parameters
6522
+ # @return [WalletGetResponse]
6523
+ def wallet_get(wallet_get_request, opts = {})
6524
+ data, _status_code, _headers = wallet_get_with_http_info(wallet_get_request, opts)
6525
+ data
6526
+ end
6527
+
6528
+ # Fetch an e-wallet
6529
+ # Fetch an e-wallet. The response includes the current balance.
6530
+ # @param wallet_get_request [WalletGetRequest]
6531
+ # @param [Hash] opts the optional parameters
6532
+ # @return [Array<(WalletGetResponse, Integer, Hash)>] WalletGetResponse data, response status code and response headers
6533
+ def wallet_get_with_http_info(wallet_get_request, opts = {})
6534
+ if @api_client.config.debugging
6535
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_get ...'
6536
+ end
6537
+ # verify the required parameter 'wallet_get_request' is set
6538
+ if @api_client.config.client_side_validation && wallet_get_request.nil?
6539
+ fail ArgumentError, "Missing the required parameter 'wallet_get_request' when calling PlaidApi.wallet_get"
6540
+ end
6541
+ # resource path
6542
+ local_var_path = '/wallet/get'
6543
+
6544
+ # query parameters
6545
+ query_params = opts[:query_params] || {}
6546
+
6547
+ # header parameters
6548
+ header_params = opts[:header_params] || {}
6549
+ # HTTP header 'Accept' (if needed)
6550
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6551
+ # HTTP header 'Content-Type'
6552
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6553
+
6554
+ # form parameters
6555
+ form_params = opts[:form_params] || {}
6556
+
6557
+ # http body (model)
6558
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_get_request)
6559
+
6560
+ # return_type
6561
+ return_type = opts[:debug_return_type] || 'WalletGetResponse'
6562
+
6563
+ # auth_names
6564
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6565
+
6566
+ new_options = opts.merge(
6567
+ :operation => :"PlaidApi.wallet_get",
6568
+ :header_params => header_params,
6569
+ :query_params => query_params,
6570
+ :form_params => form_params,
6571
+ :body => post_body,
6572
+ :auth_names => auth_names,
6573
+ :return_type => return_type
6574
+ )
6575
+
6576
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6577
+ if @api_client.config.debugging
6578
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6579
+ end
6580
+ return data, status_code, headers
6581
+ end
6582
+
6583
+ # Execute a transaction using an e-wallet
6584
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
6585
+ # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
6586
+ # @param [Hash] opts the optional parameters
6587
+ # @return [WalletTransactionExecuteResponse]
6588
+ def wallet_transaction_execute(wallet_transaction_execute_request, opts = {})
6589
+ data, _status_code, _headers = wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts)
6590
+ data
6591
+ end
6592
+
6593
+ # Execute a transaction using an e-wallet
6594
+ # Execute a transaction using the specified e-wallet. Specify the e-wallet to debit from, the counterparty to credit to, the idempotency key to prevent duplicate payouts, the amount and reference for the payout. The payouts are executed over the Faster Payment rails, where settlement usually only takes a few seconds.
6595
+ # @param wallet_transaction_execute_request [WalletTransactionExecuteRequest]
6596
+ # @param [Hash] opts the optional parameters
6597
+ # @return [Array<(WalletTransactionExecuteResponse, Integer, Hash)>] WalletTransactionExecuteResponse data, response status code and response headers
6598
+ def wallet_transaction_execute_with_http_info(wallet_transaction_execute_request, opts = {})
6599
+ if @api_client.config.debugging
6600
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transaction_execute ...'
6601
+ end
6602
+ # verify the required parameter 'wallet_transaction_execute_request' is set
6603
+ if @api_client.config.client_side_validation && wallet_transaction_execute_request.nil?
6604
+ fail ArgumentError, "Missing the required parameter 'wallet_transaction_execute_request' when calling PlaidApi.wallet_transaction_execute"
6605
+ end
6606
+ # resource path
6607
+ local_var_path = '/wallet/transaction/execute'
6608
+
6609
+ # query parameters
6610
+ query_params = opts[:query_params] || {}
6611
+
6612
+ # header parameters
6613
+ header_params = opts[:header_params] || {}
6614
+ # HTTP header 'Accept' (if needed)
6615
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6616
+ # HTTP header 'Content-Type'
6617
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6618
+
6619
+ # form parameters
6620
+ form_params = opts[:form_params] || {}
6621
+
6622
+ # http body (model)
6623
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transaction_execute_request)
6624
+
6625
+ # return_type
6626
+ return_type = opts[:debug_return_type] || 'WalletTransactionExecuteResponse'
6627
+
6628
+ # auth_names
6629
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6630
+
6631
+ new_options = opts.merge(
6632
+ :operation => :"PlaidApi.wallet_transaction_execute",
6633
+ :header_params => header_params,
6634
+ :query_params => query_params,
6635
+ :form_params => form_params,
6636
+ :body => post_body,
6637
+ :auth_names => auth_names,
6638
+ :return_type => return_type
6639
+ )
6640
+
6641
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6642
+ if @api_client.config.debugging
6643
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transaction_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6644
+ end
6645
+ return data, status_code, headers
6646
+ end
6647
+
6648
+ # List e-wallet transactions
6649
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the `created_at` time.
6650
+ # @param wallet_transactions_list_request [WalletTransactionsListRequest]
6651
+ # @param [Hash] opts the optional parameters
6652
+ # @return [WalletTransactionsListResponse]
6653
+ def wallet_transactions_list(wallet_transactions_list_request, opts = {})
6654
+ data, _status_code, _headers = wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts)
6655
+ data
6656
+ end
6657
+
6658
+ # List e-wallet transactions
6659
+ # This endpoint lists the latest transactions of the specified e-wallet. Transactions are returned in descending order by the &#x60;created_at&#x60; time.
6660
+ # @param wallet_transactions_list_request [WalletTransactionsListRequest]
6661
+ # @param [Hash] opts the optional parameters
6662
+ # @return [Array<(WalletTransactionsListResponse, Integer, Hash)>] WalletTransactionsListResponse data, response status code and response headers
6663
+ def wallet_transactions_list_with_http_info(wallet_transactions_list_request, opts = {})
6664
+ if @api_client.config.debugging
6665
+ @api_client.config.logger.debug 'Calling API: PlaidApi.wallet_transactions_list ...'
6666
+ end
6667
+ # verify the required parameter 'wallet_transactions_list_request' is set
6668
+ if @api_client.config.client_side_validation && wallet_transactions_list_request.nil?
6669
+ fail ArgumentError, "Missing the required parameter 'wallet_transactions_list_request' when calling PlaidApi.wallet_transactions_list"
6670
+ end
6671
+ # resource path
6672
+ local_var_path = '/wallet/transactions/list'
6673
+
6674
+ # query parameters
6675
+ query_params = opts[:query_params] || {}
6676
+
6677
+ # header parameters
6678
+ header_params = opts[:header_params] || {}
6679
+ # HTTP header 'Accept' (if needed)
6680
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6681
+ # HTTP header 'Content-Type'
6682
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6683
+
6684
+ # form parameters
6685
+ form_params = opts[:form_params] || {}
6686
+
6687
+ # http body (model)
6688
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(wallet_transactions_list_request)
6689
+
6690
+ # return_type
6691
+ return_type = opts[:debug_return_type] || 'WalletTransactionsListResponse'
6692
+
6693
+ # auth_names
6694
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6695
+
6696
+ new_options = opts.merge(
6697
+ :operation => :"PlaidApi.wallet_transactions_list",
6698
+ :header_params => header_params,
6699
+ :query_params => query_params,
6700
+ :form_params => form_params,
6701
+ :body => post_body,
6702
+ :auth_names => auth_names,
6703
+ :return_type => return_type
6704
+ )
6705
+
6706
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6707
+ if @api_client.config.debugging
6708
+ @api_client.config.logger.debug "API called: PlaidApi#wallet_transactions_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6709
+ end
6710
+ return data, status_code, headers
6711
+ end
6712
+
6128
6713
  # Get webhook verification key
6129
6714
  # Plaid signs all outgoing webhooks and provides JSON Web Tokens (JWTs) so that you can verify the authenticity of any incoming webhooks to your application. A message signature is included in the `Plaid-Verification` header. The `/webhook_verification_key/get` endpoint provides a JSON Web Key (JWK) that can be used to verify a JWT.
6130
6715
  # @param webhook_verification_key_get_request [WebhookVerificationKeyGetRequest]