plaid 14.14.0 → 15.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (654) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +147 -0
  3. data/Gemfile.lock +1 -1
  4. data/Makefile +1 -1
  5. data/README.md +1 -1
  6. data/lib/plaid/api/plaid_api.rb +1501 -396
  7. data/lib/plaid/api_client.rb +3 -3
  8. data/lib/plaid/api_error.rb +2 -2
  9. data/lib/plaid/configuration.rb +2 -2
  10. data/lib/plaid/models/account_access.rb +2 -2
  11. data/lib/plaid/models/account_assets.rb +2 -2
  12. data/lib/plaid/models/account_assets_all_of.rb +2 -2
  13. data/lib/plaid/models/account_balance.rb +2 -2
  14. data/lib/plaid/models/account_base.rb +2 -2
  15. data/lib/plaid/models/account_filter.rb +2 -2
  16. data/lib/plaid/models/account_filters_response.rb +2 -2
  17. data/lib/plaid/models/account_identity.rb +2 -2
  18. data/lib/plaid/models/account_identity_all_of.rb +2 -2
  19. data/lib/plaid/models/account_product_access.rb +2 -2
  20. data/lib/plaid/models/account_product_access_nullable.rb +2 -2
  21. data/lib/plaid/models/account_selection_cardinality.rb +2 -2
  22. data/lib/plaid/models/account_subtype.rb +2 -2
  23. data/lib/plaid/models/account_type.rb +2 -2
  24. data/lib/plaid/models/accounts_balance_get_request.rb +2 -2
  25. data/lib/plaid/models/accounts_balance_get_request_options.rb +2 -2
  26. data/lib/plaid/models/accounts_get_request.rb +2 -2
  27. data/lib/plaid/models/accounts_get_request_options.rb +2 -2
  28. data/lib/plaid/models/accounts_get_response.rb +2 -2
  29. data/lib/plaid/models/ach_class.rb +2 -2
  30. data/lib/plaid/models/address.rb +2 -2
  31. data/lib/plaid/models/address_data.rb +2 -2
  32. data/lib/plaid/models/address_data_nullable.rb +2 -2
  33. data/lib/plaid/models/address_nullable.rb +2 -2
  34. data/lib/plaid/models/application.rb +73 -7
  35. data/lib/plaid/models/application_get_request.rb +2 -2
  36. data/lib/plaid/models/application_get_response.rb +2 -2
  37. data/lib/plaid/models/apr.rb +2 -2
  38. data/lib/plaid/models/asset_report.rb +2 -2
  39. data/lib/plaid/models/asset_report_audit_copy_create_request.rb +2 -2
  40. data/lib/plaid/models/asset_report_audit_copy_create_response.rb +2 -2
  41. data/lib/plaid/models/asset_report_audit_copy_get_request.rb +2 -2
  42. data/lib/plaid/models/asset_report_audit_copy_remove_request.rb +2 -2
  43. data/lib/plaid/models/asset_report_audit_copy_remove_response.rb +2 -2
  44. data/lib/plaid/models/asset_report_create_request.rb +2 -2
  45. data/lib/plaid/models/asset_report_create_request_options.rb +2 -2
  46. data/lib/plaid/models/asset_report_create_response.rb +2 -2
  47. data/lib/plaid/models/asset_report_filter_request.rb +2 -2
  48. data/lib/plaid/models/asset_report_filter_response.rb +2 -2
  49. data/lib/plaid/models/asset_report_get_request.rb +2 -2
  50. data/lib/plaid/models/asset_report_get_response.rb +2 -2
  51. data/lib/plaid/models/asset_report_item.rb +2 -2
  52. data/lib/plaid/models/asset_report_pdf_get_request.rb +2 -2
  53. data/lib/plaid/models/asset_report_refresh_request.rb +2 -2
  54. data/lib/plaid/models/asset_report_refresh_request_options.rb +2 -2
  55. data/lib/plaid/models/asset_report_refresh_response.rb +2 -2
  56. data/lib/plaid/models/asset_report_relay_create_request.rb +271 -0
  57. data/lib/plaid/models/asset_report_relay_create_response.rb +240 -0
  58. data/lib/plaid/models/asset_report_relay_get_request.rb +245 -0
  59. data/lib/plaid/models/{income_verification_paystub_get_request.rb → asset_report_relay_refresh_request.rb} +26 -23
  60. data/lib/plaid/models/asset_report_relay_refresh_response.rb +254 -0
  61. data/lib/plaid/models/asset_report_relay_remove_request.rb +245 -0
  62. data/lib/plaid/models/{income_verification_paystub_get_response.rb → asset_report_relay_remove_response.rb} +17 -25
  63. data/lib/plaid/models/asset_report_remove_request.rb +2 -2
  64. data/lib/plaid/models/asset_report_remove_response.rb +2 -2
  65. data/lib/plaid/models/asset_report_transaction.rb +4 -4
  66. data/lib/plaid/models/asset_report_transaction_all_of.rb +2 -2
  67. data/lib/plaid/models/asset_report_user.rb +2 -2
  68. data/lib/plaid/models/assets_error_webhook.rb +2 -2
  69. data/lib/plaid/models/assets_product_ready_webhook.rb +2 -2
  70. data/lib/plaid/models/assets_relay_webhook.rb +299 -0
  71. data/lib/plaid/models/auth_get_numbers.rb +2 -2
  72. data/lib/plaid/models/auth_get_request.rb +2 -2
  73. data/lib/plaid/models/auth_get_request_options.rb +2 -2
  74. data/lib/plaid/models/auth_get_response.rb +2 -2
  75. data/lib/plaid/models/auth_metadata.rb +2 -2
  76. data/lib/plaid/models/auth_supported_methods.rb +2 -2
  77. data/lib/plaid/models/automatically_verified_webhook.rb +2 -2
  78. data/lib/plaid/models/bank_initiated_return_risk.rb +2 -2
  79. data/lib/plaid/models/bank_transfer.rb +2 -2
  80. data/lib/plaid/models/bank_transfer_balance.rb +2 -2
  81. data/lib/plaid/models/bank_transfer_balance_get_request.rb +2 -2
  82. data/lib/plaid/models/bank_transfer_balance_get_response.rb +2 -2
  83. data/lib/plaid/models/bank_transfer_cancel_request.rb +2 -2
  84. data/lib/plaid/models/bank_transfer_cancel_response.rb +2 -2
  85. data/lib/plaid/models/bank_transfer_create_request.rb +2 -2
  86. data/lib/plaid/models/bank_transfer_create_response.rb +2 -2
  87. data/lib/plaid/models/bank_transfer_direction.rb +2 -2
  88. data/lib/plaid/models/bank_transfer_event.rb +2 -2
  89. data/lib/plaid/models/bank_transfer_event_list_bank_transfer_type.rb +40 -0
  90. data/lib/plaid/models/bank_transfer_event_list_direction.rb +40 -0
  91. data/lib/plaid/models/bank_transfer_event_list_request.rb +4 -52
  92. data/lib/plaid/models/bank_transfer_event_list_response.rb +2 -2
  93. data/lib/plaid/models/bank_transfer_event_sync_request.rb +2 -2
  94. data/lib/plaid/models/bank_transfer_event_sync_response.rb +2 -2
  95. data/lib/plaid/models/bank_transfer_event_type.rb +2 -2
  96. data/lib/plaid/models/bank_transfer_failure.rb +2 -2
  97. data/lib/plaid/models/bank_transfer_get_request.rb +2 -2
  98. data/lib/plaid/models/bank_transfer_get_response.rb +2 -2
  99. data/lib/plaid/models/bank_transfer_list_request.rb +2 -2
  100. data/lib/plaid/models/bank_transfer_list_response.rb +2 -2
  101. data/lib/plaid/models/bank_transfer_migrate_account_request.rb +13 -3
  102. data/lib/plaid/models/bank_transfer_migrate_account_response.rb +2 -2
  103. data/lib/plaid/models/bank_transfer_network.rb +2 -2
  104. data/lib/plaid/models/bank_transfer_status.rb +2 -2
  105. data/lib/plaid/models/bank_transfer_sweep.rb +2 -2
  106. data/lib/plaid/models/bank_transfer_sweep_get_request.rb +2 -2
  107. data/lib/plaid/models/bank_transfer_sweep_get_response.rb +2 -2
  108. data/lib/plaid/models/bank_transfer_sweep_list_request.rb +2 -2
  109. data/lib/plaid/models/bank_transfer_sweep_list_response.rb +2 -2
  110. data/lib/plaid/models/bank_transfer_type.rb +2 -2
  111. data/lib/plaid/models/bank_transfer_user.rb +2 -2
  112. data/lib/plaid/models/bank_transfers_events_update_webhook.rb +2 -2
  113. data/lib/plaid/models/categories_get_response.rb +2 -2
  114. data/lib/plaid/models/category.rb +2 -2
  115. data/lib/plaid/models/cause.rb +156 -19
  116. data/lib/plaid/models/cause_all_of.rb +219 -0
  117. data/lib/plaid/models/client_provided_enhanced_transaction.rb +284 -0
  118. data/lib/plaid/models/client_provided_raw_transaction.rb +270 -0
  119. data/lib/plaid/models/connected_application.rb +7 -81
  120. data/lib/plaid/models/country_code.rb +3 -2
  121. data/lib/plaid/models/credit_account_subtype.rb +2 -2
  122. data/lib/plaid/models/credit_bank_income.rb +273 -0
  123. data/lib/plaid/models/credit_bank_income_account.rb +281 -0
  124. data/lib/plaid/models/credit_bank_income_account_type.rb +38 -0
  125. data/lib/plaid/models/credit_bank_income_category.rb +48 -0
  126. data/lib/plaid/models/credit_bank_income_cause.rb +259 -0
  127. data/lib/plaid/models/credit_bank_income_error_type.rb +53 -0
  128. data/lib/plaid/models/credit_bank_income_get_request.rb +249 -0
  129. data/lib/plaid/models/credit_bank_income_get_request_options.rb +222 -0
  130. data/lib/plaid/models/credit_bank_income_get_response.rb +236 -0
  131. data/lib/plaid/models/credit_bank_income_historical_summary.rb +273 -0
  132. data/lib/plaid/models/credit_bank_income_item.rb +274 -0
  133. data/lib/plaid/models/credit_bank_income_pay_frequency.rb +42 -0
  134. data/lib/plaid/models/credit_bank_income_source.rb +309 -0
  135. data/lib/plaid/models/credit_bank_income_summary.rb +303 -0
  136. data/lib/plaid/models/credit_bank_income_transaction.rb +304 -0
  137. data/lib/plaid/models/credit_bank_income_warning.rb +237 -0
  138. data/lib/plaid/models/credit_bank_income_warning_code.rb +41 -0
  139. data/lib/plaid/models/credit_bank_income_warning_type.rb +38 -0
  140. data/lib/plaid/models/credit_card_liability.rb +7 -23
  141. data/lib/plaid/models/credit_document_metadata.rb +258 -0
  142. data/lib/plaid/models/credit_employer_verification.rb +221 -0
  143. data/lib/plaid/models/credit_employment_get_request.rb +245 -0
  144. data/lib/plaid/models/credit_employment_get_response.rb +242 -0
  145. data/lib/plaid/models/credit_employment_verification.rb +282 -0
  146. data/lib/plaid/models/credit_filter.rb +2 -2
  147. data/lib/plaid/models/credit_payroll_income_get_request.rb +240 -0
  148. data/lib/plaid/models/{income_verification_summary_get_response.rb → credit_payroll_income_get_response.rb} +28 -18
  149. data/lib/plaid/models/credit_payroll_income_precheck_request.rb +272 -0
  150. data/lib/plaid/models/credit_payroll_income_precheck_response.rb +239 -0
  151. data/lib/plaid/models/credit_platform_ids.rb +243 -0
  152. data/lib/plaid/models/credit_w2.rb +486 -0
  153. data/lib/plaid/models/customer_initiated_return_risk.rb +2 -2
  154. data/lib/plaid/models/deductions.rb +2 -2
  155. data/lib/plaid/models/deductions_breakdown.rb +2 -2
  156. data/lib/plaid/models/deductions_total.rb +2 -2
  157. data/lib/plaid/models/default_update_webhook.rb +2 -2
  158. data/lib/plaid/models/deposit_switch_address_data.rb +2 -2
  159. data/lib/plaid/models/deposit_switch_alt_create_request.rb +2 -2
  160. data/lib/plaid/models/deposit_switch_alt_create_response.rb +2 -2
  161. data/lib/plaid/models/deposit_switch_create_request.rb +2 -2
  162. data/lib/plaid/models/deposit_switch_create_request_options.rb +2 -2
  163. data/lib/plaid/models/deposit_switch_create_response.rb +2 -2
  164. data/lib/plaid/models/deposit_switch_get_request.rb +2 -2
  165. data/lib/plaid/models/deposit_switch_get_response.rb +2 -2
  166. data/lib/plaid/models/deposit_switch_state_update_webhook.rb +2 -2
  167. data/lib/plaid/models/deposit_switch_target_account.rb +2 -2
  168. data/lib/plaid/models/deposit_switch_target_user.rb +2 -2
  169. data/lib/plaid/models/deposit_switch_token_create_request.rb +2 -2
  170. data/lib/plaid/models/deposit_switch_token_create_response.rb +2 -2
  171. data/lib/plaid/models/depository_account_subtype.rb +2 -2
  172. data/lib/plaid/models/depository_filter.rb +2 -2
  173. data/lib/plaid/models/distribution_breakdown.rb +2 -2
  174. data/lib/plaid/models/doc_type.rb +2 -2
  175. data/lib/plaid/models/document_metadata.rb +2 -2
  176. data/lib/plaid/models/earnings.rb +2 -2
  177. data/lib/plaid/models/earnings_breakdown.rb +2 -2
  178. data/lib/plaid/models/earnings_breakdown_canonical_description.rb +2 -2
  179. data/lib/plaid/models/earnings_total.rb +2 -2
  180. data/lib/plaid/models/email.rb +2 -2
  181. data/lib/plaid/models/employee.rb +2 -2
  182. data/lib/plaid/models/employee_income_summary_field_string.rb +2 -2
  183. data/lib/plaid/models/employer.rb +2 -2
  184. data/lib/plaid/models/employer_income_summary_field_string.rb +2 -2
  185. data/lib/plaid/models/employer_verification.rb +2 -2
  186. data/lib/plaid/models/employers_search_request.rb +2 -2
  187. data/lib/plaid/models/employers_search_response.rb +2 -2
  188. data/lib/plaid/models/employment_details.rb +2 -2
  189. data/lib/plaid/models/employment_verification.rb +2 -2
  190. data/lib/plaid/models/employment_verification_get_request.rb +2 -2
  191. data/lib/plaid/models/employment_verification_get_response.rb +2 -2
  192. data/lib/plaid/models/employment_verification_status.rb +2 -2
  193. data/lib/plaid/models/enhancements.rb +298 -0
  194. data/lib/plaid/models/error.rb +2 -2
  195. data/lib/plaid/models/external_payment_initiation_consent_options.rb +249 -0
  196. data/lib/plaid/models/external_payment_options.rb +2 -2
  197. data/lib/plaid/models/external_payment_refund_details.rb +2 -2
  198. data/lib/plaid/models/external_payment_schedule_base.rb +2 -2
  199. data/lib/plaid/models/external_payment_schedule_get.rb +2 -2
  200. data/lib/plaid/models/external_payment_schedule_request.rb +2 -2
  201. data/lib/plaid/models/health_incident.rb +2 -2
  202. data/lib/plaid/models/historical_balance.rb +2 -2
  203. data/lib/plaid/models/historical_update_webhook.rb +2 -2
  204. data/lib/plaid/models/holding.rb +2 -2
  205. data/lib/plaid/models/holdings_default_update_webhook.rb +2 -2
  206. data/lib/plaid/models/holdings_override.rb +2 -2
  207. data/lib/plaid/models/identity_default_update_webhook.rb +286 -0
  208. data/lib/plaid/models/identity_get_request.rb +2 -2
  209. data/lib/plaid/models/identity_get_request_options.rb +2 -2
  210. data/lib/plaid/models/identity_get_response.rb +2 -2
  211. data/lib/plaid/models/identity_update_types.rb +41 -0
  212. data/lib/plaid/models/incident_update.rb +2 -2
  213. data/lib/plaid/models/income_breakdown.rb +2 -2
  214. data/lib/plaid/models/income_breakdown_type.rb +2 -2
  215. data/lib/plaid/models/income_override.rb +2 -2
  216. data/lib/plaid/models/income_summary.rb +2 -2
  217. data/lib/plaid/models/income_summary_field_number.rb +2 -2
  218. data/lib/plaid/models/income_summary_field_string.rb +2 -2
  219. data/lib/plaid/models/income_verification_create_request.rb +2 -2
  220. data/lib/plaid/models/income_verification_create_request_options.rb +2 -2
  221. data/lib/plaid/models/income_verification_create_response.rb +2 -2
  222. data/lib/plaid/models/income_verification_documents_download_request.rb +2 -2
  223. data/lib/plaid/models/income_verification_payroll_flow_type.rb +39 -0
  224. data/lib/plaid/models/income_verification_paystubs_get_request.rb +2 -2
  225. data/lib/plaid/models/income_verification_paystubs_get_response.rb +2 -2
  226. data/lib/plaid/models/income_verification_precheck_confidence.rb +2 -2
  227. data/lib/plaid/models/income_verification_precheck_employer.rb +2 -2
  228. data/lib/plaid/models/income_verification_precheck_employer_address.rb +26 -26
  229. data/lib/plaid/models/income_verification_precheck_employer_address_data.rb +26 -26
  230. data/lib/plaid/models/income_verification_precheck_military_info.rb +3 -37
  231. data/lib/plaid/models/income_verification_precheck_request.rb +2 -2
  232. data/lib/plaid/models/income_verification_precheck_response.rb +2 -2
  233. data/lib/plaid/models/income_verification_precheck_user.rb +2 -2
  234. data/lib/plaid/models/income_verification_refresh_request.rb +2 -2
  235. data/lib/plaid/models/income_verification_refresh_response.rb +2 -2
  236. data/lib/plaid/models/income_verification_source_type.rb +39 -0
  237. data/lib/plaid/models/income_verification_status_webhook.rb +4 -19
  238. data/lib/plaid/models/income_verification_taxforms_get_request.rb +2 -2
  239. data/lib/plaid/models/income_verification_taxforms_get_response.rb +2 -2
  240. data/lib/plaid/models/income_verification_webhook_status.rb +2 -2
  241. data/lib/plaid/models/inflow_model.rb +3 -3
  242. data/lib/plaid/models/initial_update_webhook.rb +2 -2
  243. data/lib/plaid/models/institution.rb +4 -4
  244. data/lib/plaid/models/institution_status.rb +2 -2
  245. data/lib/plaid/models/institutions_get_by_id_request.rb +2 -2
  246. data/lib/plaid/models/institutions_get_by_id_request_options.rb +2 -2
  247. data/lib/plaid/models/institutions_get_by_id_response.rb +2 -2
  248. data/lib/plaid/models/institutions_get_request.rb +3 -3
  249. data/lib/plaid/models/institutions_get_request_options.rb +3 -3
  250. data/lib/plaid/models/institutions_get_response.rb +2 -2
  251. data/lib/plaid/models/institutions_search_account_filter.rb +2 -2
  252. data/lib/plaid/models/institutions_search_payment_initiation_options.rb +18 -7
  253. data/lib/plaid/models/institutions_search_request.rb +2 -2
  254. data/lib/plaid/models/institutions_search_request_options.rb +3 -3
  255. data/lib/plaid/models/institutions_search_response.rb +2 -2
  256. data/lib/plaid/models/investment_account_subtype.rb +3 -3
  257. data/lib/plaid/models/investment_filter.rb +3 -3
  258. data/lib/plaid/models/investment_holdings_get_request_options.rb +2 -2
  259. data/lib/plaid/models/investment_transaction.rb +4 -52
  260. data/lib/plaid/models/investment_transaction_subtype.rb +82 -0
  261. data/lib/plaid/models/investment_transaction_type.rb +43 -0
  262. data/lib/plaid/models/investments_default_update_webhook.rb +2 -2
  263. data/lib/plaid/models/investments_holdings_get_request.rb +2 -2
  264. data/lib/plaid/models/investments_holdings_get_response.rb +2 -2
  265. data/lib/plaid/models/investments_transactions_get_request.rb +2 -2
  266. data/lib/plaid/models/investments_transactions_get_request_options.rb +2 -2
  267. data/lib/plaid/models/investments_transactions_get_response.rb +2 -2
  268. data/lib/plaid/models/investments_transactions_override.rb +2 -2
  269. data/lib/plaid/models/item.rb +15 -3
  270. data/lib/plaid/models/item_access_token_invalidate_request.rb +2 -2
  271. data/lib/plaid/models/item_access_token_invalidate_response.rb +2 -2
  272. data/lib/plaid/models/item_application_list_request.rb +2 -2
  273. data/lib/plaid/models/item_application_list_response.rb +2 -2
  274. data/lib/plaid/models/item_application_list_user_auth.rb +2 -2
  275. data/lib/plaid/models/item_application_scopes_update_request.rb +2 -2
  276. data/lib/plaid/models/item_application_scopes_update_response.rb +2 -2
  277. data/lib/plaid/models/item_error_webhook.rb +2 -2
  278. data/lib/plaid/models/item_get_request.rb +2 -2
  279. data/lib/plaid/models/item_get_response.rb +2 -2
  280. data/lib/plaid/models/item_import_request.rb +2 -2
  281. data/lib/plaid/models/item_import_request_options.rb +2 -2
  282. data/lib/plaid/models/item_import_request_user_auth.rb +2 -2
  283. data/lib/plaid/models/item_import_response.rb +2 -2
  284. data/lib/plaid/models/item_product_ready_webhook.rb +2 -2
  285. data/lib/plaid/models/item_public_token_create_request.rb +2 -2
  286. data/lib/plaid/models/item_public_token_create_response.rb +2 -2
  287. data/lib/plaid/models/item_public_token_exchange_request.rb +2 -2
  288. data/lib/plaid/models/item_public_token_exchange_response.rb +2 -2
  289. data/lib/plaid/models/item_remove_request.rb +2 -2
  290. data/lib/plaid/models/item_remove_response.rb +2 -2
  291. data/lib/plaid/models/item_status.rb +2 -2
  292. data/lib/plaid/models/item_status_investments.rb +2 -2
  293. data/lib/plaid/models/item_status_last_webhook.rb +2 -2
  294. data/lib/plaid/models/item_status_nullable.rb +2 -2
  295. data/lib/plaid/models/item_status_transactions.rb +2 -2
  296. data/lib/plaid/models/item_webhook_update_request.rb +3 -3
  297. data/lib/plaid/models/item_webhook_update_response.rb +2 -2
  298. data/lib/plaid/models/jwk_public_key.rb +2 -2
  299. data/lib/plaid/models/jwt_header.rb +2 -2
  300. data/lib/plaid/models/liabilities_default_update_webhook.rb +2 -2
  301. data/lib/plaid/models/liabilities_get_request.rb +2 -2
  302. data/lib/plaid/models/liabilities_get_request_options.rb +2 -2
  303. data/lib/plaid/models/liabilities_get_response.rb +2 -2
  304. data/lib/plaid/models/liabilities_object.rb +2 -2
  305. data/lib/plaid/models/liability_override.rb +2 -2
  306. data/lib/plaid/models/link_token_account_filters.rb +2 -2
  307. data/lib/plaid/models/link_token_create_credit_filter.rb +2 -2
  308. data/lib/plaid/models/link_token_create_depository_filter.rb +2 -2
  309. data/lib/plaid/models/link_token_create_investment_filter.rb +2 -2
  310. data/lib/plaid/models/link_token_create_loan_filter.rb +2 -2
  311. data/lib/plaid/models/link_token_create_request.rb +17 -7
  312. data/lib/plaid/models/link_token_create_request_account_subtypes.rb +2 -2
  313. data/lib/plaid/models/link_token_create_request_auth.rb +2 -2
  314. data/lib/plaid/models/link_token_create_request_deposit_switch.rb +2 -2
  315. data/lib/plaid/models/link_token_create_request_income_verification.rb +36 -6
  316. data/lib/plaid/models/link_token_create_request_income_verification_bank_income.rb +220 -0
  317. data/lib/plaid/models/link_token_create_request_income_verification_payroll_income.rb +223 -0
  318. data/lib/plaid/models/link_token_create_request_payment_initiation.rb +2 -2
  319. data/lib/plaid/models/link_token_create_request_transfer.rb +2 -2
  320. data/lib/plaid/models/link_token_create_request_update.rb +2 -2
  321. data/lib/plaid/models/link_token_create_request_user.rb +2 -2
  322. data/lib/plaid/models/link_token_create_response.rb +2 -2
  323. data/lib/plaid/models/link_token_eu_config.rb +2 -2
  324. data/lib/plaid/models/link_token_get_metadata_response.rb +2 -2
  325. data/lib/plaid/models/link_token_get_request.rb +2 -2
  326. data/lib/plaid/models/link_token_get_response.rb +2 -2
  327. data/lib/plaid/models/loan_account_subtype.rb +2 -2
  328. data/lib/plaid/models/loan_filter.rb +2 -2
  329. data/lib/plaid/models/location.rb +2 -2
  330. data/lib/plaid/models/meta.rb +2 -2
  331. data/lib/plaid/models/mfa.rb +2 -2
  332. data/lib/plaid/models/mortgage_interest_rate.rb +2 -2
  333. data/lib/plaid/models/mortgage_liability.rb +2 -2
  334. data/lib/plaid/models/mortgage_property_address.rb +2 -2
  335. data/lib/plaid/models/net_pay.rb +2 -2
  336. data/lib/plaid/models/new_accounts_available_webhook.rb +2 -2
  337. data/lib/plaid/models/numbers.rb +2 -2
  338. data/lib/plaid/models/numbers_ach.rb +2 -2
  339. data/lib/plaid/models/numbers_ach_nullable.rb +2 -2
  340. data/lib/plaid/models/numbers_bacs.rb +2 -2
  341. data/lib/plaid/models/numbers_bacs_nullable.rb +2 -2
  342. data/lib/plaid/models/numbers_eft.rb +2 -2
  343. data/lib/plaid/models/numbers_eft_nullable.rb +2 -2
  344. data/lib/plaid/models/numbers_international.rb +2 -2
  345. data/lib/plaid/models/numbers_international_nullable.rb +2 -2
  346. data/lib/plaid/models/override_account_type.rb +2 -2
  347. data/lib/plaid/models/override_accounts.rb +2 -2
  348. data/lib/plaid/models/owner.rb +2 -2
  349. data/lib/plaid/models/owner_override.rb +2 -2
  350. data/lib/plaid/models/pay.rb +2 -2
  351. data/lib/plaid/models/pay_frequency.rb +2 -2
  352. data/lib/plaid/models/pay_frequency_value.rb +2 -2
  353. data/lib/plaid/models/pay_period_details.rb +2 -2
  354. data/lib/plaid/models/pay_stub.rb +329 -0
  355. data/lib/plaid/models/pay_stub_address.rb +265 -0
  356. data/lib/plaid/models/pay_stub_deductions.rb +240 -0
  357. data/lib/plaid/models/pay_stub_deductions_breakdown.rb +265 -0
  358. data/lib/plaid/models/pay_stub_deductions_total.rb +254 -0
  359. data/lib/plaid/models/pay_stub_distribution_breakdown.rb +287 -0
  360. data/lib/plaid/models/{requested_scopes.rb → pay_stub_earnings.rb} +29 -22
  361. data/lib/plaid/models/pay_stub_earnings_breakdown.rb +298 -0
  362. data/lib/plaid/models/pay_stub_earnings_total.rb +265 -0
  363. data/lib/plaid/models/pay_stub_employee.rb +260 -0
  364. data/lib/plaid/models/pay_stub_employer.rb +235 -0
  365. data/lib/plaid/models/pay_stub_net_pay.rb +265 -0
  366. data/lib/plaid/models/pay_stub_pay_period_details.rb +314 -0
  367. data/lib/plaid/models/pay_stub_taxpayer_id.rb +232 -0
  368. data/lib/plaid/models/pay_stub_verification.rb +237 -0
  369. data/lib/plaid/models/pay_stub_verification_attribute.rb +221 -0
  370. data/lib/plaid/models/payment_amount.rb +3 -49
  371. data/lib/plaid/models/payment_amount_currency.rb +39 -0
  372. data/lib/plaid/models/payment_channel.rb +40 -0
  373. data/lib/plaid/models/payment_consent_max_payment_amount.rb +246 -0
  374. data/lib/plaid/models/payment_consent_periodic_alignment.rb +39 -0
  375. data/lib/plaid/models/payment_consent_periodic_amount.rb +247 -0
  376. data/lib/plaid/models/payment_consent_periodic_amount_amount.rb +246 -0
  377. data/lib/plaid/models/payment_consent_periodic_interval.rb +41 -0
  378. data/lib/plaid/models/payment_consent_valid_date_time.rb +232 -0
  379. data/lib/plaid/models/payment_initiation_address.rb +2 -2
  380. data/lib/plaid/models/payment_initiation_consent.rb +357 -0
  381. data/lib/plaid/models/payment_initiation_consent_constraints.rb +241 -0
  382. data/lib/plaid/models/payment_initiation_consent_create_request.rb +373 -0
  383. data/lib/plaid/models/payment_initiation_consent_create_response.rb +254 -0
  384. data/lib/plaid/models/payment_initiation_consent_get_request.rb +266 -0
  385. data/lib/plaid/models/payment_initiation_consent_get_response.rb +380 -0
  386. data/lib/plaid/models/payment_initiation_consent_payment_execute_request.rb +325 -0
  387. data/lib/plaid/models/payment_initiation_consent_payment_execute_response.rb +254 -0
  388. data/lib/plaid/models/payment_initiation_consent_revoke_request.rb +266 -0
  389. data/lib/plaid/models/payment_initiation_consent_revoke_response.rb +220 -0
  390. data/lib/plaid/models/payment_initiation_consent_scope.rb +39 -0
  391. data/lib/plaid/models/payment_initiation_consent_status.rb +42 -0
  392. data/lib/plaid/models/payment_initiation_metadata.rb +2 -2
  393. data/lib/plaid/models/payment_initiation_optional_restriction_bacs.rb +2 -2
  394. data/lib/plaid/models/payment_initiation_payment.rb +17 -7
  395. data/lib/plaid/models/payment_initiation_payment_create_request.rb +2 -2
  396. data/lib/plaid/models/payment_initiation_payment_create_response.rb +3 -38
  397. data/lib/plaid/models/payment_initiation_payment_create_status.rb +38 -0
  398. data/lib/plaid/models/payment_initiation_payment_get_request.rb +2 -2
  399. data/lib/plaid/models/payment_initiation_payment_get_response.rb +13 -3
  400. data/lib/plaid/models/payment_initiation_payment_list_request.rb +2 -2
  401. data/lib/plaid/models/payment_initiation_payment_list_response.rb +2 -2
  402. data/lib/plaid/models/payment_initiation_payment_reverse_request.rb +2 -2
  403. data/lib/plaid/models/payment_initiation_payment_reverse_response.rb +3 -38
  404. data/lib/plaid/models/payment_initiation_payment_status.rb +2 -2
  405. data/lib/plaid/models/payment_initiation_payment_token_create_request.rb +2 -2
  406. data/lib/plaid/models/payment_initiation_payment_token_create_response.rb +2 -2
  407. data/lib/plaid/models/payment_initiation_recipient.rb +2 -2
  408. data/lib/plaid/models/payment_initiation_recipient_create_request.rb +2 -2
  409. data/lib/plaid/models/payment_initiation_recipient_create_response.rb +2 -2
  410. data/lib/plaid/models/payment_initiation_recipient_get_request.rb +2 -2
  411. data/lib/plaid/models/payment_initiation_recipient_get_response.rb +2 -2
  412. data/lib/plaid/models/payment_initiation_recipient_get_response_all_of.rb +2 -2
  413. data/lib/plaid/models/payment_initiation_recipient_list_request.rb +2 -2
  414. data/lib/plaid/models/payment_initiation_recipient_list_response.rb +2 -2
  415. data/lib/plaid/models/payment_initiation_refund.rb +3 -38
  416. data/lib/plaid/models/payment_initiation_refund_status.rb +41 -0
  417. data/lib/plaid/models/payment_initiation_standing_order_metadata.rb +2 -2
  418. data/lib/plaid/models/payment_meta.rb +2 -2
  419. data/lib/plaid/models/payment_schedule_interval.rb +2 -2
  420. data/lib/plaid/models/payment_scheme.rb +2 -2
  421. data/lib/plaid/models/payment_status_update_webhook.rb +2 -2
  422. data/lib/plaid/models/payroll_income_object.rb +255 -0
  423. data/lib/plaid/models/payroll_item.rb +241 -0
  424. data/lib/plaid/models/paystub.rb +2 -2
  425. data/lib/plaid/models/paystub_address.rb +2 -2
  426. data/lib/plaid/models/paystub_deduction.rb +2 -2
  427. data/lib/plaid/models/paystub_details.rb +2 -2
  428. data/lib/plaid/models/paystub_employer.rb +2 -2
  429. data/lib/plaid/models/paystub_override.rb +2 -2
  430. data/lib/plaid/models/paystub_override_employee.rb +2 -2
  431. data/lib/plaid/models/paystub_override_employee_address.rb +2 -2
  432. data/lib/plaid/models/paystub_override_employer.rb +2 -2
  433. data/lib/plaid/models/paystub_pay_frequency.rb +2 -2
  434. data/lib/plaid/models/paystub_verification.rb +2 -2
  435. data/lib/plaid/models/paystub_verification_status.rb +2 -2
  436. data/lib/plaid/models/paystub_ytd_details.rb +2 -2
  437. data/lib/plaid/models/pending_expiration_webhook.rb +2 -2
  438. data/lib/plaid/models/personal_finance_category.rb +4 -4
  439. data/lib/plaid/models/phone_number.rb +2 -2
  440. data/lib/plaid/models/plaid_error.rb +2 -2
  441. data/lib/plaid/models/platform_ids.rb +2 -2
  442. data/lib/plaid/models/processor_apex_processor_token_create_request.rb +2 -2
  443. data/lib/plaid/models/processor_auth_get_request.rb +2 -2
  444. data/lib/plaid/models/processor_auth_get_response.rb +2 -2
  445. data/lib/plaid/models/processor_balance_get_request.rb +2 -2
  446. data/lib/plaid/models/processor_balance_get_request_options.rb +2 -2
  447. data/lib/plaid/models/processor_balance_get_response.rb +2 -2
  448. data/lib/plaid/models/processor_bank_transfer_create_request.rb +2 -2
  449. data/lib/plaid/models/processor_bank_transfer_create_response.rb +2 -2
  450. data/lib/plaid/models/processor_identity_get_request.rb +2 -2
  451. data/lib/plaid/models/processor_identity_get_response.rb +2 -2
  452. data/lib/plaid/models/processor_number.rb +2 -2
  453. data/lib/plaid/models/processor_stripe_bank_account_token_create_request.rb +2 -2
  454. data/lib/plaid/models/processor_stripe_bank_account_token_create_response.rb +2 -2
  455. data/lib/plaid/models/processor_token_create_request.rb +4 -4
  456. data/lib/plaid/models/processor_token_create_response.rb +2 -2
  457. data/lib/plaid/models/product_access.rb +72 -7
  458. data/lib/plaid/models/product_status.rb +2 -2
  459. data/lib/plaid/models/product_status_breakdown.rb +2 -2
  460. data/lib/plaid/models/products.rb +3 -2
  461. data/lib/plaid/models/projected_income_summary_field_number.rb +2 -2
  462. data/lib/plaid/models/pslf_status.rb +2 -2
  463. data/lib/plaid/models/recaptcha_required_error.rb +2 -2
  464. data/lib/plaid/models/recipient_bacs.rb +3 -3
  465. data/lib/plaid/models/recipient_bacs_nullable.rb +2 -2
  466. data/lib/plaid/models/recurring_transaction_frequency.rb +2 -2
  467. data/lib/plaid/models/relay_event.rb +40 -0
  468. data/lib/plaid/models/removed_transaction.rb +2 -2
  469. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_request.rb +2 -2
  470. data/lib/plaid/models/sandbox_bank_transfer_fire_webhook_response.rb +2 -2
  471. data/lib/plaid/models/sandbox_bank_transfer_simulate_request.rb +2 -2
  472. data/lib/plaid/models/sandbox_bank_transfer_simulate_response.rb +2 -2
  473. data/lib/plaid/models/sandbox_income_fire_webhook_request.rb +3 -18
  474. data/lib/plaid/models/sandbox_income_fire_webhook_response.rb +2 -2
  475. data/lib/plaid/models/sandbox_item_fire_webhook_request.rb +15 -6
  476. data/lib/plaid/models/sandbox_item_fire_webhook_response.rb +2 -2
  477. data/lib/plaid/models/sandbox_item_reset_login_request.rb +2 -2
  478. data/lib/plaid/models/sandbox_item_reset_login_response.rb +2 -2
  479. data/lib/plaid/models/sandbox_item_set_verification_status_request.rb +2 -2
  480. data/lib/plaid/models/sandbox_item_set_verification_status_response.rb +2 -2
  481. data/lib/plaid/models/sandbox_oauth_select_accounts_request.rb +2 -2
  482. data/lib/plaid/models/sandbox_processor_token_create_request.rb +2 -2
  483. data/lib/plaid/models/sandbox_processor_token_create_request_options.rb +2 -2
  484. data/lib/plaid/models/sandbox_processor_token_create_response.rb +2 -2
  485. data/lib/plaid/models/sandbox_public_token_create_request.rb +2 -2
  486. data/lib/plaid/models/sandbox_public_token_create_request_options.rb +2 -2
  487. data/lib/plaid/models/sandbox_public_token_create_request_options_transactions.rb +2 -2
  488. data/lib/plaid/models/sandbox_public_token_create_response.rb +2 -2
  489. data/lib/plaid/models/sandbox_transfer_fire_webhook_request.rb +245 -0
  490. data/lib/plaid/models/sandbox_transfer_fire_webhook_response.rb +225 -0
  491. data/lib/plaid/models/sandbox_transfer_repayment_simulate_request.rb +2 -2
  492. data/lib/plaid/models/sandbox_transfer_repayment_simulate_response.rb +2 -2
  493. data/lib/plaid/models/sandbox_transfer_simulate_request.rb +2 -2
  494. data/lib/plaid/models/sandbox_transfer_simulate_response.rb +2 -2
  495. data/lib/plaid/models/sandbox_transfer_sweep_simulate_request.rb +2 -2
  496. data/lib/plaid/models/sandbox_transfer_sweep_simulate_response.rb +2 -2
  497. data/lib/plaid/models/scopes.rb +2 -2
  498. data/lib/plaid/models/scopes_context.rb +2 -2
  499. data/lib/plaid/models/scopes_nullable.rb +2 -2
  500. data/lib/plaid/models/security.rb +2 -2
  501. data/lib/plaid/models/security_override.rb +2 -2
  502. data/lib/plaid/models/sender_bacs_nullable.rb +2 -2
  503. data/lib/plaid/models/servicer_address_data.rb +2 -2
  504. data/lib/plaid/models/signal_address_data.rb +2 -2
  505. data/lib/plaid/models/signal_decision_report_request.rb +2 -2
  506. data/lib/plaid/models/signal_decision_report_response.rb +2 -2
  507. data/lib/plaid/models/signal_device.rb +2 -2
  508. data/lib/plaid/models/signal_evaluate_core_attributes.rb +326 -7
  509. data/lib/plaid/models/signal_evaluate_request.rb +2 -2
  510. data/lib/plaid/models/signal_evaluate_response.rb +2 -2
  511. data/lib/plaid/models/signal_person_name.rb +2 -2
  512. data/lib/plaid/models/signal_return_report_request.rb +2 -2
  513. data/lib/plaid/models/signal_return_report_response.rb +2 -2
  514. data/lib/plaid/models/signal_scores.rb +2 -2
  515. data/lib/plaid/models/signal_user.rb +2 -2
  516. data/lib/plaid/models/simulated_transfer_sweep.rb +2 -2
  517. data/lib/plaid/models/standalone_account_type.rb +2 -2
  518. data/lib/plaid/models/standalone_currency_code_list.rb +2 -2
  519. data/lib/plaid/models/standalone_investment_transaction_type.rb +2 -2
  520. data/lib/plaid/models/student_loan.rb +2 -2
  521. data/lib/plaid/models/student_loan_repayment_model.rb +2 -2
  522. data/lib/plaid/models/student_loan_status.rb +2 -2
  523. data/lib/plaid/models/student_repayment_plan.rb +2 -2
  524. data/lib/plaid/models/taxform.rb +2 -2
  525. data/lib/plaid/models/taxpayer_id.rb +2 -2
  526. data/lib/plaid/models/total.rb +2 -2
  527. data/lib/plaid/models/total_canonical_description.rb +2 -2
  528. data/lib/plaid/models/transaction.rb +4 -4
  529. data/lib/plaid/models/transaction_all_of.rb +2 -2
  530. data/lib/plaid/models/transaction_base.rb +4 -4
  531. data/lib/plaid/models/transaction_code.rb +2 -2
  532. data/lib/plaid/models/transaction_data.rb +2 -2
  533. data/lib/plaid/models/transaction_override.rb +3 -3
  534. data/lib/plaid/models/transaction_stream.rb +50 -7
  535. data/lib/plaid/models/transaction_stream_amount.rb +3 -3
  536. data/lib/plaid/models/transaction_stream_status.rb +41 -0
  537. data/lib/plaid/models/transactions_category_rule.rb +259 -0
  538. data/lib/plaid/models/transactions_enhance_get_request.rb +262 -0
  539. data/lib/plaid/models/transactions_enhance_get_response.rb +227 -0
  540. data/lib/plaid/models/transactions_get_request.rb +2 -2
  541. data/lib/plaid/models/transactions_get_request_options.rb +19 -7
  542. data/lib/plaid/models/transactions_get_response.rb +2 -2
  543. data/lib/plaid/models/transactions_recurring_get_request.rb +2 -2
  544. data/lib/plaid/models/transactions_recurring_get_response.rb +18 -3
  545. data/lib/plaid/models/transactions_refresh_request.rb +2 -2
  546. data/lib/plaid/models/transactions_refresh_response.rb +2 -2
  547. data/lib/plaid/models/transactions_removed_webhook.rb +2 -2
  548. data/lib/plaid/models/transactions_rule_details.rb +253 -0
  549. data/lib/plaid/models/transactions_rule_field.rb +39 -0
  550. data/lib/plaid/models/transactions_rule_type.rb +39 -0
  551. data/lib/plaid/models/transactions_rules_create_request.rb +284 -0
  552. data/lib/plaid/models/transactions_rules_create_response.rb +239 -0
  553. data/lib/plaid/models/{income_verification_summary_get_request.rb → transactions_rules_list_request.rb} +35 -32
  554. data/lib/plaid/models/transactions_rules_list_response.rb +242 -0
  555. data/lib/plaid/models/transactions_rules_remove_request.rb +270 -0
  556. data/lib/plaid/models/transactions_rules_remove_response.rb +225 -0
  557. data/lib/plaid/models/transactions_sync_request.rb +2 -2
  558. data/lib/plaid/models/transactions_sync_response.rb +2 -2
  559. data/lib/plaid/models/transfer.rb +2 -2
  560. data/lib/plaid/models/transfer_authorization.rb +3 -38
  561. data/lib/plaid/models/transfer_authorization_create_request.rb +2 -2
  562. data/lib/plaid/models/transfer_authorization_create_response.rb +2 -2
  563. data/lib/plaid/models/transfer_authorization_decision.rb +39 -0
  564. data/lib/plaid/models/transfer_authorization_decision_rationale.rb +5 -40
  565. data/lib/plaid/models/transfer_authorization_decision_rationale_code.rb +42 -0
  566. data/lib/plaid/models/transfer_authorization_device.rb +2 -2
  567. data/lib/plaid/models/transfer_authorization_guarantee_decision.rb +2 -2
  568. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale.rb +3 -38
  569. data/lib/plaid/models/transfer_authorization_guarantee_decision_rationale_code.rb +41 -0
  570. data/lib/plaid/models/transfer_authorization_proposed_transfer.rb +2 -2
  571. data/lib/plaid/models/transfer_cancel_request.rb +2 -2
  572. data/lib/plaid/models/transfer_cancel_response.rb +2 -2
  573. data/lib/plaid/models/transfer_create_request.rb +2 -2
  574. data/lib/plaid/models/transfer_create_response.rb +2 -2
  575. data/lib/plaid/models/transfer_event.rb +2 -2
  576. data/lib/plaid/models/transfer_event_list_request.rb +3 -38
  577. data/lib/plaid/models/transfer_event_list_response.rb +2 -2
  578. data/lib/plaid/models/transfer_event_list_transfer_type.rb +40 -0
  579. data/lib/plaid/models/transfer_event_sync_request.rb +2 -2
  580. data/lib/plaid/models/transfer_event_sync_response.rb +2 -2
  581. data/lib/plaid/models/transfer_event_type.rb +2 -2
  582. data/lib/plaid/models/transfer_failure.rb +2 -2
  583. data/lib/plaid/models/transfer_get_request.rb +2 -2
  584. data/lib/plaid/models/transfer_get_response.rb +2 -2
  585. data/lib/plaid/models/transfer_intent_authorization_decision.rb +39 -0
  586. data/lib/plaid/models/transfer_intent_create.rb +3 -38
  587. data/lib/plaid/models/transfer_intent_create_mode.rb +2 -2
  588. data/lib/plaid/models/transfer_intent_create_request.rb +11 -2
  589. data/lib/plaid/models/transfer_intent_create_response.rb +2 -2
  590. data/lib/plaid/models/transfer_intent_get.rb +4 -52
  591. data/lib/plaid/models/transfer_intent_get_failure_reason.rb +2 -2
  592. data/lib/plaid/models/transfer_intent_get_request.rb +2 -2
  593. data/lib/plaid/models/transfer_intent_get_response.rb +2 -2
  594. data/lib/plaid/models/transfer_intent_status.rb +40 -0
  595. data/lib/plaid/models/transfer_list_request.rb +2 -2
  596. data/lib/plaid/models/transfer_list_response.rb +2 -2
  597. data/lib/plaid/models/transfer_migrate_account_request.rb +285 -0
  598. data/lib/plaid/models/transfer_migrate_account_response.rb +255 -0
  599. data/lib/plaid/models/transfer_network.rb +2 -2
  600. data/lib/plaid/models/transfer_repayment.rb +2 -2
  601. data/lib/plaid/models/transfer_repayment_list_request.rb +2 -2
  602. data/lib/plaid/models/transfer_repayment_list_response.rb +2 -2
  603. data/lib/plaid/models/transfer_repayment_return.rb +2 -2
  604. data/lib/plaid/models/transfer_repayment_return_list_request.rb +2 -2
  605. data/lib/plaid/models/transfer_repayment_return_list_response.rb +2 -2
  606. data/lib/plaid/models/transfer_status.rb +2 -2
  607. data/lib/plaid/models/transfer_sweep.rb +2 -2
  608. data/lib/plaid/models/transfer_sweep_get_request.rb +2 -2
  609. data/lib/plaid/models/transfer_sweep_get_response.rb +2 -2
  610. data/lib/plaid/models/transfer_sweep_list_request.rb +2 -2
  611. data/lib/plaid/models/transfer_sweep_list_response.rb +2 -2
  612. data/lib/plaid/models/transfer_sweep_status.rb +2 -2
  613. data/lib/plaid/models/transfer_type.rb +2 -2
  614. data/lib/plaid/models/transfer_user_address_in_request.rb +3 -3
  615. data/lib/plaid/models/transfer_user_address_in_response.rb +3 -3
  616. data/lib/plaid/models/transfer_user_in_request.rb +2 -2
  617. data/lib/plaid/models/transfer_user_in_response.rb +2 -2
  618. data/lib/plaid/models/user_create_request.rb +245 -0
  619. data/lib/plaid/models/user_create_response.rb +254 -0
  620. data/lib/plaid/models/user_custom_password.rb +2 -2
  621. data/lib/plaid/models/user_permission_revoked_webhook.rb +2 -2
  622. data/lib/plaid/models/verification_attribute.rb +2 -2
  623. data/lib/plaid/models/verification_expired_webhook.rb +2 -2
  624. data/lib/plaid/models/verification_refresh_status.rb +2 -2
  625. data/lib/plaid/models/verification_status.rb +2 -2
  626. data/lib/plaid/models/w2.rb +2 -2
  627. data/lib/plaid/models/w2_box12.rb +2 -2
  628. data/lib/plaid/models/w2_state_and_local_wages.rb +2 -2
  629. data/lib/plaid/models/wallet_balance.rb +2 -2
  630. data/lib/plaid/models/wallet_get_request.rb +2 -2
  631. data/lib/plaid/models/wallet_get_response.rb +15 -6
  632. data/lib/plaid/models/wallet_numbers.rb +220 -0
  633. data/lib/plaid/models/wallet_transaction.rb +2 -2
  634. data/lib/plaid/models/wallet_transaction_amount.rb +2 -2
  635. data/lib/plaid/models/wallet_transaction_counterparty.rb +2 -2
  636. data/lib/plaid/models/wallet_transaction_counterparty_bacs.rb +2 -2
  637. data/lib/plaid/models/wallet_transaction_counterparty_numbers.rb +2 -2
  638. data/lib/plaid/models/wallet_transaction_execute_request.rb +2 -2
  639. data/lib/plaid/models/wallet_transaction_execute_response.rb +2 -2
  640. data/lib/plaid/models/wallet_transaction_status.rb +2 -2
  641. data/lib/plaid/models/wallet_transactions_list_request.rb +2 -2
  642. data/lib/plaid/models/wallet_transactions_list_response.rb +2 -2
  643. data/lib/plaid/models/warning.rb +2 -2
  644. data/lib/plaid/models/webhook_type.rb +43 -0
  645. data/lib/plaid/models/webhook_update_acknowledged_webhook.rb +2 -2
  646. data/lib/plaid/models/webhook_verification_key_get_request.rb +2 -2
  647. data/lib/plaid/models/webhook_verification_key_get_response.rb +2 -2
  648. data/lib/plaid/models/ytd_gross_income_summary_field_number.rb +2 -2
  649. data/lib/plaid/models/ytd_net_income_summary_field_number.rb +2 -2
  650. data/lib/plaid/version.rb +3 -3
  651. data/lib/plaid.rb +122 -7
  652. data/plaid.gemspec +2 -2
  653. metadata +122 -8
  654. data/test/test_income_verifications.rb +0 -76
@@ -3,10 +3,10 @@
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.78.2
6
+ The version of the OpenAPI document: 2020-09-14_1.94.0
7
7
 
8
8
  Generated by: https://openapi-generator.tech
9
- OpenAPI Generator version: 5.1.0
9
+ OpenAPI Generator version: 5.1.1
10
10
 
11
11
  =end
12
12
 
@@ -85,7 +85,7 @@ module Plaid
85
85
  end
86
86
 
87
87
  # Retrieve accounts
88
- # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
88
+ # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
89
89
  # @param accounts_get_request [AccountsGetRequest]
90
90
  # @param [Hash] opts the optional parameters
91
91
  # @return [AccountsGetResponse]
@@ -95,7 +95,7 @@ module Plaid
95
95
  end
96
96
 
97
97
  # Retrieve accounts
98
- # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. This endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/webhooks/#item-new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
98
+ # The `/accounts/get` endpoint can be used to retrieve a list of accounts associated with any linked Item. Plaid will only return active bank accounts — that is, accounts that are not closed and are capable of carrying a balance. For items that went through the updated account selection pane, this endpoint only returns accounts that were permissioned by the user when they initially created the Item. If a user creates a new account after the initial link, you can capture this event through the [`NEW_ACCOUNTS_AVAILABLE`](https://plaid.com/docs/api/items/#new_accounts_available) webhook and then use Link's [update mode](https://plaid.com/docs/link/update-mode/) to request that the user share this new account with you. This endpoint retrieves cached information, rather than extracting fresh information from the institution. As a result, balances returned may not be up-to-date; for realtime balance information, use `/accounts/balance/get` instead. Note that some information is nullable.
99
99
  # @param accounts_get_request [AccountsGetRequest]
100
100
  # @param [Hash] opts the optional parameters
101
101
  # @return [Array<(AccountsGetResponse, Integer, Hash)>] AccountsGetResponse data, response status code and response headers
@@ -410,7 +410,7 @@ module Plaid
410
410
  end
411
411
 
412
412
  # Create an Asset Report
413
- # The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#assets-webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
413
+ # The `/asset_report/create` endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the `asset_report_token` return value to the `/asset_report/get` or `/asset_report/pdf/get` endpoints. The Asset Report takes some time to be created and is not available immediately after calling `/asset_report/create`. When the Asset Report is ready to be retrieved using `/asset_report/get` or `/asset_report/pdf/get`, Plaid will fire a `PRODUCT_READY` webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/products/assets/#webhooks). The `/asset_report/create` endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the `/asset_report/refresh` endpoint.
414
414
  # @param asset_report_create_request [AssetReportCreateRequest]
415
415
  # @param [Hash] opts the optional parameters
416
416
  # @return [AssetReportCreateResponse]
@@ -420,7 +420,7 @@ module Plaid
420
420
  end
421
421
 
422
422
  # Create an Asset Report
423
- # The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. When the Asset Report is ready to be retrieved using &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/webhooks/#assets-webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.
423
+ # The &#x60;/asset_report/create&#x60; endpoint initiates the process of creating an Asset Report, which can then be retrieved by passing the &#x60;asset_report_token&#x60; return value to the &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60; endpoints. The Asset Report takes some time to be created and is not available immediately after calling &#x60;/asset_report/create&#x60;. When the Asset Report is ready to be retrieved using &#x60;/asset_report/get&#x60; or &#x60;/asset_report/pdf/get&#x60;, Plaid will fire a &#x60;PRODUCT_READY&#x60; webhook. For full details of the webhook schema, see [Asset Report webhooks](https://plaid.com/docs/api/products/assets/#webhooks). The &#x60;/asset_report/create&#x60; endpoint creates an Asset Report at a moment in time. Asset Reports are immutable. To get an updated Asset Report, use the &#x60;/asset_report/refresh&#x60; endpoint.
424
424
  # @param asset_report_create_request [AssetReportCreateRequest]
425
425
  # @param [Hash] opts the optional parameters
426
426
  # @return [Array<(AssetReportCreateResponse, Integer, Hash)>] AssetReportCreateResponse data, response status code and response headers
@@ -475,7 +475,7 @@ module Plaid
475
475
  end
476
476
 
477
477
  # Filter Asset Report
478
- # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
478
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the `/accounts/get` endpoint. To narrow an Asset Report to only a subset of accounts, use the `/asset_report/filter` endpoint. To exclude certain Accounts from an Asset Report, first use the `/asset_report/create` endpoint to create the report, then send the `asset_report_token` along with a list of `account_ids` to exclude to the `/asset_report/filter` endpoint, to create a new Asset Report which contains only a subset of the original Asset Report's data. Because Asset Reports are immutable, calling `/asset_report/filter` does not alter the original Asset Report in any way; rather, `/asset_report/filter` creates a new Asset Report with a new token and id. Asset Reports created via `/asset_report/filter` do not contain new Asset data, and are not billed. Plaid will fire a [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.
479
479
  # @param asset_report_filter_request [AssetReportFilterRequest]
480
480
  # @param [Hash] opts the optional parameters
481
481
  # @return [AssetReportFilterResponse]
@@ -485,7 +485,7 @@ module Plaid
485
485
  end
486
486
 
487
487
  # Filter Asset Report
488
- # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook once generation of the filtered Asset Report has completed.
488
+ # By default, an Asset Report will contain all of the accounts on a given Item. In some cases, you may not want the Asset Report to contain all accounts. For example, you might have the end user choose which accounts are relevant in Link using the Account Select view, which you can enable in the dashboard. Or, you might always exclude certain account types or subtypes, which you can identify by using the &#x60;/accounts/get&#x60; endpoint. To narrow an Asset Report to only a subset of accounts, use the &#x60;/asset_report/filter&#x60; endpoint. To exclude certain Accounts from an Asset Report, first use the &#x60;/asset_report/create&#x60; endpoint to create the report, then send the &#x60;asset_report_token&#x60; along with a list of &#x60;account_ids&#x60; to exclude to the &#x60;/asset_report/filter&#x60; endpoint, to create a new Asset Report which contains only a subset of the original Asset Report&#39;s data. Because Asset Reports are immutable, calling &#x60;/asset_report/filter&#x60; does not alter the original Asset Report in any way; rather, &#x60;/asset_report/filter&#x60; creates a new Asset Report with a new token and id. Asset Reports created via &#x60;/asset_report/filter&#x60; do not contain new Asset data, and are not billed. Plaid will fire a [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook once generation of the filtered Asset Report has completed.
489
489
  # @param asset_report_filter_request [AssetReportFilterRequest]
490
490
  # @param [Hash] opts the optional parameters
491
491
  # @return [Array<(AssetReportFilterResponse, Integer, Hash)>] AssetReportFilterResponse data, response status code and response headers
@@ -540,7 +540,7 @@ module Plaid
540
540
  end
541
541
 
542
542
  # Retrieve an Asset Report
543
- # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
543
+ # The `/asset_report/get` endpoint retrieves the Asset Report in JSON format. Before calling `/asset_report/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the `/asset_report/get` endpoint with `include_insights` set to `true`.
544
544
  # @param asset_report_get_request [AssetReportGetRequest]
545
545
  # @param [Hash] opts the optional parameters
546
546
  # @return [AssetReportGetResponse]
@@ -550,7 +550,7 @@ module Plaid
550
550
  end
551
551
 
552
552
  # Retrieve an Asset Report
553
- # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;.
553
+ # The &#x60;/asset_report/get&#x60; endpoint retrieves the Asset Report in JSON format. Before calling &#x60;/asset_report/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. By default, an Asset Report includes transaction descriptions as returned by the bank, as opposed to parsed and categorized by Plaid. You can also receive cleaned and categorized transactions, as well as additional insights like merchant name or location information. We call this an Asset Report with Insights. An Asset Report with Insights provides transaction category, location, and merchant information in addition to the transaction strings provided in a standard Asset Report. To retrieve an Asset Report with Insights, call the &#x60;/asset_report/get&#x60; endpoint with &#x60;include_insights&#x60; set to &#x60;true&#x60;.
554
554
  # @param asset_report_get_request [AssetReportGetRequest]
555
555
  # @param [Hash] opts the optional parameters
556
556
  # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
@@ -605,7 +605,7 @@ module Plaid
605
605
  end
606
606
 
607
607
  # Retrieve a PDF Asset Report
608
- # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
608
+ # The `/asset_report/pdf/get` endpoint retrieves the Asset Report in PDF format. Before calling `/asset_report/pdf/get`, you must first create the Asset Report using `/asset_report/create` (or filter an Asset Report using `/asset_report/filter`) and then wait for the [`PRODUCT_READY`](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to `/asset_report/pdf/get` is the PDF binary data. The `request_id` is returned in the `Plaid-Request-ID` header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
609
609
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
610
610
  # @param [Hash] opts the optional parameters
611
611
  # @return [File]
@@ -615,7 +615,7 @@ module Plaid
615
615
  end
616
616
 
617
617
  # Retrieve a PDF Asset Report
618
- # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/webhooks) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
618
+ # The &#x60;/asset_report/pdf/get&#x60; endpoint retrieves the Asset Report in PDF format. Before calling &#x60;/asset_report/pdf/get&#x60;, you must first create the Asset Report using &#x60;/asset_report/create&#x60; (or filter an Asset Report using &#x60;/asset_report/filter&#x60;) and then wait for the [&#x60;PRODUCT_READY&#x60;](https://plaid.com/docs/api/products/assets/#product_ready) webhook to fire, indicating that the Report is ready to be retrieved. The response to &#x60;/asset_report/pdf/get&#x60; is the PDF binary data. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header. [View a sample PDF Asset Report](https://plaid.com/documents/sample-asset-report.pdf).
619
619
  # @param asset_report_pdf_get_request [AssetReportPDFGetRequest]
620
620
  # @param [Hash] opts the optional parameters
621
621
  # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
@@ -734,6 +734,266 @@ module Plaid
734
734
  return data, status_code, headers
735
735
  end
736
736
 
737
+ # Create an `asset_relay_token` to share an Asset Report with a partner client
738
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in `/asset_report/create`. To grant access to an Asset Report to a third party, use the `/asset_report/relay/create` endpoint to create an `asset_relay_token` and then pass that token to the third party who needs access. Each third party has its own `secondary_client_id`, for example `ce5bd328dcd34123456`. You'll need to create a separate `asset_relay_token` for each third party to whom you want to grant access to the Report.
739
+ # @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
740
+ # @param [Hash] opts the optional parameters
741
+ # @return [AssetReportRelayCreateResponse]
742
+ def asset_report_relay_create(asset_report_relay_create_request, opts = {})
743
+ data, _status_code, _headers = asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts)
744
+ data
745
+ end
746
+
747
+ # Create an &#x60;asset_relay_token&#x60; to share an Asset Report with a partner client
748
+ # Plaid can share an Asset Report directly with a participating third party on your behalf. The shared Asset Report is the exact same Asset Report originally created in &#x60;/asset_report/create&#x60;. To grant access to an Asset Report to a third party, use the &#x60;/asset_report/relay/create&#x60; endpoint to create an &#x60;asset_relay_token&#x60; and then pass that token to the third party who needs access. Each third party has its own &#x60;secondary_client_id&#x60;, for example &#x60;ce5bd328dcd34123456&#x60;. You&#39;ll need to create a separate &#x60;asset_relay_token&#x60; for each third party to whom you want to grant access to the Report.
749
+ # @param asset_report_relay_create_request [AssetReportRelayCreateRequest]
750
+ # @param [Hash] opts the optional parameters
751
+ # @return [Array<(AssetReportRelayCreateResponse, Integer, Hash)>] AssetReportRelayCreateResponse data, response status code and response headers
752
+ def asset_report_relay_create_with_http_info(asset_report_relay_create_request, opts = {})
753
+ if @api_client.config.debugging
754
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_create ...'
755
+ end
756
+ # verify the required parameter 'asset_report_relay_create_request' is set
757
+ if @api_client.config.client_side_validation && asset_report_relay_create_request.nil?
758
+ fail ArgumentError, "Missing the required parameter 'asset_report_relay_create_request' when calling PlaidApi.asset_report_relay_create"
759
+ end
760
+ # resource path
761
+ local_var_path = '/asset_report/relay/create'
762
+
763
+ # query parameters
764
+ query_params = opts[:query_params] || {}
765
+
766
+ # header parameters
767
+ header_params = opts[:header_params] || {}
768
+ # HTTP header 'Accept' (if needed)
769
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
770
+ # HTTP header 'Content-Type'
771
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
772
+
773
+ # form parameters
774
+ form_params = opts[:form_params] || {}
775
+
776
+ # http body (model)
777
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_create_request)
778
+
779
+ # return_type
780
+ return_type = opts[:debug_return_type] || 'AssetReportRelayCreateResponse'
781
+
782
+ # auth_names
783
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
784
+
785
+ new_options = opts.merge(
786
+ :operation => :"PlaidApi.asset_report_relay_create",
787
+ :header_params => header_params,
788
+ :query_params => query_params,
789
+ :form_params => form_params,
790
+ :body => post_body,
791
+ :auth_names => auth_names,
792
+ :return_type => return_type
793
+ )
794
+
795
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
796
+ if @api_client.config.debugging
797
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
798
+ end
799
+ return data, status_code, headers
800
+ end
801
+
802
+ # Retrieve an Asset Report that was shared with you
803
+ # `/asset_report/relay/get` allows third parties to get an Asset Report that was shared with them, using an `asset_relay_token` that was created by the report owner.
804
+ # @param asset_report_relay_get_request [AssetReportRelayGetRequest]
805
+ # @param [Hash] opts the optional parameters
806
+ # @return [AssetReportGetResponse]
807
+ def asset_report_relay_get(asset_report_relay_get_request, opts = {})
808
+ data, _status_code, _headers = asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts)
809
+ data
810
+ end
811
+
812
+ # Retrieve an Asset Report that was shared with you
813
+ # &#x60;/asset_report/relay/get&#x60; allows third parties to get an Asset Report that was shared with them, using an &#x60;asset_relay_token&#x60; that was created by the report owner.
814
+ # @param asset_report_relay_get_request [AssetReportRelayGetRequest]
815
+ # @param [Hash] opts the optional parameters
816
+ # @return [Array<(AssetReportGetResponse, Integer, Hash)>] AssetReportGetResponse data, response status code and response headers
817
+ def asset_report_relay_get_with_http_info(asset_report_relay_get_request, opts = {})
818
+ if @api_client.config.debugging
819
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_get ...'
820
+ end
821
+ # verify the required parameter 'asset_report_relay_get_request' is set
822
+ if @api_client.config.client_side_validation && asset_report_relay_get_request.nil?
823
+ fail ArgumentError, "Missing the required parameter 'asset_report_relay_get_request' when calling PlaidApi.asset_report_relay_get"
824
+ end
825
+ # resource path
826
+ local_var_path = '/asset_report/relay/get'
827
+
828
+ # query parameters
829
+ query_params = opts[:query_params] || {}
830
+
831
+ # header parameters
832
+ header_params = opts[:header_params] || {}
833
+ # HTTP header 'Accept' (if needed)
834
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
835
+ # HTTP header 'Content-Type'
836
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
837
+
838
+ # form parameters
839
+ form_params = opts[:form_params] || {}
840
+
841
+ # http body (model)
842
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_get_request)
843
+
844
+ # return_type
845
+ return_type = opts[:debug_return_type] || 'AssetReportGetResponse'
846
+
847
+ # auth_names
848
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
849
+
850
+ new_options = opts.merge(
851
+ :operation => :"PlaidApi.asset_report_relay_get",
852
+ :header_params => header_params,
853
+ :query_params => query_params,
854
+ :form_params => form_params,
855
+ :body => post_body,
856
+ :auth_names => auth_names,
857
+ :return_type => return_type
858
+ )
859
+
860
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
861
+ if @api_client.config.debugging
862
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
863
+ end
864
+ return data, status_code, headers
865
+ end
866
+
867
+ # Refresh a Relay Token's Asset Report
868
+ # The `/asset_report/relay/refresh` endpoint allows third parties to refresh an Asset Report that was relayed to them, using an `asset_relay_token` that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
869
+ # @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
870
+ # @param [Hash] opts the optional parameters
871
+ # @return [AssetReportRelayRefreshResponse]
872
+ def asset_report_relay_refresh(asset_report_relay_refresh_request, opts = {})
873
+ data, _status_code, _headers = asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts)
874
+ data
875
+ end
876
+
877
+ # Refresh a Relay Token&#39;s Asset Report
878
+ # The &#x60;/asset_report/relay/refresh&#x60; endpoint allows third parties to refresh an Asset Report that was relayed to them, using an &#x60;asset_relay_token&#x60; that was created by the report owner. A new Asset Report will be created based on the old one, but with the most recent data available.
879
+ # @param asset_report_relay_refresh_request [AssetReportRelayRefreshRequest]
880
+ # @param [Hash] opts the optional parameters
881
+ # @return [Array<(AssetReportRelayRefreshResponse, Integer, Hash)>] AssetReportRelayRefreshResponse data, response status code and response headers
882
+ def asset_report_relay_refresh_with_http_info(asset_report_relay_refresh_request, opts = {})
883
+ if @api_client.config.debugging
884
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_refresh ...'
885
+ end
886
+ # verify the required parameter 'asset_report_relay_refresh_request' is set
887
+ if @api_client.config.client_side_validation && asset_report_relay_refresh_request.nil?
888
+ fail ArgumentError, "Missing the required parameter 'asset_report_relay_refresh_request' when calling PlaidApi.asset_report_relay_refresh"
889
+ end
890
+ # resource path
891
+ local_var_path = '/asset_report/relay/refresh'
892
+
893
+ # query parameters
894
+ query_params = opts[:query_params] || {}
895
+
896
+ # header parameters
897
+ header_params = opts[:header_params] || {}
898
+ # HTTP header 'Accept' (if needed)
899
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
900
+ # HTTP header 'Content-Type'
901
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
902
+
903
+ # form parameters
904
+ form_params = opts[:form_params] || {}
905
+
906
+ # http body (model)
907
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_refresh_request)
908
+
909
+ # return_type
910
+ return_type = opts[:debug_return_type] || 'AssetReportRelayRefreshResponse'
911
+
912
+ # auth_names
913
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
914
+
915
+ new_options = opts.merge(
916
+ :operation => :"PlaidApi.asset_report_relay_refresh",
917
+ :header_params => header_params,
918
+ :query_params => query_params,
919
+ :form_params => form_params,
920
+ :body => post_body,
921
+ :auth_names => auth_names,
922
+ :return_type => return_type
923
+ )
924
+
925
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
926
+ if @api_client.config.debugging
927
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
928
+ end
929
+ return data, status_code, headers
930
+ end
931
+
932
+ # Remove Asset Report Relay Token
933
+ # The `/asset_report/relay/remove` endpoint allows you to invalidate an `asset_relay_token`, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the `asset_relay_token` gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given `asset_relay_token.
934
+ # @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
935
+ # @param [Hash] opts the optional parameters
936
+ # @return [AssetReportRelayRemoveResponse]
937
+ def asset_report_relay_remove(asset_report_relay_remove_request, opts = {})
938
+ data, _status_code, _headers = asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts)
939
+ data
940
+ end
941
+
942
+ # Remove Asset Report Relay Token
943
+ # The &#x60;/asset_report/relay/remove&#x60; endpoint allows you to invalidate an &#x60;asset_relay_token&#x60;, meaning the third party holding the token will no longer be able to use it to access the Asset Report to which the &#x60;asset_relay_token&#x60; gives access to. The Asset Report, Items associated with it, and other Asset Relay Tokens that provide access to the same Asset Report are not affected and will remain accessible after removing the given &#x60;asset_relay_token.
944
+ # @param asset_report_relay_remove_request [AssetReportRelayRemoveRequest]
945
+ # @param [Hash] opts the optional parameters
946
+ # @return [Array<(AssetReportRelayRemoveResponse, Integer, Hash)>] AssetReportRelayRemoveResponse data, response status code and response headers
947
+ def asset_report_relay_remove_with_http_info(asset_report_relay_remove_request, opts = {})
948
+ if @api_client.config.debugging
949
+ @api_client.config.logger.debug 'Calling API: PlaidApi.asset_report_relay_remove ...'
950
+ end
951
+ # verify the required parameter 'asset_report_relay_remove_request' is set
952
+ if @api_client.config.client_side_validation && asset_report_relay_remove_request.nil?
953
+ fail ArgumentError, "Missing the required parameter 'asset_report_relay_remove_request' when calling PlaidApi.asset_report_relay_remove"
954
+ end
955
+ # resource path
956
+ local_var_path = '/asset_report/relay/remove'
957
+
958
+ # query parameters
959
+ query_params = opts[:query_params] || {}
960
+
961
+ # header parameters
962
+ header_params = opts[:header_params] || {}
963
+ # HTTP header 'Accept' (if needed)
964
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
965
+ # HTTP header 'Content-Type'
966
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
967
+
968
+ # form parameters
969
+ form_params = opts[:form_params] || {}
970
+
971
+ # http body (model)
972
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(asset_report_relay_remove_request)
973
+
974
+ # return_type
975
+ return_type = opts[:debug_return_type] || 'AssetReportRelayRemoveResponse'
976
+
977
+ # auth_names
978
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
979
+
980
+ new_options = opts.merge(
981
+ :operation => :"PlaidApi.asset_report_relay_remove",
982
+ :header_params => header_params,
983
+ :query_params => query_params,
984
+ :form_params => form_params,
985
+ :body => post_body,
986
+ :auth_names => auth_names,
987
+ :return_type => return_type
988
+ )
989
+
990
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
991
+ if @api_client.config.debugging
992
+ @api_client.config.logger.debug "API called: PlaidApi#asset_report_relay_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
993
+ end
994
+ return data, status_code, headers
995
+ end
996
+
737
997
  # Delete an Asset Report
738
998
  # The `/item/remove` endpoint allows you to invalidate an `access_token`, meaning you will not be able to create new Asset Reports with it. Removing an Item does not affect any Asset Reports or Audit Copies you have already created, which will remain accessible until you remove them specifically. The `/asset_report/remove` endpoint allows you to remove an Asset Report. Removing an Asset Report invalidates its `asset_report_token`, meaning you will no longer be able to use it to access Report data or create new Audit Copies. Removing an Asset Report does not affect the underlying Items, but does invalidate any `audit_copy_tokens` associated with the Asset Report.
739
999
  # @param asset_report_remove_request [AssetReportRemoveRequest]
@@ -1644,31 +1904,31 @@ module Plaid
1644
1904
  return data, status_code, headers
1645
1905
  end
1646
1906
 
1647
- # Create a deposit switch without using Plaid Exchange
1648
- # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1649
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1907
+ # Retrieve information from the bank accounts used for income verification
1908
+ # `/credit/bank_income/get` returns the bank income report(s) for a specified user.
1909
+ # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
1650
1910
  # @param [Hash] opts the optional parameters
1651
- # @return [DepositSwitchAltCreateResponse]
1652
- def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
1653
- data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
1911
+ # @return [CreditBankIncomeGetResponse]
1912
+ def credit_bank_income_get(credit_bank_income_get_request, opts = {})
1913
+ data, _status_code, _headers = credit_bank_income_get_with_http_info(credit_bank_income_get_request, opts)
1654
1914
  data
1655
1915
  end
1656
1916
 
1657
- # Create a deposit switch without using Plaid Exchange
1658
- # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1659
- # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
1917
+ # Retrieve information from the bank accounts used for income verification
1918
+ # &#x60;/credit/bank_income/get&#x60; returns the bank income report(s) for a specified user.
1919
+ # @param credit_bank_income_get_request [CreditBankIncomeGetRequest]
1660
1920
  # @param [Hash] opts the optional parameters
1661
- # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
1662
- def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
1921
+ # @return [Array<(CreditBankIncomeGetResponse, Integer, Hash)>] CreditBankIncomeGetResponse data, response status code and response headers
1922
+ def credit_bank_income_get_with_http_info(credit_bank_income_get_request, opts = {})
1663
1923
  if @api_client.config.debugging
1664
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
1924
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_bank_income_get ...'
1665
1925
  end
1666
- # verify the required parameter 'deposit_switch_alt_create_request' is set
1667
- if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
1668
- fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
1926
+ # verify the required parameter 'credit_bank_income_get_request' is set
1927
+ if @api_client.config.client_side_validation && credit_bank_income_get_request.nil?
1928
+ fail ArgumentError, "Missing the required parameter 'credit_bank_income_get_request' when calling PlaidApi.credit_bank_income_get"
1669
1929
  end
1670
1930
  # resource path
1671
- local_var_path = '/deposit_switch/alt/create'
1931
+ local_var_path = '/credit/bank_income/get'
1672
1932
 
1673
1933
  # query parameters
1674
1934
  query_params = opts[:query_params] || {}
@@ -1684,16 +1944,16 @@ module Plaid
1684
1944
  form_params = opts[:form_params] || {}
1685
1945
 
1686
1946
  # http body (model)
1687
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
1947
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_bank_income_get_request)
1688
1948
 
1689
1949
  # return_type
1690
- return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
1950
+ return_type = opts[:debug_return_type] || 'CreditBankIncomeGetResponse'
1691
1951
 
1692
1952
  # auth_names
1693
1953
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1694
1954
 
1695
1955
  new_options = opts.merge(
1696
- :operation => :"PlaidApi.deposit_switch_alt_create",
1956
+ :operation => :"PlaidApi.credit_bank_income_get",
1697
1957
  :header_params => header_params,
1698
1958
  :query_params => query_params,
1699
1959
  :form_params => form_params,
@@ -1704,36 +1964,36 @@ module Plaid
1704
1964
 
1705
1965
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1706
1966
  if @api_client.config.debugging
1707
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1967
+ @api_client.config.logger.debug "API called: PlaidApi#credit_bank_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1708
1968
  end
1709
1969
  return data, status_code, headers
1710
1970
  end
1711
1971
 
1712
- # Create a deposit switch
1713
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1714
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1972
+ # Retrieve a summary of an individual's employment information
1973
+ # `/credit/employment/get` returns a list of employments through a user payroll that was verified by an end user.
1974
+ # @param credit_employment_get_request [CreditEmploymentGetRequest]
1715
1975
  # @param [Hash] opts the optional parameters
1716
- # @return [DepositSwitchCreateResponse]
1717
- def deposit_switch_create(deposit_switch_create_request, opts = {})
1718
- data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
1976
+ # @return [CreditEmploymentGetResponse]
1977
+ def credit_employment_get(credit_employment_get_request, opts = {})
1978
+ data, _status_code, _headers = credit_employment_get_with_http_info(credit_employment_get_request, opts)
1719
1979
  data
1720
1980
  end
1721
1981
 
1722
- # Create a deposit switch
1723
- # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
1724
- # @param deposit_switch_create_request [DepositSwitchCreateRequest]
1982
+ # Retrieve a summary of an individual&#39;s employment information
1983
+ # &#x60;/credit/employment/get&#x60; returns a list of employments through a user payroll that was verified by an end user.
1984
+ # @param credit_employment_get_request [CreditEmploymentGetRequest]
1725
1985
  # @param [Hash] opts the optional parameters
1726
- # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
1727
- def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
1986
+ # @return [Array<(CreditEmploymentGetResponse, Integer, Hash)>] CreditEmploymentGetResponse data, response status code and response headers
1987
+ def credit_employment_get_with_http_info(credit_employment_get_request, opts = {})
1728
1988
  if @api_client.config.debugging
1729
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
1989
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_employment_get ...'
1730
1990
  end
1731
- # verify the required parameter 'deposit_switch_create_request' is set
1732
- if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
1733
- fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
1991
+ # verify the required parameter 'credit_employment_get_request' is set
1992
+ if @api_client.config.client_side_validation && credit_employment_get_request.nil?
1993
+ fail ArgumentError, "Missing the required parameter 'credit_employment_get_request' when calling PlaidApi.credit_employment_get"
1734
1994
  end
1735
1995
  # resource path
1736
- local_var_path = '/deposit_switch/create'
1996
+ local_var_path = '/credit/employment/get'
1737
1997
 
1738
1998
  # query parameters
1739
1999
  query_params = opts[:query_params] || {}
@@ -1749,16 +2009,16 @@ module Plaid
1749
2009
  form_params = opts[:form_params] || {}
1750
2010
 
1751
2011
  # http body (model)
1752
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_create_request)
2012
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_employment_get_request)
1753
2013
 
1754
2014
  # return_type
1755
- return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
2015
+ return_type = opts[:debug_return_type] || 'CreditEmploymentGetResponse'
1756
2016
 
1757
2017
  # auth_names
1758
2018
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1759
2019
 
1760
2020
  new_options = opts.merge(
1761
- :operation => :"PlaidApi.deposit_switch_create",
2021
+ :operation => :"PlaidApi.credit_employment_get",
1762
2022
  :header_params => header_params,
1763
2023
  :query_params => query_params,
1764
2024
  :form_params => form_params,
@@ -1769,36 +2029,36 @@ module Plaid
1769
2029
 
1770
2030
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1771
2031
  if @api_client.config.debugging
1772
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2032
+ @api_client.config.logger.debug "API called: PlaidApi#credit_employment_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1773
2033
  end
1774
2034
  return data, status_code, headers
1775
2035
  end
1776
2036
 
1777
- # Retrieve a deposit switch
1778
- # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
1779
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
2037
+ # Retrieve a user's payroll information
2038
+ # This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
2039
+ # @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
1780
2040
  # @param [Hash] opts the optional parameters
1781
- # @return [DepositSwitchGetResponse]
1782
- def deposit_switch_get(deposit_switch_get_request, opts = {})
1783
- data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
2041
+ # @return [CreditPayrollIncomeGetResponse]
2042
+ def credit_payroll_income_get(credit_payroll_income_get_request, opts = {})
2043
+ data, _status_code, _headers = credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts)
1784
2044
  data
1785
2045
  end
1786
2046
 
1787
- # Retrieve a deposit switch
1788
- # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
1789
- # @param deposit_switch_get_request [DepositSwitchGetRequest]
2047
+ # Retrieve a user&#39;s payroll information
2048
+ # This endpoint gets payroll income information for a specific user, either as a result of the user connecting to their payroll provider or uploading a pay related document.
2049
+ # @param credit_payroll_income_get_request [CreditPayrollIncomeGetRequest]
1790
2050
  # @param [Hash] opts the optional parameters
1791
- # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
1792
- def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
2051
+ # @return [Array<(CreditPayrollIncomeGetResponse, Integer, Hash)>] CreditPayrollIncomeGetResponse data, response status code and response headers
2052
+ def credit_payroll_income_get_with_http_info(credit_payroll_income_get_request, opts = {})
1793
2053
  if @api_client.config.debugging
1794
- @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
2054
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_get ...'
1795
2055
  end
1796
- # verify the required parameter 'deposit_switch_get_request' is set
1797
- if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
1798
- fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
2056
+ # verify the required parameter 'credit_payroll_income_get_request' is set
2057
+ if @api_client.config.client_side_validation && credit_payroll_income_get_request.nil?
2058
+ fail ArgumentError, "Missing the required parameter 'credit_payroll_income_get_request' when calling PlaidApi.credit_payroll_income_get"
1799
2059
  end
1800
2060
  # resource path
1801
- local_var_path = '/deposit_switch/get'
2061
+ local_var_path = '/credit/payroll_income/get'
1802
2062
 
1803
2063
  # query parameters
1804
2064
  query_params = opts[:query_params] || {}
@@ -1814,16 +2074,16 @@ module Plaid
1814
2074
  form_params = opts[:form_params] || {}
1815
2075
 
1816
2076
  # http body (model)
1817
- post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_get_request)
2077
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_get_request)
1818
2078
 
1819
2079
  # return_type
1820
- return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
2080
+ return_type = opts[:debug_return_type] || 'CreditPayrollIncomeGetResponse'
1821
2081
 
1822
2082
  # auth_names
1823
2083
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
1824
2084
 
1825
2085
  new_options = opts.merge(
1826
- :operation => :"PlaidApi.deposit_switch_get",
2086
+ :operation => :"PlaidApi.credit_payroll_income_get",
1827
2087
  :header_params => header_params,
1828
2088
  :query_params => query_params,
1829
2089
  :form_params => form_params,
@@ -1834,27 +2094,287 @@ module Plaid
1834
2094
 
1835
2095
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1836
2096
  if @api_client.config.debugging
1837
- @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2097
+ @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1838
2098
  end
1839
2099
  return data, status_code, headers
1840
2100
  end
1841
2101
 
1842
- # Create a deposit switch token
1843
- # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
1844
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
2102
+ # Check income verification eligibility and optimize conversion
2103
+ # `/credit/payroll_income/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing `employer` data will increase the chance of receiving a useful result.
2104
+ # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
1845
2105
  # @param [Hash] opts the optional parameters
1846
- # @return [DepositSwitchTokenCreateResponse]
1847
- def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
1848
- data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
2106
+ # @return [CreditPayrollIncomePrecheckResponse]
2107
+ def credit_payroll_income_precheck(credit_payroll_income_precheck_request, opts = {})
2108
+ data, _status_code, _headers = credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts)
1849
2109
  data
1850
2110
  end
1851
2111
 
1852
- # Create a deposit switch token
1853
- # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
1854
- # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
2112
+ # Check income verification eligibility and optimize conversion
2113
+ # &#x60;/credit/payroll_income/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification. If the user is eligible for digital verification, that information will be associated with the user token, and in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing &#x60;employer&#x60; data will increase the chance of receiving a useful result.
2114
+ # @param credit_payroll_income_precheck_request [CreditPayrollIncomePrecheckRequest]
1855
2115
  # @param [Hash] opts the optional parameters
1856
- # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
1857
- def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
2116
+ # @return [Array<(CreditPayrollIncomePrecheckResponse, Integer, Hash)>] CreditPayrollIncomePrecheckResponse data, response status code and response headers
2117
+ def credit_payroll_income_precheck_with_http_info(credit_payroll_income_precheck_request, opts = {})
2118
+ if @api_client.config.debugging
2119
+ @api_client.config.logger.debug 'Calling API: PlaidApi.credit_payroll_income_precheck ...'
2120
+ end
2121
+ # verify the required parameter 'credit_payroll_income_precheck_request' is set
2122
+ if @api_client.config.client_side_validation && credit_payroll_income_precheck_request.nil?
2123
+ fail ArgumentError, "Missing the required parameter 'credit_payroll_income_precheck_request' when calling PlaidApi.credit_payroll_income_precheck"
2124
+ end
2125
+ # resource path
2126
+ local_var_path = '/credit/payroll_income/precheck'
2127
+
2128
+ # query parameters
2129
+ query_params = opts[:query_params] || {}
2130
+
2131
+ # header parameters
2132
+ header_params = opts[:header_params] || {}
2133
+ # HTTP header 'Accept' (if needed)
2134
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2135
+ # HTTP header 'Content-Type'
2136
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2137
+
2138
+ # form parameters
2139
+ form_params = opts[:form_params] || {}
2140
+
2141
+ # http body (model)
2142
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(credit_payroll_income_precheck_request)
2143
+
2144
+ # return_type
2145
+ return_type = opts[:debug_return_type] || 'CreditPayrollIncomePrecheckResponse'
2146
+
2147
+ # auth_names
2148
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2149
+
2150
+ new_options = opts.merge(
2151
+ :operation => :"PlaidApi.credit_payroll_income_precheck",
2152
+ :header_params => header_params,
2153
+ :query_params => query_params,
2154
+ :form_params => form_params,
2155
+ :body => post_body,
2156
+ :auth_names => auth_names,
2157
+ :return_type => return_type
2158
+ )
2159
+
2160
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2161
+ if @api_client.config.debugging
2162
+ @api_client.config.logger.debug "API called: PlaidApi#credit_payroll_income_precheck\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2163
+ end
2164
+ return data, status_code, headers
2165
+ end
2166
+
2167
+ # Create a deposit switch without using Plaid Exchange
2168
+ # This endpoint provides an alternative to `/deposit_switch/create` for customers who have not yet fully integrated with Plaid Exchange. Like `/deposit_switch/create`, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
2169
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
2170
+ # @param [Hash] opts the optional parameters
2171
+ # @return [DepositSwitchAltCreateResponse]
2172
+ def deposit_switch_alt_create(deposit_switch_alt_create_request, opts = {})
2173
+ data, _status_code, _headers = deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts)
2174
+ data
2175
+ end
2176
+
2177
+ # Create a deposit switch without using Plaid Exchange
2178
+ # This endpoint provides an alternative to &#x60;/deposit_switch/create&#x60; for customers who have not yet fully integrated with Plaid Exchange. Like &#x60;/deposit_switch/create&#x60;, it creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
2179
+ # @param deposit_switch_alt_create_request [DepositSwitchAltCreateRequest]
2180
+ # @param [Hash] opts the optional parameters
2181
+ # @return [Array<(DepositSwitchAltCreateResponse, Integer, Hash)>] DepositSwitchAltCreateResponse data, response status code and response headers
2182
+ def deposit_switch_alt_create_with_http_info(deposit_switch_alt_create_request, opts = {})
2183
+ if @api_client.config.debugging
2184
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_alt_create ...'
2185
+ end
2186
+ # verify the required parameter 'deposit_switch_alt_create_request' is set
2187
+ if @api_client.config.client_side_validation && deposit_switch_alt_create_request.nil?
2188
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_alt_create_request' when calling PlaidApi.deposit_switch_alt_create"
2189
+ end
2190
+ # resource path
2191
+ local_var_path = '/deposit_switch/alt/create'
2192
+
2193
+ # query parameters
2194
+ query_params = opts[:query_params] || {}
2195
+
2196
+ # header parameters
2197
+ header_params = opts[:header_params] || {}
2198
+ # HTTP header 'Accept' (if needed)
2199
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2200
+ # HTTP header 'Content-Type'
2201
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2202
+
2203
+ # form parameters
2204
+ form_params = opts[:form_params] || {}
2205
+
2206
+ # http body (model)
2207
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_alt_create_request)
2208
+
2209
+ # return_type
2210
+ return_type = opts[:debug_return_type] || 'DepositSwitchAltCreateResponse'
2211
+
2212
+ # auth_names
2213
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2214
+
2215
+ new_options = opts.merge(
2216
+ :operation => :"PlaidApi.deposit_switch_alt_create",
2217
+ :header_params => header_params,
2218
+ :query_params => query_params,
2219
+ :form_params => form_params,
2220
+ :body => post_body,
2221
+ :auth_names => auth_names,
2222
+ :return_type => return_type
2223
+ )
2224
+
2225
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2226
+ if @api_client.config.debugging
2227
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_alt_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2228
+ end
2229
+ return data, status_code, headers
2230
+ end
2231
+
2232
+ # Create a deposit switch
2233
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
2234
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
2235
+ # @param [Hash] opts the optional parameters
2236
+ # @return [DepositSwitchCreateResponse]
2237
+ def deposit_switch_create(deposit_switch_create_request, opts = {})
2238
+ data, _status_code, _headers = deposit_switch_create_with_http_info(deposit_switch_create_request, opts)
2239
+ data
2240
+ end
2241
+
2242
+ # Create a deposit switch
2243
+ # This endpoint creates a deposit switch entity that will be persisted throughout the lifecycle of the switch.
2244
+ # @param deposit_switch_create_request [DepositSwitchCreateRequest]
2245
+ # @param [Hash] opts the optional parameters
2246
+ # @return [Array<(DepositSwitchCreateResponse, Integer, Hash)>] DepositSwitchCreateResponse data, response status code and response headers
2247
+ def deposit_switch_create_with_http_info(deposit_switch_create_request, opts = {})
2248
+ if @api_client.config.debugging
2249
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_create ...'
2250
+ end
2251
+ # verify the required parameter 'deposit_switch_create_request' is set
2252
+ if @api_client.config.client_side_validation && deposit_switch_create_request.nil?
2253
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_create_request' when calling PlaidApi.deposit_switch_create"
2254
+ end
2255
+ # resource path
2256
+ local_var_path = '/deposit_switch/create'
2257
+
2258
+ # query parameters
2259
+ query_params = opts[:query_params] || {}
2260
+
2261
+ # header parameters
2262
+ header_params = opts[:header_params] || {}
2263
+ # HTTP header 'Accept' (if needed)
2264
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2265
+ # HTTP header 'Content-Type'
2266
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2267
+
2268
+ # form parameters
2269
+ form_params = opts[:form_params] || {}
2270
+
2271
+ # http body (model)
2272
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_create_request)
2273
+
2274
+ # return_type
2275
+ return_type = opts[:debug_return_type] || 'DepositSwitchCreateResponse'
2276
+
2277
+ # auth_names
2278
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2279
+
2280
+ new_options = opts.merge(
2281
+ :operation => :"PlaidApi.deposit_switch_create",
2282
+ :header_params => header_params,
2283
+ :query_params => query_params,
2284
+ :form_params => form_params,
2285
+ :body => post_body,
2286
+ :auth_names => auth_names,
2287
+ :return_type => return_type
2288
+ )
2289
+
2290
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2291
+ if @api_client.config.debugging
2292
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2293
+ end
2294
+ return data, status_code, headers
2295
+ end
2296
+
2297
+ # Retrieve a deposit switch
2298
+ # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user's direct deposit allocation preferences.
2299
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
2300
+ # @param [Hash] opts the optional parameters
2301
+ # @return [DepositSwitchGetResponse]
2302
+ def deposit_switch_get(deposit_switch_get_request, opts = {})
2303
+ data, _status_code, _headers = deposit_switch_get_with_http_info(deposit_switch_get_request, opts)
2304
+ data
2305
+ end
2306
+
2307
+ # Retrieve a deposit switch
2308
+ # This endpoint returns information related to how the user has configured their payroll allocation and the state of the switch. You can use this information to build logic related to the user&#39;s direct deposit allocation preferences.
2309
+ # @param deposit_switch_get_request [DepositSwitchGetRequest]
2310
+ # @param [Hash] opts the optional parameters
2311
+ # @return [Array<(DepositSwitchGetResponse, Integer, Hash)>] DepositSwitchGetResponse data, response status code and response headers
2312
+ def deposit_switch_get_with_http_info(deposit_switch_get_request, opts = {})
2313
+ if @api_client.config.debugging
2314
+ @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_get ...'
2315
+ end
2316
+ # verify the required parameter 'deposit_switch_get_request' is set
2317
+ if @api_client.config.client_side_validation && deposit_switch_get_request.nil?
2318
+ fail ArgumentError, "Missing the required parameter 'deposit_switch_get_request' when calling PlaidApi.deposit_switch_get"
2319
+ end
2320
+ # resource path
2321
+ local_var_path = '/deposit_switch/get'
2322
+
2323
+ # query parameters
2324
+ query_params = opts[:query_params] || {}
2325
+
2326
+ # header parameters
2327
+ header_params = opts[:header_params] || {}
2328
+ # HTTP header 'Accept' (if needed)
2329
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2330
+ # HTTP header 'Content-Type'
2331
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2332
+
2333
+ # form parameters
2334
+ form_params = opts[:form_params] || {}
2335
+
2336
+ # http body (model)
2337
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(deposit_switch_get_request)
2338
+
2339
+ # return_type
2340
+ return_type = opts[:debug_return_type] || 'DepositSwitchGetResponse'
2341
+
2342
+ # auth_names
2343
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2344
+
2345
+ new_options = opts.merge(
2346
+ :operation => :"PlaidApi.deposit_switch_get",
2347
+ :header_params => header_params,
2348
+ :query_params => query_params,
2349
+ :form_params => form_params,
2350
+ :body => post_body,
2351
+ :auth_names => auth_names,
2352
+ :return_type => return_type
2353
+ )
2354
+
2355
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2356
+ if @api_client.config.debugging
2357
+ @api_client.config.logger.debug "API called: PlaidApi#deposit_switch_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2358
+ end
2359
+ return data, status_code, headers
2360
+ end
2361
+
2362
+ # Create a deposit switch token
2363
+ # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
2364
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
2365
+ # @param [Hash] opts the optional parameters
2366
+ # @return [DepositSwitchTokenCreateResponse]
2367
+ def deposit_switch_token_create(deposit_switch_token_create_request, opts = {})
2368
+ data, _status_code, _headers = deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts)
2369
+ data
2370
+ end
2371
+
2372
+ # Create a deposit switch token
2373
+ # In order for the end user to take action, you will need to create a public token representing the deposit switch. This token is used to initialize Link. It can be used one time and expires after 30 minutes.
2374
+ # @param deposit_switch_token_create_request [DepositSwitchTokenCreateRequest]
2375
+ # @param [Hash] opts the optional parameters
2376
+ # @return [Array<(DepositSwitchTokenCreateResponse, Integer, Hash)>] DepositSwitchTokenCreateResponse data, response status code and response headers
2377
+ def deposit_switch_token_create_with_http_info(deposit_switch_token_create_request, opts = {})
1858
2378
  if @api_client.config.debugging
1859
2379
  @api_client.config.logger.debug 'Calling API: PlaidApi.deposit_switch_token_create ...'
1860
2380
  end
@@ -1969,8 +2489,8 @@ module Plaid
1969
2489
  return data, status_code, headers
1970
2490
  end
1971
2491
 
1972
- # Retrieve a summary of an individual's employment information
1973
- # `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user.
2492
+ # (Deprecated) Retrieve a summary of an individual's employment information
2493
+ # `/employment/verification/get` returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use `/credit/employment/get` instead.
1974
2494
  # @param employment_verification_get_request [EmploymentVerificationGetRequest]
1975
2495
  # @param [Hash] opts the optional parameters
1976
2496
  # @return [EmploymentVerificationGetResponse]
@@ -1979,8 +2499,8 @@ module Plaid
1979
2499
  data
1980
2500
  end
1981
2501
 
1982
- # Retrieve a summary of an individual&#39;s employment information
1983
- # &#x60;/employment/verification/get&#x60; returns a list of employments through a user payroll that was verified by an end user.
2502
+ # (Deprecated) Retrieve a summary of an individual&#39;s employment information
2503
+ # &#x60;/employment/verification/get&#x60; returns a list of employments through a user payroll that was verified by an end user. This endpoint has been deprecated; new integrations should use &#x60;/credit/employment/get&#x60; instead.
1984
2504
  # @param employment_verification_get_request [EmploymentVerificationGetRequest]
1985
2505
  # @param [Hash] opts the optional parameters
1986
2506
  # @return [Array<(EmploymentVerificationGetResponse, Integer, Hash)>] EmploymentVerificationGetResponse data, response status code and response headers
@@ -2035,7 +2555,7 @@ module Plaid
2035
2555
  end
2036
2556
 
2037
2557
  # Retrieve identity data
2038
- # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
2558
+ # The `/identity/get` endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the `owners` object is not returned, and instead identity information is returned in the top level `identity` object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
2039
2559
  # @param identity_get_request [IdentityGetRequest]
2040
2560
  # @param [Hash] opts the optional parameters
2041
2561
  # @return [IdentityGetResponse]
@@ -2045,7 +2565,7 @@ module Plaid
2045
2565
  end
2046
2566
 
2047
2567
  # Retrieve identity data
2048
- # The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. Note: This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data.
2568
+ # The &#x60;/identity/get&#x60; endpoint allows you to retrieve various account holder information on file with the financial institution, including names, emails, phone numbers, and addresses. Only name data is guaranteed to be returned; other fields will be empty arrays if not provided by the institution. This request may take some time to complete if identity was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the data. Note: In API versions 2018-05-22 and earlier, the &#x60;owners&#x60; object is not returned, and instead identity information is returned in the top level &#x60;identity&#x60; object. For more details, see [Plaid API versioning](https://plaid.com/docs/api/versioning/#version-2019-05-29).
2049
2569
  # @param identity_get_request [IdentityGetRequest]
2050
2570
  # @param [Hash] opts the optional parameters
2051
2571
  # @return [Array<(IdentityGetResponse, Integer, Hash)>] IdentityGetResponse data, response status code and response headers
@@ -2164,7 +2684,7 @@ module Plaid
2164
2684
  return data, status_code, headers
2165
2685
  end
2166
2686
 
2167
- # Download the original documents used for income verification
2687
+ # (Deprecated) Download the original documents used for income verification
2168
2688
  # `/income/verification/documents/download` provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to `/income/verification/documents/download` is a ZIP file in binary data. If a `document_id` is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The `request_id` is returned in the `Plaid-Request-ID` header.
2169
2689
  # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
2170
2690
  # @param [Hash] opts the optional parameters
@@ -2174,7 +2694,7 @@ module Plaid
2174
2694
  data
2175
2695
  end
2176
2696
 
2177
- # Download the original documents used for income verification
2697
+ # (Deprecated) Download the original documents used for income verification
2178
2698
  # &#x60;/income/verification/documents/download&#x60; provides the ability to download the source documents associated with the verification. If Document Income was used, the documents will be those the user provided in Link. For Payroll Income, the most recent files available for download from the payroll provider will be available from this endpoint. The response to &#x60;/income/verification/documents/download&#x60; is a ZIP file in binary data. If a &#x60;document_id&#x60; is passed, a single document will be contained in this file. If not, the response will contain all documents associated with the verification. The &#x60;request_id&#x60; is returned in the &#x60;Plaid-Request-ID&#x60; header.
2179
2699
  # @param income_verification_documents_download_request [IncomeVerificationDocumentsDownloadRequest]
2180
2700
  # @param [Hash] opts the optional parameters
@@ -2229,73 +2749,8 @@ module Plaid
2229
2749
  return data, status_code, headers
2230
2750
  end
2231
2751
 
2232
- # (Deprecated) Retrieve information from a single paystub used for income verification
2233
- # /income/verification/paystub/get returns information from a single paystub used for income verification
2234
- # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2235
- # @param [Hash] opts the optional parameters
2236
- # @return [IncomeVerificationPaystubGetResponse]
2237
- def income_verification_paystub_get(income_verification_paystub_get_request, opts = {})
2238
- data, _status_code, _headers = income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts)
2239
- data
2240
- end
2241
-
2242
- # (Deprecated) Retrieve information from a single paystub used for income verification
2243
- # /income/verification/paystub/get returns information from a single paystub used for income verification
2244
- # @param income_verification_paystub_get_request [IncomeVerificationPaystubGetRequest]
2245
- # @param [Hash] opts the optional parameters
2246
- # @return [Array<(IncomeVerificationPaystubGetResponse, Integer, Hash)>] IncomeVerificationPaystubGetResponse data, response status code and response headers
2247
- def income_verification_paystub_get_with_http_info(income_verification_paystub_get_request, opts = {})
2248
- if @api_client.config.debugging
2249
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_paystub_get ...'
2250
- end
2251
- # verify the required parameter 'income_verification_paystub_get_request' is set
2252
- if @api_client.config.client_side_validation && income_verification_paystub_get_request.nil?
2253
- fail ArgumentError, "Missing the required parameter 'income_verification_paystub_get_request' when calling PlaidApi.income_verification_paystub_get"
2254
- end
2255
- # resource path
2256
- local_var_path = '/income/verification/paystub/get'
2257
-
2258
- # query parameters
2259
- query_params = opts[:query_params] || {}
2260
-
2261
- # header parameters
2262
- header_params = opts[:header_params] || {}
2263
- # HTTP header 'Accept' (if needed)
2264
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2265
- # HTTP header 'Content-Type'
2266
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2267
-
2268
- # form parameters
2269
- form_params = opts[:form_params] || {}
2270
-
2271
- # http body (model)
2272
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_paystub_get_request)
2273
-
2274
- # return_type
2275
- return_type = opts[:debug_return_type] || 'IncomeVerificationPaystubGetResponse'
2276
-
2277
- # auth_names
2278
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2279
-
2280
- new_options = opts.merge(
2281
- :operation => :"PlaidApi.income_verification_paystub_get",
2282
- :header_params => header_params,
2283
- :query_params => query_params,
2284
- :form_params => form_params,
2285
- :body => post_body,
2286
- :auth_names => auth_names,
2287
- :return_type => return_type
2288
- )
2289
-
2290
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2291
- if @api_client.config.debugging
2292
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_paystub_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2293
- end
2294
- return data, status_code, headers
2295
- end
2296
-
2297
- # Retrieve information from the paystubs used for income verification
2298
- # `/income/verification/paystubs/get` returns the information collected from the paystubs 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.
2752
+ # (Deprecated) Retrieve information from the paystubs used for income verification
2753
+ # `/income/verification/paystubs/get` returns the information collected from the paystubs that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
2299
2754
  # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
2300
2755
  # @param [Hash] opts the optional parameters
2301
2756
  # @return [IncomeVerificationPaystubsGetResponse]
@@ -2304,8 +2759,8 @@ module Plaid
2304
2759
  data
2305
2760
  end
2306
2761
 
2307
- # Retrieve information from the paystubs used for income verification
2308
- # &#x60;/income/verification/paystubs/get&#x60; returns the information collected from the paystubs 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.
2762
+ # (Deprecated) Retrieve information from the paystubs used for income verification
2763
+ # &#x60;/income/verification/paystubs/get&#x60; returns the information collected from the paystubs that were used to verify an end user&#39;&#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. This endpoint has been deprecated; new integrations should use &#x60;/credit/payroll_income/get&#x60; instead.
2309
2764
  # @param income_verification_paystubs_get_request [IncomeVerificationPaystubsGetRequest]
2310
2765
  # @param [Hash] opts the optional parameters
2311
2766
  # @return [Array<(IncomeVerificationPaystubsGetResponse, Integer, Hash)>] IncomeVerificationPaystubsGetResponse data, response status code and response headers
@@ -2359,8 +2814,8 @@ module Plaid
2359
2814
  return data, status_code, headers
2360
2815
  end
2361
2816
 
2362
- # Check digital income verification eligibility and optimize conversion
2363
- # `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result.
2817
+ # (Deprecated) Check digital income verification eligibility and optimize conversion
2818
+ # `/income/verification/precheck` is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a `precheck_id` that can be provided to `/link/token/create`. If the user is eligible for digital verification, providing the `precheck_id` in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the `precheck_id` can still be provided to `/link/token/create` and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either `employer` or `transactions_access_tokens` data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/precheck` instead.
2364
2819
  # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
2365
2820
  # @param [Hash] opts the optional parameters
2366
2821
  # @return [IncomeVerificationPrecheckResponse]
@@ -2369,8 +2824,8 @@ module Plaid
2369
2824
  data
2370
2825
  end
2371
2826
 
2372
- # Check digital income verification eligibility and optimize conversion
2373
- # &#x60;/income/verification/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a &#x60;precheck_id&#x60; that can be provided to &#x60;/link/token/create&#x60;. If the user is eligible for digital verification, providing the &#x60;precheck_id&#x60; in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the &#x60;precheck_id&#x60; can still be provided to &#x60;/link/token/create&#x60; and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either &#x60;employer&#x60; or &#x60;transactions_access_tokens&#x60; data will increase the chance of receiving a useful result.
2827
+ # (Deprecated) Check digital income verification eligibility and optimize conversion
2828
+ # &#x60;/income/verification/precheck&#x60; is an optional endpoint that can be called before initializing a Link session for income verification. It evaluates whether a given user is supportable by digital income verification and returns a &#x60;precheck_id&#x60; that can be provided to &#x60;/link/token/create&#x60;. If the user is eligible for digital verification, providing the &#x60;precheck_id&#x60; in this way will generate a Link UI optimized for the end user and their specific employer. If the user cannot be confirmed as eligible, the &#x60;precheck_id&#x60; can still be provided to &#x60;/link/token/create&#x60; and the user can still use the income verification flow, but they may be required to manually upload a paystub to verify their income. While all request fields are optional, providing either &#x60;employer&#x60; or &#x60;transactions_access_tokens&#x60; data will increase the chance of receiving a useful result. This endpoint has been deprecated; new integrations should use &#x60;/credit/payroll_income/precheck&#x60; instead.
2374
2829
  # @param income_verification_precheck_request [IncomeVerificationPrecheckRequest]
2375
2830
  # @param [Hash] opts the optional parameters
2376
2831
  # @return [Array<(IncomeVerificationPrecheckResponse, Integer, Hash)>] IncomeVerificationPrecheckResponse data, response status code and response headers
@@ -2424,7 +2879,7 @@ module Plaid
2424
2879
  return data, status_code, headers
2425
2880
  end
2426
2881
 
2427
- # Refresh an income verification
2882
+ # (Deprecated) Refresh an income verification
2428
2883
  # `/income/verification/refresh` refreshes a given income verification.
2429
2884
  # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2430
2885
  # @param [Hash] opts the optional parameters
@@ -2434,7 +2889,7 @@ module Plaid
2434
2889
  data
2435
2890
  end
2436
2891
 
2437
- # Refresh an income verification
2892
+ # (Deprecated) Refresh an income verification
2438
2893
  # &#x60;/income/verification/refresh&#x60; refreshes a given income verification.
2439
2894
  # @param income_verification_refresh_request [IncomeVerificationRefreshRequest]
2440
2895
  # @param [Hash] opts the optional parameters
@@ -2448,72 +2903,7 @@ module Plaid
2448
2903
  fail ArgumentError, "Missing the required parameter 'income_verification_refresh_request' when calling PlaidApi.income_verification_refresh"
2449
2904
  end
2450
2905
  # resource path
2451
- local_var_path = '/income/verification/refresh'
2452
-
2453
- # query parameters
2454
- query_params = opts[:query_params] || {}
2455
-
2456
- # header parameters
2457
- header_params = opts[:header_params] || {}
2458
- # HTTP header 'Accept' (if needed)
2459
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
2460
- # HTTP header 'Content-Type'
2461
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
2462
-
2463
- # form parameters
2464
- form_params = opts[:form_params] || {}
2465
-
2466
- # http body (model)
2467
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
2468
-
2469
- # return_type
2470
- return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
2471
-
2472
- # auth_names
2473
- auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2474
-
2475
- new_options = opts.merge(
2476
- :operation => :"PlaidApi.income_verification_refresh",
2477
- :header_params => header_params,
2478
- :query_params => query_params,
2479
- :form_params => form_params,
2480
- :body => post_body,
2481
- :auth_names => auth_names,
2482
- :return_type => return_type
2483
- )
2484
-
2485
- data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2486
- if @api_client.config.debugging
2487
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2488
- end
2489
- return data, status_code, headers
2490
- end
2491
-
2492
- # (Deprecated) Retrieve a summary of information derived from income verification
2493
- # `/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.
2494
- # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2495
- # @param [Hash] opts the optional parameters
2496
- # @return [IncomeVerificationSummaryGetResponse]
2497
- def income_verification_summary_get(income_verification_summary_get_request, opts = {})
2498
- data, _status_code, _headers = income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts)
2499
- data
2500
- end
2501
-
2502
- # (Deprecated) Retrieve a summary of information derived from income verification
2503
- # &#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.
2504
- # @param income_verification_summary_get_request [IncomeVerificationSummaryGetRequest]
2505
- # @param [Hash] opts the optional parameters
2506
- # @return [Array<(IncomeVerificationSummaryGetResponse, Integer, Hash)>] IncomeVerificationSummaryGetResponse data, response status code and response headers
2507
- def income_verification_summary_get_with_http_info(income_verification_summary_get_request, opts = {})
2508
- if @api_client.config.debugging
2509
- @api_client.config.logger.debug 'Calling API: PlaidApi.income_verification_summary_get ...'
2510
- end
2511
- # verify the required parameter 'income_verification_summary_get_request' is set
2512
- if @api_client.config.client_side_validation && income_verification_summary_get_request.nil?
2513
- fail ArgumentError, "Missing the required parameter 'income_verification_summary_get_request' when calling PlaidApi.income_verification_summary_get"
2514
- end
2515
- # resource path
2516
- local_var_path = '/income/verification/summary/get'
2906
+ local_var_path = '/income/verification/refresh'
2517
2907
 
2518
2908
  # query parameters
2519
2909
  query_params = opts[:query_params] || {}
@@ -2529,16 +2919,16 @@ module Plaid
2529
2919
  form_params = opts[:form_params] || {}
2530
2920
 
2531
2921
  # http body (model)
2532
- post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_summary_get_request)
2922
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(income_verification_refresh_request)
2533
2923
 
2534
2924
  # return_type
2535
- return_type = opts[:debug_return_type] || 'IncomeVerificationSummaryGetResponse'
2925
+ return_type = opts[:debug_return_type] || 'IncomeVerificationRefreshResponse'
2536
2926
 
2537
2927
  # auth_names
2538
2928
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
2539
2929
 
2540
2930
  new_options = opts.merge(
2541
- :operation => :"PlaidApi.income_verification_summary_get",
2931
+ :operation => :"PlaidApi.income_verification_refresh",
2542
2932
  :header_params => header_params,
2543
2933
  :query_params => query_params,
2544
2934
  :form_params => form_params,
@@ -2549,13 +2939,13 @@ module Plaid
2549
2939
 
2550
2940
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
2551
2941
  if @api_client.config.debugging
2552
- @api_client.config.logger.debug "API called: PlaidApi#income_verification_summary_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2942
+ @api_client.config.logger.debug "API called: PlaidApi#income_verification_refresh\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
2553
2943
  end
2554
2944
  return data, status_code, headers
2555
2945
  end
2556
2946
 
2557
- # Retrieve information from the tax documents used for income verification
2558
- # `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user's income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error.
2947
+ # (Deprecated) Retrieve information from the tax documents used for income verification
2948
+ # `/income/verification/taxforms/get` returns the information collected from forms that were used to verify an end user''s income. It can be called once the status of the verification has been set to `VERIFICATION_STATUS_PROCESSING_COMPLETE`, as reported by the `INCOME: verification_status` webhook. Attempting to call the endpoint before verification has been completed will result in an error. This endpoint has been deprecated; new integrations should use `/credit/payroll_income/get` instead.
2559
2949
  # @param request_body [Hash<String, Object>]
2560
2950
  # @param [Hash] opts the optional parameters
2561
2951
  # @return [IncomeVerificationTaxformsGetResponse]
@@ -2564,8 +2954,8 @@ module Plaid
2564
2954
  data
2565
2955
  end
2566
2956
 
2567
- # Retrieve information from the tax documents used for income verification
2568
- # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from forms 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.
2957
+ # (Deprecated) Retrieve information from the tax documents used for income verification
2958
+ # &#x60;/income/verification/taxforms/get&#x60; returns the information collected from forms that were used to verify an end user&#39;&#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. This endpoint has been deprecated; new integrations should use &#x60;/credit/payroll_income/get&#x60; instead.
2569
2959
  # @param request_body [Hash<String, Object>]
2570
2960
  # @param [Hash] opts the optional parameters
2571
2961
  # @return [Array<(IncomeVerificationTaxformsGetResponse, Integer, Hash)>] IncomeVerificationTaxformsGetResponse data, response status code and response headers
@@ -2685,7 +3075,7 @@ module Plaid
2685
3075
  end
2686
3076
 
2687
3077
  # Get details of an institution
2688
- # 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.
3078
+ # 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.
2689
3079
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2690
3080
  # @param [Hash] opts the optional parameters
2691
3081
  # @return [InstitutionsGetByIdResponse]
@@ -2695,7 +3085,7 @@ module Plaid
2695
3085
  end
2696
3086
 
2697
3087
  # Get details of an institution
2698
- # 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.
3088
+ # 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.
2699
3089
  # @param institutions_get_by_id_request [InstitutionsGetByIdRequest]
2700
3090
  # @param [Hash] opts the optional parameters
2701
3091
  # @return [Array<(InstitutionsGetByIdResponse, Integer, Hash)>] InstitutionsGetByIdResponse data, response status code and response headers
@@ -3335,7 +3725,7 @@ module Plaid
3335
3725
  end
3336
3726
 
3337
3727
  # Exchange public token for an access token
3338
- # Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
3728
+ # Exchange a Link `public_token` for an API `access_token`. Link hands off the `public_token` client-side via the `onSuccess` callback once a user has successfully created an Item. The `public_token` is ephemeral and expires after 30 minutes. An `access_token` does not expire, but can be revoked by calling `/item/remove`. The response also includes an `item_id` that should be stored with the `access_token`. The `item_id` is used to identify an Item in a webhook. The `item_id` can also be retrieved by making an `/item/get` request.
3339
3729
  # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
3340
3730
  # @param [Hash] opts the optional parameters
3341
3731
  # @return [ItemPublicTokenExchangeResponse]
@@ -3344,21 +3734,281 @@ module Plaid
3344
3734
  data
3345
3735
  end
3346
3736
 
3347
- # Exchange public token for an access token
3348
- # Exchange a Link &#x60;public_token&#x60; for an API &#x60;access_token&#x60;. Link hands off the &#x60;public_token&#x60; client-side via the &#x60;onSuccess&#x60; callback once a user has successfully created an Item. The &#x60;public_token&#x60; is ephemeral and expires after 30 minutes. The response also includes an &#x60;item_id&#x60; that should be stored with the &#x60;access_token&#x60;. The &#x60;item_id&#x60; is used to identify an Item in a webhook. The &#x60;item_id&#x60; can also be retrieved by making an &#x60;/item/get&#x60; request.
3349
- # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
3737
+ # Exchange public token for an access token
3738
+ # Exchange a Link &#x60;public_token&#x60; for an API &#x60;access_token&#x60;. Link hands off the &#x60;public_token&#x60; client-side via the &#x60;onSuccess&#x60; callback once a user has successfully created an Item. The &#x60;public_token&#x60; is ephemeral and expires after 30 minutes. An &#x60;access_token&#x60; does not expire, but can be revoked by calling &#x60;/item/remove&#x60;. The response also includes an &#x60;item_id&#x60; that should be stored with the &#x60;access_token&#x60;. The &#x60;item_id&#x60; is used to identify an Item in a webhook. The &#x60;item_id&#x60; can also be retrieved by making an &#x60;/item/get&#x60; request.
3739
+ # @param item_public_token_exchange_request [ItemPublicTokenExchangeRequest]
3740
+ # @param [Hash] opts the optional parameters
3741
+ # @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
3742
+ def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
3743
+ if @api_client.config.debugging
3744
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
3745
+ end
3746
+ # verify the required parameter 'item_public_token_exchange_request' is set
3747
+ if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
3748
+ fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
3749
+ end
3750
+ # resource path
3751
+ local_var_path = '/item/public_token/exchange'
3752
+
3753
+ # query parameters
3754
+ query_params = opts[:query_params] || {}
3755
+
3756
+ # header parameters
3757
+ header_params = opts[:header_params] || {}
3758
+ # HTTP header 'Accept' (if needed)
3759
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3760
+ # HTTP header 'Content-Type'
3761
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3762
+
3763
+ # form parameters
3764
+ form_params = opts[:form_params] || {}
3765
+
3766
+ # http body (model)
3767
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)
3768
+
3769
+ # return_type
3770
+ return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
3771
+
3772
+ # auth_names
3773
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3774
+
3775
+ new_options = opts.merge(
3776
+ :operation => :"PlaidApi.item_public_token_exchange",
3777
+ :header_params => header_params,
3778
+ :query_params => query_params,
3779
+ :form_params => form_params,
3780
+ :body => post_body,
3781
+ :auth_names => auth_names,
3782
+ :return_type => return_type
3783
+ )
3784
+
3785
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3786
+ if @api_client.config.debugging
3787
+ @api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3788
+ end
3789
+ return data, status_code, headers
3790
+ end
3791
+
3792
+ # Remove an Item
3793
+ # The `/item/remove` endpoint allows you to remove an Item. Once removed, the `access_token`, as well as any processor tokens or bank account tokens 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.
3794
+ # @param item_remove_request [ItemRemoveRequest]
3795
+ # @param [Hash] opts the optional parameters
3796
+ # @return [ItemRemoveResponse]
3797
+ def item_remove(item_remove_request, opts = {})
3798
+ data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
3799
+ data
3800
+ end
3801
+
3802
+ # Remove an Item
3803
+ # The &#x60;/item/remove&#x60; endpoint allows you to remove an Item. Once removed, the &#x60;access_token&#x60;, as well as any processor tokens or bank account tokens 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.
3804
+ # @param item_remove_request [ItemRemoveRequest]
3805
+ # @param [Hash] opts the optional parameters
3806
+ # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
3807
+ def item_remove_with_http_info(item_remove_request, opts = {})
3808
+ if @api_client.config.debugging
3809
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
3810
+ end
3811
+ # verify the required parameter 'item_remove_request' is set
3812
+ if @api_client.config.client_side_validation && item_remove_request.nil?
3813
+ fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
3814
+ end
3815
+ # resource path
3816
+ local_var_path = '/item/remove'
3817
+
3818
+ # query parameters
3819
+ query_params = opts[:query_params] || {}
3820
+
3821
+ # header parameters
3822
+ header_params = opts[:header_params] || {}
3823
+ # HTTP header 'Accept' (if needed)
3824
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3825
+ # HTTP header 'Content-Type'
3826
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3827
+
3828
+ # form parameters
3829
+ form_params = opts[:form_params] || {}
3830
+
3831
+ # http body (model)
3832
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)
3833
+
3834
+ # return_type
3835
+ return_type = opts[:debug_return_type] || 'ItemRemoveResponse'
3836
+
3837
+ # auth_names
3838
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3839
+
3840
+ new_options = opts.merge(
3841
+ :operation => :"PlaidApi.item_remove",
3842
+ :header_params => header_params,
3843
+ :query_params => query_params,
3844
+ :form_params => form_params,
3845
+ :body => post_body,
3846
+ :auth_names => auth_names,
3847
+ :return_type => return_type
3848
+ )
3849
+
3850
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3851
+ if @api_client.config.debugging
3852
+ @api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3853
+ end
3854
+ return data, status_code, headers
3855
+ end
3856
+
3857
+ # Update Webhook URL
3858
+ # The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.
3859
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
3860
+ # @param [Hash] opts the optional parameters
3861
+ # @return [ItemWebhookUpdateResponse]
3862
+ def item_webhook_update(item_webhook_update_request, opts = {})
3863
+ data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
3864
+ data
3865
+ end
3866
+
3867
+ # Update Webhook URL
3868
+ # The POST &#x60;/item/webhook/update&#x60; allows you to update the webhook URL associated with an Item. This request triggers a [&#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60;](https://plaid.com/docs/api/items/#webhook_update_acknowledged) webhook to the newly specified webhook URL.
3869
+ # @param item_webhook_update_request [ItemWebhookUpdateRequest]
3870
+ # @param [Hash] opts the optional parameters
3871
+ # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
3872
+ def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
3873
+ if @api_client.config.debugging
3874
+ @api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
3875
+ end
3876
+ # verify the required parameter 'item_webhook_update_request' is set
3877
+ if @api_client.config.client_side_validation && item_webhook_update_request.nil?
3878
+ fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
3879
+ end
3880
+ # resource path
3881
+ local_var_path = '/item/webhook/update'
3882
+
3883
+ # query parameters
3884
+ query_params = opts[:query_params] || {}
3885
+
3886
+ # header parameters
3887
+ header_params = opts[:header_params] || {}
3888
+ # HTTP header 'Accept' (if needed)
3889
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3890
+ # HTTP header 'Content-Type'
3891
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3892
+
3893
+ # form parameters
3894
+ form_params = opts[:form_params] || {}
3895
+
3896
+ # http body (model)
3897
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)
3898
+
3899
+ # return_type
3900
+ return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'
3901
+
3902
+ # auth_names
3903
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3904
+
3905
+ new_options = opts.merge(
3906
+ :operation => :"PlaidApi.item_webhook_update",
3907
+ :header_params => header_params,
3908
+ :query_params => query_params,
3909
+ :form_params => form_params,
3910
+ :body => post_body,
3911
+ :auth_names => auth_names,
3912
+ :return_type => return_type
3913
+ )
3914
+
3915
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3916
+ if @api_client.config.debugging
3917
+ @api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3918
+ end
3919
+ return data, status_code, headers
3920
+ end
3921
+
3922
+ # Retrieve Liabilities data
3923
+ # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3924
+ # @param liabilities_get_request [LiabilitiesGetRequest]
3925
+ # @param [Hash] opts the optional parameters
3926
+ # @return [LiabilitiesGetResponse]
3927
+ def liabilities_get(liabilities_get_request, opts = {})
3928
+ data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
3929
+ data
3930
+ end
3931
+
3932
+ # Retrieve Liabilities data
3933
+ # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3934
+ # @param liabilities_get_request [LiabilitiesGetRequest]
3935
+ # @param [Hash] opts the optional parameters
3936
+ # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
3937
+ def liabilities_get_with_http_info(liabilities_get_request, opts = {})
3938
+ if @api_client.config.debugging
3939
+ @api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
3940
+ end
3941
+ # verify the required parameter 'liabilities_get_request' is set
3942
+ if @api_client.config.client_side_validation && liabilities_get_request.nil?
3943
+ fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
3944
+ end
3945
+ # resource path
3946
+ local_var_path = '/liabilities/get'
3947
+
3948
+ # query parameters
3949
+ query_params = opts[:query_params] || {}
3950
+
3951
+ # header parameters
3952
+ header_params = opts[:header_params] || {}
3953
+ # HTTP header 'Accept' (if needed)
3954
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
3955
+ # HTTP header 'Content-Type'
3956
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
3957
+
3958
+ # form parameters
3959
+ form_params = opts[:form_params] || {}
3960
+
3961
+ # http body (model)
3962
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)
3963
+
3964
+ # return_type
3965
+ return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'
3966
+
3967
+ # auth_names
3968
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3969
+
3970
+ new_options = opts.merge(
3971
+ :operation => :"PlaidApi.liabilities_get",
3972
+ :header_params => header_params,
3973
+ :query_params => query_params,
3974
+ :form_params => form_params,
3975
+ :body => post_body,
3976
+ :auth_names => auth_names,
3977
+ :return_type => return_type
3978
+ )
3979
+
3980
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3981
+ if @api_client.config.debugging
3982
+ @api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3983
+ end
3984
+ return data, status_code, headers
3985
+ end
3986
+
3987
+ # Create Link Token
3988
+ # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3989
+ # @param link_token_create_request [LinkTokenCreateRequest]
3990
+ # @param [Hash] opts the optional parameters
3991
+ # @return [LinkTokenCreateResponse]
3992
+ def link_token_create(link_token_create_request, opts = {})
3993
+ data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
3994
+ data
3995
+ end
3996
+
3997
+ # Create Link Token
3998
+ # The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;, which can then be exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3999
+ # @param link_token_create_request [LinkTokenCreateRequest]
3350
4000
  # @param [Hash] opts the optional parameters
3351
- # @return [Array<(ItemPublicTokenExchangeResponse, Integer, Hash)>] ItemPublicTokenExchangeResponse data, response status code and response headers
3352
- def item_public_token_exchange_with_http_info(item_public_token_exchange_request, opts = {})
4001
+ # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
4002
+ def link_token_create_with_http_info(link_token_create_request, opts = {})
3353
4003
  if @api_client.config.debugging
3354
- @api_client.config.logger.debug 'Calling API: PlaidApi.item_public_token_exchange ...'
4004
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
3355
4005
  end
3356
- # verify the required parameter 'item_public_token_exchange_request' is set
3357
- if @api_client.config.client_side_validation && item_public_token_exchange_request.nil?
3358
- fail ArgumentError, "Missing the required parameter 'item_public_token_exchange_request' when calling PlaidApi.item_public_token_exchange"
4006
+ # verify the required parameter 'link_token_create_request' is set
4007
+ if @api_client.config.client_side_validation && link_token_create_request.nil?
4008
+ fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
3359
4009
  end
3360
4010
  # resource path
3361
- local_var_path = '/item/public_token/exchange'
4011
+ local_var_path = '/link/token/create'
3362
4012
 
3363
4013
  # query parameters
3364
4014
  query_params = opts[:query_params] || {}
@@ -3374,16 +4024,16 @@ module Plaid
3374
4024
  form_params = opts[:form_params] || {}
3375
4025
 
3376
4026
  # http body (model)
3377
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_public_token_exchange_request)
4027
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)
3378
4028
 
3379
4029
  # return_type
3380
- return_type = opts[:debug_return_type] || 'ItemPublicTokenExchangeResponse'
4030
+ return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
3381
4031
 
3382
4032
  # auth_names
3383
4033
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3384
4034
 
3385
4035
  new_options = opts.merge(
3386
- :operation => :"PlaidApi.item_public_token_exchange",
4036
+ :operation => :"PlaidApi.link_token_create",
3387
4037
  :header_params => header_params,
3388
4038
  :query_params => query_params,
3389
4039
  :form_params => form_params,
@@ -3394,36 +4044,36 @@ module Plaid
3394
4044
 
3395
4045
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3396
4046
  if @api_client.config.debugging
3397
- @api_client.config.logger.debug "API called: PlaidApi#item_public_token_exchange\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4047
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3398
4048
  end
3399
4049
  return data, status_code, headers
3400
4050
  end
3401
4051
 
3402
- # Remove an Item
3403
- # 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.
3404
- # @param item_remove_request [ItemRemoveRequest]
4052
+ # Get Link Token
4053
+ # The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
4054
+ # @param link_token_get_request [LinkTokenGetRequest]
3405
4055
  # @param [Hash] opts the optional parameters
3406
- # @return [ItemRemoveResponse]
3407
- def item_remove(item_remove_request, opts = {})
3408
- data, _status_code, _headers = item_remove_with_http_info(item_remove_request, opts)
4056
+ # @return [LinkTokenGetResponse]
4057
+ def link_token_get(link_token_get_request, opts = {})
4058
+ data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
3409
4059
  data
3410
4060
  end
3411
4061
 
3412
- # Remove an Item
3413
- # 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.
3414
- # @param item_remove_request [ItemRemoveRequest]
4062
+ # Get Link Token
4063
+ # The &#x60;/link/token/get&#x60; endpoint gets information about a previously-created &#x60;link_token&#x60; using the &#x60;/link/token/create&#x60; endpoint. It can be useful for debugging purposes.
4064
+ # @param link_token_get_request [LinkTokenGetRequest]
3415
4065
  # @param [Hash] opts the optional parameters
3416
- # @return [Array<(ItemRemoveResponse, Integer, Hash)>] ItemRemoveResponse data, response status code and response headers
3417
- def item_remove_with_http_info(item_remove_request, opts = {})
4066
+ # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
4067
+ def link_token_get_with_http_info(link_token_get_request, opts = {})
3418
4068
  if @api_client.config.debugging
3419
- @api_client.config.logger.debug 'Calling API: PlaidApi.item_remove ...'
4069
+ @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
3420
4070
  end
3421
- # verify the required parameter 'item_remove_request' is set
3422
- if @api_client.config.client_side_validation && item_remove_request.nil?
3423
- fail ArgumentError, "Missing the required parameter 'item_remove_request' when calling PlaidApi.item_remove"
4071
+ # verify the required parameter 'link_token_get_request' is set
4072
+ if @api_client.config.client_side_validation && link_token_get_request.nil?
4073
+ fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
3424
4074
  end
3425
4075
  # resource path
3426
- local_var_path = '/item/remove'
4076
+ local_var_path = '/link/token/get'
3427
4077
 
3428
4078
  # query parameters
3429
4079
  query_params = opts[:query_params] || {}
@@ -3439,16 +4089,16 @@ module Plaid
3439
4089
  form_params = opts[:form_params] || {}
3440
4090
 
3441
4091
  # http body (model)
3442
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_remove_request)
4092
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)
3443
4093
 
3444
4094
  # return_type
3445
- return_type = opts[:debug_return_type] || 'ItemRemoveResponse'
4095
+ return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'
3446
4096
 
3447
4097
  # auth_names
3448
4098
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3449
4099
 
3450
4100
  new_options = opts.merge(
3451
- :operation => :"PlaidApi.item_remove",
4101
+ :operation => :"PlaidApi.link_token_get",
3452
4102
  :header_params => header_params,
3453
4103
  :query_params => query_params,
3454
4104
  :form_params => form_params,
@@ -3459,36 +4109,36 @@ module Plaid
3459
4109
 
3460
4110
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3461
4111
  if @api_client.config.debugging
3462
- @api_client.config.logger.debug "API called: PlaidApi#item_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4112
+ @api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3463
4113
  end
3464
4114
  return data, status_code, headers
3465
4115
  end
3466
4116
 
3467
- # Update Webhook URL
3468
- # The POST `/item/webhook/update` allows you to update the webhook URL associated with an Item. This request triggers a [`WEBHOOK_UPDATE_ACKNOWLEDGED`](https://plaid.com/docs/api/webhooks/#item-webhook-update-acknowledged) webhook to the newly specified webhook URL.
3469
- # @param item_webhook_update_request [ItemWebhookUpdateRequest]
4117
+ # Create payment consent
4118
+ # The `/payment_initiation/consent/create` endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with `UNAUTHORISED` status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
4119
+ # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
3470
4120
  # @param [Hash] opts the optional parameters
3471
- # @return [ItemWebhookUpdateResponse]
3472
- def item_webhook_update(item_webhook_update_request, opts = {})
3473
- data, _status_code, _headers = item_webhook_update_with_http_info(item_webhook_update_request, opts)
4121
+ # @return [PaymentInitiationConsentCreateResponse]
4122
+ def payment_initiation_consent_create(payment_initiation_consent_create_request, opts = {})
4123
+ data, _status_code, _headers = payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts)
3474
4124
  data
3475
4125
  end
3476
4126
 
3477
- # Update Webhook URL
3478
- # The POST &#x60;/item/webhook/update&#x60; allows you to update the webhook URL associated with an Item. This request triggers a [&#x60;WEBHOOK_UPDATE_ACKNOWLEDGED&#x60;](https://plaid.com/docs/api/webhooks/#item-webhook-update-acknowledged) webhook to the newly specified webhook URL.
3479
- # @param item_webhook_update_request [ItemWebhookUpdateRequest]
4127
+ # Create payment consent
4128
+ # The &#x60;/payment_initiation/consent/create&#x60; endpoint is used to create a payment consent, which can be used to initiate payments on behalf of the user. Payment consents are created with &#x60;UNAUTHORISED&#x60; status by default and must be authorised by the user before payments can be initiated. Consents can be limited in time and scope, and have constraints that describe limitations for payments.
4129
+ # @param payment_initiation_consent_create_request [PaymentInitiationConsentCreateRequest]
3480
4130
  # @param [Hash] opts the optional parameters
3481
- # @return [Array<(ItemWebhookUpdateResponse, Integer, Hash)>] ItemWebhookUpdateResponse data, response status code and response headers
3482
- def item_webhook_update_with_http_info(item_webhook_update_request, opts = {})
4131
+ # @return [Array<(PaymentInitiationConsentCreateResponse, Integer, Hash)>] PaymentInitiationConsentCreateResponse data, response status code and response headers
4132
+ def payment_initiation_consent_create_with_http_info(payment_initiation_consent_create_request, opts = {})
3483
4133
  if @api_client.config.debugging
3484
- @api_client.config.logger.debug 'Calling API: PlaidApi.item_webhook_update ...'
4134
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_create ...'
3485
4135
  end
3486
- # verify the required parameter 'item_webhook_update_request' is set
3487
- if @api_client.config.client_side_validation && item_webhook_update_request.nil?
3488
- fail ArgumentError, "Missing the required parameter 'item_webhook_update_request' when calling PlaidApi.item_webhook_update"
4136
+ # verify the required parameter 'payment_initiation_consent_create_request' is set
4137
+ if @api_client.config.client_side_validation && payment_initiation_consent_create_request.nil?
4138
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_create_request' when calling PlaidApi.payment_initiation_consent_create"
3489
4139
  end
3490
4140
  # resource path
3491
- local_var_path = '/item/webhook/update'
4141
+ local_var_path = '/payment_initiation/consent/create'
3492
4142
 
3493
4143
  # query parameters
3494
4144
  query_params = opts[:query_params] || {}
@@ -3504,16 +4154,16 @@ module Plaid
3504
4154
  form_params = opts[:form_params] || {}
3505
4155
 
3506
4156
  # http body (model)
3507
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_webhook_update_request)
4157
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_create_request)
3508
4158
 
3509
4159
  # return_type
3510
- return_type = opts[:debug_return_type] || 'ItemWebhookUpdateResponse'
4160
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentCreateResponse'
3511
4161
 
3512
4162
  # auth_names
3513
4163
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3514
4164
 
3515
4165
  new_options = opts.merge(
3516
- :operation => :"PlaidApi.item_webhook_update",
4166
+ :operation => :"PlaidApi.payment_initiation_consent_create",
3517
4167
  :header_params => header_params,
3518
4168
  :query_params => query_params,
3519
4169
  :form_params => form_params,
@@ -3524,36 +4174,36 @@ module Plaid
3524
4174
 
3525
4175
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3526
4176
  if @api_client.config.debugging
3527
- @api_client.config.logger.debug "API called: PlaidApi#item_webhook_update\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4177
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3528
4178
  end
3529
4179
  return data, status_code, headers
3530
4180
  end
3531
4181
 
3532
- # Retrieve Liabilities data
3533
- # The `/liabilities/get` endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type `credit` with account subtype `credit card` or `paypal`, and account type `loan` with account subtype `student` or `mortgage`. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the `account_filters` parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling `/liabilities/get`. Note: This request may take some time to complete if `liabilities` was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3534
- # @param liabilities_get_request [LiabilitiesGetRequest]
4182
+ # Get payment consent
4183
+ # The `/payment_initiation/consent/get` endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
4184
+ # @param payment_initiation_consent_get_request [PaymentInitiationConsentGetRequest]
3535
4185
  # @param [Hash] opts the optional parameters
3536
- # @return [LiabilitiesGetResponse]
3537
- def liabilities_get(liabilities_get_request, opts = {})
3538
- data, _status_code, _headers = liabilities_get_with_http_info(liabilities_get_request, opts)
4186
+ # @return [PaymentInitiationConsentGetResponse]
4187
+ def payment_initiation_consent_get(payment_initiation_consent_get_request, opts = {})
4188
+ data, _status_code, _headers = payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts)
3539
4189
  data
3540
4190
  end
3541
4191
 
3542
- # Retrieve Liabilities data
3543
- # The &#x60;/liabilities/get&#x60; endpoint returns various details about an Item with loan or credit accounts. Liabilities data is available primarily for US financial institutions, with some limited coverage of Canadian institutions. Currently supported account types are account type &#x60;credit&#x60; with account subtype &#x60;credit card&#x60; or &#x60;paypal&#x60;, and account type &#x60;loan&#x60; with account subtype &#x60;student&#x60; or &#x60;mortgage&#x60;. To limit accounts listed in Link to types and subtypes supported by Liabilities, you can use the &#x60;account_filters&#x60; parameter when [creating a Link token](https://plaid.com/docs/api/tokens/#linktokencreate). The types of information returned by Liabilities can include balances and due dates, loan terms, and account details such as original loan amount and guarantor. Data is refreshed approximately once per day; the latest data can be retrieved by calling &#x60;/liabilities/get&#x60;. Note: This request may take some time to complete if &#x60;liabilities&#x60; was not specified as an initial product when creating the Item. This is because Plaid must communicate directly with the institution to retrieve the additional data.
3544
- # @param liabilities_get_request [LiabilitiesGetRequest]
4192
+ # Get payment consent
4193
+ # The &#x60;/payment_initiation/consent/get&#x60; endpoint can be used to check the status of a payment consent, as well as to receive basic information such as recipient and constraints.
4194
+ # @param payment_initiation_consent_get_request [PaymentInitiationConsentGetRequest]
3545
4195
  # @param [Hash] opts the optional parameters
3546
- # @return [Array<(LiabilitiesGetResponse, Integer, Hash)>] LiabilitiesGetResponse data, response status code and response headers
3547
- def liabilities_get_with_http_info(liabilities_get_request, opts = {})
4196
+ # @return [Array<(PaymentInitiationConsentGetResponse, Integer, Hash)>] PaymentInitiationConsentGetResponse data, response status code and response headers
4197
+ def payment_initiation_consent_get_with_http_info(payment_initiation_consent_get_request, opts = {})
3548
4198
  if @api_client.config.debugging
3549
- @api_client.config.logger.debug 'Calling API: PlaidApi.liabilities_get ...'
4199
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_get ...'
3550
4200
  end
3551
- # verify the required parameter 'liabilities_get_request' is set
3552
- if @api_client.config.client_side_validation && liabilities_get_request.nil?
3553
- fail ArgumentError, "Missing the required parameter 'liabilities_get_request' when calling PlaidApi.liabilities_get"
4201
+ # verify the required parameter 'payment_initiation_consent_get_request' is set
4202
+ if @api_client.config.client_side_validation && payment_initiation_consent_get_request.nil?
4203
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_get_request' when calling PlaidApi.payment_initiation_consent_get"
3554
4204
  end
3555
4205
  # resource path
3556
- local_var_path = '/liabilities/get'
4206
+ local_var_path = '/payment_initiation/consent/get'
3557
4207
 
3558
4208
  # query parameters
3559
4209
  query_params = opts[:query_params] || {}
@@ -3569,16 +4219,16 @@ module Plaid
3569
4219
  form_params = opts[:form_params] || {}
3570
4220
 
3571
4221
  # http body (model)
3572
- post_body = opts[:debug_body] || @api_client.object_to_http_body(liabilities_get_request)
4222
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_get_request)
3573
4223
 
3574
4224
  # return_type
3575
- return_type = opts[:debug_return_type] || 'LiabilitiesGetResponse'
4225
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentGetResponse'
3576
4226
 
3577
4227
  # auth_names
3578
4228
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3579
4229
 
3580
4230
  new_options = opts.merge(
3581
- :operation => :"PlaidApi.liabilities_get",
4231
+ :operation => :"PlaidApi.payment_initiation_consent_get",
3582
4232
  :header_params => header_params,
3583
4233
  :query_params => query_params,
3584
4234
  :form_params => form_params,
@@ -3589,36 +4239,36 @@ module Plaid
3589
4239
 
3590
4240
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3591
4241
  if @api_client.config.debugging
3592
- @api_client.config.logger.debug "API called: PlaidApi#liabilities_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4242
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3593
4243
  end
3594
4244
  return data, status_code, headers
3595
4245
  end
3596
4246
 
3597
- # Create Link Token
3598
- # The `/link/token/create` endpoint creates a `link_token`, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a `public_token`, which can then be exchanged for an `access_token` via `/item/public_token/exchange` as part of the main Link flow. A `link_token` generated by `/link/token/create` is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3599
- # @param link_token_create_request [LinkTokenCreateRequest]
4247
+ # Execute a single payment using consent
4248
+ # The `/payment_initiation/consent/payment/execute` endpoint can be used to execute payments using payment consent.
4249
+ # @param payment_initiation_consent_payment_execute_request [PaymentInitiationConsentPaymentExecuteRequest]
3600
4250
  # @param [Hash] opts the optional parameters
3601
- # @return [LinkTokenCreateResponse]
3602
- def link_token_create(link_token_create_request, opts = {})
3603
- data, _status_code, _headers = link_token_create_with_http_info(link_token_create_request, opts)
4251
+ # @return [PaymentInitiationConsentPaymentExecuteResponse]
4252
+ def payment_initiation_consent_payment_execute(payment_initiation_consent_payment_execute_request, opts = {})
4253
+ data, _status_code, _headers = payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts)
3604
4254
  data
3605
4255
  end
3606
4256
 
3607
- # Create Link Token
3608
- # The &#x60;/link/token/create&#x60; endpoint creates a &#x60;link_token&#x60;, which is required as a parameter when initializing Link. Once Link has been initialized, it returns a &#x60;public_token&#x60;, which can then be exchanged for an &#x60;access_token&#x60; via &#x60;/item/public_token/exchange&#x60; as part of the main Link flow. A &#x60;link_token&#x60; generated by &#x60;/link/token/create&#x60; is also used to initialize other Link flows, such as the update mode flow for tokens with expired credentials, or the Payment Initiation (Europe) flow.
3609
- # @param link_token_create_request [LinkTokenCreateRequest]
4257
+ # Execute a single payment using consent
4258
+ # The &#x60;/payment_initiation/consent/payment/execute&#x60; endpoint can be used to execute payments using payment consent.
4259
+ # @param payment_initiation_consent_payment_execute_request [PaymentInitiationConsentPaymentExecuteRequest]
3610
4260
  # @param [Hash] opts the optional parameters
3611
- # @return [Array<(LinkTokenCreateResponse, Integer, Hash)>] LinkTokenCreateResponse data, response status code and response headers
3612
- def link_token_create_with_http_info(link_token_create_request, opts = {})
4261
+ # @return [Array<(PaymentInitiationConsentPaymentExecuteResponse, Integer, Hash)>] PaymentInitiationConsentPaymentExecuteResponse data, response status code and response headers
4262
+ def payment_initiation_consent_payment_execute_with_http_info(payment_initiation_consent_payment_execute_request, opts = {})
3613
4263
  if @api_client.config.debugging
3614
- @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_create ...'
4264
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_payment_execute ...'
3615
4265
  end
3616
- # verify the required parameter 'link_token_create_request' is set
3617
- if @api_client.config.client_side_validation && link_token_create_request.nil?
3618
- fail ArgumentError, "Missing the required parameter 'link_token_create_request' when calling PlaidApi.link_token_create"
4266
+ # verify the required parameter 'payment_initiation_consent_payment_execute_request' is set
4267
+ if @api_client.config.client_side_validation && payment_initiation_consent_payment_execute_request.nil?
4268
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_payment_execute_request' when calling PlaidApi.payment_initiation_consent_payment_execute"
3619
4269
  end
3620
4270
  # resource path
3621
- local_var_path = '/link/token/create'
4271
+ local_var_path = '/payment_initiation/consent/payment/execute'
3622
4272
 
3623
4273
  # query parameters
3624
4274
  query_params = opts[:query_params] || {}
@@ -3634,16 +4284,16 @@ module Plaid
3634
4284
  form_params = opts[:form_params] || {}
3635
4285
 
3636
4286
  # http body (model)
3637
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_create_request)
4287
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_payment_execute_request)
3638
4288
 
3639
4289
  # return_type
3640
- return_type = opts[:debug_return_type] || 'LinkTokenCreateResponse'
4290
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentPaymentExecuteResponse'
3641
4291
 
3642
4292
  # auth_names
3643
4293
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3644
4294
 
3645
4295
  new_options = opts.merge(
3646
- :operation => :"PlaidApi.link_token_create",
4296
+ :operation => :"PlaidApi.payment_initiation_consent_payment_execute",
3647
4297
  :header_params => header_params,
3648
4298
  :query_params => query_params,
3649
4299
  :form_params => form_params,
@@ -3654,36 +4304,36 @@ module Plaid
3654
4304
 
3655
4305
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3656
4306
  if @api_client.config.debugging
3657
- @api_client.config.logger.debug "API called: PlaidApi#link_token_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4307
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_payment_execute\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3658
4308
  end
3659
4309
  return data, status_code, headers
3660
4310
  end
3661
4311
 
3662
- # Get Link Token
3663
- # The `/link/token/get` endpoint gets information about a previously-created `link_token` using the `/link/token/create` endpoint. It can be useful for debugging purposes.
3664
- # @param link_token_get_request [LinkTokenGetRequest]
4312
+ # Revoke payment consent
4313
+ # The `/payment_initiation/consent/revoke` endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.
4314
+ # @param payment_initiation_consent_revoke_request [PaymentInitiationConsentRevokeRequest]
3665
4315
  # @param [Hash] opts the optional parameters
3666
- # @return [LinkTokenGetResponse]
3667
- def link_token_get(link_token_get_request, opts = {})
3668
- data, _status_code, _headers = link_token_get_with_http_info(link_token_get_request, opts)
4316
+ # @return [PaymentInitiationConsentRevokeResponse]
4317
+ def payment_initiation_consent_revoke(payment_initiation_consent_revoke_request, opts = {})
4318
+ data, _status_code, _headers = payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts)
3669
4319
  data
3670
4320
  end
3671
4321
 
3672
- # Get Link Token
3673
- # The &#x60;/link/token/get&#x60; endpoint gets information about a previously-created &#x60;link_token&#x60; using the &#x60;/link/token/create&#x60; endpoint. It can be useful for debugging purposes.
3674
- # @param link_token_get_request [LinkTokenGetRequest]
4322
+ # Revoke payment consent
4323
+ # The &#x60;/payment_initiation/consent/revoke&#x60; endpoint can be used to revoke the payment consent. Once the consent is revoked, it is not possible to initiate payments using it.
4324
+ # @param payment_initiation_consent_revoke_request [PaymentInitiationConsentRevokeRequest]
3675
4325
  # @param [Hash] opts the optional parameters
3676
- # @return [Array<(LinkTokenGetResponse, Integer, Hash)>] LinkTokenGetResponse data, response status code and response headers
3677
- def link_token_get_with_http_info(link_token_get_request, opts = {})
4326
+ # @return [Array<(PaymentInitiationConsentRevokeResponse, Integer, Hash)>] PaymentInitiationConsentRevokeResponse data, response status code and response headers
4327
+ def payment_initiation_consent_revoke_with_http_info(payment_initiation_consent_revoke_request, opts = {})
3678
4328
  if @api_client.config.debugging
3679
- @api_client.config.logger.debug 'Calling API: PlaidApi.link_token_get ...'
4329
+ @api_client.config.logger.debug 'Calling API: PlaidApi.payment_initiation_consent_revoke ...'
3680
4330
  end
3681
- # verify the required parameter 'link_token_get_request' is set
3682
- if @api_client.config.client_side_validation && link_token_get_request.nil?
3683
- fail ArgumentError, "Missing the required parameter 'link_token_get_request' when calling PlaidApi.link_token_get"
4331
+ # verify the required parameter 'payment_initiation_consent_revoke_request' is set
4332
+ if @api_client.config.client_side_validation && payment_initiation_consent_revoke_request.nil?
4333
+ fail ArgumentError, "Missing the required parameter 'payment_initiation_consent_revoke_request' when calling PlaidApi.payment_initiation_consent_revoke"
3684
4334
  end
3685
4335
  # resource path
3686
- local_var_path = '/link/token/get'
4336
+ local_var_path = '/payment_initiation/consent/revoke'
3687
4337
 
3688
4338
  # query parameters
3689
4339
  query_params = opts[:query_params] || {}
@@ -3699,16 +4349,16 @@ module Plaid
3699
4349
  form_params = opts[:form_params] || {}
3700
4350
 
3701
4351
  # http body (model)
3702
- post_body = opts[:debug_body] || @api_client.object_to_http_body(link_token_get_request)
4352
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(payment_initiation_consent_revoke_request)
3703
4353
 
3704
4354
  # return_type
3705
- return_type = opts[:debug_return_type] || 'LinkTokenGetResponse'
4355
+ return_type = opts[:debug_return_type] || 'PaymentInitiationConsentRevokeResponse'
3706
4356
 
3707
4357
  # auth_names
3708
4358
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
3709
4359
 
3710
4360
  new_options = opts.merge(
3711
- :operation => :"PlaidApi.link_token_get",
4361
+ :operation => :"PlaidApi.payment_initiation_consent_revoke",
3712
4362
  :header_params => header_params,
3713
4363
  :query_params => query_params,
3714
4364
  :form_params => form_params,
@@ -3719,7 +4369,7 @@ module Plaid
3719
4369
 
3720
4370
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
3721
4371
  if @api_client.config.debugging
3722
- @api_client.config.logger.debug "API called: PlaidApi#link_token_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
4372
+ @api_client.config.logger.debug "API called: PlaidApi#payment_initiation_consent_revoke\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
3723
4373
  end
3724
4374
  return data, status_code, headers
3725
4375
  end
@@ -4245,7 +4895,7 @@ module Plaid
4245
4895
  end
4246
4896
 
4247
4897
  # Retrieve Auth data
4248
- # 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).
4898
+ # 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).
4249
4899
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4250
4900
  # @param [Hash] opts the optional parameters
4251
4901
  # @return [ProcessorAuthGetResponse]
@@ -4255,7 +4905,7 @@ module Plaid
4255
4905
  end
4256
4906
 
4257
4907
  # Retrieve Auth data
4258
- # 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).
4908
+ # 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).
4259
4909
  # @param processor_auth_get_request [ProcessorAuthGetRequest]
4260
4910
  # @param [Hash] opts the optional parameters
4261
4911
  # @return [Array<(ProcessorAuthGetResponse, Integer, Hash)>] ProcessorAuthGetResponse data, response status code and response headers
@@ -4505,7 +5155,7 @@ module Plaid
4505
5155
  end
4506
5156
 
4507
5157
  # Create Stripe bank account token
4508
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
5158
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Bank account tokens can also be revoked, using `/item/remove`.
4509
5159
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
4510
5160
  # @param [Hash] opts the optional parameters
4511
5161
  # @return [ProcessorStripeBankAccountTokenCreateResponse]
@@ -4515,7 +5165,7 @@ module Plaid
4515
5165
  end
4516
5166
 
4517
5167
  # Create Stripe bank account token
4518
- # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/).
5168
+ # Used to create a token suitable for sending to Stripe to enable Plaid-Stripe integrations. For a detailed guide on integrating Stripe, see [Add Stripe to your app](https://plaid.com/docs/auth/partnerships/stripe/). Bank account tokens can also be revoked, using &#x60;/item/remove&#x60;.
4519
5169
  # @param processor_stripe_bank_account_token_create_request [ProcessorStripeBankAccountTokenCreateRequest]
4520
5170
  # @param [Hash] opts the optional parameters
4521
5171
  # @return [Array<(ProcessorStripeBankAccountTokenCreateResponse, Integer, Hash)>] ProcessorStripeBankAccountTokenCreateResponse data, response status code and response headers
@@ -4570,7 +5220,7 @@ module Plaid
4570
5220
  end
4571
5221
 
4572
5222
  # Create processor token
4573
- # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations.
5223
+ # Used to create a token suitable for sending to one of Plaid's partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see `/processor/stripe/bank_account_token/create` for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using `/item/remove`.
4574
5224
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
4575
5225
  # @param [Hash] opts the optional parameters
4576
5226
  # @return [ProcessorTokenCreateResponse]
@@ -4580,7 +5230,7 @@ module Plaid
4580
5230
  end
4581
5231
 
4582
5232
  # Create processor token
4583
- # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations.
5233
+ # Used to create a token suitable for sending to one of Plaid&#39;s partners to enable integrations. Note that Stripe partnerships use bank account tokens instead; see &#x60;/processor/stripe/bank_account_token/create&#x60; for creating tokens for use with Stripe integrations. Processor tokens can also be revoked, using &#x60;/item/remove&#x60;.
4584
5234
  # @param processor_token_create_request [ProcessorTokenCreateRequest]
4585
5235
  # @param [Hash] opts the optional parameters
4586
5236
  # @return [Array<(ProcessorTokenCreateResponse, Integer, Hash)>] ProcessorTokenCreateResponse data, response status code and response headers
@@ -4830,7 +5480,7 @@ module Plaid
4830
5480
  end
4831
5481
 
4832
5482
  # Fire a test webhook
4833
- # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger 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. This endpoint can also trigger a `NEW_ACCOUNTS_AVAILABLE` webhook to be fired for a given Sandbox Item created with Account Select v2. 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.
5483
+ # The `/sandbox/item/fire_webhook` endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: `DEFAULT_UPDATE`: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a `SANDBOX_PRODUCT_NOT_ENABLED` error will result. `NEW_ACCOUNTS_AVAILABLE`: Webhook to be fired for a given Sandbox Item created with Account Select v2. `AUTH_DATA_UPDATE`: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. 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'
4834
5484
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4835
5485
  # @param [Hash] opts the optional parameters
4836
5486
  # @return [SandboxItemFireWebhookResponse]
@@ -4840,7 +5490,7 @@ module Plaid
4840
5490
  end
4841
5491
 
4842
5492
  # Fire a test webhook
4843
- # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger 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. This endpoint can also trigger a &#x60;NEW_ACCOUNTS_AVAILABLE&#x60; webhook to be fired for a given Sandbox Item created with Account Select v2. 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.
5493
+ # The &#x60;/sandbox/item/fire_webhook&#x60; endpoint is used to test that code correctly handles webhooks. This endpoint can trigger the following webhooks: &#x60;DEFAULT_UPDATE&#x60;: Transactions update webhook to be fired for a given Sandbox Item. If the Item does not support Transactions, a &#x60;SANDBOX_PRODUCT_NOT_ENABLED&#x60; error will result. &#x60;NEW_ACCOUNTS_AVAILABLE&#x60;: Webhook to be fired for a given Sandbox Item created with Account Select v2. &#x60;AUTH_DATA_UPDATE&#x60;: Webhook to be fired for a given Sandbox Item created with Auth as an enabled product. 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&#39;
4844
5494
  # @param sandbox_item_fire_webhook_request [SandboxItemFireWebhookRequest]
4845
5495
  # @param [Hash] opts the optional parameters
4846
5496
  # @return [Array<(SandboxItemFireWebhookResponse, Integer, Hash)>] SandboxItemFireWebhookResponse data, response status code and response headers
@@ -5219,6 +5869,71 @@ module Plaid
5219
5869
  return data, status_code, headers
5220
5870
  end
5221
5871
 
5872
+ # Manually fire a Transfer webhook
5873
+ # Use the `/sandbox/transfer/fire_webhook` endpoint to manually trigger a Transfer webhook in the Sandbox environment.
5874
+ # @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
5875
+ # @param [Hash] opts the optional parameters
5876
+ # @return [SandboxTransferFireWebhookResponse]
5877
+ def sandbox_transfer_fire_webhook(sandbox_transfer_fire_webhook_request, opts = {})
5878
+ data, _status_code, _headers = sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts)
5879
+ data
5880
+ end
5881
+
5882
+ # Manually fire a Transfer webhook
5883
+ # Use the &#x60;/sandbox/transfer/fire_webhook&#x60; endpoint to manually trigger a Transfer webhook in the Sandbox environment.
5884
+ # @param sandbox_transfer_fire_webhook_request [SandboxTransferFireWebhookRequest]
5885
+ # @param [Hash] opts the optional parameters
5886
+ # @return [Array<(SandboxTransferFireWebhookResponse, Integer, Hash)>] SandboxTransferFireWebhookResponse data, response status code and response headers
5887
+ def sandbox_transfer_fire_webhook_with_http_info(sandbox_transfer_fire_webhook_request, opts = {})
5888
+ if @api_client.config.debugging
5889
+ @api_client.config.logger.debug 'Calling API: PlaidApi.sandbox_transfer_fire_webhook ...'
5890
+ end
5891
+ # verify the required parameter 'sandbox_transfer_fire_webhook_request' is set
5892
+ if @api_client.config.client_side_validation && sandbox_transfer_fire_webhook_request.nil?
5893
+ fail ArgumentError, "Missing the required parameter 'sandbox_transfer_fire_webhook_request' when calling PlaidApi.sandbox_transfer_fire_webhook"
5894
+ end
5895
+ # resource path
5896
+ local_var_path = '/sandbox/transfer/fire_webhook'
5897
+
5898
+ # query parameters
5899
+ query_params = opts[:query_params] || {}
5900
+
5901
+ # header parameters
5902
+ header_params = opts[:header_params] || {}
5903
+ # HTTP header 'Accept' (if needed)
5904
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
5905
+ # HTTP header 'Content-Type'
5906
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
5907
+
5908
+ # form parameters
5909
+ form_params = opts[:form_params] || {}
5910
+
5911
+ # http body (model)
5912
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(sandbox_transfer_fire_webhook_request)
5913
+
5914
+ # return_type
5915
+ return_type = opts[:debug_return_type] || 'SandboxTransferFireWebhookResponse'
5916
+
5917
+ # auth_names
5918
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5919
+
5920
+ new_options = opts.merge(
5921
+ :operation => :"PlaidApi.sandbox_transfer_fire_webhook",
5922
+ :header_params => header_params,
5923
+ :query_params => query_params,
5924
+ :form_params => form_params,
5925
+ :body => post_body,
5926
+ :auth_names => auth_names,
5927
+ :return_type => return_type
5928
+ )
5929
+
5930
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5931
+ if @api_client.config.debugging
5932
+ @api_client.config.logger.debug "API called: PlaidApi#sandbox_transfer_fire_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5933
+ end
5934
+ return data, status_code, headers
5935
+ end
5936
+
5222
5937
  # Trigger the creation of a repayment
5223
5938
  # Use the `/sandbox/transfer/repayment/simulate` endpoint to trigger the creation of a repayment. As a side effect of calling this route, a repayment is created that includes all unreimbursed returns of guaranteed transfers. If there are no such returns, an 400 error is returned.
5224
5939
  # @param sandbox_transfer_repayment_simulate_request [SandboxTransferRepaymentSimulateRequest]
@@ -5503,7 +6218,72 @@ module Plaid
5503
6218
  fail ArgumentError, "Missing the required parameter 'signal_evaluate_request' when calling PlaidApi.signal_evaluate"
5504
6219
  end
5505
6220
  # resource path
5506
- local_var_path = '/signal/evaluate'
6221
+ local_var_path = '/signal/evaluate'
6222
+
6223
+ # query parameters
6224
+ query_params = opts[:query_params] || {}
6225
+
6226
+ # header parameters
6227
+ header_params = opts[:header_params] || {}
6228
+ # HTTP header 'Accept' (if needed)
6229
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6230
+ # HTTP header 'Content-Type'
6231
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6232
+
6233
+ # form parameters
6234
+ form_params = opts[:form_params] || {}
6235
+
6236
+ # http body (model)
6237
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)
6238
+
6239
+ # return_type
6240
+ return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
6241
+
6242
+ # auth_names
6243
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6244
+
6245
+ new_options = opts.merge(
6246
+ :operation => :"PlaidApi.signal_evaluate",
6247
+ :header_params => header_params,
6248
+ :query_params => query_params,
6249
+ :form_params => form_params,
6250
+ :body => post_body,
6251
+ :auth_names => auth_names,
6252
+ :return_type => return_type
6253
+ )
6254
+
6255
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6256
+ if @api_client.config.debugging
6257
+ @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6258
+ end
6259
+ return data, status_code, headers
6260
+ end
6261
+
6262
+ # Report a return for an ACH transaction
6263
+ # 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.
6264
+ # @param signal_return_report_request [SignalReturnReportRequest]
6265
+ # @param [Hash] opts the optional parameters
6266
+ # @return [SignalReturnReportResponse]
6267
+ def signal_return_report(signal_return_report_request, opts = {})
6268
+ data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
6269
+ data
6270
+ end
6271
+
6272
+ # Report a return for an ACH transaction
6273
+ # 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.
6274
+ # @param signal_return_report_request [SignalReturnReportRequest]
6275
+ # @param [Hash] opts the optional parameters
6276
+ # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
6277
+ def signal_return_report_with_http_info(signal_return_report_request, opts = {})
6278
+ if @api_client.config.debugging
6279
+ @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
6280
+ end
6281
+ # verify the required parameter 'signal_return_report_request' is set
6282
+ if @api_client.config.client_side_validation && signal_return_report_request.nil?
6283
+ fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
6284
+ end
6285
+ # resource path
6286
+ local_var_path = '/signal/return/report'
5507
6287
 
5508
6288
  # query parameters
5509
6289
  query_params = opts[:query_params] || {}
@@ -5519,16 +6299,16 @@ module Plaid
5519
6299
  form_params = opts[:form_params] || {}
5520
6300
 
5521
6301
  # http body (model)
5522
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_evaluate_request)
6302
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
5523
6303
 
5524
6304
  # return_type
5525
- return_type = opts[:debug_return_type] || 'SignalEvaluateResponse'
6305
+ return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
5526
6306
 
5527
6307
  # auth_names
5528
6308
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5529
6309
 
5530
6310
  new_options = opts.merge(
5531
- :operation => :"PlaidApi.signal_evaluate",
6311
+ :operation => :"PlaidApi.signal_return_report",
5532
6312
  :header_params => header_params,
5533
6313
  :query_params => query_params,
5534
6314
  :form_params => form_params,
@@ -5539,36 +6319,36 @@ module Plaid
5539
6319
 
5540
6320
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5541
6321
  if @api_client.config.debugging
5542
- @api_client.config.logger.debug "API called: PlaidApi#signal_evaluate\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6322
+ @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5543
6323
  end
5544
6324
  return data, status_code, headers
5545
6325
  end
5546
6326
 
5547
- # Report a return for an ACH transaction
5548
- # 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.
5549
- # @param signal_return_report_request [SignalReturnReportRequest]
6327
+ # enhance locally-held transaction data
6328
+ # The '/beta/transactions/v1/enhance' endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
6329
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
5550
6330
  # @param [Hash] opts the optional parameters
5551
- # @return [SignalReturnReportResponse]
5552
- def signal_return_report(signal_return_report_request, opts = {})
5553
- data, _status_code, _headers = signal_return_report_with_http_info(signal_return_report_request, opts)
6331
+ # @return [TransactionsEnhanceGetResponse]
6332
+ def transactions_enhance(transactions_enhance_get_request, opts = {})
6333
+ data, _status_code, _headers = transactions_enhance_with_http_info(transactions_enhance_get_request, opts)
5554
6334
  data
5555
6335
  end
5556
6336
 
5557
- # Report a return for an ACH transaction
5558
- # 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.
5559
- # @param signal_return_report_request [SignalReturnReportRequest]
6337
+ # enhance locally-held transaction data
6338
+ # The &#39;/beta/transactions/v1/enhance&#39; endpoint enriches raw transaction data provided directly by clients. The product is currently in beta.
6339
+ # @param transactions_enhance_get_request [TransactionsEnhanceGetRequest]
5560
6340
  # @param [Hash] opts the optional parameters
5561
- # @return [Array<(SignalReturnReportResponse, Integer, Hash)>] SignalReturnReportResponse data, response status code and response headers
5562
- def signal_return_report_with_http_info(signal_return_report_request, opts = {})
6341
+ # @return [Array<(TransactionsEnhanceGetResponse, Integer, Hash)>] TransactionsEnhanceGetResponse data, response status code and response headers
6342
+ def transactions_enhance_with_http_info(transactions_enhance_get_request, opts = {})
5563
6343
  if @api_client.config.debugging
5564
- @api_client.config.logger.debug 'Calling API: PlaidApi.signal_return_report ...'
6344
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_enhance ...'
5565
6345
  end
5566
- # verify the required parameter 'signal_return_report_request' is set
5567
- if @api_client.config.client_side_validation && signal_return_report_request.nil?
5568
- fail ArgumentError, "Missing the required parameter 'signal_return_report_request' when calling PlaidApi.signal_return_report"
6346
+ # verify the required parameter 'transactions_enhance_get_request' is set
6347
+ if @api_client.config.client_side_validation && transactions_enhance_get_request.nil?
6348
+ fail ArgumentError, "Missing the required parameter 'transactions_enhance_get_request' when calling PlaidApi.transactions_enhance"
5569
6349
  end
5570
6350
  # resource path
5571
- local_var_path = '/signal/return/report'
6351
+ local_var_path = '/beta/transactions/v1/enhance'
5572
6352
 
5573
6353
  # query parameters
5574
6354
  query_params = opts[:query_params] || {}
@@ -5584,16 +6364,16 @@ module Plaid
5584
6364
  form_params = opts[:form_params] || {}
5585
6365
 
5586
6366
  # http body (model)
5587
- post_body = opts[:debug_body] || @api_client.object_to_http_body(signal_return_report_request)
6367
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_enhance_get_request)
5588
6368
 
5589
6369
  # return_type
5590
- return_type = opts[:debug_return_type] || 'SignalReturnReportResponse'
6370
+ return_type = opts[:debug_return_type] || 'TransactionsEnhanceGetResponse'
5591
6371
 
5592
6372
  # auth_names
5593
6373
  auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
5594
6374
 
5595
6375
  new_options = opts.merge(
5596
- :operation => :"PlaidApi.signal_return_report",
6376
+ :operation => :"PlaidApi.transactions_enhance",
5597
6377
  :header_params => header_params,
5598
6378
  :query_params => query_params,
5599
6379
  :form_params => form_params,
@@ -5604,13 +6384,13 @@ module Plaid
5604
6384
 
5605
6385
  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
5606
6386
  if @api_client.config.debugging
5607
- @api_client.config.logger.debug "API called: PlaidApi#signal_return_report\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6387
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_enhance\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
5608
6388
  end
5609
6389
  return data, status_code, headers
5610
6390
  end
5611
6391
 
5612
6392
  # Get transaction data
5613
- # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
6393
+ # The `/transactions/get` endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype `student`; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in `/transactions/get`. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the `count` and `offset` parameters in conjunction with the `total_transactions` response body field to fetch all available transactions. Data returned by `/transactions/get` will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item's `status.transactions.last_successful_update` field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the `/transactions/refresh` endpoint. Note that data may not be immediately available to `/transactions/get`. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with `transactions`, or upon the first call to `/transactions/get`, if it wasn't. To be alerted when transaction data is ready to be fetched, listen for the [`INITIAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#initial_update) and [`HISTORICAL_UPDATE`](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when `/transactions/get` is called, it will return a `PRODUCT_NOT_READY` error.
5614
6394
  # @param transactions_get_request [TransactionsGetRequest]
5615
6395
  # @param [Hash] opts the optional parameters
5616
6396
  # @return [TransactionsGetResponse]
@@ -5620,7 +6400,7 @@ module Plaid
5620
6400
  end
5621
6401
 
5622
6402
  # Get transaction data
5623
- # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products#investments) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/webhooks#transactions-initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/webhooks#transactions-historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
6403
+ # The &#x60;/transactions/get&#x60; endpoint allows developers to receive user-authorized transaction data for credit, depository, and some loan-type accounts (only those with account subtype &#x60;student&#x60;; coverage may be limited). For transaction history from investments accounts, use the [Investments endpoint](https://plaid.com/docs/api/products/investments/) instead. Transaction data is standardized across financial institutions, and in many cases transactions are linked to a clean name, entity type, location, and category. Similarly, account data is standardized and returned with a clean name, number, balance, and other meta information where available. Transactions are returned in reverse-chronological order, and the sequence of transaction ordering is stable and will not shift. Transactions are not immutable and can also be removed altogether by the institution; a removed transaction will no longer appear in &#x60;/transactions/get&#x60;. For more details, see [Pending and posted transactions](https://plaid.com/docs/transactions/transactions-data/#pending-and-posted-transactions). Due to the potentially large number of transactions associated with an Item, results are paginated. Manipulate the &#x60;count&#x60; and &#x60;offset&#x60; parameters in conjunction with the &#x60;total_transactions&#x60; response body field to fetch all available transactions. Data returned by &#x60;/transactions/get&#x60; will be the data available for the Item as of the most recent successful check for new transactions. Plaid typically checks for new data multiple times a day, but these checks may occur less frequently, such as once a day, depending on the institution. An Item&#39;s &#x60;status.transactions.last_successful_update&#x60; field will show the timestamp of the most recent successful update. To force Plaid to check for new transactions, you can use the &#x60;/transactions/refresh&#x60; endpoint. Note that data may not be immediately available to &#x60;/transactions/get&#x60;. Plaid will begin to prepare transactions data upon Item link, if Link was initialized with &#x60;transactions&#x60;, or upon the first call to &#x60;/transactions/get&#x60;, if it wasn&#39;t. To be alerted when transaction data is ready to be fetched, listen for the [&#x60;INITIAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#initial_update) and [&#x60;HISTORICAL_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#historical_update) webhooks. If no transaction history is ready when &#x60;/transactions/get&#x60; is called, it will return a &#x60;PRODUCT_NOT_READY&#x60; error.
5624
6404
  # @param transactions_get_request [TransactionsGetRequest]
5625
6405
  # @param [Hash] opts the optional parameters
5626
6406
  # @return [Array<(TransactionsGetResponse, Integer, Hash)>] TransactionsGetResponse data, response status code and response headers
@@ -5740,7 +6520,7 @@ module Plaid
5740
6520
  end
5741
6521
 
5742
6522
  # Refresh transaction data
5743
- # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
6523
+ # `/transactions/refresh` is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling `/transactions/refresh`, Plaid will fire a webhook: [`TRANSACTIONS_REMOVED`](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [`DEFAULT_UPDATE`](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling `/transactions/get`. Access to `/transactions/refresh` in Production is specific to certain pricing plans. If you cannot access `/transactions/refresh` in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
5744
6524
  # @param transactions_refresh_request [TransactionsRefreshRequest]
5745
6525
  # @param [Hash] opts the optional parameters
5746
6526
  # @return [TransactionsRefreshResponse]
@@ -5750,7 +6530,7 @@ module Plaid
5750
6530
  end
5751
6531
 
5752
6532
  # Refresh transaction data
5753
- # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/webhooks#deleted-transactions-detected) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/webhooks#transactions-default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
6533
+ # &#x60;/transactions/refresh&#x60; is an optional endpoint for users of the Transactions product. It initiates an on-demand extraction to fetch the newest transactions for an Item. This on-demand extraction takes place in addition to the periodic extractions that automatically occur multiple times a day for any Transactions-enabled Item. If changes to transactions are discovered after calling &#x60;/transactions/refresh&#x60;, Plaid will fire a webhook: [&#x60;TRANSACTIONS_REMOVED&#x60;](https://plaid.com/docs/api/products/transactions/#transactions_removed) will be fired if any removed transactions are detected, and [&#x60;DEFAULT_UPDATE&#x60;](https://plaid.com/docs/api/products/transactions/#default_update) will be fired if any new transactions are detected. New transactions can be fetched by calling &#x60;/transactions/get&#x60;. Access to &#x60;/transactions/refresh&#x60; in Production is specific to certain pricing plans. If you cannot access &#x60;/transactions/refresh&#x60; in Production, [contact Sales](https://www.plaid.com/contact) for assistance.
5754
6534
  # @param transactions_refresh_request [TransactionsRefreshRequest]
5755
6535
  # @param [Hash] opts the optional parameters
5756
6536
  # @return [Array<(TransactionsRefreshResponse, Integer, Hash)>] TransactionsRefreshResponse data, response status code and response headers
@@ -5804,6 +6584,201 @@ module Plaid
5804
6584
  return data, status_code, headers
5805
6585
  end
5806
6586
 
6587
+ # Create transaction category rule
6588
+ # The `/transactions/rules/create` endpoint creates transaction categorization rules. Rules will be applied on the Item's transactions returned in `/transactions/get` response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
6589
+ # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
6590
+ # @param [Hash] opts the optional parameters
6591
+ # @return [TransactionsRulesCreateResponse]
6592
+ def transactions_rules_create(transactions_rules_create_request, opts = {})
6593
+ data, _status_code, _headers = transactions_rules_create_with_http_info(transactions_rules_create_request, opts)
6594
+ data
6595
+ end
6596
+
6597
+ # Create transaction category rule
6598
+ # The &#x60;/transactions/rules/create&#x60; endpoint creates transaction categorization rules. Rules will be applied on the Item&#39;s transactions returned in &#x60;/transactions/get&#x60; response. The product is currently in beta. To request access, contact transactions-feedback@plaid.com.
6599
+ # @param transactions_rules_create_request [TransactionsRulesCreateRequest]
6600
+ # @param [Hash] opts the optional parameters
6601
+ # @return [Array<(TransactionsRulesCreateResponse, Integer, Hash)>] TransactionsRulesCreateResponse data, response status code and response headers
6602
+ def transactions_rules_create_with_http_info(transactions_rules_create_request, opts = {})
6603
+ if @api_client.config.debugging
6604
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_create ...'
6605
+ end
6606
+ # verify the required parameter 'transactions_rules_create_request' is set
6607
+ if @api_client.config.client_side_validation && transactions_rules_create_request.nil?
6608
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_create_request' when calling PlaidApi.transactions_rules_create"
6609
+ end
6610
+ # resource path
6611
+ local_var_path = '/beta/transactions/rules/create'
6612
+
6613
+ # query parameters
6614
+ query_params = opts[:query_params] || {}
6615
+
6616
+ # header parameters
6617
+ header_params = opts[:header_params] || {}
6618
+ # HTTP header 'Accept' (if needed)
6619
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6620
+ # HTTP header 'Content-Type'
6621
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6622
+
6623
+ # form parameters
6624
+ form_params = opts[:form_params] || {}
6625
+
6626
+ # http body (model)
6627
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_create_request)
6628
+
6629
+ # return_type
6630
+ return_type = opts[:debug_return_type] || 'TransactionsRulesCreateResponse'
6631
+
6632
+ # auth_names
6633
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6634
+
6635
+ new_options = opts.merge(
6636
+ :operation => :"PlaidApi.transactions_rules_create",
6637
+ :header_params => header_params,
6638
+ :query_params => query_params,
6639
+ :form_params => form_params,
6640
+ :body => post_body,
6641
+ :auth_names => auth_names,
6642
+ :return_type => return_type
6643
+ )
6644
+
6645
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6646
+ if @api_client.config.debugging
6647
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6648
+ end
6649
+ return data, status_code, headers
6650
+ end
6651
+
6652
+ # Return a list of rules created for the Item associated with the access token.
6653
+ # The `/transactions/rules/list` returns a list of transaction rules created for the Item associated with the access token.
6654
+ # @param transactions_rules_list_request [TransactionsRulesListRequest]
6655
+ # @param [Hash] opts the optional parameters
6656
+ # @return [TransactionsRulesListResponse]
6657
+ def transactions_rules_list(transactions_rules_list_request, opts = {})
6658
+ data, _status_code, _headers = transactions_rules_list_with_http_info(transactions_rules_list_request, opts)
6659
+ data
6660
+ end
6661
+
6662
+ # Return a list of rules created for the Item associated with the access token.
6663
+ # The &#x60;/transactions/rules/list&#x60; returns a list of transaction rules created for the Item associated with the access token.
6664
+ # @param transactions_rules_list_request [TransactionsRulesListRequest]
6665
+ # @param [Hash] opts the optional parameters
6666
+ # @return [Array<(TransactionsRulesListResponse, Integer, Hash)>] TransactionsRulesListResponse data, response status code and response headers
6667
+ def transactions_rules_list_with_http_info(transactions_rules_list_request, opts = {})
6668
+ if @api_client.config.debugging
6669
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_list ...'
6670
+ end
6671
+ # verify the required parameter 'transactions_rules_list_request' is set
6672
+ if @api_client.config.client_side_validation && transactions_rules_list_request.nil?
6673
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_list_request' when calling PlaidApi.transactions_rules_list"
6674
+ end
6675
+ # resource path
6676
+ local_var_path = '/beta/transactions/rules/list'
6677
+
6678
+ # query parameters
6679
+ query_params = opts[:query_params] || {}
6680
+
6681
+ # header parameters
6682
+ header_params = opts[:header_params] || {}
6683
+ # HTTP header 'Accept' (if needed)
6684
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6685
+ # HTTP header 'Content-Type'
6686
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6687
+
6688
+ # form parameters
6689
+ form_params = opts[:form_params] || {}
6690
+
6691
+ # http body (model)
6692
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_list_request)
6693
+
6694
+ # return_type
6695
+ return_type = opts[:debug_return_type] || 'TransactionsRulesListResponse'
6696
+
6697
+ # auth_names
6698
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6699
+
6700
+ new_options = opts.merge(
6701
+ :operation => :"PlaidApi.transactions_rules_list",
6702
+ :header_params => header_params,
6703
+ :query_params => query_params,
6704
+ :form_params => form_params,
6705
+ :body => post_body,
6706
+ :auth_names => auth_names,
6707
+ :return_type => return_type
6708
+ )
6709
+
6710
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6711
+ if @api_client.config.debugging
6712
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_list\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6713
+ end
6714
+ return data, status_code, headers
6715
+ end
6716
+
6717
+ # Remove transaction rule
6718
+ # The `/transactions/rules/remove` endpoint is used to remove a transaction rule.
6719
+ # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
6720
+ # @param [Hash] opts the optional parameters
6721
+ # @return [TransactionsRulesRemoveResponse]
6722
+ def transactions_rules_remove(transactions_rules_remove_request, opts = {})
6723
+ data, _status_code, _headers = transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts)
6724
+ data
6725
+ end
6726
+
6727
+ # Remove transaction rule
6728
+ # The &#x60;/transactions/rules/remove&#x60; endpoint is used to remove a transaction rule.
6729
+ # @param transactions_rules_remove_request [TransactionsRulesRemoveRequest]
6730
+ # @param [Hash] opts the optional parameters
6731
+ # @return [Array<(TransactionsRulesRemoveResponse, Integer, Hash)>] TransactionsRulesRemoveResponse data, response status code and response headers
6732
+ def transactions_rules_remove_with_http_info(transactions_rules_remove_request, opts = {})
6733
+ if @api_client.config.debugging
6734
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transactions_rules_remove ...'
6735
+ end
6736
+ # verify the required parameter 'transactions_rules_remove_request' is set
6737
+ if @api_client.config.client_side_validation && transactions_rules_remove_request.nil?
6738
+ fail ArgumentError, "Missing the required parameter 'transactions_rules_remove_request' when calling PlaidApi.transactions_rules_remove"
6739
+ end
6740
+ # resource path
6741
+ local_var_path = '/beta/transactions/rules/remove'
6742
+
6743
+ # query parameters
6744
+ query_params = opts[:query_params] || {}
6745
+
6746
+ # header parameters
6747
+ header_params = opts[:header_params] || {}
6748
+ # HTTP header 'Accept' (if needed)
6749
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
6750
+ # HTTP header 'Content-Type'
6751
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
6752
+
6753
+ # form parameters
6754
+ form_params = opts[:form_params] || {}
6755
+
6756
+ # http body (model)
6757
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transactions_rules_remove_request)
6758
+
6759
+ # return_type
6760
+ return_type = opts[:debug_return_type] || 'TransactionsRulesRemoveResponse'
6761
+
6762
+ # auth_names
6763
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
6764
+
6765
+ new_options = opts.merge(
6766
+ :operation => :"PlaidApi.transactions_rules_remove",
6767
+ :header_params => header_params,
6768
+ :query_params => query_params,
6769
+ :form_params => form_params,
6770
+ :body => post_body,
6771
+ :auth_names => auth_names,
6772
+ :return_type => return_type
6773
+ )
6774
+
6775
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
6776
+ if @api_client.config.debugging
6777
+ @api_client.config.logger.debug "API called: PlaidApi#transactions_rules_remove\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
6778
+ end
6779
+ return data, status_code, headers
6780
+ end
6781
+
5807
6782
  # Get incremental transaction updates on an Item
5808
6783
  # 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.
5809
6784
  # @param transactions_sync_request [TransactionsSyncRequest]
@@ -5870,7 +6845,7 @@ module Plaid
5870
6845
  end
5871
6846
 
5872
6847
  # Create a transfer authorization
5873
- # 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`.
6848
+ # Use the `/transfer/authorization/create` endpoint to determine transfer failure risk. In Plaid's sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an `amount` less than the available balance in the account. - To approve a transfer with the rationale code `MANUALLY_VERIFIED_ITEM`, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code `LOGIN_REQUIRED`, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code `NSF`, the available balance on the account must be less than the authorization `amount`. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code `RISK`, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
5874
6849
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5875
6850
  # @param [Hash] opts the optional parameters
5876
6851
  # @return [TransferAuthorizationCreateResponse]
@@ -5880,7 +6855,7 @@ module Plaid
5880
6855
  end
5881
6856
 
5882
6857
  # Create a transfer authorization
5883
- # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s sandbox environment the decisions will be returned as follows: - To approve a transfer, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To permit a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To permit a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [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 &#x60;ERROR&#x60;.
6858
+ # Use the &#x60;/transfer/authorization/create&#x60; endpoint to determine transfer failure risk. In Plaid&#39;s sandbox environment the decisions will be returned as follows: - To approve a transfer with null rationale code, make an authorization request with an &#x60;amount&#x60; less than the available balance in the account. - To approve a transfer with the rationale code &#x60;MANUALLY_VERIFIED_ITEM&#x60;, create an Item in Link through the [Same Day Micro-deposits flow](https://plaid.com/docs/auth/coverage/testing/#testing-same-day-micro-deposits). - To approve a transfer with the rationale code &#x60;LOGIN_REQUIRED&#x60;, [reset the login for an Item](https://plaid.com/docs/sandbox/#item_login_required). - To decline a transfer with the rationale code &#x60;NSF&#x60;, the available balance on the account must be less than the authorization &#x60;amount&#x60;. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox. - To decline a transfer with the rationale code &#x60;RISK&#x60;, the available balance on the account must be exactly $0. See [Create Sandbox test data](https://plaid.com/docs/sandbox/user-custom/) for details on how to customize data in Sandbox.
5884
6859
  # @param transfer_authorization_create_request [TransferAuthorizationCreateRequest]
5885
6860
  # @param [Hash] opts the optional parameters
5886
6861
  # @return [Array<(TransferAuthorizationCreateResponse, Integer, Hash)>] TransferAuthorizationCreateResponse data, response status code and response headers
@@ -6454,6 +7429,71 @@ module Plaid
6454
7429
  return data, status_code, headers
6455
7430
  end
6456
7431
 
7432
+ # Migrate account into Transfers
7433
+ # As an alternative to adding Items via Link, you can also use the `/transfer/migrate_account` endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as `/accounts/balance/get`, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to `/transfer/migrate_account` is not enabled by default; to obtain access, contact your Plaid Account Manager.
7434
+ # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
7435
+ # @param [Hash] opts the optional parameters
7436
+ # @return [TransferMigrateAccountResponse]
7437
+ def transfer_migrate_account(transfer_migrate_account_request, opts = {})
7438
+ data, _status_code, _headers = transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts)
7439
+ data
7440
+ end
7441
+
7442
+ # Migrate account into Transfers
7443
+ # As an alternative to adding Items via Link, you can also use the &#x60;/transfer/migrate_account&#x60; endpoint to migrate known account and routing numbers to Plaid Items. Note that Items created in this way are not compatible with endpoints for other products, such as &#x60;/accounts/balance/get&#x60;, and can only be used with Transfer endpoints. If you require access to other endpoints, create the Item through Link instead. Access to &#x60;/transfer/migrate_account&#x60; is not enabled by default; to obtain access, contact your Plaid Account Manager.
7444
+ # @param transfer_migrate_account_request [TransferMigrateAccountRequest]
7445
+ # @param [Hash] opts the optional parameters
7446
+ # @return [Array<(TransferMigrateAccountResponse, Integer, Hash)>] TransferMigrateAccountResponse data, response status code and response headers
7447
+ def transfer_migrate_account_with_http_info(transfer_migrate_account_request, opts = {})
7448
+ if @api_client.config.debugging
7449
+ @api_client.config.logger.debug 'Calling API: PlaidApi.transfer_migrate_account ...'
7450
+ end
7451
+ # verify the required parameter 'transfer_migrate_account_request' is set
7452
+ if @api_client.config.client_side_validation && transfer_migrate_account_request.nil?
7453
+ fail ArgumentError, "Missing the required parameter 'transfer_migrate_account_request' when calling PlaidApi.transfer_migrate_account"
7454
+ end
7455
+ # resource path
7456
+ local_var_path = '/transfer/migrate_account'
7457
+
7458
+ # query parameters
7459
+ query_params = opts[:query_params] || {}
7460
+
7461
+ # header parameters
7462
+ header_params = opts[:header_params] || {}
7463
+ # HTTP header 'Accept' (if needed)
7464
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7465
+ # HTTP header 'Content-Type'
7466
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7467
+
7468
+ # form parameters
7469
+ form_params = opts[:form_params] || {}
7470
+
7471
+ # http body (model)
7472
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(transfer_migrate_account_request)
7473
+
7474
+ # return_type
7475
+ return_type = opts[:debug_return_type] || 'TransferMigrateAccountResponse'
7476
+
7477
+ # auth_names
7478
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7479
+
7480
+ new_options = opts.merge(
7481
+ :operation => :"PlaidApi.transfer_migrate_account",
7482
+ :header_params => header_params,
7483
+ :query_params => query_params,
7484
+ :form_params => form_params,
7485
+ :body => post_body,
7486
+ :auth_names => auth_names,
7487
+ :return_type => return_type
7488
+ )
7489
+
7490
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7491
+ if @api_client.config.debugging
7492
+ @api_client.config.logger.debug "API called: PlaidApi#transfer_migrate_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7493
+ end
7494
+ return data, status_code, headers
7495
+ end
7496
+
6457
7497
  # Lists historical repayments
6458
7498
  # The `/transfer/repayment/list` endpoint fetches repayments matching the given filters. Repayments are returned in reverse-chronological order (most recent first) starting at the given `start_time`.
6459
7499
  # @param transfer_repayment_list_request [TransferRepaymentListRequest]
@@ -6714,6 +7754,71 @@ module Plaid
6714
7754
  return data, status_code, headers
6715
7755
  end
6716
7756
 
7757
+ # Create user
7758
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
7759
+ # @param user_create_request [UserCreateRequest]
7760
+ # @param [Hash] opts the optional parameters
7761
+ # @return [UserCreateResponse]
7762
+ def user_create(user_create_request, opts = {})
7763
+ data, _status_code, _headers = user_create_with_http_info(user_create_request, opts)
7764
+ data
7765
+ end
7766
+
7767
+ # Create user
7768
+ # This endpoint should be called for each of your end users before they begin a Plaid income flow. This provides you a single token to access all income data associated with the user. You should only create one per end user.
7769
+ # @param user_create_request [UserCreateRequest]
7770
+ # @param [Hash] opts the optional parameters
7771
+ # @return [Array<(UserCreateResponse, Integer, Hash)>] UserCreateResponse data, response status code and response headers
7772
+ def user_create_with_http_info(user_create_request, opts = {})
7773
+ if @api_client.config.debugging
7774
+ @api_client.config.logger.debug 'Calling API: PlaidApi.user_create ...'
7775
+ end
7776
+ # verify the required parameter 'user_create_request' is set
7777
+ if @api_client.config.client_side_validation && user_create_request.nil?
7778
+ fail ArgumentError, "Missing the required parameter 'user_create_request' when calling PlaidApi.user_create"
7779
+ end
7780
+ # resource path
7781
+ local_var_path = '/user/create'
7782
+
7783
+ # query parameters
7784
+ query_params = opts[:query_params] || {}
7785
+
7786
+ # header parameters
7787
+ header_params = opts[:header_params] || {}
7788
+ # HTTP header 'Accept' (if needed)
7789
+ header_params['Accept'] = @api_client.select_header_accept(['application/json'])
7790
+ # HTTP header 'Content-Type'
7791
+ header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
7792
+
7793
+ # form parameters
7794
+ form_params = opts[:form_params] || {}
7795
+
7796
+ # http body (model)
7797
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(user_create_request)
7798
+
7799
+ # return_type
7800
+ return_type = opts[:debug_return_type] || 'UserCreateResponse'
7801
+
7802
+ # auth_names
7803
+ auth_names = opts[:debug_auth_names] || ['clientId', 'plaidVersion', 'secret']
7804
+
7805
+ new_options = opts.merge(
7806
+ :operation => :"PlaidApi.user_create",
7807
+ :header_params => header_params,
7808
+ :query_params => query_params,
7809
+ :form_params => form_params,
7810
+ :body => post_body,
7811
+ :auth_names => auth_names,
7812
+ :return_type => return_type
7813
+ )
7814
+
7815
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
7816
+ if @api_client.config.debugging
7817
+ @api_client.config.logger.debug "API called: PlaidApi#user_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
7818
+ end
7819
+ return data, status_code, headers
7820
+ end
7821
+
6717
7822
  # Fetch an e-wallet
6718
7823
  # Fetch an e-wallet. The response includes the current balance.
6719
7824
  # @param wallet_get_request [WalletGetRequest]